Class GeocodingTableReference

Represents a geocoding table as a data table reference or library item reference.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context DataTableReference IsAttached Title Transactions

Extended capability 'LibraryRead'

LibraryItem

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

DataTableReference

  • get DataTableReference(): null | DataTable

  • Gets the data table reference.

    Returns null | DataTable

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

Title

  • get Title(): string

  • Gets the title for this reference, if Spotfire.Dxp.Application.Visuals.Maps.GeocodingTableReference.HasTableReference is true the data table name is used; if Spotfire.Dxp.Application.Visuals.Maps.GeocodingTableReference.HasLibraryReference is true the Spotfire.Dxp.Application.Visuals.Maps.GeocodingTableReference.LibraryTitle is used; otherwise string.Empty is returned.

    Returns string

    Since

    2.0

Transactions

  • get Transactions(): ITransactions

  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    Since

    2.0

Extended capability 'LibraryRead'

LibraryItem

  • get LibraryItem(): null | LibraryItem

  • Gets the library item for this geocoding table reference. null if the item is not found or library is not reachable.

    Returns null | LibraryItem

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability
Extended capability 'LibraryRead'