Variable PermalinkConst

Type declaration

• init:function

  • init(config): void

  • Initialise the Permalink module with the config extracted from the active profile. Must be called before readAndStore().

    Parameters

    • config: PermalinkConfig

      Permalink section of ui.permalink or an empty object.

    Returns void

• readAndStore:function

  • readAndStore(): void

  • Read the current URL and cache the parsed state. Call this before map creation so the stored state is available for applyStoredState.

    Returns void

• applyStoredState:function

  • applyStoredState(map): void

  • Apply the stored state (from readAndStore) to the given map instance. Must be called after the map and all modules are initialised.

    Parameters

    • map: any

      MapLibre map instance.

    Returns void

• startSync:function

  • startSync(map): void

  • Begin continuous URL synchronisation on map move/zoom events. Call this after applyStoredState to avoid overwriting the restored state.

    Parameters

    • map: any

      MapLibre map instance.

    Returns void

• getState:function

  • getState(): null | PermalinkState

  • Return the currently cached permalink state (read-only). Returns null if readAndStore was not called or found no permalink in the URL.

    Returns null | PermalinkState

• buildUrl:function

  • buildUrl(state?): string

  • Serialise state (or the cached stored state) to a URL fragment / query string.

    Parameters

    • Optionalstate: null | PermalinkState

      Optional explicit state. Falls back to _storedState.

    Returns string

    URL string starting with # or ?, or empty string if no state.