Class CombinationChart

The CombinationChart class can render series of data as bars or lines.

Since

2.0

Hierarchy (View Summary)

TrellisVisualization
- CombinationChart

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

Bars

get Bars(): CombinationChartBarProperties
Gets the properties for bar series.

Returns CombinationChartBarProperties
Since
2.0

ColorAxis

get ColorAxis(): Spotfire.Dxp.Application.Visuals.ColorAxis
Gets the axis that controls how data is split into series with assigned colors.

Returns Spotfire.Dxp.Application.Visuals.ColorAxis
Remark
This axis is always categorical.

Since
2.0

CompensateForMissingTimeSeriesValues

get CompensateForMissingTimeSeriesValues(): boolean
Gets or sets a value indicating whether the visualization should inject empty values for missing time series data.

Returns boolean
Remark
When this flag is set to true, empty values will be injected into time series data prior to aggregation.

The data is considered to be a time series if any of the expressions used on the visualization's axes use the BinByDateTime method, or any time part methods such as Year, Quarter, DayOfWeek etc.

Since
2.0
set CompensateForMissingTimeSeriesValues(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

Details

get Details(): CombinationChartDetails
Gets the details displayed in tooltips.

Returns CombinationChartDetails
Since
2.0

FittingModels

get FittingModels(): FittingModelCollection
Gets the fitting models.

Returns FittingModelCollection
Since
2.0

HorizontalLegend

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

Returns HorizontalLegend
Since
2.0

Inherited from TrellisVisualization.HorizontalLegend

IndexedSeriesType

get IndexedSeriesType(): IndexedCombinationChartSeriesType
Gets an object that can be used to control the series type of each series.

Returns IndexedCombinationChartSeriesType
Since
2.0

IsAttached

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

Returns boolean
Since
2.0

Inherited from TrellisVisualization.IsAttached

LabelFontMetadata

get LabelFontMetadata(): FontMetadata
Gets or sets the font used for the labels.

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

LabelVisibility

get LabelVisibility(): LabelVisibility
Gets or sets a value indicating label visibility.

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

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

Lines

get Lines(): CombinationChartLineProperties
Gets the properties for line series.

Returns CombinationChartLineProperties
Since
2.0

MaxNumberOfLabels

get MaxNumberOfLabels(): number
Gets or sets a value indicating max number of drawn labels. Allowed values are 0 to 200.

Returns number
Since
2.0
set MaxNumberOfLabels(value: number): void
Parameters
- value: number
Returns void

SeriesLegendItem

get SeriesLegendItem(): LegendCombinationChartSeriesItem
Gets the legend item that displays series information.

Returns LegendCombinationChartSeriesItem
Remark
This is the legend items that displays color and series information. The combination chart does not display the legend item of its color axis.

Since
2.0

SeriesType

get SeriesType(): CombinationChartSeriesType
Gets or sets the default series type. Use the to modify the series type for each series.

Returns CombinationChartSeriesType
Since
2.0
set SeriesType(value: CombinationChartSeriesType): void
Parameters
- value: CombinationChartSeriesType
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

SortBy

get SortBy(): CategoryKey
Gets or sets a Spotfire.Dxp.Application.Visuals.CategoryKey that identifies the series to sort the X axis by.

Returns CategoryKey
Remark
The default value of this property is an empty category key, which means no sorting will occur.

Since
2.0
set SortBy(value: CategoryKey): void
Parameters
- value: CategoryKey
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

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

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

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

XAxis

get XAxis(): ScaleAxis
Gets the X axis.

Returns ScaleAxis
Since
2.0

YAxis

get YAxis(): ScaleAxis
Gets the Y axis.

Returns ScaleAxis
Since
2.0

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

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

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

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 CombinationChart

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

Bars

Returns CombinationChartBarProperties

Since

ColorAxis

Returns Spotfire.Dxp.Application.Visuals.ColorAxis

Remark

Since

CompensateForMissingTimeSeriesValues

Returns boolean

Remark

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

Details

Returns CombinationChartDetails

Since

FittingModels

Returns FittingModelCollection

Since

HorizontalLegend

Returns HorizontalLegend

Since

IndexedSeriesType

Returns IndexedCombinationChartSeriesType

Since

IsAttached

Returns boolean

Since

LabelFontMetadata

Returns FontMetadata

Since

Parameters

Returns void

LabelVisibility

Returns LabelVisibility

Since

Parameters

`Static`Equals