Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FeatureSetManager

Hierarchy

  • FeatureSetManager

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of an {@link geocortex.essentialsHtmlViewer.mapping.infrastructure.FeatureSetManager} object.

    class

    The central clearing-house for all system activities that create and want to expose FeatureSet instances to other areas of the system.

    constructs
    memberof

    geocortex.essentialsHtmlViewer.mapping.infrastructure

    Parameters

    • app: ViewerApplication

      The {@link geocortex.framework.application.Application} that this module belongs to.

    Returns FeatureSetManager

Properties

Private _collectionChangedEventMap

_collectionChangedEventMap: object

Map of FSC ID -> event token for the collection changed event.

Type declaration

  • [id: string]: string

Private _collectionOpenCount

_collectionOpenCount: object

Map of ID -> Open count.

Type declaration

  • [id: string]: number

Private _featureSetCollectionsMap

_featureSetCollectionsMap: object

Map of ID -> FSC.

Type declaration

_searchSuggestions

_searchSuggestions: object

Map of FSC source name -> search suggestion.

Type declaration

  • [sourceName: string]: string

app

app: ViewerApplication

The {@link geocortex.framework.application.Application} that this module belongs to.

currentResultSet

currentResultSet: Observable<FeatureSetCollection>

The FeatureSetCollection that is currently visible in the results view

featureSetCollections

featureSetCollections: ObservableCollection<FeatureSetCollection>

The feature set collections being managed.

type

FeatureSetCollection[]

Methods

Private _addCollectionImpl

  • Adds the specified collection to the feature set manager.

    Parameters

    Returns boolean

    Boolean, True if the operation was successful, false otherwise.

addCollection

  • Adds the specified collection to the feature set manager.

    Parameters

    Returns boolean

    Boolean, True if the operation was successful, false otherwise.

addSearchSuggestions

  • addSearchSuggestions(searchSuggestions: object): void

  • Adds the specified search suggestions to the feature set manager.

    Parameters

    • searchSuggestions: object

      The object containing a map of FSC source name -> search suggestion.

      • [sourceName: string]: string

    Returns void

canRemoveCollection

  • Determine whether the specified FeatureSetCollection can be removed from the manager.

    Parameters

    Returns boolean

    Boolean, True if the specified FeatureSetCollection is currently managed, false otherwise.

closeCollection

  • closeCollection(id: string): boolean

  • Closes the specified collection. Opening and closing a feature set collection does not actually change the behavior of the collection. It is used internally to keep track of multiple clients concurrently accessing a collection for the purposes of raising an event when the collection is first opened and finally closed.

    Parameters

    • id: string

      The ID of the collection to close.

    Returns boolean

    Boolean True if the collection was successfully closed, False otherwise.

findFeatureSetByUniqueId

  • findFeatureSetByUniqueId(uniqueId: string): FeatureSet

  • Searches all contained feature set collections for a feature set having the specified unique id and returns it if it exists.

    Parameters

    • uniqueId: string

      The unique id of the feature set that is being searched for.

    Returns FeatureSet

    The feature set having the unique id or null if not found.

findFeatureSetCollectionByFeatureSetUniqueId

  • findFeatureSetCollectionByFeatureSetUniqueId(uniqueId: string, isOpen?: boolean): FeatureSetCollection

  • Searches the managed feature set collections for a feature set having the specified unique id and returns it if it exists.

    Parameters

    • uniqueId: string

      The unique id of the feature set that is being searched for.

    • Optional isOpen: boolean

      Whether or not to return only currently 'open' featuresets. Defaults to false.

    Returns FeatureSetCollection

    The feature set collection having the unique id or null if not found.

findFeaturesByEsriFeature

  • findFeaturesByEsriFeature(esriFeature: Graphic, featureLayer?: FeatureLayer): Feature[]

  • Searches all contained feature set collections for Geocortex feature(s) corresponding to the specified ESRI feature, and returns all existing instances.

    Parameters

    • esriFeature: Graphic

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

    • Optional featureLayer: FeatureLayer

    Returns Feature[]

    The array Geocortex features corresponding to the given ESRI feature, if they exist, or an empty array.

findOpenFeatureSetCollectionByFeatureSetUniqueId

  • Searches the open feature set collection for a feature set having the specified unique id and returns it if it exists.

    Parameters

    • uniqueId: string

      The unique id of the feature set that is being searched for.

    Returns FeatureSetCollection

    The open feature set collection having the unique id or null if not found.

getCollectionById

  • Gets the specified feature set collection.

    Parameters

    • id: string

      The ID of the FeatureSetCollection to retrieve.

    Returns FeatureSetCollection

    FeatureSetCollection, The retrieved FeatureSetCollection.

getCollectionIds

  • getCollectionIds(): string[]

  • Get all feature collection ids managed by this class.

    Returns string[]

getSearchSuggestion

  • getSearchSuggestion(sourceName: string): string

  • Gets the specified search suggestion.

    Parameters

    • sourceName: string

      The source name of the FeatureSetCollection suggestion to retrieve.

    Returns string

    string The retrieved search suggestion.

handleCollectionChanged

  • Raises an event when a feature set collection is changed in feature set manager

    Parameters

    Returns void

isCollectionOpen

  • isCollectionOpen(id: string): boolean

  • Determines whether the specified collection is open.

    Parameters

    • id: string

      The ID of the collection to open.

    Returns boolean

    Boolean True if the collection is open, False otherwise.

openCollection

  • Opens the specified collection. Opening and closing a feature set collection does not actually change the behavior of the collection. It is used internally to keep track of multiple clients concurrently accessing a collection for the purposes of raising an event when the collection is first opened and finally closed.

    Parameters

    • id: string

      The ID of the collection to open.

    Returns FeatureSetCollection

    FeatureSetCollection The opened FeatureSetCollection for the id specified, or null if the FeatureSetCollection does not exist or could not be opened.

removeCollection

  • Removes the specified collection from the feature set manager.

    Parameters

    Returns boolean

    Boolean, True if the operation was successful, false otherwise.

removeCollectionById

  • removeCollectionById(id: string): boolean

  • Removes the specified collection from the feature set manager.

    Parameters

    • id: string

      The ID of the FeatureSetCollection to remove.

    Returns boolean

    Boolean, True if the operation was successful, false otherwise.

tryCloseCollection

  • tryCloseCollection(id: string): boolean

  • Closes the specified collection if it's open. Opening and closing a feature set collection does not actually change the behavior of the collection. It is used internally to keep track of multiple clients concurrently accessing a collection for the purposes of raising an event when the collection is first opened and finally closed.

    Parameters

    • id: string

      The ID of the collection to close.

    Returns boolean

    Boolean True if the collection was successfully closed (or is already closed), False otherwise.

updateCollectionsOnFeatureDeletion

  • updateCollectionsOnFeatureDeletion(esriFeature: Graphic, discardEmptySets?: boolean): void

  • Updates all collections with feature sets containing that particular feature in the feature set manager.

    Parameters

    • esriFeature: Graphic

      The Esri feature that has been deleted.

    • Optional discardEmptySets: boolean

      Whether to discard empty feature sets. Defaults to true.

    Returns void