Skip to main content

Class: BacklightConfig

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Backlight/BacklightConfig.ts:9

A configuration object which defines backlight options.

Implements

Constructors

Constructor

new BacklightConfig(baseInstrument, element): BacklightConfig

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Backlight/BacklightConfig.ts:30

Creates a new BacklightConfig from a configuration document element.

Parameters

ParameterTypeDescription
baseInstrumentBaseInstrumentThe BaseInstrument element associated with the configuration.
elementundefined | ElementA configuration document element.

Returns

BacklightConfig

Properties

defaultMode

readonly defaultMode: null | BacklightControlSettingMode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Backlight/BacklightConfig.ts:14

The default backlight control mode to apply on power-up, or null if the setting should be persistent between power cycles.


lightBus?

readonly optional lightBus: BacklightLightBusConfig

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Backlight/BacklightConfig.ts:23

A config that defines options for light bus control of backlighting. If not defined, then light bus control of backlighting is not supported.


photoCell

readonly photoCell: BacklightPhotoCellConfig

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Backlight/BacklightConfig.ts:17

A config that defines options for photocell control of backlighting.