TemplatePortStyleBase

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

This can be used to conveniently customize the lookup behavior of the style renderers that are associated with this instance. E.g. it is possible to provide customized implementations of ISelectionIndicatorInstaller, IHighlightIndicatorInstaller, IHandleProvider, INodeSizeConstraintProvider, and INodeInsetsProvider. Simple style implementations can use EMPTY_CONTEXT_LOOKUP but may not use null for this property. The default value is EMPTY_CONTEXT_LOOKUP

cssClass

: string

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.

normalizedOutline

: GeneralPath

Gets or sets a path that specifies the normalized outline of a port that will be displayed using the created visual.

Remarks

The shape will automatically be arranged and transformed to have the bounds of the port. This shape will be used to satisfy requests to isInBox and isHit and may be left null to indicate default (rectangular) behavior.

The default value is null.

offset

: Point

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).

renderer

: IPortStyleRenderer

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

The idiom for retrieving, e.g. an IVisualCreator implementation for a given style is:

const creator = style.renderer.getVisualCreator(port, style)
const visual = creator.createVisual(context)

Implements

IPortStyle

renderSize

: Size

Gets or sets the size of the port that will be displayed using the created visual.

Remarks

This size will be used to satisfy requests to isInBox, isInPath, getBounds, and isHit. The default value is (5,5).

styleTag

: any

Gets or sets the tag that is associated with this style instance.

Remarks

The various style renderer implementations can use this tag to make it accessible in the context of the instantiated templates and controls. The framework does not make any assumptions about the value of this property. It is there for convenient use in the process of data binding the templates. This property supports property change notification and can thus be data bound easily.

Methods

clone

() : Object

Performs a shallow clone of this instance, except for the value of styleTag which is cloned, too, if it can be cloned.

Returns

↪Object: A clone of this instance.

Implements

ICloneable

createTemplate

(context: IRenderContext, port: IPort) : SvgVisual

Factory method that is called by the TemplatePortStyleRenderer to create the visual that will be used for the display of the port.

Parameters

options - Object
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.

onPropertyChanged

(evt: PropertyChangedEventArgs)

Raises the PropertyChanged event.

Parameters

options - Object
A map of options to pass to the method.

evt - PropertyChangedEventArgs: The PropertyChangedEventArgs instance containing the event data.

Events

PropertyChanged

Occurs when a property value changes.

Overrides

IPropertyObservable.PropertyChanged

Event Registration

addPropertyChangedListener(function(this, PropertyChangedEventArgs):void)

Event Deregistration

removePropertyChangedListener(function(this, PropertyChangedEventArgs):void)

Signature Details

function(sender: any, args: PropertyChangedEventArgs)

Defines the handler for a PropertyChanged event.

Parameters

sender - any: The object which dispatched the event.
args - PropertyChangedEventArgs: The arguments which define the change.

Static Methods

loadAllTemplates

()

Loads all template script elements that have not been parsed, yet, and creates the respective template cache objects.

Remarks

This method can be called to perform the template loading at a certain point in time, for example during application startup. By default, a template is loaded lazily when the first visual using this template is built.

TemplatePortStyleBase

Type Details

See Also

Constructors