VisualizationRelations Class

Spotfire 14.3 API Reference

This class is used to set which column relation to use when there are more than one column relation in the data manager that matches an expression. The ColumnRelation must exist in the ColumnRelationCollection in the data manager in order to be set as preferred.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsVisualizationRelations

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(12, 0)]
public sealed class VisualizationRelations : DocumentNode

The VisualizationRelations type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ResetAllPreferred	Reset all preferred column relations and use the default column relations instead.
	ResetPreferred	Reset the preferred column relation and use the default column relation instead.
	SetPreferred	Sets the preferred column relation. The relation must be a reference to a column relation in the data manager.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

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

Examples

The following example shows how to use preferred column relations. The main table (CountryCapita) has two columns; Country and Capita. The second table (ExportImportAmount) has three columns; Export Country, Import Country and Amount. Add the column relations to the data manager:

Copy

var columnRelationExport = new ColumnRelation("[CountryCapita].[Country]", "[ExportImportAmount].[Export Country]");
var columnRelationImport = new ColumnRelation("[CountryCapita].[Country]", "[ExportImportAmount].[Import Country]");
dataManager.ColumnRelations.Add(columnRelationExport);
dataManager.ColumnRelations.Add(columnRelationImport);

Make a bar chart with the following expressions:

Copy

plot.XAxis.Expression = "<Country>";
plot.YAxis.Expression = "Sum([ExportImportAmount].[Amount]) / Sum([CountryCapita].[Capita]) AS [Amount per Capita]";
plot.ColorAxis.Expression = "<[Axis.Default.Names]>";

To get a plot for the amount of export per capita set columnRelationExport as the preferred.

Copy

plot.Data.Relations.SetPreferred(columnRelationExport);

To change the plot to get amount of import per capita set columnRelationImport as preferred.

Copy

plot.Data.Relations.SetPreferred(columnRelationImport);

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

Reference

Spotfire.Dxp.Application.Visuals Namespace