Interface AsukaViewCreatePayload

Payload accepted by designer.api.addView(...).

interface AsukaViewCreatePayload {
    dpi?: number;
    engine?: AsukaRenderEngineKind;
    height?: number;
    name?: string;
    physicalSize?: AsukaPhysicalSize;
    scene3d?: any;
    unit?:
        | "px"
        | "mm"
        | "cm"
        | "in";
    width?: number;
}

Hierarchy (view full)

Properties

dpi? engine? height? name? physicalSize? scene3d? unit? width?

Properties

Optionaldpi

dpi?: number

Dots per inch metadata used by exports and size conversions.

Optionalengine

engine?: AsukaRenderEngineKind

Rendering engine used by this view. Defaults to the root engine.

Optionalheight

height?: number

Export/canvas height.

Optionalname

name?: string

Human-readable view name shown in the UI.

OptionalphysicalSize

physicalSize?: AsukaPhysicalSize

Real-world extent represented by the view when no drawing area has its own calibration.

Optionalscene3d

scene3d?: any

Initial 3D scene state for 3D views.

Optionalunit

unit?:
    | "px"
    | "mm"
    | "cm"
    | "in"

Unit used by the view dimensions.

Optionalwidth

width?: number

Export/canvas width.

Settings

Member Visibility

On This Page

Properties