Class FeatureSet

constructor

• new FeatureSet(properties?): FeatureSet

• Parameters

  • Optionalproperties: FeatureSetProperties

  Returns FeatureSet

Readonly[toStringTag]

@eventTypes

Readonlyid

Readonlyschema

Readonlysettings

title

itemType

• get itemType(): string

• The item type for this entity when it participates in an App.

  Returns string

size

• get size(): number

• The number of elements in the set.

  Returns number

source

• get source(): FeatureSource

• The source for the features.

  Returns FeatureSource
• set source(value): void

• Parameters

  • value: FeatureSource

  Returns void

[iterator]

• [iterator](): SetIterator<Feature>

• Returns each element in the set in insertion order.

  Returns SetIterator<Feature>

add

• add(feature): this

• Parameters

  • feature: Feature

  Returns this

  Inherit Doc

addMany

• addMany(features): this

• Parameters

  • features: Iterable<Feature, any, any>

  Returns this

  Inherit Doc

assignProperties

• assignProperties(properties): void

• Sets the values of this object's properties.

  Parameters

  • properties: Partial<FeatureSetProperties>

    An object containing property values to set.

  Returns void

assignPropertiesAsync

• assignPropertiesAsync(properties): Promise<void>

• Sets the properties for this item.

  This version will also await any asynchronous logic that is needed to set the properties.

  Parameters

  • properties: Partial<FeatureSetProperties>

    A plain object containing property values to set, keyed by property name.

  Returns Promise<void>

clear

• clear(): void

• Returns void

  Inherit Doc

delete

• delete(feature): boolean

• Parameters

  • feature: Feature

  Returns boolean

  Inherit Doc

deleteMany

• deleteMany(features): boolean

• Parameters

  • features: Iterable<Feature, any, any>

  Returns boolean

  Inherit Doc

entries

• entries(): SetIterator<[Feature, Feature]>

• Returns SetIterator<[Feature, Feature]>

  Inherit Doc

findById

• findById(id): Feature

• Finds a feature in the set with the given ID, or undefined if there is no match.

  Parameters

  • id: string

    The ID to search for.

  Returns Feature

findByPrimaryKey

• findByPrimaryKey(primaryKey): Feature

• Finds a feature in the set with the given primary key, or undefined if there is no match.

  Parameters

  • primaryKey: string

    The primary key to search for.

  Returns Feature

finishAssignProperties

• finishAssignProperties(): Promise<void>

• Waits for all deserialization logic initiated thus far to finish, whether invoked by passing properties into the constructor, or by invoking assignProperties() or assignPropertiesAsync().

  Returns Promise<void>

forEach

• forEach(callbackfn, thisArg?): void

• Parameters

  • callbackfn: ((value: Feature, value2: Feature, set: Set<Feature>) => void)

    Function to execute for each element.

    • • (value, value2, set): void

      • Parameters

        • value: Feature
        • value2: Feature
        • set: Set<Feature>

        Returns void

  • OptionalthisArg: unknown

    Value to use as this when executing callback.

  Returns void

  Inherit Doc

getDefault

• getDefault<K>(key): FeatureSetProperties[K]

• Gets the default value of an object's property.

  Type Parameters

  • K extends keyof FeatureSetProperties

  Parameters

  • key: K

    The property of the object for which to get the default value.

  Returns FeatureSetProperties[K]

getDefaults

• getDefaults(): Partial<FeatureSetProperties>

• Gets the object's default property values.

  Returns Partial<FeatureSetProperties>

getSerializableProperties

• getSerializableProperties(serializeMode?): PropertyDefs<FeatureSetProperties>

• Returns the serializable properties.

  Parameters

  • serializeMode: SerializeMode = "all"

    Optional. If specified, only properties that support the given serialization mode will be returned.

  Returns PropertyDefs<FeatureSetProperties>

has

• has(feature): boolean

• Indicates whether or not the set contains the specified element.

  Parameters

  • feature: Feature

    The element to test for.

  Returns boolean

keys

• keys(): SetIterator<Feature>

• Returns SetIterator<Feature>

  Inherit Doc

toItemUri

• toItemUri(): string

• Creates an item:// URI reference to this entity.

  Returns string

toJSON

• toJSON(serializeMode?): FeatureSetProperties

• Returns a serializable representation of the feature set.

  Parameters

  • serializeMode: SerializeMode = "all"

    If specified, only properties that are appropriate for the given mode are returned. Otherwise, all properties will be serialized.

  Returns FeatureSetProperties

values

• values(): SetIterator<Feature>

• Returns SetIterator<Feature>

  Inherit Doc

StaticfromFeatureStream

• fromFeatureStream(features, properties?): Promise<FeatureSet>

• Reads a stream of features into a data/FeatureSet!FeatureSet.

  Parameters

  • features: AsyncIterable<Feature, any, any>

    The features to read.
  • Optionalproperties: FeatureSetProperties

    Optional properties for the new feature set.

  Returns Promise<FeatureSet>