Class MapChart

Represents a map chart visualization.

Since

2.0

Hierarchy (View Summary)

TrellisVisualization
- MapChart

Implements

Methods

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 TrellisVisualization.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 TrellisVisualization.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from TrellisVisualization.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from TrellisVisualization.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 TrellisVisualization.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 TrellisVisualization.Equals

Default capability

AutoZoom

get AutoZoom(): boolean
Gets or sets a value indicating whether to auto-zoom.

Returns boolean
Since
2.0
set AutoZoom(value: boolean): void
Parameters
- value: boolean
Returns void

Context

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

Returns INodeContext
Since
2.0

Inherited from TrellisVisualization.Context

Data

get Data(): VisualizationData
Gets the plot data.

Returns VisualizationData
Since
2.0

Inherited from TrellisVisualization.Data

DefaultFontMetadata

get DefaultFontMetadata(): FontMetadata
Gets or sets the default font for the plot.

Returns FontMetadata
Since
2.0

Inherited from TrellisVisualization.DefaultFontMetadata
set DefaultFontMetadata(value: FontMetadata): void
Parameters
- value: FontMetadata
Returns void
Inherited from TrellisVisualization.DefaultFontMetadata

Description

get Description(): string
Gets or sets the plot description.

Returns string
Since
2.0

Inherited from TrellisVisualization.Description
set Description(value: string): void
Parameters
- value: string
Returns void
Inherited from TrellisVisualization.Description

HorizontalLegend

get HorizontalLegend(): HorizontalLegend
Gets the horizontal legend object for this plot.

Returns HorizontalLegend
Since
2.0

Inherited from TrellisVisualization.HorizontalLegend

InteractionMode

get InteractionMode(): InteractionMode
Gets or sets a the interaction mode.

Returns InteractionMode
Since
2.0
set InteractionMode(value: InteractionMode): void
Parameters
- value: InteractionMode
Returns void

InteractiveLayerReference

get InteractiveLayerReference(): null | MapChartDataLayer
Gets or sets the interactive layer, that is, the data layer that will respond to user interaction like mark and highlight.

Returns null | MapChartDataLayer
Since
2.0
set InteractiveLayerReference(value: null | MapChartDataLayer): void
Parameters
- value: null | MapChartDataLayer
Returns void

IsAttached

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

Returns boolean
Since
2.0

Inherited from TrellisVisualization.IsAttached

LayerHandlerState

get LayerHandlerState(): LayerHandlerState
Gets or sets the layer handler widget state.

Returns LayerHandlerState
Since
2.0
set LayerHandlerState(value: LayerHandlerState): void
Parameters
- value: LayerHandlerState
Returns void

Layers

get Layers(): MapChartLayerCollection
Gets the map layers in the order back to front.

Returns MapChartLayerCollection
Since
2.0

Legend

get Legend(): Spotfire.Dxp.Application.Visuals.Legend
Gets the legend object for this plot.

Returns Spotfire.Dxp.Application.Visuals.Legend
Since
2.0

Inherited from TrellisVisualization.Legend

MarkingMode

get MarkingMode(): MarkingMode
Gets or sets a the marking mode.

Returns MarkingMode
Since
2.0
set MarkingMode(value: MarkingMode): void
Parameters
- value: MarkingMode
Returns void

Projection

get Projection(): Projection
Gets or sets the display projection for the map chart, or Spotfire.Dxp.Application.Visuals.Maps.Projection.None if this map chart is showing non-geographical data.

Returns Projection
Since
2.0
set Projection(value: Projection): void
Parameters
- value: Projection
Returns void

ScaleFontMetadata

get ScaleFontMetadata(): FontMetadata
Gets or sets the font metadata used for the scale.

Returns FontMetadata
Since
2.0
set ScaleFontMetadata(value: FontMetadata): void
Parameters
- value: FontMetadata
Returns void

ShowDescription

get ShowDescription(): boolean
Gets or sets a flag indicating whether to show the description or not.

Returns boolean
Since
2.0

Inherited from TrellisVisualization.ShowDescription
set ShowDescription(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from TrellisVisualization.ShowDescription

ShowInteractionMode

get ShowInteractionMode(): boolean
Gets or sets a value indicating whether to show interaction mode control.

Returns boolean
Since
2.0
set ShowInteractionMode(value: boolean): void
Parameters
- value: boolean
Returns void

ShowLayerHandler

get ShowLayerHandler(): boolean
Gets or sets a value indicating whether to show the layer handler.

Returns boolean
Since
2.0
set ShowLayerHandler(value: boolean): void
Parameters
- value: boolean
Returns void

ShowNavigationControls

get ShowNavigationControls(): boolean
Gets or sets a value indicating whether to show the navigation controls.

Returns boolean
Since
2.0
set ShowNavigationControls(value: boolean): void
Parameters
- value: boolean
Returns void

ShowScale

get ShowScale(): boolean
Gets or sets a value indicating whether to show the scale.

Returns boolean
Since
2.0
set ShowScale(value: boolean): void
Parameters
- value: boolean
Returns void

ShowSearchField

get ShowSearchField(): boolean
Gets or sets a value indicating whether to show the search field.

Returns boolean
Since
2.0
set ShowSearchField(value: boolean): void
Parameters
- value: boolean
Returns void

SupportsTransparency

get SupportsTransparency(): boolean
Gets a value indicating whether transparency is supported.

Returns boolean
Since
2.0

Inherited from TrellisVisualization.SupportsTransparency

Title

get Title(): string
Gets or sets the Visual's title.

Returns string
Remark
Note that for Spotfire.Dxp.Application.Visuals.Maps.LayerVisualization instances, you should use the Title property of the owning Spotfire.Dxp.Application.Visuals.Maps.MapChartLayer instead.

Since
2.0

Inherited from TrellisVisualization.Title
set Title(value: string): void
Parameters
- value: string
Returns void
Inherited from TrellisVisualization.Title

Transactions

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

Returns ITransactions
Since
2.0

Inherited from TrellisVisualization.Transactions

Transform

get Transform(): MapChartTransform
Gets or sets the transform for this map chart. This is used when the x and y in the data need to be displayed with scaling.

Returns MapChartTransform
Since
2.0
set Transform(value: MapChartTransform): void
Parameters
- value: MapChartTransform
Returns void

Transparency

get Transparency(): number
Gets or sets the transparency for the plot.

Returns number
Since
2.0

Inherited from TrellisVisualization.Transparency
set Transparency(value: number): void
Parameters
- value: number
Returns void
Inherited from TrellisVisualization.Transparency

Trellis

get Trellis(): Trellis
Gets the trellis.

Returns Trellis
Since
2.0

Inherited from TrellisVisualization.Trellis

TrellisLayerReference

get TrellisLayerReference(): null | MapChartDataLayer
Gets or sets the trellis layer, that is, the data layer that will control trellising.

Returns null | MapChartDataLayer
Remark
Data layers can be configured to adapt to the trellising of the main trellis layer. To enable trellising on an additional layer set the Spotfire.Dxp.Application.Visuals.Maps.LayerVisualization.TrellisingFollowsMainLayer property of the visualization associated with the layer.

Since
2.0
set TrellisLayerReference(value: null | MapChartDataLayer): void
Parameters
- value: null | MapChartDataLayer
Returns void

TypeId

get TypeId(): TypeIdentifier
Gets the type identifier for the visual.

Returns TypeIdentifier
Since
2.0

Inherited from TrellisVisualization.TypeId

UseSeparateColorForMarkedItems

get UseSeparateColorForMarkedItems(): boolean
Gets or sets a value indicating whether to use a separate color for marked items.

Returns boolean
Since
2.0

Inherited from TrellisVisualization.UseSeparateColorForMarkedItems
set UseSeparateColorForMarkedItems(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from TrellisVisualization.UseSeparateColorForMarkedItems

ViewExtent

get ViewExtent(): GeographicExtent
Gets or sets the view extent.

Returns GeographicExtent
Since
2.0
set ViewExtent(value: GeographicExtent): void
Parameters
- value: GeographicExtent
Returns void

Visual

get Visual(): null | Visual
Gets the visual instance, or null if this instance is not owned by a visual.

Returns null | Visual
Since
2.0

Inherited from TrellisVisualization.Visual

ApplyUserPreferences

ApplyUserPreferences(): void
Applies user preferences to a newly created visual.

Returns void
Since
2.0

Inherited from TrellisVisualization.ApplyUserPreferences

AutoConfigure

AutoConfigure(): void
Configures a newly created visual with reasonable default values given the current data set.

Returns void
Remark
This method is called when a visual is created by the user, but the exact configuration produced is undefined and can change between versions. This method should only be used if you want to mimic the user's action in the application, and it should only be called once. It implicity calls Spotfire.Dxp.Application.Visuals.VisualContent.ApplyUserPreferences.
Code samples on how to create and configure a visualization are available in Spotfire Technology Network. Additional action needed for the Map Chart: in order to load the default layers (i.e. base map layer) you need to explicitly call Spotfire.Dxp.Application.Visuals.Maps.MapChart.AutoConfigureLayers.

Since
2.0

Inherited from TrellisVisualization.AutoConfigure

AutoConfigureLayers

AutoConfigureLayers(): void
Loads the default layers for a Map Chart (e.g. base Map Layer, TMS Layer or Feature Layer) and causes the main thread to hang until these default layers are loaded.

Returns void
Since
2.0

IsConfigurationValid

IsConfigurationValid(): boolean
Determines whether the current plot configuration is valid.

Returns boolean
true if the current plot configuration is valid; otherwise, false.

Since
2.0

Inherited from TrellisVisualization.IsConfigurationValid

RefreshOnDemandData

RefreshOnDemandData(): void
Refreshes data in data tables that depends on other data and is not automatically updated. This includes on-demand data with manual refresh, data functions with update behavior Manual and calculations with update behavior Invalidate. Only data tables used by this visualization will be included.

Returns void
Remark
This will only refresh the data tables where the Spotfire.Dxp.Data.DataTable.NeedsRefresh property is true.

Since
2.0

Inherited from TrellisVisualization.RefreshOnDemandData

ResetViewExtent

ResetViewExtent(): void
Sets the view extent to the union of all layers that have the property IncludeInResetViewExtent set to true.

Returns void
Since
2.0

TryGetFilterRules

TryGetFilterRules(filterRules: OutParam<FilterRuleCollection>): boolean
Try to get the filter rules for the plot.
Parameters
- filterRules: OutParam<FilterRuleCollection>
  The FilterRuleCollection or null if filter rules are not supported
Returns boolean
false if this visualization does not support filter, rules, otherwise true.

Since
2.0

Inherited from TrellisVisualization.TryGetFilterRules

Class MapChart

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

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

AutoZoom

Returns boolean

Since

Parameters

Returns void

Context

Returns INodeContext

Since

Data

Returns VisualizationData

Since

DefaultFontMetadata

Returns FontMetadata

Since

Parameters

Returns void

Description

Returns string

Since

Parameters

Returns void

HorizontalLegend

Returns HorizontalLegend

Since

InteractionMode

Returns InteractionMode

Since

Parameters

Returns void

InteractiveLayerReference

Returns null | MapChartDataLayer

Since

Parameters

Returns void

IsAttached

Returns boolean

Since

LayerHandlerState

Returns LayerHandlerState

Since

Parameters

Returns void

Layers

Returns MapChartLayerCollection

Since

Legend

Returns Spotfire.Dxp.Application.Visuals.Legend

Since

MarkingMode

Returns MarkingMode

Since

Parameters

Returns void

`Static`Equals