Representation of a waterfall chart.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
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: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[SerializableAttribute] [ToolContextAttribute] [PersistenceVersionAttribute(24, 0)] public sealed class WaterfallChart : TrellisVisualization, IFittingModelHost, IRewriteForOlderFileVersion, IColorRuleVisualization, IScaleAxisHost, IWaterfallChart, IBarChart, IColorAxis, IPlotHierarchyGapProvider
The WaterfallChart type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | ApplyUserPreferences | Applies user preferences to a newly created visual.
(Inherited from VisualContent.) |
 | ApplyUserPreferencesCore | Override this method to apply 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.) |
| CreateEventRelay(PropertyName, StatelessDependencyDeclarer) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
| CreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoableListT) |
Creates an UndoableListT and assigns it to the specified field.
The UndoableListT will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoableSetT) |
Creates an UndoableSetT and assigns it to the specified field.
The UndoableSetT will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) |
Creates an UndoableCrossReferencePropertyT and assigns it to the specified field.
The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoablePropertyT, T) |
Creates an UndoablePropertyT and assigns it to the specified field.
The UndoablePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
| CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) |
Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field.
The UndoableDictionaryTKey, TValue will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) |
Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field.
The UndoableKeyedCollectionTKey, TNode will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreateReadOnlyPropertyT |
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.) |
| CreateRuntimeConstantT |
Creates a runtime constant. A runtime constant is a property in the document model
whose value is computed once when first accessed. The value is then disposed
along with the DocumentNode.
(Inherited from DocumentNode.) |
| CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) | Obsolete.
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
| CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) |
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) |
Deserializes an UndoableCrossReferencePropertyT with value of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) | (Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) | (Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) | (Inherited from DocumentNode.) |
| DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) | (Inherited from DocumentNode.) |
| DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) | (Inherited from DocumentNode.) |
| DeserializeReadOnlyPropertyT |
Deserializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| DuplicateSubtreeT | Returns a copy of the sub tree spanned from this node that
has the same outwards non-owning references. The returned copy will
be in state New and is intended to be attached to the document
immediately. (Inherited from DocumentNode.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GenerateAutoTitleCore |
Override this method to generate a title used by ${AutoTitle}. When overriden, make sure to override AddAutoTitleTrigger for all properties used.
(Overrides Visualization.GenerateAutoTitleCore.) |
| GetActiveRanges |
Gets the active ranges for all features.
(Overrides Visualization.GetActiveRanges(Axis, IListRange, Boolean, IListBoolean).) |
| GetActiveRangesTrigger | Gets the active ranges' triggers.
(Overrides Visualization.GetActiveRangesTrigger(DocumentNode, IListTrigger).) |
| GetObjectData |
Gets the object data.
(Overrides TrellisVisualization.GetObjectData(SerializationInfo, StreamingContext).) |
| GetPersistedTypeName | Can be used in the deserialization constructor to get the type name that the class
corresponding to this class had when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
| GetPersistedVersion | Can be used in the deserialization constructor to get the persistence version that this class
was marked with when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
| 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.) |
| GetRenderTriggerCore | Override to create and return a render trigger.
The render trigger is used to signal when the visualization is invalid and need to re-render.
Note that it should not fire when highlight changes.
The default implementation returns a NeverTrigger.
(Inherited from VisualContent.) |
| GetService | Service provider returning IPlot2d if requested.
(Overrides TrellisVisualization.GetService(Type).) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InternalTransaction |
Starts an internal transaction on the document model by
executing the specified executor delegate.
(Inherited from DocumentNode.) |
| IsConfigurationValid | Determines whether the current plot configuration is valid.
(Inherited from Visualization.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnConfigure |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
| OnConfigured |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
| OnReconfigure |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
| OnReconfigured |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
 | Render | Renders the visual to the specified graphics context.
(Inherited from VisualContent.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT) | Serializes an Undoable*Property with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT) | Serializes an UndoableList with values of type T
storing it in info with key list.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT) | Serializes an UndoableProperty with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT) | Serializes an UndoableSet storing it in info
with key given by the property name of the set.
(Inherited from DocumentNode.) |
| SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue) | Serializes an UndoableDictionary storing it in info
with key given by the property name of the dictionary.
(Inherited from DocumentNode.) |
| SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) |
Serializes an UndoableKeyedCollectionTKey, TNode storing it in info
with key given by the property name of the keyedCollection.
(Inherited from DocumentNode.) |
| SerializeReadOnlyPropertyT |
Serializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| TryGetFilterRules |
Try to get the filter rules for the plot.
(Inherited from Visualization.) |
| ValidateAttached | Validates that the node is attached.
(Inherited from DocumentNode.) |
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 | 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.
|
| 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 | 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.
|
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
  | IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) |
| INodeContextGetAncestorT |
Implements GetAncestorT.
(Inherited from DocumentNode.) |
| INodeContextGetServiceT |
Implements GetServiceT.
(Inherited from DocumentNode.) |
| INodeContextIsDescendantOf |
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.) |
| ITransactionsBeginAggregatedTransaction |
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.) |
| ITransactionsExecuteInvisibleTransaction |
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.) |
| ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) |
| ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Version Information
See Also