AmbientLightSensor
Sensor implementation which returns the current light level or
illuminance of the ambient light around the hosting device.
See
https://developer.mozilla.org/docs/Web/API/AmbientLightSensor
Extends
Constructors
new AmbientLightSensor()
new AmbientLightSensor(opts): AmbientLightSensor
Parameters
| Parameter | Type |
|---|---|
opts | AmbientLightSensorOptions |
Returns
Overrides
Sensor.constructor
See
https://developer.mozilla.org/docs/Web/API/AmbientLightSensor/AmbientLightSensor
Accessors
activated
get activated(): boolean
A read-only boolean value indicating whether the sensor is active.
See
https://developer.mozilla.org/docs/Web/API/Sensor/activated
Returns
boolean
Overrides
hasReading
get hasReading(): boolean
A read-only boolean value indicating whether the sensor has a reading.
See
https://developer.mozilla.org/docs/Web/API/Sensor/hasReading
Returns
boolean
Overrides
illuminance
get illuminance(): null | number
The current light level (in lux) of the ambient light level around the hosting device.
See
https://developer.mozilla.org/docs/Web/API/AmbientLightSensor/illuminance
Returns
null | number
timestamp
get timestamp(): null | number
A read-only number representing the timestamp of the latest sensor reading.
Value is null if there has not yet been a reading of the sensor.
See
https://developer.mozilla.org/docs/Web/API/Sensor/timestamp
Returns
null | number
Overrides
Methods
addEventListener()
addEventListener(type, listener, options)
addEventListener(type, listener, options?): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Parameters
| Parameter | Type |
|---|---|
type | "error" | "activate" | "reading" |
listener | (ev) => any |
options? | boolean | AddEventListenerOptions |
Returns
void
Inherited from
See
https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener
addEventListener(type, listener, options)
addEventListener(type, listener, options?): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Parameters
| Parameter | Type |
|---|---|
type | string |
listener | EventListenerOrEventListenerObject |
options? | boolean | AddEventListenerOptions |
Returns
void
Inherited from
See
https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener
dispatchEvent()
dispatchEvent(event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Parameters
| Parameter | Type |
|---|---|
event | Event |
Returns
boolean
Inherited from
See
https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent
removeEventListener()
removeEventListener(type, callback, options?): void
Removes the event listener in target's event listener list with the same type, callback, and options.
Parameters
| Parameter | Type |
|---|---|
type | string |
callback | null | EventListenerOrEventListenerObject<any> |
options? | boolean | EventListenerOptions |
Returns
void
Inherited from
See
https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener
start()
start(): void
Activates the sensor.
Returns
void
Overrides
See
https://developer.mozilla.org/docs/Web/API/Sensor/start
stop()
stop(): void
Deactivates the sensor.
Returns
void