Class GeocodingTableReferenceCollection

Represents a collection of geocoding tables as data table references or library item references.

Since

2.0

Hierarchy (View Summary)

Spotfire.Dxp.Framework.DocumentModel.DocumentNode
- GeocodingTableReferenceCollection

Implements

Index

Methods

[iterator]

"[iterator]"(): Iterator<
Spotfire.Dxp.Application.Visuals.Maps.GeocodingTableReference,
>
Returns Iterator<Spotfire.Dxp.Application.Visuals.Maps.GeocodingTableReference>

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

Equals

Equals(obj: any): 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.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): T1 | null
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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1 | null
Inherited from DocumentNode.TryCast

`Static`Equals

Equals(objA: any, objB: any): 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.

Inherited from DocumentNode.Equals

Default capability

`Readonly`Item

Item: PropertyGet<
    number
    | System.Int32,
    Spotfire.Dxp.Application.Visuals.Maps.GeocodingTableReference,
>

Gets the element at the specified index.

Param: index

The zero-based index of the element to get or set.

Returns

The element at the specified index.

Since

2.0

Context

get Context(): Spotfire.Dxp.Framework.DocumentModel.INodeContext
Gets the context of this node.

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Count

get Count(): number
Gets the number of elements contained in the collection.

Returns number
Since
2.0

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Transactions

get Transactions(): Spotfire.Dxp.Framework.DocumentModel.ITransactions
Gets a collection of methods for executing transactions on the document.

Returns Spotfire.Dxp.Framework.DocumentModel.ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

Add

Add(dataTable: Spotfire.Dxp.Data.DataTable): void
Adds a data table to the collection.
Parameters
- dataTable: Spotfire.Dxp.Data.DataTable
  The data table to add to this collection.
Returns void
Since
2.0
Add(libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem): void
Adds the specified library item to this collection.
Parameters
- libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem
  The library item to add.
Returns void
Since
2.0
Add(
dataTable: Spotfire.Dxp.Data.DataTable,
libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem,
): void
Adds a data table to this collection.
Parameters
- dataTable: Spotfire.Dxp.Data.DataTable
  The data table to add to this collection.
- libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem
  The corresponding library item that the data table was loaded from.
Returns void
Since
2.0

Clear

Clear(): void
Removes all items from the collection.

Returns void
Since
2.0

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: System.Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: System.Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<
Spotfire.Dxp.Application.Visuals.Maps.GeocodingTableReference,
>
Returns an enumerator that iterates through the collection.

Returns System.Collections.Generic.IEnumerator<
Spotfire.Dxp.Application.Visuals.Maps.GeocodingTableReference,
>
A System.Collections.Generic.IEnumerator that can be used to iterate through the collection.

Since
2.0

Move

Move(fromIndex: number | System.Int32, toIndex: number | System.Int32): void
Moves the Spotfire.Dxp.Application.Visuals.Maps.GeocodingTableReference at the specified index to a new location in the collection.
Parameters
- fromIndex: number | System.Int32
  The zero-based index specifying the location of the item to be moved.
- toIndex: number | System.Int32
  The zero-based index specifying the new location of the item.
Returns void
Since
2.2

Remove

Remove(dataTable: Spotfire.Dxp.Data.DataTable): boolean
Removes the specified data table from this collection.
Parameters
- dataTable: Spotfire.Dxp.Data.DataTable
  The data table to remove from this collection.
Returns boolean
true if dataTable was successfully removed from this collection, otherwise false. This method also returns false if dataTable is not found in the original collection.

Since
2.0
Remove(libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem): boolean
Removes the specified library item from this collection.
Parameters
- libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem
  The library item to remove from the collection.
Returns boolean
true if libraryItem was successfully removed from the collection, otherwise false. This method also returns false if libraryItem is not found in the original collection.

Since
2.0

Extended capability 'LibraryRead'

Add

Add(dataTable: Spotfire.Dxp.Data.DataTable): void
Adds a data table to the collection.
Parameters
- dataTable: Spotfire.Dxp.Data.DataTable
  The data table to add to this collection.
Returns void
Since
2.0
Add(libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem): void
Adds the specified library item to this collection.
Parameters
- libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem
  The library item to add.
Returns void
Since
2.0
Add(
dataTable: Spotfire.Dxp.Data.DataTable,
libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem,
): void
Adds a data table to this collection.
Parameters
- dataTable: Spotfire.Dxp.Data.DataTable
  The data table to add to this collection.
- libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem
  The corresponding library item that the data table was loaded from.
Returns void
Since
2.0

Remove

Remove(dataTable: Spotfire.Dxp.Data.DataTable): boolean
Removes the specified data table from this collection.
Parameters
- dataTable: Spotfire.Dxp.Data.DataTable
  The data table to remove from this collection.
Returns boolean
true if dataTable was successfully removed from this collection, otherwise false. This method also returns false if dataTable is not found in the original collection.

Since
2.0
Remove(libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem): boolean
Removes the specified library item from this collection.
Parameters
- libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem
  The library item to remove from the collection.
Returns boolean
true if libraryItem was successfully removed from the collection, otherwise false. This method also returns false if libraryItem is not found in the original collection.

Since
2.0

Class GeocodingTableReferenceCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Extended capability 'LibraryRead'

Methods

[iterator]

Returns Iterator<Spotfire.Dxp.Application.Visuals.Maps.GeocodingTableReference>

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns T1 | null

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: index

Returns

Since

Context

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns Spotfire.Dxp.Framework.DocumentModel.ITransactions

Since

Add

Parameters

Returns void

Since

Parameters

Returns void

Since

Parameters

Returns void

Since

Clear

Returns void

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator< Spotfire.Dxp.Application.Visuals.Maps.GeocodingTableReference,>

Since

Move

Parameters

Returns void

Since

Remove

Parameters

Returns boolean

Since

Parameters

Returns boolean

Since

Extended capability 'LibraryRead'

Add

`Static`Equals

`Readonly`Item

Returns System.Collections.Generic.IEnumerator<
Spotfire.Dxp.Application.Visuals.Maps.GeocodingTableReference,
>