documentationfor yFiles for HTML 3.0.0.3

Usages of ILabelStyle

Properties

stylein FoldingLabelDefaultsGets or sets the ILabelStyle to use when initializing the folding labels.
stylein FoldingLabelStateGets or sets the style of this label.
stylein ILabelGets the style that is responsible for the visual representation of this node in a CanvasComponent.
stylein ILabelDefaultsGets or sets the style to use for labels.
stylein LabelDefaults
stylein SimpleLabelGets or sets the style that is responsible for the visual representation of this node in a CanvasComponent.
stylein LabelEditingEventArgsGets or sets the style of the label to add.
stylesin CompositeLabelStyleGets a readonly list of the styles used by this instance.
wrappedStylein IconLabelStyleGets or sets the style that renders the text of the label and possibly its background.
labelStylein NodeStyleLabelStyleAdapterGets the ILabelStyle that is used for rendering the foreground of the label.
labelStylein LabelStyleIndicatorRendererGets or sets the style to use for the rendering.
stylein WebGLLabelStyleDecoratorThe style that will be used to render the ILabel outside of the WebGL2 context.

Fields

VOID_LABEL_STYLEin ILabelStyleA void implementation of a label style that does nothing and behaves like an invisible style.

Method Return Values

getStyle (TDataItem)in LabelCreatorObtains an ILabelStyle instance or null by resolving the styleProvider.
getUpdatedStyle (IGraph, ILabel, TDataItem)in LabelCreatorResolves the styleProvider and then applies the style bindings.
copyLabelStyle (IGraph, ILabel)in ClipboardGraphCopierCopies an ILabelStyle instance.
getDefaultStyleInstance ()in FoldingLabelDefaultsCreates the default ILabelStyle to use in initializeState.
copyLabelStyle (IGraph, ILabel)in GraphCopierCopies an ILabelStyle instance.
getStyleInstance (ILabelOwner)in ILabelDefaultsFactory method that returns a style instance for use with newly created labels.
createLabelStyle (IStripe)in ITableCreates an instance of the default label style for the given stripe.
getStyleInstance (ILabelOwner)in LabelDefaults
getLabelStyle (IInputModeContext, ILabelOwner)in EditLabelHelperDetermines the style to use for the label, depending on the owner.
getStyle (ILabel)in DelegatingLabelStyleProvides the core implementation of this style, returning the instance to delegate rendering logic.

Method Parameters

addLabelCore (IGraph, ILabelOwner, string, ILabelModelParameter, ILabelStyle, Size, ILabel['tag'])in LabelCreatorCalled from addLabel and performs the actual label creation in the graph.
addLabel (string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in FolderNodeState
addLabel (string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in FoldingEdgeState
FoldingLabelDefaults (ILabelDefaults?, )in FoldingLabelDefaultsCreates a new instance of this type, optionally configuring the values from the given ILabelDefaults object.
addLabel (FoldingLabelOwnerState, ILabel, string, ILabelModelParameter, ILabelStyle, Size, any)in FoldingLabelDefaultsSimple callback method that delegates to addLabel
addLabel (string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in FoldingLabelOwnerStateAdds a FoldingLabelState to this state.
addLabel (ILabelOwner, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in Graph
createUndoUnitForLabelStyleChange (ILabel, ILabelStyle)in GraphCreates the undo unit for changing the style of the given label.
onChangingLabelStyle (ILabel, ILabelStyle)in GraphCalled before a label style is being changed.
onLabelStyleChanged (ILabel, ILabelStyle)in GraphCalled after a label style has changed.
setStyle (ILabel, ILabelStyle)in GraphAssigns the given style instance by reference to the label.
addLabel (ILabelOwner, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in GraphWrapperBase
onLabelStyleChanged (ItemChangedEventArgs<ILabel,ILabelStyle>)in GraphWrapperBaseRaises the label-style-changed event.
setStyle (ILabel, ILabelStyle)in GraphWrapperBase
addLabel (ILabelOwner, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in IGraphAdd a label to the given node or edge using the text as the initial label text and label model parameter, style, and tag.
calculateLabelPreferredSize (ILabelOwner, string, ILabelModelParameter?, ILabelStyle?, ILabel['tag']?)in IGraphCalculates the preferred size of a label with the given properties.
setStyle (ILabel, ILabelStyle)in IGraphAssigns the given style instance by reference to the label.
addLabel (IStripe, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in ITableAdd a label to the given owner using the text as the initial label text and label model parameter and style.
calculateLabelPreferredSize (IStripe, ILabelStyle, ILabelModelParameter, string, ILabel['tag'])in ITableCalculates the preferred size of a label with the given properties.
setStyle (ILabel, ILabelStyle)in ITableAssigns the given style instance by reference to the label.
LabelDefaults ()in LabelDefaultsInitializes a new instance of the LabelDefaults class using a trivial parameter.
SimpleLabel (ILabelOwner?, string?, ILabelModelParameter?, )in SimpleLabelCreates an instance of the SimpleLabel class with default lookup, VOID_LABEL_STYLE as style, and the given parameter, text, and owner.
addLabel (IStripe, string, ILabelModelParameter?, ILabelStyle?, Size?, ILabel['tag']?)in Table
setStyle (ILabel, ILabelStyle)in TableAssigns the given style instance by reference to the label.
CompositeLabelStyle (ILabelStyle, ILabelStyle)in CompositeLabelStyleCreates a new instance of this style.
getBoundsProvider (ILabel, ILabelStyle)in ILabelStyleRendererGets an implementation of the IBoundsProvider interface that can handle the provided label and its associated style.
getContext (ILabel, ILabelStyle)in ILabelStyleRendererGets a temporary context instance that can be used to query additional information for the label's style.
getHitTestable (ILabel, ILabelStyle)in ILabelStyleRendererGets an implementation of the IHitTestable interface that can handle the provided label and its associated style.
getLassoTestable (ILabel, ILabelStyle)in ILabelStyleRendererGets an implementation of the ILassoTestable interface that can handle the provided label and its associated style.
getMarqueeTestable (ILabel, ILabelStyle)in ILabelStyleRendererGets an implementation of the IMarqueeTestable interface that can handle the provided label and its associated style.
getPreferredSize (ILabel, ILabelStyle)in ILabelStyleRendererCalculates the preferredSize of a given label using the associated style.
getVisibilityTestable (ILabel, ILabelStyle)in ILabelStyleRendererGets an implementation of the IVisibilityTestable interface that can handle the provided label and its associated style.
getVisualCreator (ILabel, ILabelStyle)in ILabelStyleRendererGets an implementation of the IVisualCreator interface that can handle the provided label and its associated style.
IconLabelStyle ()in IconLabelStyleCreates a new instance.
NodeStyleLabelStyleAdapter (INodeStyle?, ILabelStyle?, )in NodeStyleLabelStyleAdapterCreates a label style that uses the provided node style to render the background and the label style to render the foreground of this style.
LabelStyleIndicatorRenderer ()in LabelStyleIndicatorRendererCreate a new instance of this class.
WebGLLabelStyleDecorator (ILabelStyle, WebGLLabelStyle | WebGLIconLabelStyle)in WebGLLabelStyleDecoratorCreates a new instance of the class, specifying both styles to use depending on whether the label is rendered in- or outside the context of WebGL.

Implementing Types

IconLabelStyleA label style that wraps another ILabelStyle and draws an icon in addition to the text.
LabelStyleA basic label style which renders the label's text and optionally a background and border.
LabelStyleBaseAn abstract base class that makes it possible to easily implement a custom ILabelStyle.
MarkupLabelStyleA label style that interprets the label's text as markup and renders the label using rich text features.
NodeStyleLabelStyleAdapterA 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.
WebGLIconLabelStyleAn icon label style for use in WebGL2 rendering.
WebGLLabelStyleA label style for use in WebGL2 rendering.
WebGLLabelStyleDecoratorThis ILabelStyle is a decorator that lets the style unmodified, but carries a webGLStyle instance that will be used when this style is used for an ILabel in the context of a WebGLGraphModelManager.