Action
    Preparing search index...

    Class BarChart

    Representation of a bar chart. A bar chart displays data using a number of bars, each of which represents a particular category as defined by the Spotfire.Dxp.Application.Visuals.BarChart.XAxis. The height of each bar is proportional to a specific aggregation (for example to the sum of the values in the category it represents) defined on the Spotfire.Dxp.Application.Visuals.BarChart.YAxis. In addition bars can be split into further categories by means of the Spotfire.Dxp.Application.Visuals.BarChart.ColorAxis.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    BarWidth ColorAxis CompensateForMissingTimeSeriesValues Context Data DefaultFontMetadata Description Details FittingModels HorizontalLegend HundredPercentBars IsAttached LabelCompleteBar LabelFontMetadata LabelOrientation LabelPercentageDecimalDigits LabelSegments LabelVisibility Legend MaxNumberOfLabels Orientation ReverseSegmentOrder SegmentLabelInformationType ShowDescription ShowShadowBars SortBy SortedBars SortSegmentsBySize StackMode SupportsTransparency Title Transactions Transparency Trellis TypeId UseSeparateColorForMarkedItems Visual XAxis YAxis ApplyUserPreferences AutoConfigure ForEachNodeInSubTree 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 BarWidth(): number

      Gets or sets the width of the bars. Allowed values are in the range [0, 100].

      Returns number

      This property is only used when the x axis is categorical. A value of 100 means the bar will occupy the full width of a category. A value of 0 will cause the bars will have a minimum width.

      If the x axis is continuous, this property is ignored. If binning is used on the x axis, the bars will occupy the full width of the bins. If binning is not used, bars will have a minimum width.

      2.0

    • set BarWidth(value: number): void

      Parameters

      • value: number

      Returns void

    • get CompensateForMissingTimeSeriesValues(): boolean

      Gets or sets a value indicating whether the visualization should inject empty values for missing time series data.

      Returns boolean

      When this flag is set to true, empty values will be injected into time series data prior to aggregation.

      The data is considered to be a time series if any of the expressions used on the visualization's axes use the BinByDateTime method, or any time part methods such as Year, Quarter, DayOfWeek etc.

      2.0

    • set CompensateForMissingTimeSeriesValues(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get DefaultFontMetadata(): FontMetadata

      Gets or sets the default font for the plot.

      Returns FontMetadata

      2.0

    • set DefaultFontMetadata(value: FontMetadata): void

      Parameters

      Returns void

    • 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 HundredPercentBars(): boolean

      Gets or sets a flag indicating if all bars in this plot should be drawn with maximum size.

      Returns boolean

      2.0

    • set HundredPercentBars(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get LabelCompleteBar(): boolean

      Gets or sets a value indicating whether the complete bar shall be labeled or not.

      Returns boolean

      2.0

    • set LabelCompleteBar(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get LabelPercentageDecimalDigits(): number

      Gets or sets the number of decimal digits for percentages. Allowed values are 0 through 6.

      Returns number

      2.0

    • set LabelPercentageDecimalDigits(value: number): void

      Parameters

      • value: number

      Returns void

    • get LabelSegments(): boolean

      Gets or sets a value indicating whether or not bar segments shall be labeled.

      Returns boolean

      2.0

    • set LabelSegments(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get MaxNumberOfLabels(): number

      Gets or sets a value indicating max number of drawn labels. Allowed values are 0 to 200.

      Returns number

      2.0

    • set MaxNumberOfLabels(value: number): void

      Parameters

      • value: number

      Returns void

    • get ReverseSegmentOrder(): boolean

      Gets or sets a value indicating whether segments in stacked bars should be shown in reversed order.

      Returns boolean

      2.0

    • set ReverseSegmentOrder(value: boolean): void

      Parameters

      • value: boolean

      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 ShowShadowBars(): boolean

      Gets or sets a flag indicating if shadow bars should be drawn.

      Returns boolean

      2.0

    • set ShowShadowBars(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get SortedBars(): boolean

      Gets or sets a value indicating whether the bars in this plot are sorted.

      Returns boolean

      This property applies only when the X axis is categorical. A continuous axis cannot be sorted. The sorting can be further controlled by the Spotfire.Dxp.Application.Visuals.BarChart.SortBy property.

      2.0

    • set SortedBars(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get SortSegmentsBySize(): boolean

      Gets or sets a value indicating whether segments in stacked bars should be ordered by size.

      Returns boolean

      2.0

    • set SortSegmentsBySize(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 Trellis(): Trellis

      Gets the trellis.

      Returns Trellis

      2.0

    • get TypeId(): TypeIdentifier

      Gets the type identifier for the visual.

      Returns TypeIdentifier

      2.0

    • 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