Visualization Class

Spotfire 14.2 API Reference
Common base class for all visualizations.
Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsVisualContent
        Spotfire.Dxp.Application.VisualsVisualization
          Spotfire.Dxp.Application.VisualsKpiChart
          Spotfire.Dxp.Application.VisualsKpiVisualization
          Spotfire.Dxp.Application.Visuals.MiniaturesMiniatureVisualization
          Spotfire.Dxp.Application.Visuals.TablesTableBase
          Spotfire.Dxp.Application.VisualsTrellisVisualization

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]
[PersistenceVersionAttribute(56, 0)]
[ToolContextAttribute]
public abstract class Visualization : VisualContent

The Visualization type exposes the following members.

Properties

  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyData
Gets the plot data.
Public propertyDescription
Gets or sets the plot description.
Public propertyHorizontalLegend
Gets the horizontal legend object for this plot.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyLegend
Gets the legend object for this plot.
Public propertyShowDescription
Gets or sets a flag indicating whether to show the description or not.
Public propertySupportsTransparency
Gets a value indicating whether transparency is supported.
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.
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.
Public propertyVisual
Gets the visual instance, or null if this instance is not owned by a visual.
(Inherited from VisualContent.)
Top
Methods

  NameDescription
Protected methodAddAutoTitleTrigger
Returns all triggers needed for generating autotitle. Add triggers for all properties used in GenerateAutoTitle.
Protected methodStatic memberApplyColumnNamesOnAxis
Applies the column names expression on the specified axis.
Protected methodStatic memberApplySelectionsOnAxis
Applies the selections expression on the specified axis.
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.
(Overrides VisualContentApplyUserPreferencesCore(PreferenceManager).)
Public methodAutoConfigure
Configures a newly created visual with reasonable default values given the current data set.
(Inherited from VisualContent.)
Protected methodChangeDataTableCore
Performs plot-specific data table change. The default implementation just changes the data table, with no other fixup.
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 (Inherited from DocumentNode.)
Protected methodDeclareInternalEventHandlers
Override this method to declare handlers of internal events.
(Overrides VisualContentDeclareInternalEventHandlers(InternalEventManager).)
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 methodGenerateAutoTitleCore
Override this method to generate a title used by ${AutoTitle}. When overriden, make sure to override AddAutoTitleTrigger for all properties used.
Protected methodGetActiveRanges
Gets the active ranges for all features.
Protected methodGetActiveRangesTrigger
Gets the active ranges' triggers.
Protected methodGetObjectData
Serializes this instance.
(Overrides VisualContentGetObjectData(SerializationInfo, StreamingContext).)
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.
(Overrides VisualContentGetService(Type).)
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 methodIsAggregationEnabled
Gets a value indicating whether aggregation is enabled. Override to provide plot-specific behavior. The default implementation returns true.
Public methodIsConfigurationValid
Determines whether the current plot configuration is valid.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConfigure
This method is called when first added to a page.
(Overrides VisualContentOnConfigure.)
Protected methodOnConfigured
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigure
This method is called when moved to a new page.
(Overrides DocumentNodeOnReconfigure.)
Protected methodOnReconfigured
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
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.
Public methodCode exampleRender Obsolete.
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.)
Protected methodSupportsChangeDataTableByCheckingAxesAndExpressionColumns
Plots that use axes and expression columns need to check those, when attempting to switch data table. Other plots (such as the table plot) has special columns instead.
Protected methodSupportsTryChangeDataTable
Checks whether the visualization supports the TryChangeDataTable mechanism at all.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetFilterRules
Try to get the filter rules for the plot.
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
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
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