Element Details: Chart.Heatmap
 Back


Available in: Logi Info Source code name: Chart.HeatmapIntroduced in: v10.0.366

Creates a heatmap chart. Heatmaps use size and color to visualize complex information. The work especially well when each item to be charted and compared is represented by a caption and also two numbers for size and color.

Each row from a DataLayer is shown as a cell in the heatmap. The size and color of each cell is determined by a pair of numeric columns. Cells are labeled with the Heatmap Label Data Column.

Heatmap cells may be grouped together to show how items relate to each other.

When using an Action element under a chart, use @Chart tokens instead of @Data tokens.

Element Group:Charts, Gauges and GIS Maps



ATTRIBUTES

Click attribute Name to drill down for more information.

NamePossible ValuesDescription
AltText
UserDefined
The Alternate Text is displayed when the browser options have images turned off. The text is also used by browsers that convert text to speech or braille output.
BackgroundColor
UserDefined
Sets the background color of the element. Enter a color by name, decimal RGB value, or hex RGB value. Prefix hex values with the pound sign, like #112233.
BorderBottom
UserDefined
The border is the distance between the edge of the chart's image, and the chart itself. The value is in pixels. Use a border to leave room for labels or a legend.
BorderLeft
UserDefined
The border is the distance between the edge of the chart's image, and the chart itself. The value is in pixels. Use a border to leave room for labels or a legend.
BorderRight
UserDefined
The border is the distance between the edge of the chart's image, and the chart itself. The value is in pixels. Use a border to leave room for labels or a legend.
BorderTop
UserDefined
The border is the distance between the edge of the chart's image, and the chart itself. The value is in pixels. Use a border to leave room for labels or a legend.
CellBorder
UserDefined
The width of the border in pixels.
CellBorderColor
UserDefined
Sets the color of the border lines. For charts, you may select "Transparent". Enter a color by name, decimal RGB value, or hex RGB value. Prefix hex values with the pound sign, like #112233.
ChartHeight
UserDefined
(Required) The height of the chart image, in pixels.
ChartTexture
VerticalGradient
RoundedEdge
HorizontalGradient
Flat
DiagonalGradient
The texture setting to be applied to the chart.
ChartTitle
UserDefined
The title of the chart. It appears at the top of the chart image. You can use CDML tags directly in the chart title string to specify different font colors, size etc. Expected tag format is <*font=fontname,color=hexcolorname,size=fontsize*> or simply <*color=hexcolorname*> for just changing the color of the text after the tag. e.g. <*font=Verdana,color=000000,size=12*>Text Part 1 <*color=999999*> Text Part 2 or <*color=000000*>Text Part 1<*color=999999*>Text Part 2<*color=4c4c4c*>Text Part 3.
ChartWidth
UserDefined
(Required) The width of the chart, usually in pixels. For ChartCanvas charts, the value may be a percentage, by specifying the value like "50%".
DarkBackgroundFontColor
UserDefined
Heatmap cells can have different font colors depending on the darkness of each cell, making the text easier to read. DarkBackgroundFontColor sets the color of text for cells that have a dark background. Choose a light color. Default value is White.
HeatmapColorDataColumn
UserDefined
(Required) The name of a data field/column returned from the DataLayer.
HeatmapLabelDataColumn
UserDefined
(Required) The name of a data field/column returned from the DataLayer.
HeatmapSizeDataColumn
UserDefined
(Required) The name of a data field/column returned from the DataLayer.
HighValueColor
UserDefined
The color used for the highest values of the data set. The default is green.
ID
UserDefined
The ID attribute is a pervasive attribute that uniquely identifies an element within a definition file. The ID needs to be a unique value within the definition.
LabelHorizontalAlignment
Right
Left
Center
Describes how a label is horizontally positioned within a parent's layout slot. Default value is Left.
LabelVerticalAlignment
Top
Middle
Bottom
Describes how a label is vertically positioned within a parent's layout slot. Default value is Top.
LightBackgroundFontColor
UserDefined
Heatmap cells can have different font colors depending on the darkness of each cell, making the text easier to read. LightBackgroundFontColor sets the color of text for cells that have a light background. Choose a dark color. Default value is Black.
LowValueColor
UserDefined
The color used for the lowest values of the data set. The default is red.
MediumValueColor
UserDefined
The color used for values that are in the middle of the data set. For CellColorSliders, the default is yellow. Otherwise, the default is the color between the LowValueColor and HighValueColor.
OuterBorderColor
UserDefined
Use this attribute to set the Outer Border Color of the chart canvas. Enter a color by name, decimal RGB value, or hex RGB value. Prefix hex values with the pound sign, like #112233.
RoundedBorder
UserDefined
Use this attribute to set a chart with rounded frame borders. Select a value in pixels, to set the radii of the 4 corners of the chart frame border.
ShowWaitIcon
True
False
Some charts can take significant time to run on the server and display in the browser. The wait icon shows a spinning image informing the user that chart content is coming. To not show the wait icon, set ShowWaitIcon="False". The default is "True".
Tooltip
UserDefined
Text that appears when the user hovers the pointer over the image or text.



PARENT ELEMENTS

Click element to drill down for more information.



CHILD ELEMENTS

Click element to drill down for more information.

Action.Exit
Action.Export CSV
Action.Export Native Excel
Action.Export Native Word
Action.Export PDF
Action.Export Word Or Excel
Action.Export XML
Action.Google Spreadsheet
Action.Javascript
Action.Link
Action.Map Location
Action.Process
Action.Refresh Element
Action.Report
Action.Show Element
Action.Template
Action.Widget
Auto Sizer
DataLayer.Cached
DataLayer.CSV
DataLayer.Definition List
DataLayer.Directory
DataLayer.Excel
DataLayer.Fixed Format File
DataLayer.Google App
DataLayer.Google Spreadsheet
DataLayer.JSON
DataLayer.LDAP
DataLayer.Linked
DataLayer.Mongo Find
DataLayer.Mongo Map Reduce
DataLayer.Mongo Run Command
DataLayer.Plugin
DataLayer.REST
DataLayer.SP
DataLayer.SQL
DataLayer.Static
DataLayer.Twitter
DataLayer.Web Feed
DataLayer.Web Scraper
DataLayer.Web Service
DataLayer.XML
Group Drillthrough
Heatmap Group Column
Heatmap Label
Hover Highlight
Label Font
Quicktip
Resizer
Title Font
Zero Rows Message


 Back to top


 Chart Debug