Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • FeatureSetCollection

Index

Constructors

constructor

  • Initializes a new instance of the {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetCollection} class.

    class

    Represents a Geocortex Essentials FeatureSetCollection.

    constructs
    memberof

    geocortex.essentialsHtmlViewer.mapping.infrastructure

    Returns FeatureSetCollection

Properties

displayName

displayName: Observable<string>

The displayName for the feature set collection.

type

String

extendedProperties

The extended collection for the feature set collection.

type

Array

featureSets

The collection of feature set objects constituting the collection.

type

ObservableCollection

id

id: string

The id of the feature set collection.

type

Number

isModified

isModified: Observable<boolean>

Whether the feature set collection has been modified.

sourceName

sourceName: string

The source of the feature set collection.

type

String

tag

tag: any

The tag for the feature set collection.

type

String

Methods

Protected _buildFeatureSetLookup

Protected _buildLayerLookup

Protected _generateLayerKey

  • _generateLayerKey(mapServiceId: string, layerId: string): string
  • Parameters

    • mapServiceId: string
    • layerId: string

    Returns string

Protected _getFeatureSetByIdImpl

  • _getFeatureSetByIdImpl(id: string, isUniqueId?: boolean): FeatureSet
  • Parameters

    • id: string
    • Optional isUniqueId: boolean

    Returns FeatureSet

clear

  • clear(): void
  • Clears the feature collection within each FeatureSet, before clearing the FeatureSet collection.

    Returns void

clone

  • Performs a shallow copy of this FeatureSetCollection, returning the cloned value.

    Parameters

    • Optional deepCopy: boolean

      Whether to clone the FeatureSets belonging to this collection. Defaults to false

    Returns FeatureSetCollection

cloneStructure

  • Given a FeatureSetCollection, creates a new empty one just like the original (same layer, name etc) Note: This method will not copy the feature sets within the original collection.

    Returns FeatureSetCollection

countFeatures

  • countFeatures(): number
  • Get the number of features contained in all feature sets in this collection.

    Returns number

findFeatureByEsriFeature

  • findFeatureByEsriFeature(esriFeature: Graphic, featureLayer?: FeatureLayer): Feature
  • Searches all contained feature sets for a Geocortex feature corresponding to the specified ESRI feature, and returns it if found. There is an inherent assumption here that a Geocortex feature instance will be unique among all feature sets in a feature set collection.

    Parameters

    • esriFeature: Graphic

      The esri graphic for which the corresponding Geocortex feature needs to be retrieved.

    • Optional featureLayer: FeatureLayer

    Returns Feature

    The Geocortex feature corresponding to the given ESRI feature, if it exists, or null.

firstFeature

  • Returns the first Feature of the first FeatureSet, or null if none exists.

    Returns Feature

    Feature The first Feature in the collection.

getExtendedPropertyByName

  • getExtendedPropertyByName(name: string): any
  • Finds the extended property matching the specified name.

    Parameters

    • name: string

      The name of the property to find.

    Returns any

getFeatureSetById

  • Returns the FeatureSet having the specified ID, or null if none exists.

    Parameters

    • id: string

      The id of the FeatureSet to return.

    Returns FeatureSet

    FeatureSet The FeatureSet with the specified ID.

getFeatureSetByLayer

  • Returns the FeatureSet having the specified {@link geocortex.essentials.Layer}, or null if none exists.

    Parameters

    • layer: Layer

      The Geocortex Layer of the FeatureSet to return.

    Returns FeatureSet

    FeatureSet The FeatureSet found, if any.

getFeatureSetByUniqueId

  • Returns the FeatureSet having the specified unique ID, or null if none exists.

    Parameters

    • id: string

      The unique id of the FeatureSet to return.

    Returns FeatureSet

    FeatureSet The FeatureSet with the specified unique ID.

getFeatureSetbyEsriLayer

  • getFeatureSetbyEsriLayer(layer: Layer): FeatureSet
  • Returns the FeatureSet having the specified {@link esri.layers.Layer}, or null if none exists. Note - If possible, use getFeatureSetByLayer which takes geocortex.essentials.Layer rather than esri.layers.Layer as parameter. This method is created primarily for layers which don't have essentials layer example - markup layer.

    Parameters

    • layer: Layer

      The esri Layer of the FeatureSet to return.

    Returns FeatureSet

    FeatureSet The FeatureSet found, if any.

intersectInPlace

  • Produces the set intersection of two sequences of Features by using the default equality comparer to compare values. The intersection of two sets A and B is defined as the set that contains all the elements of A that also appear in B, but no other elements.

    Parameters

    Returns boolean

    true if this set changed as a result of the call; false otherwise.

intersectManyInPlace

  • Parameters

    Returns boolean

setExtendedProperty

  • setExtendedProperty(name: string, value: any): void
  • Sets the extended property matching the specified name.

    Parameters

    • name: string

      The name of the property to update.

    • value: any

      The property value.

    Returns void

subtractInPlace

  • Produces the set difference of two sequences of Features by using the default equality comparer to compare values. The set difference of two sets is defined as the members of the first set that do not appear in the second set. Note: This method modifies this set to only keep those elements that do not appear in the second set. It does not also include those elements in the second set that do not appear in this set.

    Parameters

    Returns boolean

    true if this set changed as a result of the call; false otherwise.

subtractManyInPlace

  • Parameters

    Returns boolean

unionInPlace

  • Produces the set union of two sequences of Features by using the default equality comparer. In other words, it adds all of the elements in the second set to this set if they're not already present.

    Parameters

    Returns boolean

    true if this set changed as a result of the call; false otherwise.

unionManyInPlace

  • Parameters

    Returns boolean