This is the documentation of version 0.47.0. Go to the latest version, 1.0.0.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ToolState

    State passed to tool factory functions. Organized by feature area, each sub-state mixes lazy module access with the current service data produced during the session.

    function createMyTool(state: ToolState) {
    return tool({
    execute: async () => {
    const module = await state.places.getPlacesModule();
    state.routing.currentRoutes; // most recent routes
    state.baseMap.mapLibreMap; // MapLibre instance
    }
    });
    }
    type ToolState = {
        baseMap: BaseMapState;
        mapPOIs: MapPOIsState;
        places: PlacesState;
        ranges: RangeState;
        routing: RoutingState;
        traffic: TrafficState;
    }
    Index

    Properties

    baseMap: BaseMapState

    Base map display: style, language, viewport, layers, and hillshade.

    mapPOIs: MapPOIsState

    Map POI layer: visibility, filtering, and category management.

    places: PlacesState

    Place search, geocoding, and geometries state.

    ranges: RangeState

    Reachable range results: origin, budgets, and bbox summaries.

    routing: RoutingState

    Route calculation, waypoint management, and planning parameter state.

    traffic: TrafficState

    Traffic flow and incident overlay state.