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

    Interface GeoLeafTopLevelApi

    Les méthodes raccourcies montées directement sur globalThis.GeoLeaf.

    Tous les membres sont optionnels : le namespace est assemblé au boot (chaîne B1→B11), et un consommateur qui le lit trop tôt voit un objet partiel. C'est la même posture que GeoLeafGlobal, qui référence ce contrat membre par membre — en ligne, jamais par extends : les lecteurs d'AST du dépôt (scripts/lib/ts-decl-read.cjs) n'itèrent que les membres déclarés, et un membre hérité leur serait invisible.

    interface GeoLeafTopLevelApi {
        init?: (options: Record<string, unknown>) => unknown;
        setTheme?: (theme: string) => boolean;
        loadConfig?: (input: string | Record<string, unknown>) => Promise<unknown>;
        createMap?: (id: string, options?: Record<string, unknown>) => unknown;
        getMap?: (id: string) => unknown;
        getAllMaps?: () => unknown[];
        getModule?: (name: string) => unknown;
        hasModule?: (name: string) => boolean;
        getNamespace?: (name: string) => unknown;
        getHealth?: () => unknown;
        getMetrics?: () => unknown;
    }
    Index

    Properties

    init? setTheme? loadConfig? createMap? getMap? getAllMaps? getModule? hasModule? getNamespace? getHealth? getMetrics?

    Properties

    init?: (options: Record<string, unknown>) => unknown

    Initialise GeoLeaf et crée la carte.

    ⚠️ map.target — ou son raccourci target/mapId — est obligatoire : APIInitializationManager._normalizeInitOptions jette sans lui. La forme attendue est { map: { target }, data: { activeProfile, profilesBasePath } }.

    ⚠️ Distinct de GeoLeafTopLevelApi.boot : boot() lance l'application pilotée par profil (chargement de config puis registry.init()), init() est l'enveloppe manuelle de GeoLeaf.Core.init(). Le init du chemin de boot est celui du ModuleRegistry, pas celui-ci.

    setTheme?: (theme: string) => boolean

    Applique un thème par identifiant. Rend true si le thème a été appliqué.

    loadConfig?: (input: string | Record<string, unknown>) => Promise<unknown>

    Charge une configuration depuis une URL ou un objet. Jette (TypeError) sur autre chose.

    createMap?: (id: string, options?: Record<string, unknown>) => unknown

    Crée une instance de carte gérée par GeoLeaf. Rend null si le contrôleur est absent.

    getMap?: (id: string) => unknown

    Rend l'instance de carte enregistrée sous cet identifiant, ou null.

    getAllMaps?: () => unknown[]

    Rend toutes les instances de carte enregistrées — tableau vide si aucune.

    getModule?: (name: string) => unknown

    Rend un module enregistré par son nom, ou null.

    hasModule?: (name: string) => boolean

    true si un module de ce nom est enregistré.

    getNamespace?: (name: string) => unknown

    Rend un namespace de premier niveau (GeoLeaf[name]), ou null.

    getHealth?: () => unknown

    Rapport de santé de l'APIController, ou null s'il est indisponible.

    getMetrics?: () => unknown

    Alias de GeoLeafTopLevelApi.getHealth.

    ⚠️ Les deux implémentations doivent pointer une fonction qui ne dépend pas de this — la forme this.getHealth() jetait dès que la méthode était détachée du namespace.

    Settings

    Member Visibility

    On This Page

    Properties