olp-sdk-dataservice-read
Index
Classes
- Artifact
Client - Catalog
Client - Catalog
Request - Catalog
Version Request - Catalogs
Request - Config
Client - Data
Request - Index
Layer Client - Index
Query Request - Layer
Versions Request - Metadata
Cache Repository - Partitions
Request - Poll
Request - Quad
Key Partitions Request - Quad
Tree Index Cache Repository - Quad
Tree Index Request - Query
Client - Schema
Details Request - Schema
Request - Seek
Request - Statistics
Client - Statistics
Request - Stream
Layer Client - Subscribe
Request - Summary
Request - Tile
Request - Unsubscribe
Request - Versioned
Layer Client - Volatile
Layer Client
Functions
get
- get
Tile(request: TileRequest, params: TileRequestParams, abortSignal?: AbortSignal): Promise<Response>
-
Fetches asynchronously data from a tile or from its nearest ancestor if not found.
The tile is a geometric area represented as a HERE tile. The quad tree metadata fetches the blob of needed tile from the HERE Query Service, then caches it, and returns to the user. To disable caching of metadata use
request.withFetchOption(FetchOptions.OnlineOnly).see
TileRequestsee
theAbortControllerdocumentation.example
const params: GetTileParams = {settings: "% your `OlpClientSettings` instance % ", catalogHrn: "% the HRN instance of your catalog %", layerId: "% your layer ID %", layerType: "% versioned or volatile %",}const request = new TileRequest();
const tile1 = await getTile(request.withTileKey(yourTileKey1), params);
const tile2 = await getTile(request.withTileKey(yourTileKey2), params);Parameters-
request: TileRequest
Requests the TileRequest instance with the configured parameters.
-
params: TileRequestParams
-
Optional abortSignal: AbortSignal
The signal object that allows you to communicate with a request (such as the
fetchrequest) and, if required, abort it using theAbortControllerobject.
Returns Promise<Response>The blob of the requested tile or the blob of the closest parent Tile.
-
On this page
- Coverage Data Type
- Artifact Client
- Catalog Client
- Catalog Request
- Catalog Version Request
- Catalogs Request
- Config Client
- Data Request
- Index Layer Client
- Index Query Request
- Layer Versions Request
- Metadata Cache Repository
- Partitions Request
- Poll Request
- Quad Key Partitions Request
- Quad Tree Index Cache Repository
- Quad Tree Index Request
- Query Client
- Schema Details Request
- Schema Request
- Seek Request
- Statistics Client
- Statistics Request
- Stream Layer Client
- Subscribe Request
- Summary Request
- Tile Request
- Unsubscribe Request
- Versioned Layer Client
- Volatile Layer Client
- Get Tile Params
- Index Layer Client Params
- Stream Layer Client Params
- Tile Request Params
- Versioned Layer Client Params
- Volatile Layer Client Params
- Quad Tree Index Depth
- get Tile
- validate Billing Tag
- validate Partitions Ids List
The recursion depth of the quadtree.
If set to 0, the response includes only data for the quadKey specified in the request. In this way, depth describes the maximum length of the subQuadKeys in the response. The maximum allowed value for the depth parameter is 4.