Interface AGSStoreFromURLOptions

Specifies an AGSStore constructed from a URL.

interface AGSStoreFromURLOptions {
    apiKey?: string;
    collectionId?: string;
    customParameters?: object;
    geometryFieldName?: string;
    id: string;
    name?: string;
    objectIdField?: string;
    supportsIdQueries?: boolean;
    supportsPostQueries?: boolean;
    type?: "feature" | "geojson" | "csv" | "wfs" | "ogc-feature";
    url: string;
}

Hierarchy (view full)

Properties

apiKey? collectionId? customParameters? geometryFieldName? id name? objectIdField? supportsIdQueries? supportsPostQueries? type? url

Properties

Optional apiKey

apiKey?: string

An API key (or token) required to access the service.

See also https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#apiKey

Optional collectionId

collectionId?: string

Specifies the collectionId of a ogc-feature layer.

Optional customParameters

customParameters?: object

A list of URL parameters which will be appended during fetching of the layer.

Optional geometryFieldName

geometryFieldName?: string

Name of the geometry field for polygon queries against OGCFeatureServices.

id

id: string

The id of the new store.

Optional name

name?: string

Specifies the name of the WFS layer.

Optional objectIdField

objectIdField?: string

Specifies the objectIdField of a ogc-feature layer. Default is 'id'

Optional supportsIdQueries

supportsIdQueries?: boolean

Flag for ogc-feature layer, to enable queries for features using the objectIdField property. Default is false.

Optional supportsPostQueries

supportsPostQueries?: boolean

Flag to indicate that the layer supports filtering using POST requests. Default is false for non ArcGIS OGCFeaturesServices, which means that requests with long query strings will fail. If supportsIdQueries is true and supportsPostQueries is false then these id queries are split to ensure GET requests are used for feature lookup by ids.

Optional type

type?: "feature" | "geojson" | "csv" | "wfs" | "ogc-feature"

The type of the service. Defaults to "feature".

url

url: string

A service url, for services that are not in the map.

Settings

Member Visibility

Theme

On This Page

apiKeycollectionIdcustomParametersgeometryFieldNameidnameobjectIdFieldsupportsIdQueriessupportsPostQueriestypeurl

Generated using TypeDoc