TomTom Maps for JavaScript
    Preparing search index...

    Variable geocodeAreasConst

    geocodeAreas: (
        query: string,
        opts?: { bias?: Position; limit?: number },
        execOptions?: ToolExecuteOptions,
    ) => Promise<Place[]>

    Geocodes query restricted to administrative area geographies (not streets/POIs), biased toward bias (the map centre). Because geographyTypes filters to areas, every result carries a boundingBox. Callers choose among the candidates, for example the one nearest the current view. A centre bias is used rather than a hard viewport-bbox filter, so out-of-view areas still resolve.

    Type Declaration

      • (
            query: string,
            opts?: { bias?: Position; limit?: number },
            execOptions?: ToolExecuteOptions,
        ): Promise<Place[]>
      • Parameters

        • query: string
        • Optionalopts: { bias?: Position; limit?: number }
        • OptionalexecOptions: ToolExecuteOptions

        Returns Promise<Place[]>