A class that accepts a collection of objects from the NodeCreator<TDataItem> or EdgeCreator<TDataItem> to build ILabels from.
Remarks
Type Parameters
- TDataItem
- The type of the data items in the source.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.binding.LabelsSource
See Also
Constructors
LabelsSource
(labelCreator: LabelCreator<TDataItem>, idProvider?: function(TDataItem, Object):Object)Creates a new source with the given labelCreator.
Parameters
A map of options to pass to the method.
- labelCreator - LabelCreator<TDataItem>
- The creator that is used to create the edges of this source.
- idProvider - function(TDataItem, Object):Object
- An optional function that yields an id for each element of the associated data collection in the GraphBuilder.
Signature Details
function(dataItem: TDataItem, canonicalId: any) : anyA callback that provides an unique identifier for thedataItem.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.
Returns
- any
Properties
Gets or sets a provider that yields an id for each element of the associated data collection in the GraphBuilder.
Remarks
Signature Details
function(dataItem: TDataItem, canonicalId: any) : any
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.
Returns
- any
Gets or sets the LabelCreator<TDataItem> for this source which can be used to adjust the creation behavior.