ExpressionDetailItem Class

Spotfire 15.0 API Reference

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

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsDetailItem
        Spotfire.Dxp.Application.VisualsExpressionDetailItem

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

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
	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.)
	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
	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

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

Reference

Spotfire.Dxp.Application.Visuals Namespace