C

NodeStyleLabelStyleAdapter

Show Usages
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.
ImplementsInheritance Hierarchy

Remarks

The renderer of the nodeStyle used by this class must create SvgVisuals.

See Also

Developer's Guide

Members

No filters for this type

Constructors

NodeStyleLabelStyleAdapter

(nodeStyle?: INodeStyle, labelStyle?: ILabelStyle)
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.
Note that the styles will be stored by reference, thus modifying the style will directly affect the rendering of this instance.

Parameters

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.

Properties

autoFlip

: boolean
Gets a value indicating whether the label should be flipped 180 degrees automatically, if it would be oriented downwards, otherwise.
final

Property Value

true if the label should be flipped automatically, false otherwise. The default is true.

labelStyle

: ILabelStyle
Gets the ILabelStyle that is used for rendering the foreground of the label.
final

See Also

Developer's Guide

labelStylePadding

: Insets
Gets or sets the padding to apply for the labelStyle.
The default is (0,0,0,0)
conversionfinal

Property Value

The label style padding.

nodeStyle

: INodeStyle
Gets the INodeStyle that is used for rendering the background of the label.
final

renderer

: ILabelStyleRenderer
readonly
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.
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)
readonlyfinal

Methods

clone

(): Object
Create a clone of this object.

Return Value

Object
A clone of this object.