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

    Interface Metadata

    Metadata to describe a store.

    interface Metadata {
        description?: string;
        displayField?: string;
        fields: readonly FieldData[];
        supportsChangedEvent?: boolean;
        supportsGeometry?: boolean;
        supportsGeometryGeneralization?: boolean;
        supportsSorting?: boolean;
        title?: string;
        readonly [k: string]: any;
    }

    Indexable

    • readonly [k: string]: any

      Stores may contain arbitrary custom metadata information.

    Index

    Properties

    description?: string

    Description of the store.

    displayField?: string

    Name of the display field. Used e.g. for search results to display items.

    fields: readonly FieldData[]

    Fields available in the store. These are mandatory.

    supportsChangedEvent?: boolean

    Indicates whether the store supports listening for changes in the underlying data. If this is true, store.on("changed", ...) must be implemented as well.

    Note that depending on the specific store, not all kinds of changes can be detected. For example, a store based on a feature layer might report client side edits, but may not report changes made to the service by other users.

    supportsGeometry?: boolean

    Flag to indicate, if the store supports spatial operations. If set to 'true', this implicitly declares that the items have a 'geometry' field. Default is 'false'.

    supportsGeometryGeneralization?: boolean

    Flag to indicate, if the store supports spatial geometry generalization. If set to 'true' clients know that the usage of the GeometryOptions.maxAllowableOffset is supported by the store.

    supportsSorting?: boolean

    Flag to indicate, if the store can react to the 'sort' option in queries. If this flag omitted, the default value is 'true'.

    title?: string

    Title of the store.