KpiVisualization Class

Spotfire 14.2 API Reference
A visualization that can render key performance indicators (KPIs) within a KpiChart.
Inheritance Hierarchy

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

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

C#
[SerializableAttribute]
[PersistenceVersionAttribute(29, 0)]
public sealed class KpiVisualization : Visualization

The KpiVisualization type exposes the following members.

Properties

  NameDescription
Public propertyColorAxis
Gets the color axis.
Public propertyComparativeAxis
Gets the comparative axis.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyData
Gets the plot data.
(Inherited from Visualization.)
Public propertyDescription
Gets or sets the plot description.
(Inherited from Visualization.)
Public propertyEmptyTileColor
Gets or sets the color of tiles when there is no data.
Public propertyEmptyTileText
Gets or sets the text to display when there is no data.
Public propertyHorizontalLegend
Gets the horizontal legend object for this plot.
(Inherited from Visualization.)
Public propertyIncludeOrigin
Gets or sets a value indicating whether to include the origin in the sparkline.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyLegend
Gets the legend object for this plot.
(Inherited from Visualization.)
Public propertyShowDescription
Gets or sets a flag indicating whether to show the description or not.
(Inherited from Visualization.)
Public propertyShowSparkline
Gets or sets a value indicating whether to show the sparkline.
Public propertyShowSparklineScale
Gets or sets a value indicating whether to show the sparkline scale.
Public propertyShowXLabelInTile
Gets or sets a value indicating whether to show x labels in the KPI tiles.
Public propertySortColumn
Gets the sort column. This column is used to calculate the value to be used in the comparison between tiles when the SortMode is HighestFirst or LowestFirst.
Public propertySupportsTransparency
Gets a value indicating whether transparency is supported.
(Inherited from Visualization.)
Public propertyTileAxis
Gets the tile axis. This axis is used to split up a KPI into tiles.
Public propertyTitle
Gets or sets the Visual's title.
(Inherited from VisualContent.)
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTransparency
Gets or sets the transparency for the plot.
(Inherited from Visualization.)
Public propertyTypeId
Gets the type identifier for the visual.
(Inherited from VisualContent.)
Public propertyUseSeparateColorForMarkedItems
Gets or sets a value indicating whether to use a separate color for marked items.
(Inherited from Visualization.)
Public propertyVisual
Gets the visual instance, or null if this instance is not owned by a visual.
(Inherited from VisualContent.)
Public propertyXAxis
Gets the X axis.
Public propertyYAxis
Gets the Y axis.
Top
Methods

  NameDescription
Public methodApplyUserPreferences
Applies user preferences to a newly created visual.
(Inherited from VisualContent.)
Public methodAutoConfigure
Configures a newly created visual with reasonable default values given the current data set.
(Inherited from VisualContent.)
Public methodGetRenderTrigger
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.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsConfigurationValid
Determines whether the current plot configuration is valid.
(Inherited from Visualization.)
Public methodRefreshOnDemandData
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.)
Public methodCode exampleRender Obsolete.
Renders the visual to the specified graphics context.
(Inherited from VisualContent.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetFilterRules
Try to get the filter rules for the plot.
(Inherited from Visualization.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference