map.apps Bundle APIs 4.20.0
    Preparing search index...

    Interface Parametrizable

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

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

    Properties

    parameterNames?

    Methods

    decodeURLParameter? encodeURLParameter?

    Properties

    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

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

      Parameters

      Returns void

    • 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

    On This Page

    Properties
    Methods