ExpressionDetailItem Class

Spotfire 14.2 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: 64.0.19329.3263 (64.0.19329.3263)
Syntax

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

The ExpressionDetailItem type exposes the following members.

Properties

  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyExpression
Gets or sets the expression string used to generate the output for this detail (tooltip) item.
Public propertyImageSize
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.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyValueRenderer
Gets the settings for the value renderer used for this detail item.
Public propertyVisible
Gets or sets a value indicating whether this DetailItem is visible.
(Inherited from DetailItem.)
Top
Methods

  NameDescription
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodCode exampleSetValueRenderer
Sets the renderer for the detail (tooltip) item.
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
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.
C#
plot.Details.Items.AddExpression("SUM([Sales]) as Total Sales");
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference