C

ShapeProcessingContext

Show Usages

A context that is passed to the methods of IShapeProcessingStep and provides access to the export GraphComponent, the IGraph and a CoordinateConverter.

Inheritance Hierarchy

Members

No filters for this type

Properties

config

: VsdxExportConfiguration

The configuration that was passed to the VsdxExport

coordinateConverter

: CoordinateConverter

A coordinate converter instance for the current page

graph

: IGraph

The export graph

graphComponent

: GraphComponent

The export graphComponent

media

: Media

A factory that creates media objects like images

Methods

getMasterFor

(item: IModelItem): Promise<ShapeStyleConfiguration>

Invokes the IMasterProvider chain to retrieve master and styles for this graph item. This method can be used to implement style adapter patterns.

Parameters

Return Value

processEdge

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

Invokes the IShapeProcessingStep pipeline for this edge. This method can be used to implement style adapter patterns.

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.

Return Value

processLabel

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

Invokes the IShapeProcessingStep pipeline for this label. This method can be used to implement style adapter patterns.

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 shall be the container shape of the node.

label: ILabel

The label this shape represents.

Return Value

processNode

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

Invokes the IShapeProcessingStep pipeline for this node. This method can be used to implement style adapter patterns.

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.

Return Value

processPort

(
shape: Shape
containerShape: GroupShape
port: IPort
): Promise<void>

Invokes the IShapeProcessingStep pipeline for this port. This method can be used to implement style adapter patterns.

Parameters

shape: Shape

The shape representing the port.

containerShape: GroupShape

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

port: IPort

The port this shape represents.

Return Value