2.2.3.48 wheatmap

1 Menu Information
2 Brief Information
3 Command Line Usage
4 X-Function Execution Options
5 Variables
6 Description
7 Related X-Functions

Menu Information

Worksheet: Conditional Formatting: Heatmap

Brief Information

Apply conditional formatting to worksheet cells using a heatmap

Command Line Usage

1. wheatmap rng:=[Book1]Sheet1!A:B name:="C1R1-C4R0";

2. wheatmap rng:=[Book1]Sheet1!A:B name:="C1R1-C2R0" trcolor.method:=0 trcolor.from:=31306751 trcolor.to:=32497615 trcolor.head:=19 trcolor.tail:=20;

3. wheatmap rng:=[Book1]Sheet1!A:B name:="C1R1-C2R0" trlevel.rescale:=0 trlevel.from:=5 trlevel.to:=30 trlevel.by:=0 trlevel.val:=3 trlevel.first:=6 trcolor.autocolor:=1 trcolor.method:=3 trcolor.name:="Soft Thermometer";

X-Function Execution Options

Please refer to this page for additional option switches when accessing the x-function from script.

Variables

Display Name	Variable Name	I/O and Type	Default Value	Description
Range	rng	Input Range	<active>	Specify range of the cells in the worksheet to apply conditional formatting. Note: if you want to applly the conditional formatting according to a set of text values, please set this column as categorical first (right click on this column and select Set as Categorical).
Name	name	Input string		Specify the name for the selected range.
Apply Coloring to Sheet	extend	Input int	0	Specify whether to color the whole sheet range by the specifed condition. If selected, the applied color will extend from the input range to the whole row. This option is only available when Range is single column.
Levels	trlevel	Input TreeNode	<unassigned>	Set the levels of the heatmap. See more details in this page.
Colors	trcolor	Input TreeNode	<unassigned>	Set the colors of the heatmap. See more details in this page.