C

LabelProcessingStep

Show Usages

A class responsible for calculating the geometry of a Shape representing an ILabel object rendered with the LabelStyle.

Remarks

More precisely, this class rearranges the actual label's shape by creating a background shape and a shape that will contain the label text. Both shapes are placed in their correct locations based on their owner shapes.

This processing step has to be registered to the list of IShapeProcessingSteps of the VsdxExportConfiguration and needs to run after LabelLayoutProcessingStep.

Members

Show:

Constructors

LabelProcessingStep

()

Initializes a new instance of the LabelProcessingStep class.

Methods

clear

()

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

edge

(
shape: Shape
sourceConnection: Connection
targetConnection: Connection
edge: IEdge
context: ShapeProcessingContext
): Promise<void>

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.

label

(
shape: Shape
ownerShape: Shape
label: ILabel
context: ShapeProcessingContext
): Promise<void>

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.

node

(
shape: Shape
containerShape: GroupShape
node: INode
context: ShapeProcessingContext
): Promise<void>

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.

port

(
shape: Shape
ownerShape: GroupShape
port: IPort
context: ShapeProcessingContext
): Promise<void>

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.