A configuration class for use with VsdxExport's export methods.
Remarks
It holds lists of IMasterProviders and IShapeProcessingSteps that are used during the export to translate the different items of the graph. Additionally, it has some general configuration properties.
One configuration instance can be used multiple times safely.
Members
Constructors
Properties
Determines whether edges should be cropped using an IEdgePathCropper.
Determines whether edges should be cropped using an IEdgePathCropper.
Set to true/false to enable/disable cropping for all edges or assign a function
to enable cropping only for specific edges.
The default is true.
The stylesheet used during the export.
The stylesheet used during the export.
When set to null the export will copy all stylesheets available through the
CSSStyleSheet API in the current document. When set to a string containing a set of valid CSS
rules this string is used as stylesheet during the export instead. The default setting is
null.
Note that explicitly setting the stylesheet can improve the overall performance significantly and is therefore highly recommended. You can also set this property to an empty string if your yFiles styles don't rely on CSS stylesheets. Another use case would be to use different CSS rules during the export than for displaying the graph in yFiles.
Determines the style in which the edges will be routed and corresponds to the VSDX
'ConLineRouteExt' property.
Determines the style in which the edges will be routed and corresponds to the VSDX 'ConLineRouteExt' property.
By default, the edges will be routed with polyline segments.
Determines whether values and formulas should be automatically calculated.
Determines whether values and formulas should be automatically calculated.
When set to true, the export will evaluate all formulas for which no values are
already specified. Values and formulas are automatically inherited from master shapes and
style sheets to shapes. Otherwise, no formulas will be evaluated at all and cells will not be
inherited from master shapes and style sheets. The default is false.
Note that setting this property to true may have a negative impact on the export performance. For this reason, you should enable this property only when formula calculation is really necessary for the export operation, especially when using VssxStencilProviderFactory. In most other cases, when IMasterProvider or IShapeProcessingStep provided by the VSDX Export are used, there is no need for formula calculation. The same holds when the user creates custom IMasterProvider or IShapeProcessingStep in which the values of each cell have already been calculated during the creation.
The page margins in pixels.
The page margins in pixels.
The default is 60 pixels.
The list of master providers to use for the export.
The list of master providers to use for the export.
Graph items will be propagated through this list from start to end until one accepts the item and returns a value.
The size of the created page in pixels.
The size of the created page in pixels.
When provided, the graph will be scaled to fit the page. When using the VsdxIO class,
the graph will only be scaled to fit the page if no targetBounds are provided to
the VsdxIO.addGraph method.
When set to null, the export automatically chooses a size fitting the graph bounds. The
default is null.
Determines whether self-loop edges should be routed as round self-loop paths i.e., paths that
start from one side of the node and end at a different side of the node.
Determines whether self-loop edges should be routed as round self-loop paths i.e., paths that start from one side of the node and end at a different side of the node.
The default is false.
The graph scale used during the export.
The graph scale used during the export.
This scale does not affect margins or pageSize, and has no effect when used in
combination with pageSize or the targetBounds parameter of the
VsdxIO.addGraph method.
The default is 1.0.
The list of shape processors to use for the export.
The list of shape processors to use for the export.
Graph items will be propagated through this list from start to end.
The zoom level used during the export.
The zoom level used during the export.
This mostly affects styles that create different visualizations for different zoom levels.
The default is 1.0.
Methods
Adds an event listener that will be called once an export has finished.
Adds an event listener that will be called once an export has finished.
This can be used to set custom document properties or make some final modifications to the VSDX file.
Parameters
- name: "export-finished"
- listener: any
Removes a listener registered with addEventListener.
Removes a listener registered with addEventListener.
Parameters
- name: "export-finished"
- listener: any
Static Methods
Creates a configuration containing all provided default IMasterProviders and
IShapeProcessingSteps in a reasonable order and should work out-of-the-box for most
use cases.
Creates a configuration containing all provided default IMasterProviders and IShapeProcessingSteps in a reasonable order and should work out-of-the-box for most use cases.
The configuration contains the following processing steps in this order:
- NodeLayoutProcessingStep
- ShapeNodeProcessingStep
- ArrowNodeProcessingStep
- RectangleNodeProcessingStep
- ImageNodeProcessingStep
- ArrowEdgeProcessingStep
- LabelLayoutProcessingStep
- GroupNodeProcessingStep
- StretchNodeLabelProcessingStep
- LabelProcessingStep
- NodePortLocationProcessingStep
- PortConnectionProcessingStep
- NodePortAdapterProcessingStep
- CompositeEdgeProcessingStep
- SvgProcessingStep
- EdgePathProcessingStep
- AutoRoutingStyleProcessingStep
The configuration contains also the following master providers in this order:
Return Value
Creates a new empty VsdxExportConfiguration object.
Creates a new empty VsdxExportConfiguration object.
The resulting configuration contains no IMasterProviders or IShapeProcessingSteps, and thus, the user has to register all necessary IMasterProviders or IShapeProcessingSteps for the export operation.