ScatterPlot Class

Spotfire 14.2 API Reference

Representation of a Scatter Plot.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsVisualContent
        Spotfire.Dxp.Application.VisualsVisualization
          Spotfire.Dxp.Application.VisualsTrellisVisualization
            Spotfire.Dxp.Application.VisualsScatterPlot

Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 64.0.19329.3263 (64.0.19329.3263)

Syntax

Copy

[SerializableAttribute]
[ToolContextAttribute]
[PersistenceVersionAttribute(5, 0)]
public sealed class ScatterPlot : TrellisVisualization

The ScatterPlot type exposes the following members.

Properties

	Name	Description
	ColorAxis	Gets the axis object representing the coloring of markers in this 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.
	DrawingOrderAxis	Gets the drawing order axis.
	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.)
	LabelColumn	Gets the label column, that is, the column to label the features in the plot by.
	LabelFont	Obsolete. Gets or sets the font used for the labels.
	LabelFontMetadata	Gets or sets the font used for the labels.
	LabelImageSize	Gets or sets the size of labels showing images.
	LabelRenderer	Gets the label renderer settings. To set the renderer used for labels, use SetLabelRenderer(TypeIdentifier).
	LabelVisibility	Gets or sets a value indicating the visibility of labels in this scatter plot.
	Legend	Gets the legend object for this plot. (Inherited from Visualization.)
	LineConnection	Gets the line connection properties of this plot.
	MarkerByAxis	Gets the axis object which can be used to alter the expression by which the plot is marked.
	MarkerClass	Gets or sets the class type of the markers in this scatter plot. Using this property the markers can be switched between simple markers, tiled markers and separate charts (for example pie charts).
	MarkerLabelLayout	Gets or sets the label layout. See MarkerLabelLayout for more details.
	MarkerSize	Gets or sets the size of the markers.
	MaxNumberOfLabels	Gets or sets a value indicating max number of drawn labels.
	PieMarker	Gets the pie marker settings to use when this plot is configured to show pies.
	RotationAxis	Gets the marker rotation axis.
	ShapeAxis	Gets the axis object which can be used to alter the expression by which marker shape is chosen.
	ShowDescription	Gets or sets a flag indicating whether to show the description or not. (Inherited from Visualization.)
	ShowEmptyLabels	Gets or sets a value indicating whether a label with empty content should be shown or not.
	ShowStraightLineFit	Gets or sets a flag indicating if a straight line fit should be drawn. Obsolete. Add a straight line fit using FittingModels instead.
	SizeAxis	Gets the axis object representing the size of markers in this plot.
	SupportsTransparency	Gets a value indicating whether transparency is supported. (Inherited from Visualization.)
	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.)
	UseSeparateColorForMarkedItems	Gets or sets a value indicating whether to use a separate color for marked items. (Inherited from Visualization.)
	Visual	Gets the visual instance, or null if this instance is not owned by a visual. (Inherited from VisualContent.)
	XAxis	Gets the X axis of this plot.
	XJitter	Gets or sets the amount of jittering in the x direction.
	YAxis	Gets the Y axis of this plot.
	YJitter	Gets or sets the amount of jittering in the y direction.

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.)
	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.)
	SetLabelRenderer	Sets the label renderer.
	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

Remarks

Scatter plots are used to plot data points on a horizontal and a vertical axis in the attempt to show how much one variable is affected by another. Each row in the data set is represented by a marker whose position depends on its values in the columns set on the X and Y axes.

The Scatter Plot supports additional variables corresponding to the color, size, and the shape of the markers to be set, thus adding more dimensions to the plot.

Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4

Reference

Spotfire.Dxp.Application.Visuals Namespace