A label model for node labels that lie inside of the node's layout bounds and have been stretched to fit the node's size.
Remarks
This label model supports seven positions inside of the layout's bounds.
The label's preferredSize is ignored. Instead, the label is stretched to fit the node's width and/or height.
For the vertical positions CENTER_VERTICAL, WEST, and EAST the label is rotated by 90 degrees.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.InteriorStretchLabelModel
See Also
Sample Graphs
Constructors
Properties
Methods
Creates a default parameter that can be used for this model.
Creates the parameter for the given position.
Parameters
A map of options to pass to the method.
- position - InteriorStretchLabelModelPosition
- The position.
Provides a lookup context for the given combination of label and parameter.
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 implementation of the ILookup interface that can be used to query additional aspects of the label/parameter combination.
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 the minimum size this model would require for the node owner of the label if the the given label was used with the provided parameter.
Parameters
A map of options to pass to the method.
- label - ILabel
- The label to use.
- layoutParameter - ILabelModelParameter
- The parameter to use.
Returns
- ↪Size
- The minimum size requirements for this label.
Returns the insets this model would require for the node owner of the label if the the given label was used with the provided parameter.
Parameters
A map of options to pass to the method.
- label - ILabel
- The label to use.
- layoutParameter - ILabelModelParameter
- The parameter to use.
Returns
- ↪Insets
- The insets rectangle.
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
See Also
Implements
Constants
A predefined parameter that places the label inside the node, filling the node's layout.
Remarks
See Also
Sample Graphs
A predefined parameter that places the label at the vertical center with the preferred height of the label and the width of the node.
Remarks
Sample Graphs
A predefined parameter that places the label at the horizontal center with the preferred width of the label and the height of the node.
Remarks
Sample Graphs
A predefined parameter that places the label at the right side of the node interior, stretching over the node's height.
Remarks
The label is rotated 90 degrees clockwise.
This parameter's model is immutable. Trying to change its insets property will raise an InvalidOperationError.
Sample Graphs
A predefined parameter that places the label at the top side of the node interior, stretching over the node's width.
Remarks
Sample Graphs
A predefined parameter that places the label at the bottom side of the node interior, stretching over the node's width.
Remarks
Sample Graphs
A predefined parameter that places the label at the left side of the node interior, stretching over the node's height.
Remarks
The label is rotated 90 degrees counterclockwise.
This parameter's model is immutable. Trying to change its insets property will raise an InvalidOperationError.