Skip to main content

View.Layer

Properties
Accessors
Methods

Properties​

Measurements​

Measurements: Omit<View.Measurements, 'MeasurementType' | 'getData' | 'data' | 'toggleMode' | 'mode'>

Tag​

Tag: Omit<View.Tag, 'AttachmentType' | 'attachments' | 'data' | 'openTags' | 'close' | 'dock' | 'open' | 'registerAttachment' | 'registerSandbox' | 'toggleDocking' | 'toggleNavControls' | 'toggleSharing'>

A subset of the Tag namespace's functionality to manipulate Tags on this layer.

Provides access to Tag mutations including Tag.add to add directly to a layer.

Does not include observables or enums.

Accessors​

common​

common: (readonly) boolean

Whether this layer is common (shared across all views)

id​

id: (readonly) string

The unique id of the Layer

name​

name: (readonly) string

The human-readable name of the Layer

toggled​

toggled: (readonly) boolean

Whether this Layer toggled on or off. If toggled off, this Layer's objects are hidden.

type​

type: (readonly) LayerType

The type of layer

Methods​

toggle​

toggle(active?: boolean): Promise<void>

Toggle this Layer's state to active.

ParameterType
active?boolean
Whether this Layer should be toggled on or off. If active is undefined, the state is flipped.

Returns: Promise<void>