Interface IBooleanParameter

Describes a boolean-based parameter object, exposing the additional functionality to toggle the internal value of the parameter.

interface IBooleanParameter {
    config: IBooleanParameterConfig;
    type: Boolean;
    getValue(): boolean;
    resetValue(source?: ParameterChangeSource): void;
    setValue(value: boolean, source?: ParameterChangeSource): void;
    subscribe(listener: ParameterListener<boolean>): () => void;
    toggle(source?: ParameterChangeSource): void;
}

Hierarchy (View Summary)

IParameter<Boolean>
- IBooleanParameter

Index

Properties

Methods

getValue resetValue setValue subscribe toggle

Properties

`Readonly`config

config: IBooleanParameterConfig

The particular configuration of this parameter.

`Readonly`type

The particular parameter type of this parameter.

Methods

getValue

getValue(): boolean
Gets the current internal value of this parameter.

Returns boolean
Inherited from IParameter.getValue
- Defined in parameter/parameter.types.ts:74

resetValue

resetValue(source?: ParameterChangeSource): void
Resets the internal value of this parameter to its default.
Parameters
- Optionalsource: ParameterChangeSource
Returns void
Inherited from IParameter.resetValue
- Defined in parameter/parameter.types.ts:84

setValue

setValue(value: boolean, source?: ParameterChangeSource): void
Sets the internal value of this parameter.
Parameters
- value: boolean
- Optionalsource: ParameterChangeSource
Returns void
Inherited from IParameter.setValue
- Defined in parameter/parameter.types.ts:79

subscribe(listener: ParameterListener<boolean>): () => void
Registers a listener callback that executes when changes occur to this parameter's internal value.
Parameters
- listener: ParameterListener<boolean>
Returns () => void
Inherited from IParameter.subscribe
- Defined in parameter/parameter.types.ts:69

toggle

toggle(source?: ParameterChangeSource): void
Parameters
- Optionalsource: ParameterChangeSource
Returns void
- Defined in parameter/parameter.types.ts:92