QuadKeyPartitionsRequest | @here/olp-sdk-ts
Class QuadKeyPartitionsRequest
Hierarchy
- QuadKeyPartitionsRequest
Index
Constructors
constructor
Returns QuadKeyPartitionsRequest
Methods
get
Gets the additional fields for the request.
Returns undefined | AdditionalFields
Additional fields.
get
Gets a billing tag to group billing records together.
Returns undefined | string
The
BillingTagstring.
get
Gets the configured depth for the request.
Returns QuadTreeIndexDepth
The number of the configured depth.
get
with
A setter for the provided additional fields
Parameters
additionalFields: AdditionalFields
Array of strings. Array could contain next values "dataSize" | "checksum" | "compressedDataSize | "crc"". This values could be useful for getPartitions method from versionedLayerClient and volatileLayerClient.
Returns QuadKeyPartitionsRequest
The updated QuadKeyPartitionsRequest instance that you can use to chain methods.
with
An optional free-form tag that is used for grouping billing records together.
If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A-Za-z0-9].
Parameters
tag: string
The
BillingTagstring.
Returns QuadKeyPartitionsRequest
The updated QuadKeyPartitionsRequest instance that you can use to chain methods.
with
The recursion depth of the response. The maximum allowed value for the depth parameter is 4.
Parameters
depth: QuadTreeIndexDepth
The recursion depth of the response.
Returns QuadKeyPartitionsRequest
The updated QuadKeyPartitionsRequest instance that you can use to chain methods.
If set to 0, the response includes only data from the quadkey specified in the request. In this way, the depth describes the maximum length of the subQuadKeys in the response.
with
A geometric area represented as a HERE tile.
Parameters
quadKey: QuadKey
Addresses a tile in the quadtree.
Returns QuadKeyPartitionsRequest
The updated QuadKeyPartitionsRequest instance that you can use to chain methods.
Generated using TypeDoc
Prepares information for calls to get quadtree metadata from the Query Service API.
This class works only with versioned and volatile layers where the partitioning scheme is HERE Tile.