Layer

Defined in: layer/Layer.ts:7

A layer controls the z-ordering of parts in a diagram. Parts in lower z-order layers are rendered first (behind).

Constructors

Constructor

new Layer(name, zOrder): Layer

Defined in: layer/Layer.ts:15

Parameters

name

string

zOrder

number

Returns

Layer

Accessors

isTemporary

Get Signature

get isTemporary(): boolean

Defined in: layer/Layer.ts:36

Whether this is a temporary layer (for dragging, etc.).

Returns

boolean

Set Signature

set isTemporary(value): void

Defined in: layer/Layer.ts:41

Set whether this is a temporary layer.

Parameters

value

boolean

Returns

void

---

name

Get Signature

get name(): string

Defined in: layer/Layer.ts:21

The layer name.

Returns

string

---

opacity

Get Signature

get opacity(): number

Defined in: layer/Layer.ts:46

The opacity of this layer (0-1).

Returns

number

Set Signature

set opacity(value): void

Defined in: layer/Layer.ts:51

Set the opacity.

Parameters

value

number

Returns

void

---

partCount

Get Signature

get partCount(): number

Defined in: layer/Layer.ts:70

Get the number of parts in this layer.

Returns

number

---

parts

Get Signature

get parts(): readonly Part[]

Defined in: layer/Layer.ts:65

Get all parts in this layer.

Returns

readonly Part[]

---

visible

Get Signature

get visible(): boolean

Defined in: layer/Layer.ts:56

GoJS-compatible: Whether this layer is visible.

Returns

boolean

Set Signature

set visible(value): void

Defined in: layer/Layer.ts:60

Parameters

value

boolean

Returns

void

---

zOrder

Get Signature

get zOrder(): number

Defined in: layer/Layer.ts:26

The z-order of this layer (lower values rendered first).

Returns

number

Set Signature

set zOrder(value): void

Defined in: layer/Layer.ts:31

Set the z-order.

Parameters

value

number

Returns

void

Methods

add()

add(part): void

Defined in: layer/Layer.ts:75

Add a part to this layer.

Parameters

part

Part

Returns

void

---

clear()

clear(): void

Defined in: layer/Layer.ts:99

Remove all parts from this layer.

Returns

void

---

contains()

contains(part): boolean

Defined in: layer/Layer.ts:89

Check if a part is in this layer.

Parameters

part

Part

Returns

boolean

---

getVisibleParts()

getVisibleParts(): Part[]

Defined in: layer/Layer.ts:94

Get all visible parts in this layer.

Returns

Part[]

---

remove()

remove(part): boolean

Defined in: layer/Layer.ts:81

Remove a part from this layer.

Parameters

part

Part

Returns

boolean