ExpressionDetailItem Class

Spotfire 14.5 API Reference

Represents a marker detail (tooltip) based on an expression.

Inheritance Hierarchy

System.Object
  Node
    Spotfire.Dxp.Framework.DocumentModel.DocumentNode
      Spotfire.Dxp.Application.Visuals.DetailItem
        Spotfire.Dxp.Application.Visuals.ExpressionDetailItem

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(8, 0)]
public sealed class ExpressionDetailItem : DetailItem

The ExpressionDetailItem type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Expression	Gets or sets the expression string used to generate the output for this detail (tooltip) item.
	ImageSize	Gets or sets the image size of this detail item. The size is only used when the value renderer produces images. Allowed values are 1-1600 pixels.
	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.)
	ValueRenderer	Gets the settings for the value renderer used for this detail item.
	Visible	Gets or sets a value indicating whether this DetailItem is visible. (Inherited from DetailItem.)

Top

Methods

	Name	Description
	ForEachNodeInSubTree<TNode>	Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node. (Inherited from DocumentNode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SetValueRenderer	Sets the renderer for the detail (tooltip) item.

Top

Explicit Interface Implementations

	Name	Description
	INodeContext.GetAncestor<T>	Implements GetAncestor<T>(). (Inherited from DocumentNode.)
	INodeContext.GetService<T>	Implements GetService<T>(). (Inherited from DocumentNode.)
	INodeContext.IsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactions.BeginAggregatedTransaction	Implements BeginAggregatedTransaction(). (Inherited from DocumentNode.)
	ITransactions.ExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactions.ExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactions.ExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Remarks

This class is creatable only via the AddExpression(String) or the InsertExpression(Int32, String) methods.

Examples

This example shows how to add a detail that will display something like "Total Sales: 500" in the tooltip for a marker.

Copy

plot.Details.Items.AddExpression("SUM([Sales]) as Total Sales");

Version Information

Supported in: 14.5, 14.4, 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