ScatterPlot Class TIBCO Spotfire 7.9 API Reference
Representation of a Scatter Plot.
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.VisualsScatterPlot

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

C#
[SerializableAttribute]
[ToolContextAttribute]
[PersistenceVersionAttribute(5, 0)]
public sealed class ScatterPlot : TrellisVisualization, 
	IFittingModelHost, IColorRuleVisualization, IColorAxis, IDefinesImplicitDataProperties

The ScatterPlot 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 methodCode exampleSetLabelRenderer
Sets the label renderer.
Public methodTryGetFilterRules
Try to get the filter rules for the plot.
(Inherited from Visualization.)
Top
Properties

  NameDescription
Public propertyColorAxis
Gets the axis object representing the coloring of markers in this 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 propertyDrawingOrderAxis
Gets the drawing order axis.
Public propertyFittingModels
Gets the fitting models.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyLabelColumn
Gets the label column, that is, the column to label the features in the plot by.
Public propertyLabelFont
Gets or sets the font used for the labels.
Public propertyLabelImageSize
Gets or sets the size of labels showing images.
Public propertyLabelRenderer
Gets the label renderer settings. To set the renderer used for labels, use SetLabelRenderer(TypeIdentifier).
Public propertyLabelVisibility
Gets or sets a value indicating the visibility of labels in this scatter plot.
Public propertyLegend
Gets the legend object for this plot.
(Inherited from Visualization.)
Public propertyLineConnection
Gets the line connection properties of this plot.
Public propertyMarkerByAxis
Gets the axis object which can be used to alter the expression by which the plot is marked.
Public propertyMarkerClass
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).
Public propertyMarkerLabelLayout
Gets or sets the label layout. See MarkerLabelLayout for more details.
Public propertyMarkerSize
Gets or sets the size of the markers.
Public propertyMaxNumberOfLabels
Gets or sets a value indicating max number of drawn labels.
Public propertyPieMarker
Gets the pie marker settings to use when this plot is configured to show pies.
Public propertyReferenceLines Obsolete.
Gets the reference lines settings for this plot.
Public propertyShapeAxis
Gets the axis object which can be used to alter the expression by which marker shape is chosen.
Public propertyShowDescription
Gets or sets a flag indicating whether to show the description or not.
(Inherited from Visualization.)
Public propertyShowEmptyLabels
Gets or sets a value indicating whether a label with empty content should be shown or not.
Public propertyShowStraightLineFit
Gets or sets a flag indicating if a straight line fit should be drawn. Obsolete. Add a straight line fit using FittingModels instead.
Public propertySizeAxis
Gets the axis object representing the size of markers in this plot.
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
Gets the X axis of this plot.
Public propertyXJitter
Gets or sets the amount of jittering in the x direction.
Public propertyYAxis
Gets the Y axis of this plot.
Public propertyYJitter
Gets or sets the amount of jittering in the y direction.
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
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: 7.9, 7.8, 7.7, 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference