HTTPProviderOptions | XYZ Maps Documentation

Options to configuration of HTTPProvider.

Hierarchy

EditableRemoteTileProviderOptions
- HTTPProviderOptions
  - SpaceProviderOptions
  - IMLProviderOptions

Index

Properties

Methods

Properties

Optional editable

editable: boolean

Allow or prevent editing by the editor.Editor module.

defaultvalue: false

Optional enforceRandomFeatureId

enforceRandomFeatureId: boolean

Enforce random ids for newly created features. If "enforceRandomFeatureId" is set to true, the ids of features created by editor.addFeature are ignored and randomly created. If "enforceRandomFeatureId" is set to false, ids of features created by editor.addFeature can be set. Random ids are only generated if none have been set.

defaultvalue: true

Optional headers

headers: {}

Set custom url service headers. Custom headers will be applied to all request done by provider.

Type declaration

[header: string]: string

Optional hooks

hooks: { Coordinates.update?: CoordinatesUpdateHook | CoordinatesUpdateHook[]; Feature.remove?: FeatureRemoveHook | FeatureRemoveHook[]; Navlink.disconnect?: NavlinkDisconnectHook | NavlinkDisconnectHook[]; Navlink.split?: NavlinkSplitHook | NavlinkSplitHook[] }

Add hook functions that will be called during the execution of the corresponding "editing operation". The "hooks" option is a map with the "editing operation" as its key and the corresponding Hook or Array of Hook function(s) as its value.

Available editing operations are 'Navlink.disconnect', 'Navlink.split', 'Feature.remove', 'Coordinates.remove'.

see: editor.Editor.addHook

Type declaration

Optional Coordinates.update?: CoordinatesUpdateHook | CoordinatesUpdateHook[]

The CoordinatesUpdateHook(s) will be called whenever the coordinates of a feature are added, updated or removed ('Coordinates.update' operation).
Optional Feature.remove?: FeatureRemoveHook | FeatureRemoveHook[]

The FeatureRemoveHook(s) will be called when a feature is being removed ('Feature.remove' operation).
Optional Navlink.disconnect?: NavlinkDisconnectHook | NavlinkDisconnectHook[]

The NavlinkDisconnectHook(s) will be called whenever a Navlink is disconnected from an intersection ('Navlink.disconnect' operation).
Optional Navlink.split?: NavlinkSplitHook | NavlinkSplitHook[]

The NavlinkSplitHook(s) will be called whenever a Navlink is devided into two new Navlinks. ('Navlink.split' operation).

Optional https

https: boolean

Indicates if the requests should be made with https.

defaultvalue: true

Optional id

id: string

optional id to identify the provider.

Optional ignoreTileQueryLimit

ignoreTileQueryLimit: boolean

To prevent an overwhelming volume of tile requests, any requests for zoom levels lower than the provider's setting are disregarded. Enabling "ignoreTileQueryLimit" will bypass the tile query limit but may risk browser crashes.

defaultvalue: false

level

level: number

The zoomlevel at which tiles should be loaded from remote and a local index gets created.

Optional margin

margin: number

Tile margin of the provider.

Optional name

name: string

Name of the provider.

Optional params

params: {}

Set custom url parameters. Custom parameters will be applied to all request done by provider.

Type declaration

[paramter: string]: string

Optional url

url: string | ((z: number, y: number, x: number, quadkey: string) => string)

URL for requesting tiles.

It is either a string which may contain following flags that will be replaced by provider:

{SUBDOMAIN_CHAR}: subdomain id(a, b, c and d) for balancing the load
{SUBDOMAIN_INT}: subdomain id(0,1,2 and 3) for balancing the load
{SUBDOMAIN_INT_1_4}: subdomain id(1,2,3 and 4) for balancing the load
{QUADKEY}: quadkey of the tile to be requested
{Z}: z of the tile to be requested
{X}: x of the tile to be requested
{Y}: y of the tile to be requested

or a callback function that's called with the following parameters z,y,x,quadkey and needs to return the url for the respective tile. The callback function needs to handle custom parameters by its own.

example

// string
url: 'https://xyz.api.here.com/hub/spaces/mySpace/tile/quadkey/{QUADKEY}?access_token=myAccessToken'
// callback function
url: (z, y, x, quadkey) => {
    return 'https://xyz.api.here.com/hub/spaces/mySpace/tile/quadkey/' + quadkey + '?access_token=myAccessToken';
}

Optional withCredentials

withCredentials: boolean

Indicates if requests are made with credentials.

defaultvalue: false

Methods

Optional postProcessor

postProcessor(input: { data: { put: GeoJSONFeature[]; remove: GeoJSONFeature[] }; ready: (data: any) => void }): { put: GeoJSONFeature[]; remove: GeoJSONFeature[] } | Promise<{ put: GeoJSONFeature[]; remove: GeoJSONFeature[] }>

Inherited from RemoteTileProviderOptions.postProcessor
PostProcessor for remote data sources. The PostProcessor will be executed just before created/modified or removed Features will be sent to the remote backend. If the processor function is returning the processed data then its treated as a synchronous processor. If the processor function does not return any value (undefined) or a Promise then its treated as asynchronous processor. An asynchronous processor that's not using a Promise MUST call the input.ready(..) callback when data processing is finished.

Due to the execution of the processor in a separate worker thread the processor function must be scope independent. The processor must be a "standalone function/class" that only depends on its own scope and only accesses its own local variables. No references to the outer scope of the processor function are allowed.
example
```
// PostProcessorData:
 {put: GeoJsonFeature[],remove: GeoJsonFeature[]}
// PostProcessor:
 ({data: PostProcessorData, ready: (data) => void}) => PostProcessorData | Promise<GeoJsonFeature[]>
```
Parameters
- input: { data: { put: GeoJSONFeature[]; remove: GeoJSONFeature[] }; ready: (data: any) => void }
  - data: { put: GeoJSONFeature[]; remove: GeoJSONFeature[] }
    - put: GeoJSONFeature[]
    - remove: GeoJSONFeature[]
  - ready: (data: any) => void
    - - (data: any): void
      - Parameters
        
        data: any
        
        Returns void
Returns { put: GeoJSONFeature[]; remove: GeoJSONFeature[] } | Promise<{ put: GeoJSONFeature[]; remove: GeoJSONFeature[] }>

Optional preProcessor

preProcessor(input: { data: any[]; ready: (features: GeoJSONFeature[]) => void; tile?: { x: number; y: number; z: number } }): GeoJSONFeature[] | Promise<GeoJSONFeature[]>

Inherited from RemoteTileProviderOptions.preProcessor
PreProcessor for remote data sources. The PreProcessor will be executed just after Features are received from remote backend. If the processor function is returning the processed data then its treated as a synchronous processor. If the processor function does not return any value (undefined) or a Promise then its treated as asynchronous processor. An asynchronous processor that's not using a Promise MUST call the input.ready(..) callback when data processing is finished.

Due to the execution of the processor in a separate worker thread the processor function must be scope independent. The processor must be a "standalone function/class" that only depends on its own scope and only accesses its own local variables. No references to the outer scope of the processor function are allowed.
example
```
// PreProcessor:
 ({data: any[], ready: (GeoJsonFeature[]) => void, tile?:{x:number,y:number,z:number}) => GeoJsonFeature[] | Promise<GeoJsonFeature[]>
```
Parameters
- input: { data: any[]; ready: (features: GeoJSONFeature[]) => void; tile?: { x: number; y: number; z: number } }
  - data: any[]
  - ready: (features: GeoJSONFeature[]) => void
    - - (features: GeoJSONFeature[]): void
      - Parameters
        
        features: GeoJSONFeature[]
        
        Returns void
  - Optional tile?: { x: number; y: number; z: number }
    - x: number
    - y: number
    - z: number
Returns GeoJSONFeature[] | Promise<GeoJSONFeature[]>

Hierarchy

Index

Properties

Methods

Properties

Optional editable

Optional enforceRandomFeatureId

Optional headers

Type declaration

[header: string]: string

Optional hooks

Type declaration

Optional Coordinates.update?: CoordinatesUpdateHook | CoordinatesUpdateHook[]

Optional Feature.remove?: FeatureRemoveHook | FeatureRemoveHook[]

Optional Navlink.disconnect?: NavlinkDisconnectHook | NavlinkDisconnectHook[]

Optional Navlink.split?: NavlinkSplitHook | NavlinkSplitHook[]

Optional https

Optional id

Optional ignoreTileQueryLimit

level

Optional margin

Optional name

Optional params

Type declaration

[paramter: string]: string

Optional url

Optional withCredentials

Methods

Optional postProcessor

Parameters

input: { data: { put: GeoJSONFeature[]; remove: GeoJSONFeature[] }; ready: (data: any) => void }

data: { put: GeoJSONFeature[]; remove: GeoJSONFeature[] }

put: GeoJSONFeature[]

remove: GeoJSONFeature[]

ready: (data: any) => void

Parameters

data: any

Returns void

Returns { put: GeoJSONFeature[]; remove: GeoJSONFeature[] } | Promise<{ put: GeoJSONFeature[]; remove: GeoJSONFeature[] }>

Optional preProcessor

Parameters

input: { data: any[]; ready: (features: GeoJSONFeature[]) => void; tile?: { x: number; y: number; z: number } }

data: any[]

ready: (features: GeoJSONFeature[]) => void

Parameters

features: GeoJSONFeature[]

Returns void

Optional tile?: { x: number; y: number; z: number }

x: number

y: number

z: number

Returns GeoJSONFeature[] | Promise<GeoJSONFeature[]>