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

    Interface AGSStore

    The type of stores created by the AGSStoreFactory.

    interface AGSStore {
        get(
            id: AllowedIdTypes,
            options?: GetOptions,
        ): Promise<undefined | Readonly<Record<string, any>>>;
        getIdentity(item: Partial<ItemType>): undefined | AllowedIdTypes;
        getMetadata(): Promise<Metadata>;
        id: undefined | string;
        idProperty?: string;
        layer: Layer | Sublayer;
        load(): Promise<void>;
        query(
            query?: ComplexQueryExpression,
            options?: QueryOptions,
        ): AsyncQueryResult<Readonly<Record<string, any>>>;
        target: undefined | string;
        url: undefined | string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id idProperty? layer target url

    Methods

    get getIdentity? getMetadata load query

    Properties

    id: undefined | string

    ID of the store.

    idProperty?: string

    Name of the property used as ID. If not provided, the 'getIdentity' method must be declared.

    layer: Layer | Sublayer

    The layer used by this store.

    target: undefined | string

    Use url instead.

    url: undefined | string

    The URL of the layer queried by this store. Undefined if this store works on a client side layer.

    Methods

    • Retrieves an item by its identifier.

      Parameters

      Returns Promise<undefined | Readonly<Record<string, any>>>

    • Returns any available metadata about the store. This may include attribution, available fields, cache directives, history or version information.

      Returns Promise<Metadata>

    • Manually loads required metadata from backend services if needed.

      Some methods (such as query) may not be available before metadata have been loaded.

      Note: Metadata can also be loaded by calling AsyncStore.getMetadata.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods