types | References | ArcGIS Maps SDK for JavaScript

Types

import type { Collection, CollectionsPage, LandingPage, QueryParameters, QueryOptions } from "@arcgis/core/layers/ogc/types.js";

Type definitions

Collection

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

An OGC API-Features collection.

id

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The collection identifier.

See also

OGCFeatureLayer.collectionId

landingPage

Property

Type: LandingPage

Since: ArcGIS Maps SDK for JavaScript 5.0

The landing page of the OGC API-Features server hosting the collection.

description

Property

Type: string | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The description of the collection.

title

Property

Type: string | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The title of the collection.

CollectionsPage

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The collections page for an OGC API-Features server.

collections

Property

Type: Collection[]

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of collections available from the OGC API-Features server.

LandingPage

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The landing page of an OGC API-Features server.

description

Property

Type: string | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The description of the OGC API-Features server.

title

Property

Type: string | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The title of the OGC API-Features server.

url

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The url to the OGC API-Features server.

QueryParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

apiKey

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

An authorization string used to access a resource or service. This property will append the API key to all requests made by the layer to the service. API keys are generated and managed in the portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage. Setting a fine-grained API key on a specific class overrides the global API key.

If loading a secure layer with API authentication via a PortalItem, the API key needs to be set on the portalItem.

See also

Example

// set the api key to access a protected service
const layer = new FeatureLayer({
  url: serviceUrl,
  apiKey: "YOUR_API_KEY"
});

customParameters

Property

Type: CustomParameters | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

A list of custom parameters appended to the URL of all resources fetched by the layer. It's an object with key-value pairs where value is a string. The layer's refresh() method needs to be called if the customParameters are updated at runtime.

Example

// send a custom parameter to your special service
let layer = new MapImageLayer({
  url: serviceUrl,
  customParameters: {
    "key": "my-special-key"
  }
});

QueryOptions

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: QueryParameters ‚ AbortOptions