diff --git a/docs/classes/config.ClientConfig.html b/docs/classes/config.ClientConfig.html index eb1b33a..e82cab7 100644 --- a/docs/classes/config.ClientConfig.html +++ b/docs/classes/config.ClientConfig.html @@ -1,4 +1,4 @@ -ClientConfig | MapTiler Client - v1.5.0
+ClientConfig | MapTiler Client - v1.6.0
  • Preparing search index...
  • -
  • The search index is not available
MapTiler Client - v1.5.0
+
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -24,7 +24,7 @@

    Hierarchy

    • ClientConfig
    +
  • Defined in config.ts:19
  • @@ -58,7 +58,7 @@

    Returns void

    +
  • Defined in config.ts:34
  • set fetch(f: FetchFunction): void
  • Set a the custom fetch function to replace the default one

    @@ -92,7 +92,7 @@

    Parameters

    f: FetchFunction
  • Returns void

    +
  • Defined in config.ts:48
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -26,7 +26,7 @@

    Hierarchy

    +
  • Defined in services/ServiceError.ts:4
  • @@ -57,14 +57,14 @@
    customMessage: stringReturns ServiceError
    +
  • Defined in services/ServiceError.ts:5
  • Properties

    res: Response
    +
  • Defined in services/ServiceError.ts:5
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -22,7 +22,7 @@

    Function getAutoLanguageGeocoding

  • Returns LanguageGeocodingString

  • +
  • Defined in language.ts:71
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -29,7 +29,7 @@
    points: Positionnumber

    Returns Position[]

    +
  • Defined in services/simplify.ts:76
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    -

    MapTiler Client - v1.5.0

    +

    MapTiler Client - v1.6.0

    offcial page →
    @@ -324,7 +324,7 @@

    Theme

    @@ -6,12 +6,12 @@
    MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    -

    MapTiler Client - v1.5.0

    +

    MapTiler Client - v1.6.0

    Index

    @@ -43,7 +43,7 @@

    Theme

    @@ -6,17 +6,17 @@ MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    +
  • Defined in config.ts:1
  • @@ -50,7 +50,7 @@

    Theme

    @@ -6,17 +6,17 @@
    MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    +
  • Defined in language.ts:4
  • @@ -50,7 +50,7 @@

    Theme

    @@ -6,17 +6,17 @@
    MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    +
  • Defined in services/ServiceError.ts:4
  • @@ -42,7 +42,7 @@

    Theme

    @@ -6,17 +6,17 @@
    MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    +
  • Defined in services/coordinates.ts:1
  • @@ -55,7 +55,7 @@

    Theme

    @@ -6,17 +6,17 @@
    MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    +
  • Defined in services/data.ts:1
  • @@ -46,7 +46,7 @@

    Theme

    @@ -6,17 +6,17 @@
    MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    +
  • Defined in services/geocoding.ts:1
  • @@ -54,7 +54,7 @@

    Theme

    @@ -6,17 +6,17 @@
    MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    +
  • Defined in services/geolocation.ts:1
  • @@ -47,7 +47,7 @@

    Theme

    @@ -6,17 +6,17 @@
    MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    +
  • Defined in services/simplify.ts:5
  • @@ -42,7 +42,7 @@

    Theme

    @@ -6,17 +6,17 @@
    MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    +
  • Defined in services/staticMaps.ts:1
  • @@ -50,7 +50,7 @@

    Theme

    @@ -6,13 +6,13 @@
    MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -33,7 +33,7 @@
    url: string
    options: object

    Returns Promise<any>

    +
  • Defined in config.ts:1
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -20,7 +20,7 @@

    Type alias LanguageGeocodingString

    Built-in languages values as strings

    +
  • Defined in language.ts:69
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -25,7 +25,7 @@
    proj4:
    wkt: string
    +
  • Defined in services/coordinates.ts:38
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -23,7 +23,7 @@

    Type declaration

  • path: string
  • +
  • Defined in services/coordinates.ts:43
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -25,7 +25,7 @@
    authority:
    code: BigInteger
    +
  • Defined in services/coordinates.ts:33
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -47,7 +47,7 @@
    Optional transformations
    Optional unit?: string
    +
  • Defined in services/coordinates.ts:61
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -29,7 +29,7 @@
    total:

    The number of results

    +
  • Defined in services/coordinates.ts:91
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -30,7 +30,7 @@
    transformer_selection_strategy
    +
  • Defined in services/coordinates.ts:159
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -43,7 +43,7 @@
    Optional unit
    usable: boolean
    +
  • Defined in services/coordinates.ts:47
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -37,7 +37,7 @@
    Optional transformations

    Show detailed transformations for each CRS (default: false)

    +
  • Defined in services/coordinates.ts:11
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -39,7 +39,7 @@
    Optional targetCrs

    Target coordinate reference system (default: 4326)

    +
  • Defined in services/coordinates.ts:174
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -27,7 +27,7 @@
    Optional y
    Optional z?: number
    +
  • Defined in services/coordinates.ts:153
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -27,7 +27,7 @@
    Optional apiKey

    Custom MapTiler Cloud API key to use instead of the one in global config

    +
  • Defined in services/data.ts:14
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    ByIdGeocodingOptions: LanguageGeocodingOptions
    +
  • Defined in services/geocoding.ts:88
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    CommonForwardAndReverseGeocodingOptions: LanguageGeocodingOptions & {
        apiKey?: string;
        limit?: number;
        types?: ("country" | "region" | "subregion" | "county" | "joint_municipality" | "joint_submunicipality" | "municipality" | "municipal_district" | "locality" | "neighbourhood" | "place" | "postal_code" | "address" | "poi")[];
    }
    +
  • Defined in services/geocoding.ts:25
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    Coordinates: Position
    +
  • Defined in services/geocoding.ts:90
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    FeatureHierarchy: FeatureProperties & FeatureBase
    +
  • Defined in services/geocoding.ts:159
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    GeocodingFeature: Feature<Geometry, FeatureProperties> & FeatureBase & {
        address?: string;
        bbox: BBox;
        center: Coordinates;
        context?: FeatureHierarchy[];
        place_name: string;
        place_type: string[];
        place_type_name: string[];
        relevance: number;
        [key: `place_name_${string}`]: string;
    }
    +
  • Defined in services/geocoding.ts:161
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    GeocodingOptions: CommonForwardAndReverseGeocodingOptions & {
        autocomplete?: boolean;
        bbox?: BBox;
        country?: string[];
        fuzzyMatch?: boolean;
        proximity?: Position;
    }
    +
  • Defined in services/geocoding.ts:58
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -35,7 +35,7 @@
    query:
    type: "FeatureCollection"
    +
  • Defined in services/geocoding.ts:213
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -25,7 +25,7 @@
    Optional language

    Prefer results in specific language. It’s possible to specify multiple values.

    +
  • Defined in services/geocoding.ts:18
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    +
  • Defined in services/geocoding.ts:86
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -27,7 +27,7 @@
    Optional apiKey

    Custom MapTiler Cloud API key to use instead of the one in global config

    +
  • Defined in services/geolocation.ts:14
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -90,7 +90,7 @@
    Optional timezone
    +
  • Defined in services/geolocation.ts:21
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -20,7 +20,7 @@

    Type alias AutomaticStaticMapOptions

    Options that can be provided to automatic static maps

    +
  • Defined in services/staticMaps.ts:141
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -20,7 +20,7 @@

    Type alias BoundedStaticMapOptions

    Options that can be provided to bounded static maps

    +
  • Defined in services/staticMaps.ts:130
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -20,7 +20,7 @@

    Type alias CenteredStaticMapOptions

    Options that can be provided to centered static maps

    +
  • Defined in services/staticMaps.ts:125
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -116,7 +116,7 @@
    Optional width
    +
  • Defined in services/staticMaps.ts:10
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -20,7 +20,7 @@

    Type alias StaticMapMarker

    Definition of a maker to show on a static map

    +
  • Defined in services/staticMaps.ts:146
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -20,7 +20,7 @@

    Variable configConst

    Configuration object

    +
  • Defined in config.ts:63
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -133,7 +133,7 @@
    UKRAINIAN:
    WELSH: string
    +
  • Defined in language.ts:4
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -64,7 +64,7 @@
    positions: PositionCoordinatesTransformOptions = {}

    Returns Promise<CoordinateTransformResult>

    +
  • Defined in services/coordinates.ts:253
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -43,7 +43,7 @@
    dataId: string
    options: GetDataOptions = {}

    Returns Promise<FeatureCollection>

    +
  • Defined in services/data.ts:59
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -220,7 +220,7 @@
    position: Position
    options: CommonForwardAndReverseGeocodingOptions = {}

    Returns Promise<GeocodingSearchResult>

    +
  • Defined in services/geocoding.ts:450
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -41,7 +41,7 @@

    Parameters

    options: GeolocationInfoOptions = {}

    Returns Promise<GeolocationResult>

    +
  • Defined in services/geolocation.ts:135
  • MapTiler Client - v1.5.0 +
  • The search index is not available
  • MapTiler Client - v1.6.0
    @@ -87,7 +87,7 @@
    zoom: number
    options: StaticMapBaseOptions = {}

    Returns string

    +
  • Defined in services/staticMaps.ts:457