Represents a visualization for one or several key performance indicators (KPIs),
each represented by a KpiVisualization.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
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: 30.0.11525.4184 (30.0.11525.4184)
Syntax
C#
[SerializableAttribute] [ToolContextAttribute] [PersistenceVersionAttribute(26, 0)] public sealed class KpiChart : Visualization, IColorRuleVisualization, IRewriteForOlderFileVersion
The KpiChart type exposes the following members.
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.) | |
Render | Renders the visual to the specified graphics context.
(Inherited from VisualContent.) | |
TryGetFilterRules |
Try to get the filter rules for the plot.
(Inherited from Visualization.) |
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.
| |
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.) | |
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.) | |
PreferredTileWidth |
Gets or sets the preferred width of a KPI tile in pixels. 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.) | |
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.) |
Explicit Interface Implementations
Name | Description | |
---|---|---|
IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) | |
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.) | |
ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) | |
ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Remarks
Version Information
See Also