C

LabelTextProcessingStep

A class responsible for processing the text of an ILabel object.

Remarks

More precisely, this class creates the Text object and assigns it to the label's shape.

This processing step has to be registered to the list of IShapeProcessingSteps of the VsdxExportConfiguration. It is not part of the default configuration.

Members

Show:

Constructors

Initializes a new instance of the LabelTextProcessingStep class.

Parameters

predicate: any

Methods

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

See node.

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.

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.

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.

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.