Representation of a waterfall chart.
Inheritance Hierarchy
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: 66.0.19621.1485 (66.0.19621.1485)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(24, 0)] [ToolContextAttribute] public sealed class WaterfallChart : TrellisVisualization
The WaterfallChart type exposes the following members.
Properties
Name | Description | |
---|---|---|
![]() | BarWidth | Gets or sets the width of the bars.
Allowed values are in the range [0, 100].
|
![]() | ColorAxis |
Gets the Axis by which coloring in the plot is made.
|
![]() | CompensateForMissingTimeSeriesValues |
Gets or sets a value indicating whether the visualization should inject empty values for missing time series data.
|
![]() | ConnectingLinesColor |
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.
|
![]() | Context |
Gets the context of this node.
(Inherited from DocumentNode.) |
![]() | Data | Gets the plot data.
(Inherited from Visualization.) |
![]() | DefaultFont | Obsolete.
Gets or sets the default font for the plot.
(Inherited from TrellisVisualization.) |
![]() | DefaultFontMetadata |
Gets or sets the default font for the plot.
(Inherited from TrellisVisualization.) |
![]() | Description | Gets or sets the plot description.
(Inherited from Visualization.) |
![]() | Details |
Gets the details object that controls how tooltips are displayed in this plot.
|
![]() | FittingModels |
Gets the fitting models.
|
![]() | HorizontalLegend | Gets the horizontal legend object for this plot.
(Inherited from Visualization.) |
![]() | IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) |
![]() | LabelBlocks |
Gets or sets a value indicating whether or not blocks should be
labeled.
|
![]() | LabelFont | Obsolete.
Gets or sets the font used for the labels.
|
![]() | LabelFontMetadata |
Gets or sets the font used for the labels.
|
![]() | LabelOrientation | Gets or sets label orientation of this plot.
|
![]() | LabelRunningTotals |
Gets or sets a value indicating whether running total labels should be shown or not.
|
![]() | LabelVisibility | Gets or sets a value indicating label visibility.
|
![]() | Legend | Gets the legend object for this plot.
(Inherited from Visualization.) |
![]() | MaxNumberOfLabels | Gets or sets a value indicating max number of drawn labels.
Allowed values are 0 to 200.
|
![]() | Orientation |
Gets or sets the orientation of the bars.
|
![]() | ReverseBlockOrder |
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.
|
![]() | RootLevelTotalBarName |
Gets or sets the name of the total bar for the root level.
|
![]() | ShowConnectingLines |
Gets or sets a value indicating whether to show connecting lines between blocks.
|
![]() | ShowDescription | Gets or sets a flag indicating whether to show the description or not.
(Inherited from Visualization.) |
![]() | SortBlocksByValue |
Gets or sets a value indicating whether the waterfall blocks should be ordered within each category on x when split on color.
|
![]() | SupportsTransparency |
Gets a value indicating whether transparency is supported.
(Inherited from Visualization.) |
![]() | Title | Gets or sets the Visual's title.
(Inherited from VisualContent.) |
![]() | TotalBarColor |
Gets or sets the color of the total bars.
|
![]() | TotalBarLevel |
Gets or sets the hierarchy level at which to (try) to show total bars.
|
![]() | TotalBarVisibility |
Gets or sets a value indicating whether total bars should be visible.
|
![]() | Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
![]() | Transparency | Gets or sets the transparency for the plot.
(Inherited from Visualization.) |
![]() | Trellis | Gets the trellis.
(Inherited from TrellisVisualization.) |
![]() | TypeId | Gets the type identifier for the visual.
(Inherited from VisualContent.) |
![]() | UseSeparateColorForMarkedItems |
Gets or sets a value indicating whether to use a separate color for marked items.
(Inherited from Visualization.) |
![]() | WaterfallOver |
Gets or sets the axes the waterfall is stacked over.
|
![]() | Visual | Gets the visual instance, or null if this instance is not owned by a visual.
(Inherited from VisualContent.) |
![]() | XAxis |
Gets the X-axis.
|
![]() | YAxis |
Gets the Y-axis.
|
Methods
Name | Description | |
---|---|---|
![]() | ApplyUserPreferences | Applies user preferences to a newly created visual.
(Inherited from VisualContent.) |
![]() | AutoConfigure | Configures a newly created visual with reasonable default
values given the current data set.
(Inherited from VisualContent.) |
![]() | GetRenderTrigger | 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.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IsConfigurationValid | Determines whether the current plot configuration is valid.
(Inherited from Visualization.) |
![]() | RefreshOnDemandData |
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.) |
![]() ![]() | Render | Obsolete. Renders the visual to the specified graphics context.
(Inherited from VisualContent.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | TryGetFilterRules |
Try to get the filter rules for the plot.
(Inherited from Visualization.) |
Explicit Interface Implementations
Version Information
Supported in: 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also