Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a Search Table defined by a Site.

Hierarchy

Index

Constructors

constructor

Events

onInitializationFailed

onInitializationFailed: function

Occurs when initialization of this object fails.

Type declaration

    • (error: Error): void
    • Parameters

      • error: Error

      Returns void

onInitialized

onInitialized: function

Occurs when initialization succeeds with a response from the REST endpoint. Depending on the API, this response may actually be an error message served as a correct HTTP response.

Type declaration

    • (sender: any): void
    • Parameters

      • sender: any

      Returns void

Properties

Private _initializing

_initializing: boolean

displayName

displayName: string

The display name of the SearchTable.

featureDescription

featureDescription: string

The format for a description of a feature.

featureLabel

featureLabel: string

The format for a label of a feature.

featureLongDescription

featureLongDescription: string

The format for a long description of a feature.

iconUri

iconUri: string

URI to an icon representing this search table.

id

id: string

The ID of the SearchTable.

includeInGlobalSearch

includeInGlobalSearch: boolean

Indicates if the search table should participate in Global Search.

initializationFailure

initializationFailure: Error

The exception that occurred if the object could not be initialized.

isInitialized

isInitialized: boolean

Whether or not the object was successfully initialized.

parameters

parameters: SearchTableParameter[]

The parameters of the SearchTable, as defined by an administrator.

site

site: Site

The Site that the SearchTable belongs to.

url

url: string

The URL that this resource was initialized from.

Methods

Private _configureObject

  • _configureObject(obj: any, deepInitialize?: boolean): void

Private _initializationFailedHandler

  • _initializationFailedHandler(err: Error): void

Private _initializedHandler

  • _initializedHandler(sender: any): void

Private _restErrorHandler

  • _restErrorHandler(error: Error): void

Private _restLoadHandler

  • _restLoadHandler(deepInitialize: boolean, result: any): void

doWhenInitialized

  • doWhenInitialized(callback: function): void
  • doWhenInitialized(scope: any, callback: function): void
  • Parameters

    Returns void

  • Performs a callback function when this instance has been initialized. If this instance is already initialized when this function is called, the callback function will execute immediately.

    Parameters

    • scope: any

      The scope to using when executing the callback - i.e. the value of the 'this' variable in the callback function. This parameter may be ommitted in which cased the first parameter will be used as the callback function.

    • callback: function

      The callback function to execute when this instance has been initialized.

    Returns void

initialize

  • initialize(obj?: any): void
  • Initializes the {@link geocortex.essentials.AsyncInitializable}. This is an asynchronous method, you may subscribe to the onInitialized and onInitializationFailed events for completion information.

    Parameters

    • Optional obj: any

    Returns void

isSearching

  • isSearching(): boolean
  • Gets whether the {@link geocortex.essentials.SearchTable} is currently performing a search.

    Returns boolean

    True if searchTable is currently being performed, false otherwise.

performSearch

  • performSearch(searchParameters: __type, searchComplete: function, searchError: function): void
  • The task exercises the SearchTables/Search operation seen on site for the Essentials 3.8 or greater.

    Parameters

    • searchParameters: __type

      Contains an object in which key/value represent the parameters for the search.

    • searchComplete: function

      The delegate that will be called when the operation has completed, even if an error occurs. This delegate expects one argument: an Object containing the result.

        • (results: FeatureSet): void
        • Parameters

          • results: FeatureSet

          Returns void

    • searchError: function

      The delegate that will be called if an error occurs during the operation. This delegate expects two arguments: a reference to the SearchTable instance, and an Error.

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void