ModVisualization Class

Spotfire 14.7 API Reference

Represents a ModVisualization.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsVisualContent
        Spotfire.Dxp.Application.VisualsVisualization
          Spotfire.Dxp.Application.ModsModDataViewVisualization
            Spotfire.Dxp.Application.ModsModVisualization

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(69, 0)]
[ToolContextAttribute]
public sealed class ModVisualization : ModDataViewVisualization

The ModVisualization type exposes the following members.

Properties

	Name	Description
	Axes	Gets the axes declared by this Mod Visualization, as defined in the mod-manifest.json, excluding the color axis. To access the color axis, use the ColorAxis property.
	AxesNames	Gets the names of the axes declared by this instance, including the Color axis, if declared.
	ColorAxis	Gets the color axis, or null.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Data	Gets the plot data. (Inherited from Visualization.)
	Description	Gets or sets the plot description. (Inherited from Visualization.)
	Details	Gets the details.
	HasColorAxis	Gets a value indicating whether this instance has a color axis in the mod manifest.
	HasTooltips	Gets a value indicating whether this instance has tooltips enabled. (Overrides ModDataViewVisualizationHasTooltips.)
	HorizontalLegend	Gets the horizontal legend object for this plot. (Inherited from Visualization.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Legend	Gets the legend object for this plot. (Inherited from Visualization.)
	ModIdentifier	Gets the static mod identifier, as specified in the mod manifest, or null.
	Name	Gets the view name. (Inherited from ModDataViewVisualization.)
	NamedDataViews	Gets the named data views.
	Properties	Gets the properties of this Mod Visualization, as defined in the mod-manifest.json.
	ShowDescription	Gets or sets a flag indicating whether to show the description or not. (Inherited from Visualization.)
	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.)
	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.)

Top

Methods

	Name	Description
	ApplyUserPreferences	Applies 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.)
	Axis	Gets the axis with the specified name declared by this Mod Visualization, as defined in the mod-manifest.json, excluding the color axis. To access the color axis, use the ColorAxis property.
	ForEachNodeInSubTreeTNode	Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node. (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.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsConfigurationValid	Determines whether the current plot configuration is valid. (Inherited from Visualization.)
	PropertyTValue	Gets the Mod Property with the specified name, or null if no such property of the specified type TValue exists.
	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. (Inherited from Visualization.)
	Render	Obsolete. Renders the visual to the specified graphics context. (Inherited from VisualContent.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetFilterRules	Try to get the filter rules for the plot. (Inherited from Visualization.)
	TryGetNamedDataView	Try to get a named dataview.

Top

Explicit Interface Implementations

	Name	Description
	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.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Supported in: 14.7, 14.6, 14.5

Reference

Spotfire.Dxp.Application.Mods Namespace