Class Light
Hierarchy (View Summary)
- Evented
- Light
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
OptionallightOptions: LightSpecification
Returns Light
Methods
fire
Parameters
- event: string | Event
Optionalproperties: any
Returns this
getLight
Returns LightSpecification
hasTransition
Returns boolean
listens
Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.
Parameters
- type: string
The event type
Returns boolean
trueif there is at least one registered listener for specified event type,falseotherwise- type: string
off
Removes a previously registered event listener.
Parameters
- type: string
The event type to remove listeners for.
- listener: Listener
The listener function to remove.
Returns this
- type: string
on
Adds a listener to a specified event type.
Parameters
- type: string
The event type to add a listen for.
- listener: Listener
The function to be called when the event is fired. The listener function is called with the data object passed to
fire, extended withtargetandtypeproperties.
Returns Subscription
- type: string
once
Adds a listener that will be called only once to a specified event type.
The listener will be called first time the event fires after the listener is registered.
Parameters
- type: string
The event type to listen for.
Optionallistener: ListenerThe function to be called when the event is fired the first time.
Returns Promise<any> | Light
thisor a promise if a listener is not provided- type: string
recalculate
Parameters
- parameters: EvaluationParameters
Returns void
setEventedParent
Bubble all events fired by this instance of Evented to this parent instance of Evented.
Parameters
Optionalparent: Evented | nullOptionaldata: any
Returns this
setLight
Parameters
Optionallight: LightSpecificationOptionaloptions: StyleSetterOptions
Returns void
updateTransitions
Parameters
- parameters: TransitionParameters
Returns void
Methods mixed in to other classes for event capabilities.