Common base class for all visualizations.
Inheritance Hierarchy
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: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(56, 0)] [ToolContextAttribute] public abstract class Visualization : VisualContent
The Visualization type exposes the following members.
Properties
Name | Description | |
---|---|---|
Context |
Gets the context of this node.
(Inherited from DocumentNode.) | |
Data | Gets the plot data.
| |
Description | Gets or sets the plot description.
| |
HorizontalLegend | Gets the horizontal legend object for this plot.
| |
IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) | |
Legend | Gets the legend object for this plot.
| |
ShowDescription | Gets or sets a flag indicating whether to show the description or not.
| |
SupportsTransparency |
Gets a value indicating whether transparency is supported.
| |
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.
| |
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.
| |
Visual | Gets the visual instance, or null if this instance is not owned by a visual.
(Inherited from VisualContent.) |
Methods
Name | Description | |
---|---|---|
AddAutoTitleTrigger |
Returns all triggers needed for generating autotitle. Add triggers for all properties used in GenerateAutoTitle.
| |
ApplyColumnNamesOnAxis |
Applies the column names expression on the specified axis.
| |
ApplySelectionsOnAxis |
Applies the selections expression on the specified axis.
| |
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.
(Overrides VisualContentApplyUserPreferencesCore(PreferenceManager).) | |
AutoConfigure | Configures a newly created visual with reasonable default
values given the current data set.
(Inherited from VisualContent.) | |
ChangeDataTableCore |
Performs plot-specific data table change. The default implementation
just changes the data table, with no other fixup.
| |
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 |
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) | |
DeclareInternalEventHandlers | Override this method to declare handlers of internal events.
(Overrides VisualContentDeclareInternalEventHandlers(InternalEventManager).) | |
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) | (Inherited from DocumentNode.) | |
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) | (Inherited from DocumentNode.) | |
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) | (Inherited from DocumentNode.) | |
DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) | (Inherited from DocumentNode.) | |
DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) | (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.) | |
GenerateAutoTitleCore |
Override this method to generate a title used by ${AutoTitle}. When overriden, make sure to override AddAutoTitleTrigger for all properties used.
| |
GetActiveRanges |
Gets the active ranges for all features.
| |
GetActiveRangesTrigger | Gets the active ranges' triggers.
| |
GetObjectData | Serializes this instance.
(Overrides VisualContentGetObjectData(SerializationInfo, StreamingContext).) | |
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.
(Overrides VisualContentGetService(Type).) | |
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.) | |
IsAggregationEnabled | Gets a value indicating whether aggregation is enabled.
Override to provide plot-specific behavior. The default implementation
returns true.
| |
IsConfigurationValid | Determines whether the current plot configuration is valid.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnConfigure | This method is called when first added to a page.
(Overrides VisualContentOnConfigure.) | |
OnConfigured |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) | |
OnReconfigure | This method is called when moved to a new page.
(Overrides DocumentNodeOnReconfigure.) | |
OnReconfigured |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) | |
RefreshOnDemandData |
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.
| |
Render | Obsolete. 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.) | |
SupportsChangeDataTableByCheckingAxesAndExpressionColumns |
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.
| |
SupportsTryChangeDataTable |
Checks whether the visualization supports the TryChangeDataTable mechanism at all.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TryGetFilterRules |
Try to get the filter rules for the plot.
| |
ValidateAttached | Validates that the node is attached.
(Inherited from DocumentNode.) |
Explicit Interface Implementations
Version Information
Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also