A label style decorator that uses a node style instance to render the background and a label style instance to render the foreground of a label.
Remarks
Type Details
- yFiles module
- view
Constructors
Creates a label style that uses the provided node style to render the background and the label style to render the foreground of this style.
Remarks
Note that the styles will be stored by reference, thus modifying the style will directly affect the rendering of this instance.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- nodeStyle - INodeStyle
- The style to use for rendering the background of the label.
- labelStyle - ILabelStyle
- The style to use for rendering the foreground of the label.
- autoFlip - boolean
- A value indicating whether the label should be flipped 180 degrees automatically, if it would be oriented downwards, otherwise. This option sets the autoFlip property on the created object.
- labelStylePadding - Insets
- The padding to apply for the labelStyle. This option sets the labelStylePadding property on the created object.
Properties
Gets the ILabelStyle that is used for rendering the foreground of the label.
Gets or sets the padding to apply for the labelStyle.
Remarks
The default is
(0,0,0,0)Property Value
The label style padding.
Gets the INodeStyle that is used for rendering the background of the label.
Gets the renderer implementation that can be queried for implementations that provide details about the visual appearance and visual behavior for a given label and this style instance.
Remarks
The idiom for retrieving, e.g. an IVisualCreator implementation for a given style is:
const creator = style.renderer.getVisualCreator(label, style)
const visual = creator.createVisual(context)Implements
Methods
Create a clone of this object.