A label model for stripe labels which supports the possible header positions of IRows and IColumns.
Remarks
This label model supports four positions inside of the stripe bounds. The east and west positions are rotated automatically. ILabelModelParameters created by this model support only IStripe instances as label owner.
It uses the label's preferredSize for the size of the label layout.
Type Details
- yfiles module
- view-table
- yfiles-umd modules
- view-table, view
- Legacy UMD name
- yfiles.graph.StripeLabelModel
See Also
Sample Graphs
Constructors
Creates a new instance of this model with empty insets.
Parameters
A map of options to pass to the method.
- useActualInsets - boolean
A value indicating whether to use the actual insets or the normal insets of a stripe for centering the label inside the stripe header area. This option sets the useActualInsets property on the created object.
- ratio - number
The ratio how far the label should be positioned from the border in the header area. This option sets the ratio property on the created object.
Properties
Gets or sets a value indicating whether to use the actual insets or the normal insets of a stripe for centering the label inside the stripe header area.
Remarks
true the header insets are used. Default is falseMethods
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 - StripeLabelModelPosition
- 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 in form of an IOrientedRectangle for a given label using the given model parameter.
Remarks
Parameters
A map of options to pass to the method.
- label - ILabel
- the label to calculate the geometry for
- layoutParameter - ILabelModelParameter
- A parameter that has been created by this model. This is typically the parameter that yielded this instance through its model property.
Returns
- ↪IOrientedRectangle
- An instance that describes the geometry. This is typically an instance designed as a flyweight, so 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
See Also
Implements
Constants
A predefined parameter instance that places a label inside the right header of a row.
Remarks
Sample Graphs
A predefined parameter instance that places a label inside the top header of a column.
Remarks
Sample Graphs
A predefined parameter instance that places a label inside the bottom header of a column.
Remarks
Sample Graphs
A predefined parameter instance that places a label inside the left header of a row.