An IPortStyle that uses an SVG snippet as template for the visualization of IPorts.
Remarks
In contrast to TemplatePortStyle, the SVG template used by this style must be encoded as string and assigned to the svgContent property. Note that the renderSize should be specified to match the size of the visual's template.
It is vital that the SVG snippet does not declare the SVG namespace itself. Its content is parsed in a dummy namespace in order to avoid immediate validation of the result. The resulting SVG elements are automatically created in the SVG namespace before they are added to the DOM.
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 port'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 port that are exposed by the ITemplateStyleBindingContext 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 depending:
yfiles-selectedyfiles-focusedyfiles-highlighted
Related Programming Samples
- Organization Chart
- An interactive viewer for organization charts with adaptive styles and automatic layout.
Type Details
- yfiles module
- styles-template
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.styles.StringTemplatePortStyle
See Also
Constructors
Creates a new instance using the provided renderer.
Parameters
A map of options to pass to the method.
- svgContent - string
- The SVG snippet to use as template.
- renderer - TemplatePortStyleRenderer
- The custom renderer for this style instance.
- 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.
- renderSize - Size
The size of the port that will be displayed using the created visual. This option sets the renderSize property on the created object.
- offset - Point
An offset for the port visualization. This option sets the offset property on the created object.
- normalizedOutline - GeneralPath
A path that specifies the normalized outline of a port that will be displayed using the created visual. This option sets the normalizedOutline property on the created object.
Properties
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
null for this property. The default value is EMPTY_CONTEXT_LOOKUPDefined 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 a path that specifies the normalized outline of a port that will be displayed using the created visual.
Gets or sets an offset for the port visualization.
Remarks
This offset will be used to satisfy requests to isInBox, isInPath, getBounds, and isHit. This can be used to have a port visualization that is not centered on the port's location, e.g. to get a port visualization that extends outside of the node, while the port lies on the node outline.
The default value is (0,0).
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 port and this style instance.
Remarks
const creator = style.renderer.getVisualCreator(port, 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 TemplatePortStyleRenderer to create the visual that will be used for the display of the port.
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context for which the visual should be created.
- port - IPort
- The port that will be rendered.
Returns
- ↪SvgVisual
- The readily styled visual.
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
Default Properties
Specifies whether code contained in the templates should be included in the DOM.
Remarks
Script tags and event listeners can be used to inject malicious code. This property should only be enabled if the templates originate from trusted sources. If the application allows to load external GraphML files, this property should probably not be enabled.
This setting is shared by StringTemplateNodeStyle, StringTemplateLabelStyle, StringTemplatePortStyle, and StringTemplateStripeStyle.
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.