BoxPlot Class

Spotfire 14.7 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
  Node
    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: 69.0.21424.2902 (69.0.21424.2902)

Syntax

Copy

[SerializableAttribute]
[ToolContextAttribute]
[PersistenceVersionAttribute(69, 0)]
public sealed class BoxPlot : TrellisVisualization

The BoxPlot type exposes the following members.

Properties

	Name	Description
	BoxWidth	Gets or sets the width of the boxes. Allowed values are in the range [0, 100].
	ColorAxis	Gets the color axis.
	ComparisonCircles	Gets the comparison circles for the box plot.
	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 displayed in tooltips.
	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.)
	Layers	Gets the collection of layers.
	Legend	Gets the legend object for this plot. (Inherited from Visualization.)
	MarkerShape	Gets or sets the marker shape.
	MarkerSize	Gets or sets the size of the markers.
	Orientation	Gets or sets the orientation of the box plot.
	ReferencePoints	Gets the reference points.
	Show95PercentConfidenceInterval	Gets or sets a value indicating whether 95 % confidence intervals are drawn.
	ShowDescription	Gets or sets a flag indicating whether to show the description or not. (Inherited from Visualization.)
	ShowDistribution	Gets or sets a value indicating whether distributions are drawn within the boxes.
	SupportsTransparency	Gets a value indicating whether transparency is supported. (Inherited from Visualization.)
	Table	Gets the table with statistical measures shown beneath the x axis.
	Title	Gets or sets the Visual's title. (Inherited from VisualContent.)
	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.)
	UseRelativeScale	Gets or sets a value indicating whether to use relative scale on the Y-axis.
	UseSeparateColorForMarkedItems	Gets or sets a value indicating whether to use a separate color for marked items. (Inherited from Visualization.)
	Violin	Gets the object used to control the the display of the distribution in the shape of a violin.
	VisibleMarkers	Gets or sets a value indicating which markers that should be visible.
	Visual	Gets the visual instance, or null if this instance is not owned by a visual. (Inherited from VisualContent.)
	XAxis	Gets the X-axis.
	XJitter	Gets or sets the amount of jittering in the x direction.
	YAxis	Gets the Y-axis.

Top

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.)
	ForEachNodeInSubTreeTNode	Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node. (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.)
	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.)

Top

Explicit Interface Implementations

	Name	Description
	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.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application.Visuals Namespace