WaterfallChart Class

Spotfire 14.2 API Reference
Representation of a waterfall chart.
Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsVisualContent
        Spotfire.Dxp.Application.VisualsVisualization
          Spotfire.Dxp.Application.VisualsTrellisVisualization
            Spotfire.Dxp.Application.VisualsWaterfallChart

Namespace:  Spotfire.Dxp.Application.Visuals
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(24, 0)]
[ToolContextAttribute]
public sealed class WaterfallChart : TrellisVisualization

The WaterfallChart type exposes the following members.

Properties

  NameDescription
Public propertyBarWidth
Gets or sets the width of the bars. Allowed values are in the range [0, 100].
Public propertyColorAxis
Gets the Axis by which coloring in the plot is made.
Public propertyCompensateForMissingTimeSeriesValues
Gets or sets a value indicating whether the visualization should inject empty values for missing time series data.
Public propertyConnectingLinesColor
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.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyData
Gets the plot data.
(Inherited from Visualization.)
Public propertyDefaultFont Obsolete.
Gets or sets the default font for the plot.
(Inherited from TrellisVisualization.)
Public propertyDefaultFontMetadata
Gets or sets the default font for the plot.
(Inherited from TrellisVisualization.)
Public propertyDescription
Gets or sets the plot description.
(Inherited from Visualization.)
Public propertyDetails
Gets the details object that controls how tooltips are displayed in this plot.
Public propertyFittingModels
Gets the fitting models.
Public propertyHorizontalLegend
Gets the horizontal legend object for this plot.
(Inherited from Visualization.)
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyLabelBlocks
Gets or sets a value indicating whether or not blocks should be labeled.
Public propertyLabelFont Obsolete.
Gets or sets the font used for the labels.
Public propertyLabelFontMetadata
Gets or sets the font used for the labels.
Public propertyLabelOrientation
Gets or sets label orientation of this plot.
Public propertyLabelRunningTotals
Gets or sets a value indicating whether running total labels should be shown or not.
Public propertyLabelVisibility
Gets or sets a value indicating label visibility.
Public propertyLegend
Gets the legend object for this plot.
(Inherited from Visualization.)
Public propertyMaxNumberOfLabels
Gets or sets a value indicating max number of drawn labels. Allowed values are 0 to 200.
Public propertyOrientation
Gets or sets the orientation of the bars.
Public propertyReverseBlockOrder
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.
Public propertyRootLevelTotalBarName
Gets or sets the name of the total bar for the root level.
Public propertyShowConnectingLines
Gets or sets a value indicating whether to show connecting lines between blocks.
Public propertyShowDescription
Gets or sets a flag indicating whether to show the description or not.
(Inherited from Visualization.)
Public propertySortBlocksByValue
Gets or sets a value indicating whether the waterfall blocks should be ordered within each category on x when split on color.
Public propertySupportsTransparency
Gets a value indicating whether transparency is supported.
(Inherited from Visualization.)
Public propertyTitle
Gets or sets the Visual's title.
(Inherited from VisualContent.)
Public propertyTotalBarColor
Gets or sets the color of the total bars.
Public propertyTotalBarLevel
Gets or sets the hierarchy level at which to (try) to show total bars.
Public propertyTotalBarVisibility
Gets or sets a value indicating whether total bars should be visible.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTransparency
Gets or sets the transparency for the plot.
(Inherited from Visualization.)
Public propertyTrellis
Gets the trellis.
(Inherited from TrellisVisualization.)
Public propertyTypeId
Gets the type identifier for the visual.
(Inherited from VisualContent.)
Public propertyUseSeparateColorForMarkedItems
Gets or sets a value indicating whether to use a separate color for marked items.
(Inherited from Visualization.)
Public propertyWaterfallOver
Gets or sets the axes the waterfall is stacked over.
Public propertyVisual
Gets the visual instance, or null if this instance is not owned by a visual.
(Inherited from VisualContent.)
Public propertyXAxis
Gets the X-axis.
Public propertyYAxis
Gets the Y-axis.
Top
Methods

  NameDescription
Public methodApplyUserPreferences
Applies user preferences to a newly created visual.
(Inherited from VisualContent.)
Public methodAutoConfigure
Configures a newly created visual with reasonable default values given the current data set.
(Inherited from VisualContent.)
Public methodGetRenderTrigger
Gets a trigger signaling that the visualization has changed and needs to be re-rendered. Note that it does not trigger when highlight changes.
(Inherited from VisualContent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsConfigurationValid
Determines whether the current plot configuration is valid.
(Inherited from Visualization.)
Public methodRefreshOnDemandData
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.
(Inherited from Visualization.)
Public methodCode exampleRender Obsolete.
Renders the visual to the specified graphics context.
(Inherited from VisualContent.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetFilterRules
Try to get the filter rules for the plot.
(Inherited from Visualization.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference