Provides logical grouping of Element objects.

Layers are commonly used to group objects in the drawing by function (e.g. walls, furniture, etc.), but in principle they can represent any type of virtual grouping. All objects in a layer share appearance, can be shown and hidden together. A drawing element can only belong to one layer.

The drawing layer holds an isVisible attribute, which is true by default.

Extends

BaseObject

Constructors

new Layer()

‍new Layer(name?): Layer

Parameters

name?

string

Added name.

Returns

Layer

Overrides

BaseObject.constructor

Properties

isVisible

‍isVisible: boolean = true

Indicates whether the drawing layer is visible or not.

Accessors

id

Get Signature

‍get id(): bigint

Returns object id.

Returns

bigint

Inherited from

BaseObject.id

name

Get Signature

‍get name(): null | string

Returns name of the drawing layer. null if the drawing layer has no name (by default).

Returns

null | string

Set Signature

‍set name(name): void

Sets name of the drawing layer.

Parameters

name

Name of the drawing layer.

null | string

Returns

void

uuid

Get Signature

‍get uuid(): null | `$string