Class: Options

.xyz.maps.providers.RemoteTileProvider. Options

Configuration of providers.

Extends

Members Summary

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

Members Details

level :number

zoom level at which tiles are cached.
Type:
number

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

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