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

Copy

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

The ScatterPlot type exposes the following members.

Methods

	Name	Description
	ApplyUserPreferences	Applies user preferences to a newly created visual. (Inherited from VisualContent.)
	ApplyUserPreferencesCore	Override this method to apply 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.)
	CreateEventRelay(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.)
	CreateEventRelay(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.)
	CreatePropertyT(PropertyName, UndoableListT)	Creates an UndoableListT and assigns it to the specified field. The UndoableListT will have the specified propertyName. (Inherited from DocumentNode.)
	CreatePropertyT(PropertyName, UndoableSetT)	Creates an UndoableSetT and assigns it to the specified field. The UndoableSetT will have the specified propertyName. (Inherited from DocumentNode.)
	CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode)	Creates an UndoableCrossReferencePropertyT and assigns it to the specified field. The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue. (Inherited from DocumentNode.)
	CreatePropertyT(PropertyName, UndoablePropertyT, T)	Creates an UndoablePropertyT and assigns it to the specified field. The UndoablePropertyT will have the specified propertyName and initialValue. (Inherited from DocumentNode.)
	CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue)	Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field. The UndoableDictionaryTKey, TValue will have the specified propertyName. (Inherited from DocumentNode.)
	CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode)	Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field. The UndoableKeyedCollectionTKey, TNode will have the specified propertyName. (Inherited from DocumentNode.)
	CreateReadOnlyPropertyT	Creates a read-only property of type T and assigns it to the specified field. (Inherited from DocumentNode.)
	CreateRuntimeConstantT	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.)
	CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT)	Obsolete. Creates a RuntimePropertyT. (Inherited from DocumentNode.)
	CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT)	Creates a RuntimePropertyT. (Inherited from DocumentNode.)
	DeclareInternalEventHandlers	Override this method to declare handlers of internal events. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT)	Deserializes an UndoableCrossReferencePropertyT with value of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT)	Deserializes an UndoableListT with value of type T stored in info with key given by propertyName. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT)	Deserializes an UndoablePropertyT with value of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT)	Deserializes an UndoableSetT with value of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue)	Deserializes an UndoableDictionaryTKey, TValue stored in info with key given by propertyName. (Inherited from DocumentNode.)
	DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode)	Deserializes an UndoableKeyedCollectionTKey, TNode stored in info with key given by propertyName. (Inherited from DocumentNode.)
	DeserializeReadOnlyPropertyT	Deserializes a read-only property of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DuplicateSubtreeT	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.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetPersistedTypeName	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.)
	GetPersistedVersion	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.)
	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.)
	GetRenderTriggerCore	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.)
	GetService	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.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InternalTransaction	Starts an internal transaction on the document model by executing the specified executor delegate. (Inherited from DocumentNode.)
	IsConfigurationValid	Determines whether the current plot configuration is valid. (Inherited from Visualization.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnConfigure	Allows a node to configure itself to the surrounding document. (Inherited from DocumentNode.)
	OnConfigured	Allows a node to configure itself to the surrounding document. (Inherited from DocumentNode.)
	OnReconfigure	Allows a node to reconfigure itself to a new part of the surrounding document. (Inherited from DocumentNode.)
	OnReconfigured	Allows a node to reconfigure itself to a new part of the surrounding document. (Inherited from DocumentNode.)
	Render	Renders the visual to the specified graphics context. (Inherited from VisualContent.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)	Serializes an Undoable*Property with value of type T storing it in info with key property.Name. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)	Serializes an UndoableList with values of type T storing it in info with key list.Name. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)	Serializes an UndoableProperty with value of type T storing it in info with key property.Name. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)	Serializes an UndoableSet storing it in info with key given by the property name of the set. (Inherited from DocumentNode.)
	SerializePropertyTKey, 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.)
	SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode)	Serializes an UndoableKeyedCollectionTKey, TNode storing it in info with key given by the property name of the keyedCollection. (Inherited from DocumentNode.)
	SerializeReadOnlyPropertyT	Serializes a read-only property of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	SetLabelRenderer	Sets the label renderer.
	TryGetFilterRules	Try to get the filter rules for the plot. (Inherited from Visualization.)
	ValidateAttached	Validates that the node is attached. (Inherited from DocumentNode.)

Top

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	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.
	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	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.
	ReferenceLines	Obsolete. Gets the reference lines settings for this plot.
	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

Explicit Interface Implementations

	Name	Description
	IServiceProviderGetService	Implements IServiceProvider. (Inherited from Node.)
	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.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (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

Spotfire.Dxp.Application.Visuals Namespace

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0See Also

Reference

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also