Class Layer

Represents a design element on the canvas.

This client-side class corresponds to the server-side class Canvas and provides access to its primary members in TypeScript.

Package: @aurigma/design-atoms

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Layer class.

Properties

canvas

Declaration

get canvas(): ICanvas;

set canvas(value: ICanvas);

Property Value

Type	Description
ICanvas

container

Declaration

get container(): Container;

Property Value

Type	Description
Container

data

Declaration

get data(): string;

set data(v: string);

Property Value

Type	Description
string

ditherAmount

Declaration

get ditherAmount(): number;

Property Value

Type	Description
number

ditherType

Declaration

get ditherType(): import("@aurigma/design-atoms-model/Product/Dither").Dither;

Property Value

Type	Description
import("@aurigma/design-atoms-model/Product/Dither").Dither

flatItemHandlers

Declaration

get flatItemHandlers(): Collection<ItemHandler>;

Property Value

Type	Description
Collection<ItemHandler>

itemHandlers

Declaration

get itemHandlers(): ItemHandlersCollection;

Property Value

Type	Description
ItemHandlersCollection

locked

Declaration

get locked(): boolean;

set locked(v: boolean);

Property Value

Type	Description
boolean

name

Declaration

get name(): string;

set name(v: string);

Property Value

Type	Description
string

previewColor

Declaration

get previewColor(): RgbColor;

set previewColor(value: RgbColor);

Property Value

Type	Description
RgbColor

region

Gets or sets the rectangle region on the layer surface in which v-objects can be placed.

Declaration

get region(): RectangleF;

set region(region: RectangleF);

Property Value

Type	Description
RectangleF	Gets or sets the rectangle region on the layer surface in which v-objects can be placed.

renderingType

Declaration

get renderingType(): import("@aurigma/design-atoms-model").RenderingType;

Property Value

Type	Description
import("@aurigma/design-atoms-model").RenderingType

textureImage

Declaration

textureImage: HTMLCanvasElement | HTMLImageElement;

Property Value

Type	Description
HTMLCanvasElement | HTMLImageElement

textureSourceHeight

Declaration

get textureSourceHeight(): number;

set textureSourceHeight(v: number);

Property Value

Type	Description
number

textureSourceWidth

Declaration

get textureSourceWidth(): number;

set textureSourceWidth(v: number);

Property Value

Type	Description
number

textureStorageId

Declaration

get textureStorageId(): string;

set textureStorageId(v: string);

Property Value

Type	Description
string

uniqueId

Gets a unique ID used for deserialization.

Declaration

get uniqueId(): string;

set uniqueId(v: string);

Property Value

Type	Description
string	Gets a unique ID used for deserialization.

updateTexture

Declaration

updateTexture: (forceUpdate?: boolean) => void;

Property Value

Type	Description
(forceUpdate?: boolean) => void

visible

Declaration

get visible(): boolean;

set visible(v: boolean);

Property Value

Type	Description
boolean

Methods

dispose()

Declaration

dispose(): void;

Returns

Type	Description
void

isTextureLoadedOrNotExists()

Declaration

isTextureLoadedOrNotExists(): boolean;

Returns

Type	Description
boolean

onLayerAdded()

Declaration

onLayerAdded(): void;

Returns

Type	Description
void