Class MapChartLayerCollection

Represents a collection of map chart layers in the order back to front. That is, the layer at index 0 is the rearmost layer.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- MapChartLayerCollection

Implements

Methods

[iterator]

"[iterator]"(): Iterator<MapChartLayer>
Returns Iterator<MapChartLayer>

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>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
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 | Int32, MapChartLayer>

Gets the layer at the specified index.

Param: index

The zero-based index of the layer to get.

Returns

The layer at the specified index.

Since

2.0

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Count

get Count(): number
Gets the number of layers contained in this instance.

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(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

AddNewFeatureLayer

AddNewFeatureLayer(
featureTable: DataTable,
featureLayerVisualization: OutParam<FeatureLayerVisualization>,
): MapChartDataLayer
Adds a new Spotfire.Dxp.Application.Visuals.Maps.MapChartDataLayer to this collection.
Parameters
- featureTable: DataTable
  The data table to be used as feature table for the layer.
- featureLayerVisualization: OutParam<FeatureLayerVisualization>
  The newly created feature layer visualization.
Returns MapChartDataLayer
The newly created layer.

Since
2.0

AddNewImageLayer

AddNewImageLayer(stream: Stream): ImageLayer
Adds a new image layer to this collection, using the specified stream.
Parameters
- stream: Stream
  The stream to use for creating the image layer.
Returns ImageLayer
The newly created image layer.

Remark
Supported file formats are: PNG, JPEG, BMP, TIFF and GIF. EMF and WMF files are supported on Windows only.

Since
2.1

AddNewMarkerLayer

AddNewMarkerLayer(
dataTable: DataTable,
markerLayerVisualization: OutParam<MarkerLayerVisualization>,
): MapChartDataLayer
Adds a new Spotfire.Dxp.Application.Visuals.Maps.MapChartDataLayer to this collection.
Parameters
- dataTable: DataTable
  The data table to be used for the layer.
- markerLayerVisualization: OutParam<MarkerLayerVisualization>
  The newly created marker layer visualization.
Returns MapChartDataLayer
The newly created layer.

Since
2.0

AddNewStandardTileLayer

AddNewStandardTileLayer(): StandardTileLayer
Adds a new standard tile layer.

Returns StandardTileLayer
The newly created standard tile layer.

Since
2.0

AddNewTmsLayer

AddNewTmsLayer(): TmsLayer
Adds a new TMS layer.

Returns TmsLayer
The newly created TMS layer.

Since
2.0

AddNewWmsLayer

AddNewWmsLayer(): WmsLayer
Adds a new WMS layer.

Returns WmsLayer
The newly created WMS layer.

Since
2.0

Clear

Clear(): void
Removes all items from this instance.

Returns void
Since
2.0

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: 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: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<MapChartLayer>
Returns an enumerator that iterates through the collection.

Returns System.Collections.Generic.IEnumerator<MapChartLayer>
A System.Collections.Generic.IEnumerator that can be used to iterate through the collection.

Since
2.0

IndexOf

IndexOf(item: MapChartLayer): number
Determines the index of a specific item.
Parameters
- item: MapChartLayer
  The object to locate.
Returns number
The index of item if found; otherwise, -1.

Since
2.0

Move

Move(fromIndex: number | Int32, toIndex: number | Int32): void
Moves the item at the specified index to a new location in the collection.
Parameters
- fromIndex: number | Int32
  The zero-based index specifying the location of the item to be moved.
- toIndex: number | Int32
  The zero-based index specifying the new location of the item.
Returns void
Since
2.0

Remove

Remove(item: MapChartLayer): boolean
Removes the first occurrence of the specified layer from this instance.
Parameters
- item: MapChartLayer
  The item to remove.
Returns boolean
true if item was removed; otherwise, false. This method also returns false if item is not found.

Since
2.0

RemoveAt

RemoveAt(index: number | Int32): void
Removes the item at the specified index.
Parameters
- index: number | Int32
  The zero-based index of the item to remove.
Returns void
Since
2.0

Class MapChartLayerCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<MapChartLayer>

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: index

Returns

Since

Context

Returns INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

AddNewFeatureLayer

Parameters

Returns MapChartDataLayer

Since

AddNewImageLayer

Parameters

Returns ImageLayer

Remark

Since

AddNewMarkerLayer

Parameters

Returns MapChartDataLayer

Since

AddNewStandardTileLayer

Returns StandardTileLayer

Since

AddNewTmsLayer

Returns TmsLayer

Since

AddNewWmsLayer

Returns WmsLayer

Since

Clear

Returns void

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator<MapChartLayer>

Since

IndexOf

Parameters

`Static`Equals

`Readonly`Item