Powered by Zoomin Software. For more details please contactZoomin

Data Inspector Library - API Reference

Product category
Technology
Doc type
Version
Product lifecycle
This publication

Data Inspector Library - API Reference: InteractiveLayer | Data Inspector Library API Reference

Table of Contents

InteractiveLayer | Data Inspector Library API Reference

An interactive layer.

Hierarchy

  • BaseLayer<ConfigApi.InteractiveMapsLayer>
    • InteractiveLayer

Index

Constructors

constructor

  • new InteractiveLayer(model: InteractiveMapsLayer, catalog: Catalog, settings: OlpClientSettings): InteractiveLayer
  • inheritdoc

    Parameters

    • model: InteractiveMapsLayer
    • catalog: Catalog
    • settings: OlpClientSettings

    Returns InteractiveLayer

Properties

Protected Optional Readonly artifactClient

artifactClient: undefined | ArtifactClient

An artifact client.

Readonly catalog

catalog: Catalog

Protected m_features

m_features: Map<string, Promise<undefined | Feature>> = ...

Cached promises with requests to get full features.

Readonly model

model: InteractiveMapsLayer

Optional Readonly settings

settings: undefined | OlpClientSettings

Accessors

contentType

  • get contentType(): undefined | string
  • Returns undefined | string

partitioning

  • get partitioning(): undefined | Partitioning
  • Returns undefined | Partitioning

schema

  • get schema(): undefined | Schema
  • Returns undefined | Schema

Methods

getAllPartitionsInfo

getFeature

  • getFeature(id: string): Promise<undefined | Feature>
  • Get feature by ID.

    Parameters

    • id: string

      feature ID.

    Returns Promise<undefined | Feature>

    GeoJSON feature, or undefined if feature is not found or other error occured.

getFeaturesForBoundingBox

  • getFeaturesForBoundingBox(bbox: GeoBox, limit?: number): Promise<any>
  • Retrieves features for geo box.

    Parameters

    • bbox: GeoBox

      Bounding box for features.

    • Optional limit: number

      Limit of partitions to retrieve.

    Returns Promise<any>

    GeoJSON feature collection.

getPartition

  • getPartition(id: string, abortSignal?: AbortSignal): Promise<Response>
  • inheritdoc

    Parameters

    • id: string
    • Optional abortSignal: AbortSignal

    Returns Promise<Response>

getPartitionsInfo

  • getPartitionsInfo(ids: string[], additionalFields?: AdditionalPartitionFields[], abortSignal?: AbortSignal): Promise<Partition[]>
  • inheritdoc

    Parameters

    Returns Promise<Partition[]>

Protected getRequestBuilder

  • getRequestBuilder(version?: string): Promise<DataStoreRequestBuilder>
  • Creates and reuses an instance of request builder for "interactive" API.

    Parameters

    • version: string = "v1"

      API version.

    Returns Promise<DataStoreRequestBuilder>

    Promise with request builder.

getSchema

  • getSchema(): Promise<undefined | ArrayBuffer>
  • Get a schema.

    Returns Promise<undefined | ArrayBuffer>

getSchemaDetails

  • getSchemaDetails(): Promise<undefined | GetSchemaResponseObj>
  • Get schema details.

    Returns Promise<undefined | GetSchemaResponseObj>

getStatistics

  • getStatistics(skipCache?: boolean): Promise<Statistics>
  • Get statistics for an interactive layer.

    Parameters

    • Optional skipCache: boolean

      If set to true the response is not returned from cache. Default is false.

    Returns Promise<Statistics>

    Layer statistics.

getTile

  • getTile(partitionId: string | TileKey, abortSignal?: AbortSignal): Promise<ArrayBufferLike>
  • Load the data of a tile.

    deprecated

    This is a convenience wrapper over getPartition so use it instead.

    Parameters

    • partitionId: string | TileKey

      Partition id or TileKey.

    • Optional abortSignal: AbortSignal

      A signal object that allows you to communicate with a request and, if required, abort it using the AbortController object.

    Returns Promise<ArrayBufferLike>

getWebtileInteractive

  • getWebtileInteractive(id: string, sampling?: "off" | "low" | "med" | "high", limit?: number, abortSignal?: AbortSignal): Promise<Response>
  • Retrieves features for tile. Tile must use webMercatorTilingScheme.

    Parameters

    • id: string

      TileKey Morton code.

    • Optional sampling: "off" | "low" | "med" | "high"

      Features simplification level.

    • limit: number = 100000

      Limit of features per tile.

    • Optional abortSignal: AbortSignal

      Optional request abort signal.

    Returns Promise<Response>

    Promise with response containing features.

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Class
  • Class with type parameter
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Interface
  • Interface with type parameter
  • Protected property
  • Protected method
  • Enumeration
Was this article helpful?
TitleResults for “How to create a CRG?”Also Available inAlert