Action
    Preparing search index...

    Class KpiChart

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

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

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    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

    • 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

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

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

    • 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

    • 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

      2.0

    • set ActiveKpi(value: null | KpiVisualization): void

      Parameters

      Returns void

    • 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

      2.0

    • set AdditionalSpacingBetweenKpis(value: number): void

      Parameters

      • value: number

      Returns void

    • 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

      2.0

    • set BaseFontMetadata(value: FontMetadata): void

      Parameters

      Returns void

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Description(): string

      Gets or sets the plot description.

      Returns string

      2.0

    • set Description(value: string): void

      Parameters

      • value: string

      Returns void

    • get HorizontalLegend(): HorizontalLegend

      Gets the horizontal legend object for this plot.

      Returns HorizontalLegend

      2.0

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • 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

      2.0

    • set MinTilesPerRow(value: number): void

      Parameters

      • value: number

      Returns void

    • 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

      2.0

    • set MinVisibleTiles(value: number): void

      Parameters

      • value: number

      Returns void

    • 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

      2.0

    • set NewRowPerKpi(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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

      2.0

    • set PreferredRelativeTileWidth(value: number): void

      Parameters

      • value: number

      Returns void

    • get ShowDescription(): boolean

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

      Returns boolean

      2.0

    • set ShowDescription(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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

      2.0

    • set ShowTitlesForKpis(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get SupportsTransparency(): boolean

      Gets a value indicating whether transparency is supported.

      Returns boolean

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get Transparency(): number

      Gets or sets the transparency for the plot.

      Returns number

      2.0

    • set Transparency(value: number): void

      Parameters

      • value: number

      Returns void

    • get UseSeparateColorForMarkedItems(): boolean

      Gets or sets a value indicating whether to use a separate color for marked items.

      Returns boolean

      2.0

    • set UseSeparateColorForMarkedItems(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Visual(): null | Visual

      Gets the visual instance, or null if this instance is not owned by a visual.

      Returns null | Visual

      2.0

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

      Returns void

      This method is called when a visual is created by the user, but the exact configuration produced is undefined and can change between versions. This method should only be used if you want to mimic the user's action in the application, and it should only be called once. It implicity calls Spotfire.Dxp.Application.Visuals.VisualContent.ApplyUserPreferences.
      Code samples on how to create and configure a visualization are available in Spotfire Technology Network. Additional action needed for the Map Chart: in order to load the default layers (i.e. base map layer) you need to explicitly call Spotfire.Dxp.Application.Visuals.Maps.MapChart.AutoConfigureLayers.

      2.0

    • Determines whether the current plot configuration is valid.

      Returns boolean

      true if the current plot configuration is valid; otherwise, false.

      2.0

    • 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

      This will only refresh the data tables where the Spotfire.Dxp.Data.DataTable.NeedsRefresh property is true.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability