Options
All
  • Public
  • Public/Protected
  • All
Menu

Module olp-sdk-dataservice-read

Index

Enumerations

Classes

Interfaces

Type Aliases

Functions

Type Aliases

QuadTreeIndexDepth

QuadTreeIndexDepth: 0 | 1 | 2 | 3 | 4

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.

Functions

getTile

  • 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

    TileRequest

    see

    the AbortController documentation.

    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 fetch request) and, if required, abort it using the AbortController object.

    Returns Promise<Response>

    The blob of the requested tile or the blob of the closest parent Tile.

validateBillingTag

  • validateBillingTag(tag: string): string

  • Validates the billinig tag.

    It must be 4–16 characters long and contain only alphanumeric ASCII characters [A-Za-z0-9].

    Parameters

    • tag: string

      The string that represents the billing tag.

    Returns string

    The billing tag if it's valid. Otherwise, throws an error.

validatePartitionsIdsList

  • validatePartitionsIdsList(list: string[]): string[]

Generated using TypeDoc