Class: Options

.xyz.maps.providers.SpaceProvider. Options

Configuration of geospace provider.

Extends

Members Summary

clip :Boolean

Indicates if return clip features in request.

credentials :Object

User credential of the provider, a valid credential needs to contain the "access_code".

headers :Object

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

https :Boolean

Indicates if request is made with https.

level :number

zoom level at which tiles are cached.

name :string

Provider name

postProcessor :function

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.

PostProcessorData:
{put: GeoJsonFeature[],remove: GeoJsonFeature[]}
PostProcessor:
({data: PostProcessorData, ready: (data) => void) => PostProcessorData | Promise

preProcessor :function

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.

PreProcessor:
({data: any[], ready: (GeoJsonFeature[]) => void, tile?:{x:number,y:number,z:number}) => GeoJsonFeature[] | Promise

propertySearch :Object

define property search query to enable remote filtering by property search
https://www.here.xyz/api/devguide/propertiessearch/

space :string

Space name.

tags :Boolean

Indicates which tag is set in requests.

url :string

url of the provider, it points to xyz-hub space endpoint.

withCredentials :Boolean

Indicates if request is made with credentials.

Members Details

clip :Boolean [Optional]

Indicates if return clip features in request.
Type:
Boolean
Default Value:
  • false

credentials :Object

User credential of the provider, a valid credential needs to contain the "access_code".
Type:
Object

headers :Object [Optional]

set custom url service headers.
custom headers will be applied to all request done by provider
Type:
Object
Default Value:
  • null

https :Boolean [Optional]

Indicates if request is made with https.
Type:
Boolean
Default Value:
  • true

level :number

zoom level at which tiles are cached.
Type:
number
Inherited From:

name :string [Optional]

Provider name
Type:
string
Inherited From:

postProcessor :function [Optional]

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.

PostProcessorData:
{put: GeoJsonFeature[],remove: GeoJsonFeature[]}
PostProcessor:
({data: PostProcessorData, ready: (data) => void) => PostProcessorData | Promise
Type:
function
Inherited From:

preProcessor :function [Optional]

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.

PreProcessor:
({data: any[], ready: (GeoJsonFeature[]) => void, tile?:{x:number,y:number,z:number}) => GeoJsonFeature[] | Promise
Type:
function
Inherited From:

propertySearch :Object [Optional]

define property search query to enable remote filtering by property search
https://www.here.xyz/api/devguide/propertiessearch/
Type:
Object
Default Value:
  • null

space :string

Space name.
Type:
string

tags :Boolean [Optional]

Indicates which tag is set in requests.
Type:
Boolean
Default Value:
  • false

url :string [Optional]

url of the provider, it points to xyz-hub space endpoint.
Type:
string
Default Value:
  • null

withCredentials :Boolean [Optional]

Indicates if request is made with credentials.
Type:
Boolean
Default Value:
  • false