Interface BooleanOption

A boolean option.

interface BooleanOption {
    defaultValue?: boolean;
    description?: LocalizableString;
    icon?: string;
    identifier: string;
    label?: LocalizableString;
}

Hierarchy (view full)

OptionBase
- BooleanOption

Index

Properties

defaultValue? description? icon? identifier label?

Properties

`Optional` `Readonly` defaultValue

defaultValue?: boolean

The default value of the option. If omitted, boolean options default to true.

`Optional` `Readonly` description

description?: LocalizableString

An optional longer explanantion of this option, to be shown in the UI.

`Optional` `Readonly` icon

icon?: string

An icon for this option. It is only displayed for boolean options, next to the check box.

`Readonly` identifier

identifier: string

An identifying string for this option.

`Optional` `Readonly` label

label?: LocalizableString

A short label for this option.