KpiChart Properties

Spotfire 14.2 API Reference

The KpiChart type exposes the following members.

Properties

  NameDescription
Public propertyActiveKpi
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.
Public propertyAdditionalSpacingBetweenKpis
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.
Public propertyBaseFontMetadata
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.
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 propertyHorizontalLegend
Gets the horizontal legend object for this plot.
(Inherited from Visualization.)
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyKpiCollection
Gets the collection of KPIs for this KPI Chart.
Public propertyLegend
Gets the legend object for this plot.
(Inherited from Visualization.)
Public propertyMinTilesPerRow
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.
Public propertyMinVisibleTiles
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.
Public propertyNewRowPerKpi
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.
Public propertyPreferredRelativeTileWidth
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.
Public propertyPreferredTileWidth 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.
Public propertyShowDescription
Gets or sets a flag indicating whether to show the description or not.
(Inherited from Visualization.)
Public propertyShowTitlesForKpis
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.
Public propertySortMode
Gets or sets the sort mode for the individual tiles for all KPIs in the KpiChart.
Public propertySupportsTransparency
Gets a value indicating whether transparency is supported.
(Inherited from Visualization.)
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.)
Top
See Also

Reference