Interface ExportOptions

Defines the possible image export options.

interface ExportOptions {
    height?: number;
    margin?: number;
    scalePercent?: number;
    selectedAreaOnly?: boolean;
    visualizationSettings?: VisualizationSettings;
    width?: number;
}

Properties

height? margin? scalePercent? selectedAreaOnly? visualizationSettings? width?

Properties

Optionalheight

height?: number

The height of the image in pixels.

Optionalmargin

margin?: number

The margin of the image in pixels.

OptionalscalePercent

scalePercent?: number

The percentage scale to apply to the content within the SVG. For example, 100 means no scaling, 50 scales content to half size.

OptionalselectedAreaOnly

selectedAreaOnly?: boolean

Whether to export the whole canvas or only the selected area. Default value is false. If true, the selected area will be exported. If false, the whole canvas will be exported.

OptionalvisualizationSettings

visualizationSettings?: VisualizationSettings

Visualization. For image export, only variableAttachmentHighlight, rgroupAttachmentOrderVisible and structureHighlightVisible settings are supported.

Optionalwidth

width?: number

The width of the image in pixels.

Settings

Member Visibility

On This Page

Properties