DetailItemCollection.InsertExpression Method

DetailItemCollection InsertExpression Method

TIBCO Spotfire 6.5 API Reference

Inserts a detail item based on an expression.

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

Syntax

C++

Copy to Clipboard Print

public ExpressionDetailItem InsertExpression(
	int index,
	string expression
)

public ExpressionDetailItem InsertExpression(
	int index,
	string expression
)

Parameters

index: Type: System Int32
Index to insert at.

expression: Type: System String
The expression.

Return Value

Type: ExpressionDetailItem
An ExpressionDetailItem

Exceptions

Exception	Condition
System ArgumentOutOfRangeException	The index value is less than zero or is greater than or equal to the number of items in the collection.
System ArgumentNullException	The expression value is null.

Examples

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

C++

Copy to Clipboard Print

plot.Details.Items.InsertExpression(0, "SUM([Sales]) as Total Sales");

plot.Details.Items.InsertExpression(0, "SUM([Sales]) as Total Sales");

Version Information

Supported in: 6.5, 6.0, 5.5, 5.0, 4.5