types.BooleanSetting#

Defines a toggle / checkbox setting.

SYNTAX#

{ key: string; type: 'boolean'; label: string; default: boolean }

ARGUMENTS#

• key (string) — Setting key.
• type ('boolean') — Discriminator.
• label (string) — Display label.
• default (boolean) — Default true/false value.

RETURNS#

Type definition.

EXAMPLE#

{ key: 'showBands', type: 'boolean', default: true, label: 'Show Bands' }

SEE ALSO#

types.NumberSetting, types.ColorSetting, types.SelectSetting, indicator.getSettings