ScatterPlot3D Class

Spotfire 14.2 API Reference
Representation of a 3D 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.VisualsScatterPlot3D

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

C#
[SerializableAttribute]
[ToolContextAttribute]
[PersistenceVersionAttribute(17, 0)]
public sealed class ScatterPlot3D : TrellisVisualization

The ScatterPlot3D type exposes the following members.

Properties

  NameDescription
Public propertyCamera
Gets the camera.
Public propertyColorAxis
Gets the axis that varies the color of markers based on an expression.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyData
Gets the plot data.
(Inherited from Visualization.)
Public propertyDefaultFont Obsolete.
Gets or sets the default font for the plot.
(Inherited from TrellisVisualization.)
Public propertyDefaultFontMetadata
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 propertyHorizontalLegend
Gets the horizontal legend object for this plot.
(Inherited from Visualization.)
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyLabelColumn
Gets the label column, that is, an object whose expression controls what is displayed in the marker labels in the plot.
Public propertyLabelFont Obsolete.
Gets or sets the font used for marker labels.
Public propertyLabelFontMetadata
Gets or sets the font used for marker labels.
Public propertyLabelVisibility
Gets or sets a value controlling which subset of the markers to label.
Public propertyLegend
Gets the legend object for this plot.
(Inherited from Visualization.)
Public propertyMarkerByAxis
Gets the axis that controls aggregation of markers.
Public propertyMarkerSize
Gets or sets the size of the markers. Allowed values are 0-100.
Public propertyMaxNumberOfLabels
Gets or sets a value indicating max number of drawn marker labels. Valid range is 0 through 200.
Public propertyShapeAxis
Gets the axis that varies the shape of markers based on an expression.
Public propertyShowDescription
Gets or sets a flag indicating whether to show the description or not.
(Inherited from Visualization.)
Public propertyShowNavigationControls
Gets or sets a value indicating whether to show the 3D navigation controls not.
Public propertySizeAxis
Gets the axis that varies the size of markers based on an expression.
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.
Public propertyXJitter
Gets or sets the amount of jittering in the x direction.
Public propertyYAxis
Gets the Y axis.
Public propertyYJitter
Gets or sets the amount of jittering in the y direction.
Public propertyZAxis
Gets the Z axis.
Public propertyZJitter
Gets or sets the amount of jittering in the z direction.
Top
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 methodRefreshOnDemandData
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.)
Public methodCode exampleRender Obsolete.
Renders the visual to the specified graphics context.
(Inherited from VisualContent.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetFilterRules
Try to get the filter rules for the plot.
(Inherited from Visualization.)
Top
Explicit Interface Implementations

  NameDescription
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 methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Remarks

A 3D scatter plot is a generalization of a scatter plot that adds an extra axis. Besides having X and Y-axes, the 3D scatter plot also has a Z-axis.

The 3D 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
See Also

Reference