Layer
Classes
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.
Constructors
Constructor
new Layer(container?, canvas?): Layer;
Parameters
| Parameter | Type |
|---|---|
container? | Container |
canvas? | ICanvas |
Returns
Properties
textureImage
textureImage: HTMLCanvasElement | HTMLImageElement = null;
Accessors
canvas
Get Signature
get canvas(): ICanvas;
Returns
Set Signature
set canvas(value): void;
Parameters
| Parameter | Type |
|---|---|
value | ICanvas |
Returns
void
container
Get Signature
get container(): Container;
Returns
Container
data
Get Signature
get data(): string;
Returns
string
Set Signature
set data(v): void;
Parameters
| Parameter | Type |
|---|---|
v | string |
Returns
void
ditherAmount
Get Signature
get ditherAmount(): any;
Returns
any
ditherType
Get Signature
get ditherType(): any;
Returns
any
flatItemHandlers
Get Signature
get flatItemHandlers(): Collection<ItemHandler>;
Returns
Collection<ItemHandler>
itemHandlers
Get Signature
get itemHandlers(): ItemHandlersCollection;
Returns
locked
Get Signature
get locked(): boolean;
Returns
boolean
Set Signature
set locked(v): void;
Parameters
| Parameter | Type |
|---|---|
v | boolean |
Returns
void
name
Get Signature
get name(): string;
Returns
string
Set Signature
set name(v): void;
Parameters
| Parameter | Type |
|---|---|
v | string |
Returns
void
previewColor
Get Signature
get previewColor(): RgbColor;
Returns
RgbColor
Set Signature
set previewColor(value): void;
Parameters
| Parameter | Type |
|---|---|
value | RgbColor |
Returns
void
region
Get Signature
get region(): RectangleF;
Gets or sets the rectangle region on the layer surface in which v-objects can be placed.
Returns
RectangleF
Set Signature
set region(region): void;
Parameters
| Parameter | Type |
|---|---|
region | RectangleF |
Returns
void
renderingType
Get Signature
get renderingType(): any;
Returns
any
textureSourceHeight
Get Signature
get textureSourceHeight(): number;
Returns
number
Set Signature
set textureSourceHeight(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
textureSourceWidth
Get Signature
get textureSourceWidth(): number;
Returns
number
Set Signature
set textureSourceWidth(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
textureStorageId
Get Signature
get textureStorageId(): string;
Returns
string
Set Signature
set textureStorageId(v): void;
Parameters
| Parameter | Type |
|---|---|
v | string |
Returns
void
uniqueId
Get Signature
get uniqueId(): string;
Gets a unique ID used for deserialization.
Returns
string
Set Signature
set uniqueId(v): void;
Sets a unique ID used for deserialization.
Parameters
| Parameter | Type |
|---|---|
v | string |
Returns
void
visible
Get Signature
get visible(): boolean;
Returns
boolean
Set Signature
set visible(v): void;
Parameters
| Parameter | Type |
|---|---|
v | boolean |
Returns
void
Methods
dispose()
dispose(): void;
Returns
void
isTextureLoadedOrNotExists()
isTextureLoadedOrNotExists(): boolean;
Returns
boolean
onLayerAdded()
onLayerAdded(): void;
Returns
void
updateTexture()
updateTexture(forceUpdate?): void;
Parameters
| Parameter | Type |
|---|---|
forceUpdate? | boolean |
Returns
void