Class KpiChart

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

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

ActiveKpi AdditionalSpacingBetweenKpis BaseFontMetadata Context Data Description HorizontalLegend IsAttached KpiCollection Legend MinTilesPerRow MinVisibleTiles NewRowPerKpi PreferredRelativeTileWidth ShowDescription ShowTitlesForKpis SortMode SupportsTransparency Title Transactions Transparency TypeId UseSeparateColorForMarkedItems Visual ApplyUserPreferences AutoConfigure IsConfigurationValid RefreshOnDemandData TryGetFilterRules

Methods

Cast

  • Cast<T1, T2>(this, type): 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

    Returns T1

Equals

  • Equals(obj): 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): 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

    Returns null | T1

StaticEquals

  • Equals(objA, objB): 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.

Default capability

ActiveKpi

  • get ActiveKpi(): null | KpiVisualization

  • 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.

    Returns null | KpiVisualization

    Since

    2.0

  • set ActiveKpi(value): void

  • Parameters

    Returns void

AdditionalSpacingBetweenKpis

  • get AdditionalSpacingBetweenKpis(): number

  • 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 Spotfire.Dxp.Application.Visuals.KpiChart.NewRowPerKpi is false. Default value is 24. Allowed values are 0 to 100.

    Returns number

    Since

    2.0

  • set AdditionalSpacingBetweenKpis(value): void

  • Parameters

    • value: number

    Returns void

BaseFontMetadata

  • get BaseFontMetadata(): FontMetadata

  • 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.

    Returns FontMetadata

    Since

    2.0

  • set BaseFontMetadata(value): void

  • Parameters

    Returns void

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Data

Description

  • get Description(): string

  • Gets or sets the plot description.

    Returns string

    Since

    2.0

  • set Description(value): void

  • Parameters

    • value: string

    Returns void

HorizontalLegend

  • get HorizontalLegend(): HorizontalLegend

  • Gets the horizontal legend object for this plot.

    Returns HorizontalLegend

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

KpiCollection

Legend

  • get Legend(): Legend

  • Gets the legend object for this plot.

    Returns Legend

    Since

    2.0

MinTilesPerRow

  • get MinTilesPerRow(): number

  • 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.

    Returns number

    Since

    2.0

  • set MinTilesPerRow(value): void

  • Parameters

    • value: number

    Returns void

MinVisibleTiles

  • get MinVisibleTiles(): number

  • 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.

    Returns number

    Since

    2.0

  • set MinVisibleTiles(value): void

  • Parameters

    • value: number

    Returns void

NewRowPerKpi

  • get NewRowPerKpi(): boolean

  • 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.

    Returns boolean

    Since

    2.0

  • set NewRowPerKpi(value): void

  • Parameters

    • value: boolean

    Returns void

PreferredRelativeTileWidth

  • get PreferredRelativeTileWidth(): number

  • Gets or sets the preferred width of a KPI tile as a multiple of the current font size. When filling up the Spotfire.Dxp.Application.Visuals.KpiChart with KPI tiles, no tile will be less than this size (given that the width of the Spotfire.Dxp.Application.Visuals.KpiChart is not smaller than this size). In addition, the KPI tiles will not be larger than twice this size.

    Returns number

    Since

    2.0

  • set PreferredRelativeTileWidth(value): void

  • Parameters

    • value: number

    Returns void

ShowDescription

  • get ShowDescription(): boolean

  • Gets or sets a flag indicating whether to show the description or not.

    Returns boolean

    Since

    2.0

  • set ShowDescription(value): void

  • Parameters

    • value: boolean

    Returns void

ShowTitlesForKpis

  • get ShowTitlesForKpis(): boolean

  • 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 Spotfire.Dxp.Application.Visuals.KpiChart.NewRowPerKpi is false. Default value is true.

    Returns boolean

    Since

    2.0

  • set ShowTitlesForKpis(value): void

  • Parameters

    • value: boolean

    Returns void

SortMode

SupportsTransparency

  • get SupportsTransparency(): boolean

  • Gets a value indicating whether transparency is supported.

    Returns boolean

    Since

    2.0

Title

  • get Title(): string

  • Gets or sets the Visual's title.

    Returns string

    Since

    2.0

  • set Title(value): void

  • Parameters

    • value: string

    Returns void

Transactions

  • get Transactions(): ITransactions

  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    Since

    2.0

Transparency

  • get Transparency(): number

  • Gets or sets the transparency for the plot.

    Returns number

    Since

    2.0

  • set Transparency(value): void

  • Parameters

    • value: number

    Returns void

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

  • set UseSeparateColorForMarkedItems(value): void

  • Parameters

    • value: boolean

    Returns void

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

ApplyUserPreferences

AutoConfigure

  • AutoConfigure(): void

  • Configures a newly created visual with reasonable default values given the current data set.

    Returns void

    Since

    2.0

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

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

    Since

    2.0

TryGetFilterRules

  • TryGetFilterRules(filterRules): boolean

  • Try to get the filter rules for the plot.

    Parameters

    Returns boolean

    false if this visualization does not support filter, rules, otherwise true.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability