Interface ImportOptions

Options for document import.

interface ImportOptions {
    clearCanvas: boolean;
    layout?: LayoutType;
    placement?: PlacementType;
    scale?: ScaleType;
    scalePercent?: number;
    select: boolean;
    throwError: boolean;
}

Properties

clearCanvas layout? placement? scale? scalePercent? select throwError

Properties

clearCanvas

clearCanvas: boolean

Whether to clear the whole canvas prior importing the new structure.

Optionallayout

layout?: LayoutType

Defines the layout how the imported structure will be placed on the canvas.
Accepted values: 'DEFAULT' | 'GRID';

Optionalplacement

placement?: PlacementType

Defines where the imported structure will be placed on the canvas.
Accepted values: 'CENTER' | 'TOP_LEFT' | 'TOP' | 'TOP_RIGHT' | 'RIGHT' | 'BOTTOM_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'LEFT' | 'LEFT_BELOW';

Optionalscale

scale?: ScaleType

Defines how the zoom is changed after the input. Accepted values: 'NONE' | 'SHRINK';

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.

select

select: boolean

Whether to select the imported structure after successful import.

throwError

throwError: boolean

Whether to throw error if import fails.

Settings

Member Visibility

On This Page

Properties