Action
    Preparing search index...

    Class WaterfallChart

    Representation of a waterfall chart.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    BarWidth ColorAxis CompensateForMissingTimeSeriesValues ConnectingLinesColor Context Data DefaultFontMetadata Description Details FittingModels HorizontalLegend IsAttached LabelBlocks LabelFontMetadata LabelOrientation LabelRunningTotals LabelVisibility Legend MaxNumberOfLabels Orientation ReverseBlockOrder RootLevelTotalBarName ShowConnectingLines ShowDescription SortBlocksByValue SupportsTransparency Title TotalBarColor TotalBarLevel TotalBarVisibility Transactions Transparency Trellis TypeId UseSeparateColorForMarkedItems Visual WaterfallOver XAxis YAxis 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 BarWidth(): number

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

      Returns number

      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.

      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 ConnectingLinesColor(): null | ColorInfo

      Gets or sets the color of the lines that connect waterfall blocks. A value of null means the color of the connection lines is decided by the current theme.

      Returns null | ColorInfo

      2.0

    • set ConnectingLinesColor(value: null | ColorInfo): void

      Parameters

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

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get LabelBlocks(): boolean

      Gets or sets a value indicating whether or not blocks should be labeled.

      Returns boolean

      2.0

    • set LabelBlocks(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get LabelRunningTotals(): boolean

      Gets or sets a value indicating whether running total labels should be shown or not.

      Returns boolean

      2.0

    • set LabelRunningTotals(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 ReverseBlockOrder(): boolean

      Gets or sets a value indicating whether the waterfall blocks should be shown in reverse order within each category on x when split on color.

      Returns boolean

      2.0

    • set ReverseBlockOrder(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get RootLevelTotalBarName(): string

      Gets or sets the name of the total bar for the root level.

      Returns string

      2.0

    • set RootLevelTotalBarName(value: string): void

      Parameters

      • value: string

      Returns void

    • get ShowConnectingLines(): boolean

      Gets or sets a value indicating whether to show connecting lines between blocks.

      Returns boolean

      2.0

    • set ShowConnectingLines(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 SortBlocksByValue(): boolean

      Gets or sets a value indicating whether the waterfall blocks should be ordered within each category on x when split on color.

      Returns boolean

      2.0

    • set SortBlocksByValue(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get SupportsTransparency(): boolean

      Gets a value indicating whether transparency is supported.

      Returns boolean

      2.0

    • get TotalBarLevel(): number

      Gets or sets the hierarchy level at which to (try) to show total bars.

      Returns number

      Level zero corresponds to just one total bar (i.e. no subtotals). If set to a higher level than presently exists in the x hierarchy just one total bar will be shown. Hierarchies with slider are counted as fully expanded with respect to the number of hierarchy levels they give rise to in this sense. When set to the highest level of a hierarchy with a slider, changing level with the slider with result in (sub)total bars at the level at which the slider indicates.

      2.0

    • set TotalBarLevel(value: number): void

      Parameters

      • value: number

      Returns void

    • get TotalBarVisibility(): boolean

      Gets or sets a value indicating whether total bars should be visible.

      Returns boolean

      2.0

    • set TotalBarVisibility(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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