Interface AGSStore

The type of stores created by the AGSStoreFactory.

Hierarchy

  • AsyncStore
    • AGSStore

Properties

id idProperty? target url

Methods

get getIdentity? getMetadata query

Properties

Readonly id

id: undefined | string

ID of the store.

Optional Readonly idProperty

idProperty?: string

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

target

target: undefined | string

Deprecated

Use url instead.

url

url: undefined | string

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

Methods

get

  • Retrieves an item by its identifier.

    Parameters

    • id: AllowedIdTypes

      id of an item in the store.

    • Optional options: GetOptions

      options to specify the result.

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

Optional getIdentity

  • Returns an items‘s identity. This must always execute synchronously.

    Parameters

    • item: Partial<Readonly<Record<string, any>>>

      the item.

    Returns undefined | AllowedIdTypes

    the ID

getMetadata

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

    Returns Promise<Metadata>

query

  • Queries the store using the provided query.

    Parameters

    • Optional query: ComplexQueryExpression

      a query to execute.

    • Optional options: QueryOptions

      the query options.

    Returns AsyncQueryResult<Readonly<Record<string, any>>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc