A label model for group node labels that are placed inside the tab or tab background area of a GroupNodeStyle instance.
Type Details
- yfiles module
- styles-group
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.GroupNodeLabelModel
See Also
Constructors
Initializes a new instance of this class.
Parameters
A map of options to pass to the method.
- considerTabInset - boolean
A value that determines if the label geometry calculated by this model takes the tabInset into account. This option sets the considerTabInset property on the created object.
Properties
Gets or sets a value that determines if the label geometry calculated by this model takes the tabInset into account.
Remarks
If true, the label geometry will fill the area between group or folder icon and the outer border of the tab (background) area only up to a distance of tabInset to icon and border. If false, the label geometry will fill the aforementioned area completely.
The default value is true.
Methods
Creates a parameter that places labels inside the tab area of a GroupNodeStyle instance.
Returns
- ↪ILabelModelParameter
- A parameter that places labels inside the tab area of a GroupNodeStyle instance.
See Also
Implements
Creates a parameter that places labels inside the tab background area of a GroupNodeStyle.
Returns
- ↪ILabelModelParameter
- A parameter that places labels inside the tab background area of a GroupNodeStyle.
See Also
Returns an empty context.
Parameters
A map of options to pass to the method.
- label - ILabel
- The label to use in the context.
- layoutParameter - ILabelModelParameter
- The parameter to use for the label in the context.
Returns
- ↪ILookup
- An empty context.
See Also
Implements
Calculates the geometry of the given label using the given model parameter.
Parameters
A map of options to pass to the method.
- label - ILabel
- The label to calculate the geometry for.
- layoutParameter - ILabelModelParameter
- A parameter that is compatible with this model. Typically, this is a parameter that has been created by this model, and its property model returns this instance.
Returns
- ↪IOrientedRectangle
- An IOrientedRectangle that describes the geometry of the label. This is typically designed as a flyweight, therefore clients should not cache the instance but store the values if they need a snapshot for later use.
Implements
Returns an enumerator over a set of possible ILabelModelParameter instances that can be used for the given label and model.
Parameters
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.
Implements
Returns an instance that implements the given type or null.
Remarks
null implementations for the types, nor does it have to return the same instance any time. Also it depends on the type and context whether the instance returned stays up to date or needs to be reobtained for subsequent use.Type Parameters
- T: any
Parameters
A map of options to pass to the method.
- type - Class<T>
- The type for which an instance shall be returned.
Returns
- ↪T
- an instance that is assignable to type or
null