Helper interface used by ILabelModel implementations to provide possible candidate ILabelModelParameters for a given label and model.
Inheritance Hierarchy
ILabelModelParameterProvider
Remarks
Implementations of this interface can be retrieved from the ILabelModel's lookup method. Note that not all models necessarily need to or can provide implementations of this interface.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.ILabelModelParameterProvider
See Also
Methods
Returns an enumerator over a set of possible ILabelModelParameter instances that can be used for the given label and model.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- label - ILabel
- The label instance to use.
- model - ILabelModel
- The model to provide parameters for.
Returns
- ↪IEnumerable<ILabelModelParameter>
- A possibly empty enumerator over a set of label model parameters.
Static Methods
create
(getParameters: function(ILabel, ILabelModel):IEnumerable<ILabelModelParameter>) : ILabelModelParameterProviderCreates an implementation of the interface ILabelModelParameterProvider by using the given function as implementation for its getParameters method.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- getParameters - function(ILabel, ILabelModel):IEnumerable<ILabelModelParameter>
- A function for ILabelModelParameterProvider's single abstract method getParameters.
Returns
- ↪ILabelModelParameterProvider
- An instance of the ILabelModelParameterProvider interface based on the given function.