ScatterPlot Class TIBCO Spotfire 7.6 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: 25.11.10401.3615 (25.11.10401.3615)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(5, 0)]
[ToolContextAttribute]
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.)
Protected methodApplyUserPreferencesCore
Override this method to apply 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.)
Protected methodCreateEventRelay(PropertyName, StatelessDependencyDeclarer)
Creates an event relay. An event relay is a property in the document model which propagates event. An event is raised for the event relay whenever when the trigger returned by the specified dependencyDeclarer fires.
(Inherited from DocumentNode.)
Protected methodCreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode)
Creates an event relay. An event relay is a property in the document model which propagates event. An event is raised for the event relay whenever when the trigger returned by the specified dependencyDeclarer fires.
(Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected methodCreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) (Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoablePropertyT, T) (Inherited from DocumentNode.)
Protected methodCreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected methodCreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodCreateReadOnlyPropertyT
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.)
Protected methodCreateRuntimeConstantT
Creates a runtime constant. A runtime constant is a property in the document model whose value is computed once when first accessed. The value is then disposed along with the DocumentNode.
(Inherited from DocumentNode.)
Protected methodCreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) Obsolete. (Inherited from DocumentNode.)
Protected methodCreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) (Inherited from DocumentNode.)
Protected methodDeclareInternalEventHandlers
Override this method to declare handlers of internal events.
(Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected methodDeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodDeserializeReadOnlyPropertyT
Deserializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodDuplicateSubtreeT
Returns a copy of the sub tree spanned from this node that has the same outwards non-owning references. The returned copy will be in state New and is intended to be attached to the document immediately.
(Inherited from DocumentNode.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetPersistedTypeName
Can be used in the deserialization constructor to get the type name that the class corresponding to this class had when it was originally serialized. Will return null if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.)
Protected methodGetPersistedVersion
Can be used in the deserialization constructor to get the persistence version that this class was marked with when it was originally serialized. Will return null if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.)
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.)
Protected methodGetRenderTriggerCore
Override to create and return a render trigger. The render trigger is used to signal when the visualization is invalid and need to re-render. Note that it should not fire when highlight changes. The default implementation returns a NeverTrigger.
(Inherited from VisualContent.)
Protected methodGetService
Override this method to provide services accessible from this node and its descendants. If you can not provide the requested service, you should call base.GetService which relays the request to the owner or to the AnalysisApplication if no owner is set.
(Inherited from Node.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInternalTransaction
Starts an internal transaction on the document model by executing the specified executor delegate.
(Inherited from DocumentNode.)
Public methodIsConfigurationValid
Determines whether the current plot configuration is valid.
(Inherited from Visualization.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConfigure
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnConfigured
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigure
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigured
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Public methodCode exampleRender
Renders the visual to the specified graphics context.
(Inherited from VisualContent.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)
Serializes an UndoableList with values of type T storing it in info with key list.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)
Serializes an UndoableSet storing it in info with key given by the property name of the set.
(Inherited from DocumentNode.)
Protected methodSerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue)
Serializes an UndoableDictionary storing it in info with key given by the property name of the dictionary.
(Inherited from DocumentNode.)
Protected methodSerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodSerializeReadOnlyPropertyT
Serializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Public methodCode exampleSetLabelRenderer
Sets the label renderer.
Public methodTryGetFilterRules
Try to get the filter rules for the plot.
(Inherited from Visualization.)
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
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.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference