Skip to content
Apexify.jsDocs
Apexify.js version v5.4.5

type export

SceneLayer

One drawable item in deterministic paint order (array index 0 is bottom, final index is top).

apexify.jsCURRENTnode22node24node26
Source: lib-next/types/scene.ts (opens in a new tab)

Signature

TypeScript
export type SceneLayer = {
    type: "image";
    images: ImageProperties | ImageProperties[];
    options?: CreateImageOptions;
} | {
    type: "text";
    texts: TextProperties | TextProperties[];
} | {
    type: "path";
    path: PathCommand[] | unknown;
    options?: Path2DDrawOptions;
} | {
    type: "imageBuffer";
    buffer: Buffer;
    x: number;
    y: number;
    width?: number;
    height?: number;
    globalAlpha?: number;
    globalCompositeOperation?: GlobalCompositeOperation;
} | {
    type: "chart";
    chartType: SceneChartType;
    data: unknown;
    options?: unknown;
    x: number;
    y: number;
    width?: number;
    height?: number;
    opacity?: number;
} | {
    type: "chartComparison";
    options: unknown;
    x: number;
    y: number;
    width?: number;
    height?: number;
    opacity?: number;
} | {
    type: "chartCombo";
    options: unknown;
    x: number;
    y: number;
    width?: number;
    height?: number;
    opacity?: number;
} | {
    type: "customLines";
    lines: CustomOptions | CustomOptions[];
} | {
    type: "surface";
    placement: SceneSurfacePlacement;
    /** Child background paint only; dimensions are always taken from `placement`. */
    background?: SceneBackground;
    /** Child layers are clipped to the child surface canvas before parent transforms/opacity are applied. */
    layers: SceneLayer[];
};

Related APIs

No explicit related API metadata.

Next steps