Class WaterfallChart

Representation of a waterfall chart.

Since

2.0

Hierarchy (view full)

Implements

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

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

BarWidth

  • get BarWidth(): number

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

    Returns number

    Since

    2.0

  • set BarWidth(value): void

  • Parameters

    • value: number

    Returns void

ColorAxis

CompensateForMissingTimeSeriesValues

  • get CompensateForMissingTimeSeriesValues(): boolean

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

    Returns boolean

    Since

    2.0

  • set CompensateForMissingTimeSeriesValues(value): void

  • Parameters

    • value: boolean

    Returns void

ConnectingLinesColor

  • 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

    Since

    2.0

  • set ConnectingLinesColor(value): void

  • Parameters

    Returns void

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Data

DefaultFontMetadata

  • get DefaultFontMetadata(): FontMetadata

  • Gets or sets the default font for the plot.

    Returns FontMetadata

    Since

    2.0

  • set DefaultFontMetadata(value): void

  • Parameters

    Returns void

Description

  • get Description(): string

  • Gets or sets the plot description.

    Returns string

    Since

    2.0

  • set Description(value): void

  • Parameters

    • value: string

    Returns void

Details

FittingModels

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

LabelBlocks

  • get LabelBlocks(): boolean

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

    Returns boolean

    Since

    2.0

  • set LabelBlocks(value): void

  • Parameters

    • value: boolean

    Returns void

LabelFontMetadata

  • get LabelFontMetadata(): FontMetadata

  • Gets or sets the font used for the labels.

    Returns FontMetadata

    Since

    2.0

  • set LabelFontMetadata(value): void

  • Parameters

    Returns void

LabelOrientation

LabelRunningTotals

  • get LabelRunningTotals(): boolean

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

    Returns boolean

    Since

    2.0

  • set LabelRunningTotals(value): void

  • Parameters

    • value: boolean

    Returns void

LabelVisibility

Legend

  • get Legend(): Legend

  • Gets the legend object for this plot.

    Returns Legend

    Since

    2.0

MaxNumberOfLabels

  • get MaxNumberOfLabels(): number

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

    Returns number

    Since

    2.0

  • set MaxNumberOfLabels(value): void

  • Parameters

    • value: number

    Returns void

Orientation

ReverseBlockOrder

  • 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

    Since

    2.0

  • set ReverseBlockOrder(value): void

  • Parameters

    • value: boolean

    Returns void

RootLevelTotalBarName

  • get RootLevelTotalBarName(): string

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

    Returns string

    Since

    2.0

  • set RootLevelTotalBarName(value): void

  • Parameters

    • value: string

    Returns void

ShowConnectingLines

  • get ShowConnectingLines(): boolean

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

    Returns boolean

    Since

    2.0

  • set ShowConnectingLines(value): void

  • Parameters

    • value: boolean

    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

SortBlocksByValue

  • 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

    Since

    2.0

  • set SortBlocksByValue(value): void

  • Parameters

    • value: boolean

    Returns void

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

TotalBarColor

  • get TotalBarColor(): ColorInfo

  • Gets or sets the color of the total bars.

    Returns ColorInfo

    Since

    2.0

  • set TotalBarColor(value): void

  • Parameters

    Returns void

TotalBarLevel

  • get TotalBarLevel(): number

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

    Returns number

    Since

    2.0

  • set TotalBarLevel(value): void

  • Parameters

    • value: number

    Returns void

TotalBarVisibility

  • get TotalBarVisibility(): boolean

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

    Returns boolean

    Since

    2.0

  • set TotalBarVisibility(value): void

  • Parameters

    • value: boolean

    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

Trellis

  • get Trellis(): Trellis

  • Gets the trellis.

    Returns Trellis

    Since

    2.0

TypeId

  • get TypeId(): TypeIdentifier

  • Gets the type identifier for the visual.

    Returns TypeIdentifier

    Since

    2.0

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

WaterfallOver

XAxis

YAxis

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