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
- view
Constructors
Initializes a new instance of this class.
Parameters
A map of options to pass to the method.
- considerTabPadding - boolean
- A value that determines if the label geometry calculated by this model takes the tabPadding into account. This option sets the considerTabPadding property on the created object.
Properties
Gets or sets a value that determines if the label geometry calculated by this model takes the tabPadding 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 tabPadding to the 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 background area of a GroupNodeStyle.
Returns
- ↪GroupNodeLabelModelParameter
- A parameter that places labels inside the tab background area of a GroupNodeStyle.
Creates a parameter that places labels inside the tab area of a GroupNodeStyle instance.
Returns
- ↪GroupNodeLabelModelParameter
- A parameter that places labels inside the tab area of a GroupNodeStyle instance.
Provides a lookup context for the given label.
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.