HeatMap Class

 TIBCO Spotfire 12.0 API Reference
HeatMap class.
Inheritance Hierarchy
System.Object
  Node
    Spotfire.Dxp.Framework.DocumentModel.DocumentNode
      Spotfire.Dxp.Application.Visuals.VisualContent
        Spotfire.Dxp.Application.Visuals.Visualization
          Spotfire.Dxp.Application.Visuals.TrellisVisualization
            Spotfire.Dxp.Application.Visuals.HeatMap

Namespace:  Spotfire.Dxp.Application.Visuals
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 56.0.17612.3435 (56.0.17612.3435)
Syntax
C#
Copy
[SerializableAttribute]
[ToolContextAttribute]
[PersistenceVersionAttribute(6, 0)]
public sealed class HeatMap : TrellisVisualization

The HeatMap type exposes the following members.

Properties
  NameDescription
Public propertyColorCategory
Gets or sets the category defining how color schemes can be applied. The category should be the name of one of the levels in either the row hierarchy or the column hierarchy. CategoryKey.Empty represents Column Names, presented as "(Cell Values)".
Public propertyColorings
Gets the ColoringCollection for this plot. The ColoringCollection contains Coloring objects, and has methods to apply them to parts of the plot.
Public propertyColumnDendrogram
Gets the column clustering and dendrogram.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyData
Gets the plot data.
(Inherited from Visualization.)
Public propertyDefaultFont
Gets or sets the default font for the plot.
(Inherited from TrellisVisualization.)
Public propertyDescription
Gets or sets the plot description.
(Inherited from Visualization.)
Public propertyDetails
Gets the details displayed in tooltips.
Public propertyHorizontalLegend
Gets the horizontal legend object for this plot.
(Inherited from Visualization.)
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyLegend
Gets the legend object for this plot.
(Inherited from Visualization.)
Public propertyMeasureAxis
Gets the measure axis.
Public propertyRowDendrogram
Gets the row clustering and dendrogram.
Public propertyShowDescription
Gets or sets a flag indicating whether to show the description or not.
(Inherited from Visualization.)
Public propertySortBy
Gets or sets the measure to sort by.
Public propertySortOrder
Gets or sets the sort order.
Public propertySupportsTransparency
Gets a value indicating whether transparency is supported.
(Inherited from Visualization.)
Public propertyTitle
Gets or sets the Visual's title.
(Inherited from VisualContent.)
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTransparency
Gets or sets the transparency for the plot.
(Inherited from Visualization.)
Public propertyTrellis
Gets the trellis.
(Inherited from TrellisVisualization.)
Public propertyTypeId
Gets the type identifier for the visual.
(Inherited from VisualContent.)
Public propertyUseSeparateColorForMarkedItems
Gets or sets a value indicating whether to use a separate color for marked items.
(Inherited from Visualization.)
Public propertyVisual
Gets the visual instance, or null if this instance is not owned by a visual.
(Inherited from VisualContent.)
Public propertyXAxis
Gets the X axis.
Public propertyYAxis
Gets the Y axis.
Top
Methods
  NameDescription
Public methodApplyUserPreferences
Applies user preferences to a newly created visual.
(Inherited from VisualContent.)
Public methodAutoConfigure
Configures a newly created visual with reasonable default values given the current data set.
(Inherited from VisualContent.)
Public methodGetRenderTrigger
Gets a trigger signaling that the visualization has changed and needs to be re-rendered. Note that it does not trigger when highlight changes.
(Inherited from VisualContent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsConfigurationValid
Determines whether the current plot configuration is valid.
(Inherited from Visualization.)
Public methodRefreshOnDemandData
Refreshes data in data tables that depends on other data and is not automatically updated. This includes on-demand data with manual refresh, data functions with update behavior Manual and calculations with update behavior Invalidate. Only data tables used by this visualization will be included.
(Inherited from Visualization.)
Public methodCode exampleRender Obsolete.
Renders the visual to the specified graphics context.
(Inherited from VisualContent.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetFilterRules
Try to get the filter rules for the plot.
(Inherited from Visualization.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodINodeContext.GetAncestor<T>
Implements GetAncestor<T>().
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContext.GetService<T>
Implements GetService<T>().
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContext.IsDescendantOf
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.BeginAggregatedTransaction
Implements BeginAggregatedTransaction().
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteInvisibleTransaction
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteStickyTransaction
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteTransaction
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.)
Top
Version Information

Supported in: 12.0, 11.8, 11.7, 11.6, 11.5, 11.4, 11.3, 11.2, 11.1, 11.0, 10.10, 7.11
See Also

Reference

Spotfire.Dxp.Application.Visuals Namespace