Variable PermalinkConst

Type Declaration

• init: function

  • init(config: PermalinkConfig): void

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

    Parameters

    • config: PermalinkConfig

      The profile's modules.permalink block, or an empty object.

    Returns void

    Example

    GeoLeaf.Permalink.init({ enabled: true, mode: "hash" });
    Copy

• 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: IMapAdapter): 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: IMapAdapter

      MapLibre map adapter instance.

    Returns void

• startSync: function

  • startSync(map: IMapAdapter): void

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

    Parameters

    • map: IMapAdapter

      MapLibre map adapter instance.

    Returns void

• stopSync: function

  • stopSync(): void

    Stop URL synchronisation started by Permalink.startSync, removing every listener it attached (map moveend + the three document listeners). Safe to call when no sync is active.

    Returns void

• getState: function

  • getState(): PermalinkState | null

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

    ⚠️ A null therefore means two different things — the page was not opened through a permalink, or Permalink.readAndStore has not run yet. Only the boot order tells them apart.

    Returns PermalinkState | null

    Example

    const state = GeoLeaf.Permalink.getState();
    // → { lat: 48.857, lng: 2.347, zoom: 13, layers: [], filter: "café" }
    // → null
    Copy

• buildUrl: function

  • buildUrl(state?: PermalinkState | null): string

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

    Parameters

    • Optionalstate: PermalinkState | null

      Optional explicit state. Falls back to _storedState.

    Returns string

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

    Example

    // Current stored state
    const url = GeoLeaf.Permalink.buildUrl();
    // → "#gl_lat=48.857445&gl_lng=2.347211&gl_zoom=13"
    Copy

    Example

    // A complete shareable link — the fragment alone is not enough.
    const permalinkUrl =
        window.location.origin + window.location.pathname + GeoLeaf.Permalink.buildUrl();
    Copy

• isEnabled: function

  • isEnabled(): boolean

    Returns true when permalink is enabled (modules.permalink.enabled !== false).

    Returns boolean

• getConfig: function

  • getConfig(): PermalinkConfig

    Returns the resolved modules.permalink config (merged over the built-in defaults).

    Returns PermalinkConfig