Hierarchy
-
IObservable<View.Layer>
- Layer
Index
Properties
Tag
Accessors
common
-
Whether this layer is common (shared across all views)
Returns boolean
id
-
The unique id of the Layer
Returns string
name
-
The human-readable name of the Layer
Returns string
toggled
-
Whether this Layer toggled on or off. If toggled off, this Layer's objects are hidden.
Returns boolean
type
-
The type of layer
Returns View.LayerType
Methods
subscribe
-
Subscribe to changes on this object. When this observable detects a change, the
observerprovided will be called with the data associated with this observable.Parameters
-
observer: IObserver<View.Layer> | ObserverCallback<View.Layer>
Returns ISubscription
A subscription that can be used to remove the subscribed observer.
-
toggle
-
Toggle this Layer's state to
active.Parameters
-
Optional active: undefined | false | true
Whether this Layer should be toggled on or off. If
activeis undefined, the state is flipped.
Returns Promise<void>
-
waitUntil
-
Wait for a specific condition on this object to be met. When this observable detects a change, the
conditionprovided will be called. When theconditionreturns true, the returned Promise will be resolved.Parameters
-
condition: ICondition<View.Layer> | ConditionCallback<View.Layer>
Returns Promise<View.Layer>
A promise that is resolved when
conditionreturns true. -
A subset of the Tag namespace's functionality to manipulate Tags on this layer.