Interface IParameter<T>

Generic type definition for a parameter object, containing the necessities for getting and setting values as well as listening for changes.

interface IParameter<T extends ParameterType> {
    config: ParameterConfigFromType<T>;
    type: T;
    getValue(): ParameterValueFromType<T>;
    resetValue(source?: ParameterChangeSource): void;
    setValue(
        value: ParameterValueFromType<T>,
        source?: ParameterChangeSource,
    ): void;
    subscribe(
        listener: ParameterListener<ParameterValueFromType<T>>,
    ): () => void;
}

Type Parameters

T extends ParameterType

Hierarchy (View Summary)

IParameter

Index

Properties

Methods

getValue resetValue setValue subscribe

Properties

`Readonly`config

config: ParameterConfigFromType<T>

The particular configuration of this parameter.

`Readonly`type

type: T

The particular parameter type of this parameter.

Methods

getValue

getValue(): ParameterValueFromType<T>
Gets the current internal value of this parameter.

Returns ParameterValueFromType<T>
- 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
- Defined in parameter/parameter.types.ts:84

setValue

setValue(value: ParameterValueFromType<T>, source?: ParameterChangeSource): void
Sets the internal value of this parameter.
Parameters
- value: ParameterValueFromType<T>
- Optionalsource: ParameterChangeSource
Returns void
- Defined in parameter/parameter.types.ts:79

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