map.apps Bundle APIs 4.20.0
    Preparing search index...

    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" | "scene";
        url: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    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

    collectionId?: string

    Specifies the collectionId of a ogc-feature layer.

    customParameters?: object

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

    geometryFieldName?: string

    Name of the geometry field for polygon queries against OGCFeatureServices.

    id: string

    The id of the new store.

    name?: string

    Specifies the name of the WFS layer.

    objectIdField?: string

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

    supportsIdQueries?: boolean

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

    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.

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

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

    url: string

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

    Settings

    Member Visibility

    On This Page

    Properties