BoxPlot Class TIBCO Spotfire 7.12 API Reference
Represents a box plot.

Box plots are used to visualize key statistical measures, such as median, mean and quartiles. The measures are shown on the Y-axis for each category defined by the X-axis.

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.VisualsBoxPlot

Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 30.0.11525.4184 (30.0.11525.4184)
Syntax
C#
Copy
[SerializableAttribute]
[PersistenceVersionAttribute(10, 0)]
[ToolContextAttribute]
public sealed class BoxPlot : TrellisVisualization, 
	IFittingModelHost, IColorRuleVisualization, IColorAxis

The BoxPlot type exposes the following members.

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 methodCode exampleRender
Renders the visual to the specified graphics context.
(Inherited from VisualContent.)
Public methodTryGetFilterRules
Try to get the filter rules for the plot.
(Inherited from Visualization.)
Top
Properties
  NameDescription
Public propertyBoxWidth
Gets or sets the width of the boxes. Allowed values are in the range [0, 100].
Public propertyColorAxis
Gets the color axis.
Public propertyComparisonCircles
Gets the comparison circles for the box plot.
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 displayed in tooltips.
Public propertyFittingModels
Gets the fitting models.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyLegend
Gets the legend object for this plot.
(Inherited from Visualization.)
Public propertyMarkerSize
Gets or sets the size of the markers.
Public propertyReferenceLines Obsolete.
Gets an object that controls the display of reference lines.
Public propertyReferencePoints
Gets the reference points.
Public propertyShow95PercentConfidenceInterval
Gets or sets a value indicating whether 95 % confidence intervals are drawn.
Public propertyShowDescription
Gets or sets a flag indicating whether to show the description or not.
(Inherited from Visualization.)
Public propertyShowDistribution
Gets or sets a value indicating whether distributions are drawn within the boxes.
Public propertySupportsTransparency
Gets a value indicating whether transparency is supported.
(Inherited from Visualization.)
Public propertyTable
Gets the table with statistical measures shown beneath the x axis.
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 propertyUseRelativeScale
Gets or sets a value indicating whether to use relative scale on the Y-axis.
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
Gets the X-axis.
Public propertyXJitter
Gets or sets the amount of jittering in the x direction.
Public propertyYAxis
Gets the Y-axis.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIServiceProviderGetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implementationPrivate methodINodeContextGetAncestorT
Implements GetAncestorT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT
Implements GetServiceT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.)
Top
Version Information

Supported in: 7.9, 7.8, 7.7, 7.6, 7.5, 7.12, 7.11, 7.10, 7.0
See Also

Reference

Spotfire.Dxp.Application.Visuals Namespace