This is the documentation of version 0.48.1. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias BYODEntry

    A single entry in the BYOD (bring-your-own-data) GeoJSON history. Each entry is a customer-authored layer the agent can read, render, query, or pipe through analyseData / processData.

    type BYODEntry = {
        _analysis?: BYODAnalysis[];
        _module?: CustomGeoJSONModule;
        _shown?: boolean;
        data: FeatureCollection;
        id: string;
        label: string;
        layers: CustomGeoJSONLayerSpec[];
        profile: BYODDataProfile;
        source: BYODSource;
        timestamp: number;
    }
    Index

    Properties

    _analysis?: BYODAnalysis[]

    Analyses attached by analyseData (keyed by name — re-running an analysis with the same name replaces it). Empty / absent until the first analysis runs against this entry.

    _module?: CustomGeoJSONModule

    Per-entry CustomGeoJSONModule. Each entry owns its own module so display state (currently-rendered feature set, visibility) lives on the entry instead of a shared slice-level module. Lazy-initialised via BYODState helpers.

    _shown?: boolean

    True while this entry's _module is rendering on the map.

    id: string
    label: string
    layers: CustomGeoJSONLayerSpec[]

    MapLibre layer specs the slice renders this entry under. Always explicit — empty until set via setByodLayers (the agent path) or by passing layers to addEntry. An entry with no layers renders nothing.

    Runtime-inferred shape of data — geometry types and a per-property profile. Derived once at addEntry time (see profileFeatureCollection) so recall / ingest tools can describe the data to the model without shipping the full FeatureCollection.

    source: BYODSource

    Provenance for the data — used by recall tools and the UI.

    timestamp: number