Visual Class

Spotfire 14.4 API Reference

This class represents either a visualization or a text area.

Inheritance Hierarchy

System.Object
  Node
    Spotfire.Dxp.Framework.DocumentModel.DocumentNode
      Spotfire.Dxp.Application.Visual

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(56, 0)]
public sealed class Visual : DocumentNode, 
	IServiceProvider

The Visual type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	CustomNodes	Gets the collection of custom nodes associated with this visual.
	Id	Gets the unique id for this instance.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	ShowTitle	Gets or sets a flag indicating whether to show the title or not.
	Title	Gets or sets the title.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	TypeId	Gets or sets the type identifier for the visual. By setting this property, the visual is converted to the specified type.

Top

Methods

	Name	Description
	ApplyUserPreferences	Applies user preferences to a newly created visual.
	As<T>	Gets the visual as the specified type.
	AutoConfigure	Configures a newly created visual with reasonable default values given the current data set.
	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.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Render	Obsolete. Renders the visual to the specified graphics context.
	RenderAsync	Renders the visual asynchronously to a PNG image with the specified settings.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	GetService<TService>	Convenience generic extension method that calls GetService(Type) and casts the result. (Defined by Extensions.)

Top

Explicit Interface Implementations

	Name	Description
	INodeContext.GetAncestor<T>	Implements GetAncestor<T>(). (Inherited from DocumentNode.)
	INodeContext.GetService<T>	Implements GetService<T>(). (Inherited from DocumentNode.)
	INodeContext.IsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactions.BeginAggregatedTransaction	Implements BeginAggregatedTransaction(). (Inherited from DocumentNode.)
	ITransactions.ExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactions.ExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactions.ExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Remarks

The type is determined by the TypeId property, which typically is one of the VisualTypeIdentifiers. By setting the TypeId property, the visual is converted to the new type. Since the user can convert any visual at any time via the user interface, the TypeId must always be determined before calling As<T> () to get the specific visualization (or text area) type. Although the visualization methods and properties are sometimes declared on abstract base classes such as TablePlotBase and TrellisVisualization, always use the concrete visualization classes, such as BarChart, directly.

Version Information

Supported in: 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application Namespace