Visual Class TIBCO Spotfire 7.6 API Reference
This class represents either a visualization or a text area.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.DocumentModelNode
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.ApplicationVisual

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

C#
[SerializableAttribute]
[PersistenceVersionAttribute(20, 0)]
public sealed class Visual : DocumentNode, 
	IExportable, IVisual, ITitledItem

The Visual type exposes the following members.

Methods

  NameDescription
Public methodApplyUserPreferences
Applies user preferences to a newly created visual.
Public methodAsT
Gets the visual as the specified type.
Public methodAutoConfigure
Configures a newly created visual with reasonable default values given the current data set.
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.
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.)
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.
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.)
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Top
Properties

  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyCustomNodes
Gets the collection of custom nodes associated with this visual.
Public propertyId
Gets the unique id for this instance.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyShowTitle
Gets or sets a flag indicating whether to show the title or not.
Public propertyTitle
Gets or sets the title.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTypeId
Gets or sets the type identifier for the visual. By setting this property, the visual is converted to the specified type.
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

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 AsT 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: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference