VersionedLayerClient
Constructors
constructor
- new
Versioned Layer Client(params: VersionedLayerClientParams): VersionedLayerClient
-
Creates the VersionedLayerClient instance with VersionedLayerClientParams.
Parameters-
params: VersionedLayerClientParams
parameters for use to initialize VersionLayerClient.
Returns VersionedLayerClient -
Methods
get
- get
Aggregated Data(request: TileRequest, abortSignal?: AbortSignal): Promise<Response>
-
brief
Fetches data of a tile or its closest ancestor. Use this API for tile-tree structures where children tile data is aggregated and stored in parent tiles.Parameters-
request: TileRequest
The
TileRequestinstance that contains a complete set of request parameters. -
Optional abortSignal: AbortSignal
A signal object that allows you to communicate with a request (such as the
fetchrequest) and, if required, abort it using theAbortControllerobject.For more information, see the
AbortControllerdocumentation.
Returns Promise<Response>Tile data (if it exists) or the nearest parent tile data
-
get
- get
Data(dataRequest: DataRequest, abortSignal?: AbortSignal): Promise<Response>
-
Fetches partition data using one of the following methods: ID, quadkey, or data handle.
Parameters-
dataRequest: DataRequest
The DataRequest instance of the configured request parameters.
-
Optional abortSignal: AbortSignal
A signal object that allows you to communicate with a request (such as the
fetchrequest) and, if required, abort it using theAbortControllerobject.For more information, see the
AbortControllerdocumentation.
Returns Promise<Response>The data from the requested partition.
-
get
- get
Partitions(quadKeyPartitionsRequest: QuadKeyPartitionsRequest, abortSignal?: AbortSignal): Promise<QueryApi.Index> - get
Partitions(partitionsRequest: PartitionsRequest, abortSignal?: AbortSignal): Promise<MetadataApi.Partitions>
-
Fetches partitions metadata from the Query Service API using a quadkey.
Parameters-
quadKeyPartitionsRequest: QuadKeyPartitionsRequest
The QuadKeyPartitionsRequest instance.
-
Optional abortSignal: AbortSignal
A signal object that allows you to communicate with a request (such as the
fetchrequest) and, if required, abort it using theAbortControllerobject.For more information, see the
AbortControllerdocumentation.
The quadtree index for the requested partitions.
-
-
Fetches all partitions metadata from a layer using the partition ID from the PartitionsRequest instance.
Parameters-
partitionsRequest: PartitionsRequest
The PartitionsRequest instance.
-
Optional abortSignal: AbortSignal
A signal object that allows you to communicate with a request (such as the
fetchrequest) and, if required, abort it using theAbortControllerobject.For more information, see the
AbortControllerdocumentation.
A list of metadata for each of the partitions from the requested layer.
If the partition IDs are not set, you get metadata from all of the partitions of the requested layer from the Metadata Service API. If the IDs are set, you get data from the Query Service API.
-
Describes a versioned layer and provides the possibility to get partitions metadata and data.