A class that accepts a collection of objects from the GraphBuilder to build IEdges from.
Inheritance Hierarchy
Remarks
It manages the structural aspects of the graph creation, while the associated edgeCreator is responsible for the properties of the created items.
Type Parameters
TDataItem
- The type of the data items in the source.
See Also
Developer's Guide
Members
Show:
Constructors
Parameters
- edgeCreator: EdgeCreator<TDataItem>
- The creator that is used to create the edges of this source.
- sourceIdProvider: function(TDataItem): anyconversion
- A function that yields a source node id for each element of the associated data collection in the GraphBuilder.A callback that provides an instance of type
TValuefor the givendataItem.Parameters- dataItem: TDataItem
- The data item for which a value shall be provided.
Return Value- any
- targetIdProvider: function(TDataItem): anyconversion
- A function that yields a target node id for each element of the associated data collection in the GraphBuilder.A callback that provides an instance of type
TValuefor the givendataItem.Parameters- dataItem: TDataItem
- The data item for which a value shall be provided.
Return Value- any
- idProvider?: function(TDataItem, any): anyconversion
- An optional function that yields an id for each element of the associated data collection in the GraphBuilder.A callback that provides an unique identifier for the
dataItem.id provider are used in NodesSource.idProvider, EdgesSource.idProvider and LabelsSource. idProvider to identify the created nodes, edges, and labels and avoid duplicate creation of items with the same ID.
The ID can also be used by parentIdProvider and sourceIdProvider and targetIdProvider to resolve the parent, source, or target nodes.
The ID is further used to identify nodes, edges, and labels during updateGraph.
Parameters- dataItem: TDataItem
- The value that will be passed in.
- canonicalId: any
- The original canonical id of the value. For data arrays and iterables this is the index into the collection. For Maps and data objects this is the key associated with a value.
Return Value- any
Properties
Gets or sets the EdgeCreator<TDataItem> for this source, which can be used to adjust the creation behavior.
Gets or sets the EdgeCreator<TDataItem> for this source, which can be used to adjust the creation behavior.
final
Gets or sets a provider that yields an id for each element of the associated data collection in the GraphBuilder.
Gets or sets a provider that yields an id for each element of the associated data collection in the GraphBuilder.
conversionfinal
A callback that provides an unique identifier for the
dataItem.id provider are used in NodesSource.idProvider, EdgesSource.idProvider and LabelsSource. idProvider to identify the created nodes, edges, and labels and avoid duplicate creation of items with the same ID.
The ID can also be used by parentIdProvider and sourceIdProvider and targetIdProvider to resolve the parent, source, or target nodes.
The ID is further used to identify nodes, edges, and labels during updateGraph.
Parameters
- dataItem: TDataItem
- The value that will be passed in.
- canonicalId: any
- The original canonical id of the value. For data arrays and iterables this is the index into the collection. For Maps and data objects this is the key associated with a value.
Return Value
- any
Gets the provider that yields a source node id for each element of the associated data collection in the GraphBuilder.
Gets the provider that yields a source node id for each element of the associated data collection in the GraphBuilder.
readonlyfinal
A callback that provides an instance of type
TValue for the given dataItem.Parameters
- dataItem: TDataItem
- The data item for which a value shall be provided.
Return Value
- any
See Also
Developer's Guide
Gets the provider that yields a target node id for each element of the associated data collection in the GraphBuilder.
Gets the provider that yields a target node id for each element of the associated data collection in the GraphBuilder.
readonlyfinal
A callback that provides an instance of type
TValue for the given dataItem.Parameters
- dataItem: TDataItem
- The data item for which a value shall be provided.
Return Value
- any
See Also
Developer's Guide
Methods
This implementation uses the sourceIdProvider to obtain the value from the data item.
protected
Parameters
- dataItem: TDataItem
- A single data item from the associated data collection in the GraphBuilder.
Return Value
- any
- The source node id to which the sourceIdProvider resolves with the data item.
This implementation uses the targetIdProvider to obtain the value from the data item.
protected
Parameters
- dataItem: TDataItem
- A single data item from the associated data collection in the GraphBuilder.
Return Value
- any
- The target node id to which the targetIdProvider resolves with the data item.