InteractiveLayer | Data Inspector Library API Reference
- Last UpdatedJan 18, 2025
- 4 minute read
Hierarchy
-
BaseLayer<ConfigApi.InteractiveMapsLayer>
- InteractiveLayer
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Parameters
-
model: InteractiveMapsLayer
-
catalog: Catalog
-
settings: OlpClientSettings
Returns InteractiveLayer
-
Properties
Protected Optional Readonly artifactClient
An artifact client.
Readonly catalog
Protected m_features
Cached promises with requests to get full features.
Readonly model
Optional Readonly settings
Accessors
contentType
-
Returns undefined | string
partitioning
-
Returns undefined | Partitioning
schema
-
Returns undefined | Schema
Methods
getAllPartitionsInfo
-
Parameters
-
Optional limit: number
-
Optional additionalFields: AdditionalPartitionFields[]
Returns Promise<Partition[]>
-
getFeature
-
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
-
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
-
Parameters
-
id: string
-
Optional abortSignal: AbortSignal
Returns Promise<Response>
-
getPartitionsInfo
-
Parameters
-
ids: string[]
-
Optional additionalFields: AdditionalPartitionFields[]
-
Optional abortSignal: AbortSignal
Returns Promise<Partition[]>
-
Protected getRequestBuilder
-
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
-
Get a schema.
Returns Promise<undefined | ArrayBuffer>
getSchemaDetails
-
Get schema details.
Returns Promise<undefined | GetSchemaResponseObj>
getStatistics
-
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
-
Load the data of a tile.
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
-
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.
-
An interactive layer.