C

VoidPortProvider

Show Usages

A class responsible for creating VSDX masters and style sheets for IPorts that are rendered using the IPortStyle.VOID_PORT_STYLE.

Implements
Inheritance Hierarchy

Remarks

The provider has to be registered to the list of master providers of the VsdxExportConfiguration.

The master created for this style will be cached and returned for all ports that are rendered with IPortStyle.VOID_PORT_STYLE.

Members

Show:

Constructors

VoidPortProvider

()

Initializes a new instance of the VoidPortProvider class.

Methods

clear

()

This will be called once after the export is finished and shall clear any state created during the export, especially maps containing masters or style sheets for reuse.

Note that a master or style sheet is only valid for the same export run it was created.

Parameters

Return Value

Parameters

Return Value

node

(node: INode, context: MasterProviderContext): Promise<[ ShapeStyleConfiguration, null]> | ShapeStyleConfiguration | null

Will be called once for each node in the graph and shall return a VSDX Master and VSDX StyleSheets or an empty Promise.

When this method returns a value the propagation will be stopped and the returned master and styles are used for the shape representing this node. Otherwise, this node will be propagated through other IMasterProviders in the chain after this one.

Parameters

node: INode

The node to create the master and styles for.

context: MasterProviderContext

Return Value

Promise<[ ShapeStyleConfiguration, null]> | ShapeStyleConfiguration | null
A promise with an object containing a master and style sheets to stop the propagation or an empty promise.

Parameters

Return Value