Interface Parametrizable

A Parametrizable is an object that supports configuration through URL parameters.

interface Parametrizable {
    decodeURLParameter?(allParameters): void;
    encodeURLParameter?(): Record<string, EncodedParameterValue>;
    parameterNames?: string[];
}

Properties

parameterNames?

Methods

decodeURLParameter? encodeURLParameter?

Properties

Optional parameterNames

parameterNames?: string[]

Lists all parameters handled by this Parametrizable. It is used to remove existing URL parameters if they are not listed by the encodeURLParameter() response.

Methods

Optional decodeURLParameter

  • decodeURLParameter(allParameters): void

  • Called by the ParameterManager to trigger the decoding of parameters.

    Parameters

    Returns void

Optional encodeURLParameter

  • encodeURLParameter(): Record<string, EncodedParameterValue>

  • Creates an object, which lists all parameters to append to a URL. Parameters that have 'undefined' values are removed from a URL.

    Returns Record<string, EncodedParameterValue>

Settings

Member Visibility

Theme

On This Page

parameterNamesdecodeURLParameterencodeURLParameter

Generated using TypeDoc