An ILabelStyle that uses an SVG snippet as template for the visualization of ILabels.
Remarks
This template style uses the styleResourceKey property to determine the template that will be applied to the Visual. The template must be specified in the DOM in a script element with the attribute type='text/yfiles-template'. See the StringTemplateLabelStyle class for a template style that gets its template as string.
The SVG template snippet can contain bindings in the form attribute="{Binding propertyName}" that bind the attribute value to the value of the property with the given name in the label's tag. The tag itself can be bound with attribute="{Binding}". If the bound object provides the function addPropertyChangedListener(listener) or implements IPropertyObservable, bindings to properties of the business object are dynamically updated if the registered listeners are called on property change. Business objects can be made observable by calling makeObservable.
TemplateBindings in the form attribute="{TemplateBinding propertyName}" bind the attribute value to one of the properties of the label that are exposed by the ILabelTemplateStyleBindingContext interface.
Bindings can specify converters and converter parameters. Converters are simple functions with the signature function(value:object, parameter:object):object. A converter has to be registered under its name either in the converter store or with the window object before it can be used.
TextWrapConverter is a built-in converter function which emits wrapped text as SVG elements. It can be used to display wrapped text in a template style. To use the TextWrapConverter the template style must include a <g> element that binds a property containing the text to be wrapped to data-content. TextWrapConverter must be specified as the converter function. The converter’s parameters are passed using a shorthand notation for width, height, font, trimming and color. See Text Wrapping in a Template Style for more details.
Depending on the current state, the following CSS classes are added to the root element of the template:
yfiles-selectedyfiles-focusedyfiles-highlighted
Related Programming Samples
- Template Styles
- Shows SVG template styles for nodes, labels and ports.
Type Details
- yfiles module
- styles-template
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.styles.TemplateLabelStyle
See Also
Constructors
Creates a new instance using the given render template id and a custom renderer instance.
Parameters
A map of options to pass to the method.
- renderTemplateId - string
- The id of the SVG snippet that will be used for the component.
- renderer - TemplateLabelStyleRenderer
- The custom renderer for this style instance.
- styleResourceKey - string
The string that will be used to look up the template that is applied to the component. This option sets the styleResourceKey property on the created object.
- styleTag - Object
The tag that is associated with this style instance. This option sets the styleTag property on the created object.
- contextLookup - IContextLookup
An implementation of IContextLookup that can be used to satisfy queries that are made to the implementation which is returned by calls to getContext that are made on the style renderer that is associated with this style instance. This option sets the contextLookup property on the created object.
- cssClass - string
An additional CSS class that will be added to the template's root element. This option sets the cssClass property on the created object.
- normalizedOutline - GeneralPath
The normalized outline of a label that will be displayed using the created visual. This option sets the normalizedOutline property on the created object.
- autoFlip - boolean
A value indicating whether the rendering should automatically be flipped (rotated by 180 degrees) if otherwise it would be rendered upside-down. This option sets the autoFlip property on the created object.
- preferredSize - Size
The preferred size of the labels that use this style. This option sets the preferredSize property on the created object.
Properties
Gets or sets a value indicating whether the rendering should automatically be flipped (rotated by 180 degrees) if otherwise it would be rendered upside-down.
Gets or sets an implementation of IContextLookup that can be used to satisfy queries that are made to the implementation which is returned by calls to getContext that are made on the style renderer that is associated with this style instance.
Remarks
Defined in
Gets or sets an additional CSS class that will be added to the template's root element.
Remarks
The default value is an empty string, in which case nothing is added.
Multiple classes can be set by separating them with spaces, just like with the SVG class attribute.
Defined in
Gets or sets the normalized outline of a label that will be displayed using the created visual.
Gets or sets the preferred size of the labels that use this style.
Defined in
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
const creator = style.renderer.getVisualCreator(label, style)
const visual = creator.createVisual(context)Implements
Gets or sets the tag that is associated with this style instance.
Remarks
Defined in
Methods
Performs a shallow clone of this instance, except for the value of styleTag which is cloned, too, if it can be cloned.
Factory method that is called by the TemplateLabelStyleRenderer to create the visual that will be used for the display of the label.
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context for which the visual should be created.
- label - ILabel
- The label that will be rendered.
Returns
- ↪SvgVisual
- The readily styled visual.
Defined in
Determines the preferred size of the label if this style was applied.
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context for which the size should be calculated.
- label - ILabel
- The label to determine the preferred size of.
Returns
- ↪Size
- The preferred size.
Defined in
Raises the PropertyChanged event.
Parameters
A map of options to pass to the method.
- evt - PropertyChangedEventArgs
- The PropertyChangedEventArgs instance containing the event data.
Defined in
Events
Occurs when a property value changes.
Overrides
Event Registration
addPropertyChangedListener(function(this, PropertyChangedEventArgs):void)Event Deregistration
removePropertyChangedListener(function(this, PropertyChangedEventArgs):void)Signature Details
function(sender: any, args: PropertyChangedEventArgs)
Parameters
- sender - any
- The object which dispatched the event.
- args - PropertyChangedEventArgs
- The arguments which define the change.
Constants
Gets the storage object for binding converters.
Remarks
Static Methods
Makes an object observable to bindings in template styles.
Remarks
Bindings to observable objects react to changes in the bound data. This enables dynamic styling of graph items that reacts to changes of the underlying business data of each graph item.
This method adds the functions firePropertyChanged, addPropertyChangedListener and removePropertyChangedListener to the given object. Call firePropertyChanged(propertyName: string) each time a bound property value changes in order to update the related bindings.
Parameters
A map of options to pass to the method.
- dataObject - Object
- The object to make observable.
Returns
- ↪Object
- The object that was passed in.