GeoLeaf Core API - v3.0.0
    Preparing search index...

    Interface GeoLeafApiController

    Surface of APIController consumed by geoleaf-api.ts.

    Mirrors the runtime instance exposed on GeoLeaf._APIController. Methods return unknown where the value flows straight back to integrators (maps, configs) — callers narrow at the boundary.

    interface GeoLeafApiController {
        isInitialized: boolean;
        moduleAccessFn?: IModuleAccessFn | null;
        managers?: { factory?: ApiFactorySurface };
        geoleafInit(options: Record<string, unknown>): unknown;
        geoleafSetTheme(theme: string): boolean;
        geoleafLoadConfig(
            input: string | Record<string, unknown>,
        ): Promise<unknown>;
        geoleafCreateMap(id: string, options?: Record<string, unknown>): unknown;
        getHealthStatus(): IControllerHealthStatus & Record<string, unknown>;
    }
    Index

    Properties

    isInitialized moduleAccessFn? managers?

    Methods

    geoleafInit geoleafSetTheme geoleafLoadConfig geoleafCreateMap getHealthStatus

    Properties

    isInitialized: boolean
    moduleAccessFn?: IModuleAccessFn | null
    managers?: { factory?: ApiFactorySurface }

    Methods

    • Parameters

      • input: string | Record<string, unknown>

      Returns Promise<unknown>

    • Parameters

      • id: string
      • Optionaloptions: Record<string, unknown>

      Returns unknown

    Settings

    Member Visibility

    On This Page

    Properties
    Methods