KpiChart Class

Spotfire 14.3 API Reference

Represents a visualization for one or several key performance indicators (KPIs), each represented by a KpiVisualization.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsVisualContent
        Spotfire.Dxp.Application.VisualsVisualization
          Spotfire.Dxp.Application.VisualsKpiChart

Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(62, 0)]
[ToolContextAttribute]
public sealed class KpiChart : Visualization

The KpiChart type exposes the following members.

Properties

	Name	Description
	ActiveKpi	Gets or sets the active KPI. This can be used to identify the KPI Visualization within the KPI Chart that the user last interacted with. This value can be null.
	AdditionalSpacingBetweenKpis	Gets or sets a value for the number of pixels spacing between kpis when each kpi starts on a new row. Has no effect if NewRowPerKpi is false. Default value is 24. Allowed values are 0 to 100.
	BaseFontMetadata	Gets or sets the font metadata used for the base font. The base font is the smallest font used in the kpi chart. All other font sizes are derived from this size.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Data	Gets the plot data. (Inherited from Visualization.)
	Description	Gets or sets the plot description. (Inherited from Visualization.)
	HorizontalLegend	Gets the horizontal legend object for this plot. (Inherited from Visualization.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	KpiCollection	Gets the collection of KPIs for this KPI Chart.
	Legend	Gets the legend object for this plot. (Inherited from Visualization.)
	MinTilesPerRow	Gets or sets the minimum number of tiles to show on each row. If the kpi chart cannot show that number of tiles with the given width and font settings the tiles will be scaled down (including the font size) until they do. Default value is 1. Allowed values are 1 to 100.
	MinVisibleTiles	Gets or sets the minimum number of tiles to keep completely visible in the kpi chart. If the kpi chart cannot show that number of tiles with the given width and font settings the tiles will be scaled down (including the font size) until they do. Default value is 0. Allowed values are 0 to 100.
	NewRowPerKpi	Gets or sets a value indicating whether the tiles for one kpi should be grouped and started on a new line or not. This also affects the sorting, when the kpis each starts on a new line sorting is done for each kpi separately. Default value if false.
	PreferredRelativeTileWidth	Gets or sets the preferred width of a KPI tile as a multiple of the current font size. When filling up the KpiChart with KPI tiles, no tile will be less than this size (given that the width of the KpiChart is not smaller than this size). In addition, the KPI tiles will not be larger than twice this size.
	PreferredTileWidth	Obsolete. Gets or sets the preferred width of a KPI tile in pixels, at the default font size. The actual width will scale with the font size. When filling up the KpiChart with KPI tiles, no tile will be less than this size (given that the width of the KpiChart is not smaller than this size). In addition, the KPI tiles will not be larger than twice this size.
	ShowDescription	Gets or sets a flag indicating whether to show the description or not. (Inherited from Visualization.)
	ShowTitlesForKpis	Gets or sets a value indicating whether the title is shown for each kpi when each kpi starts on a new row. Has no effect if NewRowPerKpi is false. Default value is true.
	SortMode	Gets or sets the sort mode for the individual tiles for all KPIs in the KpiChart.
	SupportsTransparency	Gets a value indicating whether transparency is supported. (Inherited from Visualization.)
	Title	Gets or sets the Visual's title. (Inherited from VisualContent.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	Transparency	Gets or sets the transparency for the plot. (Inherited from Visualization.)
	TypeId	Gets the type identifier for the visual. (Inherited from VisualContent.)
	UseSeparateColorForMarkedItems	Gets or sets a value indicating whether to use a separate color for marked items. (Inherited from Visualization.)
	Visual	Gets the visual instance, or null if this instance is not owned by a visual. (Inherited from VisualContent.)

Top

Methods

	Name	Description
	ApplyUserPreferences	Applies user preferences to a newly created visual. (Inherited from VisualContent.)
	AutoConfigure	Configures a newly created visual with reasonable default values given the current data set. (Inherited from VisualContent.)
	GetRenderTrigger	Gets a trigger signaling that the visualization has changed and needs to be re-rendered. Note that it does not trigger when highlight changes. (Inherited from VisualContent.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsConfigurationValid	Determines whether the current plot configuration is valid. (Inherited from Visualization.)
	RefreshOnDemandData	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. (Inherited from Visualization.)
	Render	Obsolete. Renders the visual to the specified graphics context. (Inherited from VisualContent.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetFilterRules	Try to get the filter rules for the plot. (Inherited from Visualization.)

Top

Explicit Interface Implementations

	Name	Description
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Remarks

The KpiChart does not have a DataTable of its own. Instead it exposes the DataTable of the KpiVisualization which is currently active. This KpiVisualization is exposed via the ActiveKpi property of this instance.

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application.Visuals Namespace