Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a DataLink as defined by a {@link geocortex.essentials.Layer}. A data link is a data relation between spatial attributes and tabular data from a foreign data source, such as a SQL database or a spreadsheet. DataLinks allow data from external data sources to be pulled into web mapping applications.

Hierarchy

Index

Constructors

constructor

  • Initializes a new instance of the {@link geocortex.essentials.DataLink} class.

    Parameters

    • url: string

    Returns DataLink

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.

extensions

extensions: Extension[]

The collection of {@link geocortex.essentials.Extension}s associated with the data link. Extensions can be defined by the administrator on the server.

id

id: string

The ID of the DataLink

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.

isOneToOne

isOneToOne: boolean

Indicates whether the data fetched by the datalink represents a one to one relationship with the feature.

layer

layer: Layer

The Layer that this DataLink belongs to.

parameters

parameters: DataLinkParameter[]

The parameters of the data link.

properties

properties: any

Arbitrary properties associated with this DataLink. The properties are defined by the administrator on the server.

searches

searches: DataLinkSearch[]

The collection of search tables for the data link.

site

The {@link geocortex.essentials.Site} that this resource belongs to.

url

url: string

The URL that this resource was initialized from.

visible

visible: boolean

The visibility of the DataLink.

Methods

Private _configureObject

  • _configureObject(results: 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

isDataLinking

  • isDataLinking(): boolean
  • Gets whether the {@link geocortex.essentials.DataLink} is currently performing data linking.

    Returns boolean

    True if datalinking is currently being performed, false otherwise.

performDataLinking

  • performDataLinking(featureSetParameters: any, dataLinkingComplete: function, dataLinkingError: function): void
  • Performs the data linking operation using set of feature attributes required during the operation. This is an asynchronous method; you may provide delegates for completion or error information.

    Parameters

    • featureSetParameters: any

      An esri.tasks.FeatureSet that contains the attributes defined in the parameters. The method uses only the required attributes and ignores any other attributes in the feature set.

    • dataLinkingComplete: 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: any): void
        • Parameters

          • results: any

          Returns void

    • dataLinkingError: function

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

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void