Interface ExportOptions

Defines the possible image export options.

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

Properties

height? margin? selectedAreaOnly? visualizationSettings? width?

Properties

Optional height

height?: number

The height of the image in pixels.

Optional margin

margin?: number

The margin of the image in pixels.

Optional selectedAreaOnly

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.

Optional visualizationSettings

visualizationSettings?: VisualizationSettings

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

Optional width

width?: number

The width of the image in pixels.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc