BarChart Class TIBCO Spotfire 7.6 API Reference
Representation of a bar chart. A bar chart displays data using a number of bars, each of which represents a particular category as defined by the XAxis. The height of each bar is proportional to a specific aggregation (for example to the sum of the values in the category it represents) defined on the YAxis. In addition bars can be split into further categories by means of the ColorAxis.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.DocumentModelNode
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsVisualContent
        Spotfire.Dxp.Application.VisualsVisualization
          Spotfire.Dxp.Application.VisualsTrellisVisualization
            Spotfire.Dxp.Application.VisualsBarChart

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(21, 0)]
public sealed class BarChart : TrellisVisualization, 
	IFittingModelHost, IColorRuleVisualization, IScaleAxisHost, IBarChart, IColorAxis

The BarChart type exposes the following members.

Methods

  NameDescription
Public methodApplyUserPreferences
Applies user preferences to a newly created visual.
(Inherited from VisualContent.)
Protected methodApplyUserPreferencesCore
Override this method to apply 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.)
Protected methodCreateEventRelay(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.)
Protected methodCreateEventRelay(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.)
Protected methodCreatePropertyT(PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected methodCreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) (Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoablePropertyT, T) (Inherited from DocumentNode.)
Protected methodCreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected methodCreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodCreateReadOnlyPropertyT
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.)
Protected methodCreateRuntimeConstantT
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.)
Protected methodCreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) Obsolete. (Inherited from DocumentNode.)
Protected methodCreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) (Inherited from DocumentNode.)
Protected methodDeclareInternalEventHandlers
Override this method to declare handlers of internal events.
(Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected methodDeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodDeserializeReadOnlyPropertyT
Deserializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodDuplicateSubtreeT
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.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetPersistedTypeName
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.)
Protected methodGetPersistedVersion
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.)
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.)
Protected methodGetRenderTriggerCore
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.)
Protected methodGetService
Override this method to provide services accessible from this node and its descendants. If you can not provide the requested service, you should call base.GetService which relays the request to the owner or to the AnalysisApplication if no owner is set.
(Inherited from Node.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInternalTransaction
Starts an internal transaction on the document model by executing the specified executor delegate.
(Inherited from DocumentNode.)
Public methodIsConfigurationValid
Determines whether the current plot configuration is valid.
(Inherited from Visualization.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConfigure
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnConfigured
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigure
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigured
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Public methodCode exampleRender
Renders the visual to the specified graphics context.
(Inherited from VisualContent.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)
Serializes an UndoableList with values of type T storing it in info with key list.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)
Serializes an UndoableSet storing it in info with key given by the property name of the set.
(Inherited from DocumentNode.)
Protected methodSerializePropertyTKey, 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.)
Protected methodSerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodSerializeReadOnlyPropertyT
Serializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Public methodTryGetFilterRules
Try to get the filter rules for the plot.
(Inherited from Visualization.)
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Top
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 propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyData
Gets the plot data.
(Inherited from Visualization.)
Public propertyDefaultFont
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 propertyHundredPercentBars
Gets or sets a flag indicating if all bars in this plot should be drawn with maximum size.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyLabelCompleteBar
Gets or sets a value indicating whether the complete bar shall be labeled or not.
Public propertyLabelFont
Gets or sets the font used for the labels.
Public propertyLabelOrientation
Gets or sets label orientation of this plot.
Public propertyLabelPercentageDecimalDigits
Gets or sets the number of decimal digits for percentages. Allowed values are 0 through 6.
Public propertyLabelSegments
Gets or sets a value indicating whether or not bar segments shall be labeled.
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 propertyReferenceLines Obsolete.
Gets an object that controls the display of reference lines.
Public propertyReverseSegmentOrder
Gets or sets a value indicating whether segments in stacked bars should be shown in reversed order.
Public propertySegmentLabelInformationType
Gets or sets the type of the segment label information.
Public propertyShowDescription
Gets or sets a flag indicating whether to show the description or not.
(Inherited from Visualization.)
Public propertyShowShadowBars
Gets or sets a flag indicating if shadow bars should be drawn.
Public propertySortedBars
Gets or sets a value indicating whether or not the bars in this plot are sorted.
Public propertySortSegmentsBySize
Gets or sets a value indicating whether segments in stacked bars should be ordered by size.
Public propertyStackMode
Gets or sets the stack mode.
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 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 propertyVisual
Gets the visual instance, or null if this instance is not owned by a visual.
(Inherited from VisualContent.)
Public propertyXAxis
Get the X-axis.
Public propertyYAxis
Gets the Y-axis.
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodIServiceProviderGetService
Implements IServiceProvider.
(Inherited from Node.)
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 methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Top
Version Information

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference