new GraphConfiguration()
Configuration of a graph
Extends
Methods
(static) forContext(contextopt) → {$k.GraphConfiguration}
Returns the graph configuration for the context)
| Name | Type | Attributes | Description |
|---|---|---|---|
context | $k.SemanticElement | <optional> | Context of the configuration |
- Since
- 4.1.0
- Deprecated
- This function is deprecated and might be removed in future releases
- Type:
- $k.GraphConfiguration
(static) from(configurationElement) → {$k.GraphConfiguration}
Returns the confguration defined by the element
| Name | Type | Description |
|---|---|---|
configurationElement | $k.SemanticElement | The configuration element |
- Since
- 4.1.0
- Type:
- $k.GraphConfiguration
addElements(semanticElements) → {Array.<$k.SemanticElement>}
Set the node topics
| Name | Type | Description |
|---|---|---|
semanticElements | Array.<$k.SemanticElement> | The topics to add |
- Since
- 4.1.0
all elements in graph
- Type:
- Array.<$k.SemanticElement>
categories(keyFilteropt, detailFilteropt) → {Array.<object>}
| Name | Type | Attributes | Description |
|---|---|---|---|
keyFilter | object | <optional> | Alternative 1 (preferred): a $k.JSONRenderContext Alternative 2 (compatibility only): A filter. See $k.JSONRenderContext.prototype.setFilters(). |
detailFilter | object | <optional> | Only used if the key filter is not a $k.JSONRenderContext. See $k.JSONRenderContext.prototype.setLevelsOfDetail() |
- Since
- 4.1.0
- Type:
- Array.<object>
collapse(semanticElement) → {Array.<object>}
Collapse neigbours from node
| Name | Type | Description |
|---|---|---|
semanticElement | object | The element to collapse |
- Since
- 4.1.0
The collapsed graph objects
- Type:
- Array.<object>
configElement() → {$k.SemanticElement}
- Since
- 4.1.0
- Type:
- $k.SemanticElement
decorateElements(elements, decoration)
Add some JSON to each element
| Name | Type | Description |
|---|---|---|
elements | Array.<object> | The elements to be decorated |
decoration | object | decoration object |
- Since
- 4.3.0
expand(semanticElements, depthopt) → {Array.<object>}
Expand Node to its neighbours
| Name | Type | Attributes | Description |
|---|---|---|---|
semanticElements | Array.<object> | The element to expand | |
depth | Integer | <optional> | The depth to expand |
- Since
- 4.1.0
The expanded graph objects
- Type:
- Array.<object>
expandNodes(expandDepthopt) → {Array.<object>}
Expand the Nodes to their neighbours
| Name | Type | Attributes | Description |
|---|---|---|---|
expandDepth | integer | <optional> | The depth to expand the semantic objects via their connection, default value is 1 |
- Since
- 4.1.0
The expanded graph objects
- Type:
- Array.<object>
possibleRelationTargets(sourceTopic, keyFilteropt, detailFilteropt) → {Array.<object>}
Returns the possible relationtypes by targetTopic
| Name | Type | Attributes | Description |
|---|---|---|---|
sourceTopic | semanticElement | Semantisches Element | |
keyFilter | object | <optional> | Alternative 1 (preferred): a $k.JSONRenderContext Alternative 2 (compatibility only): A filter. See $k.JSONRenderContext.prototype.setFilters(). |
detailFilter | object | <optional> | Only used if the key filter is not a $k.JSONRenderContext. See $k.JSONRenderContext.prototype.setLevelsOfDetail() |
- Since
- 4.1.0
Map with key: target Topic value: Array with possibleRelationTypes
- Type:
- Array.<object>
render(keyFilteropt, detailFilteropt) → {Array.<object>}
Renders the graph node as literal objects
| Name | Type | Attributes | Description |
|---|---|---|---|
keyFilter | object | <optional> | Alternative 1 (preferred): a $k.JSONRenderContext Alternative 2 (compatibility only): A filter. See $k.JSONRenderContext.prototype.setFilters(). |
detailFilter | object | <optional> | Only used if the key filter is not a $k.JSONRenderContext. See $k.JSONRenderContext.prototype.setLevelsOfDetail() |
- Since
- 4.1.0
The rendered graph objects
- Type:
- Array.<object>
semanticElements() → {Array.<semanticElement>}
- Since
- 4.1.0
- Type:
- Array.<semanticElement>
setRenderContext(renderContextObject)
Set render context
| Name | Type | Description |
|---|---|---|
renderContextObject | RenderContext |
- Since
- 5.3.0
- Inherited From
- Deprecated
- This function is deprecated and might be removed in future releases