--- title: "Layer | Customer's Canvas On-Premises" canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/Layer/" --- # Layer > Represents a design element on the canvas. ## Classes ### Layer This client-side class corresponds to the server-side class `Canvas` and provides access to its primary members in TypeScript. #### Constructors ##### Constructor ```ts new Layer(container?, canvas?): Layer; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `container?` | `Container` | | `canvas?` | [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas) | ###### Returns [`Layer`](#layer) #### Properties ##### textureImage ```ts textureImage: HTMLCanvasElement | HTMLImageElement = null; ``` #### Accessors ##### canvas ###### Get Signature ```ts get canvas(): ICanvas; ``` ###### Returns [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas) ###### Set Signature ```ts set canvas(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas) | ###### Returns `void` ##### container ###### Get Signature ```ts get container(): Container; ``` ###### Returns `Container` ##### data ###### Get Signature ```ts get data(): string; ``` ###### Returns `string` ###### Set Signature ```ts set data(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `string` | ###### Returns `void` ##### ditherAmount ###### Get Signature ```ts get ditherAmount(): any; ``` ###### Returns `any` ##### ditherType ###### Get Signature ```ts get ditherType(): any; ``` ###### Returns `any` ##### flatItemHandlers ###### Get Signature ```ts get flatItemHandlers(): Collection; ``` ###### Returns `Collection`\<[`ItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ItemHandler.md#itemhandler)\> ##### itemHandlers ###### Get Signature ```ts get itemHandlers(): ItemHandlersCollection; ``` ###### Returns [`ItemHandlersCollection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ItemHandlersCollection.md#itemhandlerscollection) ##### locked ###### Get Signature ```ts get locked(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set locked(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `boolean` | ###### Returns `void` ##### name ###### Get Signature ```ts get name(): string; ``` ###### Returns `string` ###### Set Signature ```ts set name(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `string` | ###### Returns `void` ##### previewColor ###### Get Signature ```ts get previewColor(): RgbColor; ``` ###### Returns `RgbColor` ###### Set Signature ```ts set previewColor(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `RgbColor` | ###### Returns `void` ##### region ###### Get Signature ```ts get region(): RectangleF; ``` Gets or sets the rectangle region on the layer surface in which v-objects can be placed. ###### Returns `RectangleF` ###### Set Signature ```ts set region(region): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `region` | `RectangleF` | ###### Returns `void` ##### renderingType ###### Get Signature ```ts get renderingType(): any; ``` ###### Returns `any` ##### textureSourceHeight ###### Get Signature ```ts get textureSourceHeight(): number; ``` ###### Returns `number` ###### Set Signature ```ts set textureSourceHeight(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ##### textureSourceWidth ###### Get Signature ```ts get textureSourceWidth(): number; ``` ###### Returns `number` ###### Set Signature ```ts set textureSourceWidth(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ##### textureStorageId ###### Get Signature ```ts get textureStorageId(): string; ``` ###### Returns `string` ###### Set Signature ```ts set textureStorageId(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `string` | ###### Returns `void` ##### uniqueId ###### Get Signature ```ts get uniqueId(): string; ``` Gets a unique ID used for deserialization. ###### Returns `string` ###### Set Signature ```ts set uniqueId(v): void; ``` Sets a unique ID used for deserialization. ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `string` | ###### Returns `void` ##### visible ###### Get Signature ```ts get visible(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set visible(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `boolean` | ###### Returns `void` #### Methods ##### dispose() ```ts dispose(): void; ``` ###### Returns `void` ##### isTextureLoadedOrNotExists() ```ts isTextureLoadedOrNotExists(): boolean; ``` ###### Returns `boolean` ##### onLayerAdded() ```ts onLayerAdded(): void; ``` ###### Returns `void` ##### updateTexture() ```ts updateTexture(forceUpdate?): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `forceUpdate?` | `boolean` | ###### Returns `void`