I

IShapeProcessingStep

Implementations of this interface can modify specific properties of shapes.

Inheritance Hierarchy

Remarks

They can be registered at a VsdxExportConfiguration. Usually, there is no need to implement this interface directly. Instead, extend the ShapeProcessingStepBase class.

The VsdxExportConfiguration holds a list of IShapeProcessingSteps which each will be called once for each item of the graph in the order of this list. In contrast to IMasterProviders, every IShapeProcessingStep in the pipeline is guaranteed to run once per item.

Members

No filters for this type

Methods

This will be called once after the export is finished and shall clear any state created during the export.

abstract

See node.

abstract

Parameters

shape: Shape

The shape representing the edge.

sourceConnection: Connection

The source connection representing the source port.

targetConnection: Connection

The target connection representing the target port.

edge: IEdge

The edge this shape represents.

context: ShapeProcessingContext

Return Value

Promise<void>
An empty promise.

See node.

abstract

Parameters

shape: Shape

The shape representing the label.

ownerShape: Shape

The shape representing the label's owner. In case the owner is a node, this is the container shape of the node.

label: ILabel

The label this shape represents

context: ShapeProcessingContext

Return Value

Promise<void>
An empty promise.

Will be called once for each node in the graph.

This method may now set or modify any values of the shape.

abstract

Parameters

shape: Shape

The shape representing the visual appearance of the node.

containerShape: GroupShape

The shape containing all shapes belonging to this node, including shapes for labels, ports and the shape passed as first argument.

node: INode

The node this shape represents.

context: ShapeProcessingContext

Return Value

Promise<void>
An empty promise.

See node.

abstract

Parameters

shape: Shape

The shape representing the port.

ownerShape: GroupShape

The shape representing the port's owner. In case the owner is a node, this is the container shape of the node.

port: IPort

The port this shape represents.

context: ShapeProcessingContext

Return Value

Promise<void>
An empty promise.