HeatmapChart 属性

热图的外观和行为

HeatmapChart 属性控制 HeatmapChart 对象的外观和行为。通过更改属性值，您可以修改热图的某些方面。例如，您可以添加标题：

h = heatmap([1 3 5; 2 4 6]);
h.Title = 'My Heatmap Title';

标签

Title — 图标题

字符向量 | 字符向量元胞数组 | 字符串数组 | 分类数组

图标题，指定为字符向量、字符向量元胞数组、字符串数组或分类数组。

示例: h = heatmap(rand(10,10),'Title','My Title Text')

示例: h.Title = 'My Title Text';

要创建一个多行标题，请指定字符向量元胞数组或字符串数组。数组中的每个元素对应一行文本。

示例: h.Title = {'My','Title'};

如果将标题指定为分类数组，MATLAB^® 将使用数组中的值，而不是类别。

如果使用表格数据创建图，默认图具有自动生成的标题。如果您不需要标题，请指定 ''。

默认情况下，热图支持对您指定的文本使用某些 TeX 标记。使用 TeX 标记可添加下标和上标，修改字体类型和颜色，并在文本中包括特殊字符。如果要在常规文本中使用 TeX 标记字符，如下划线 (_)，请在要包含的字符前插入反斜杠 (\)。反斜杠是 TeX 转义字符。有关详细信息，请参阅文本对象的Interpreter属性。

XLabel — x 轴的标签

字符向量 | 字符向量元胞数组 | 字符串数组 | 分类数组

x 轴的标签，指定为字符向量、字符向量元胞数组、字符串数组或分类数组。

示例: h = heatmap(rand(10,10),'XLabel','My Label')

示例: h.XLabel = 'My Label';

要创建一个多行标签，请指定字符向量元胞数组或字符串数组。数组中的每个元素对应一行文本。

示例: h.XLabel = {'My','Label'};

如果将标签指定为分类数组，MATLAB 将使用数组中的值，而不是类别。

如果使用表格数据创建图，默认图具有自动生成的标签。如果您不需要标签，请指定 ''。

默认情况下，热图支持对您指定的文本使用某些 TeX 标记。使用 TeX 标记可添加下标和上标，修改字体类型和颜色，并在文本中包括特殊字符。如果要在常规文本中使用 TeX 标记字符，如下划线 (_)，请在要包含的字符前插入反斜杠 (\)。反斜杠是 TeX 转义字符。有关详细信息，请参阅文本对象的Interpreter属性。

YLabel — y 轴的标签

字符向量 | 字符向量元胞数组 | 字符串数组 | 分类数组

y 轴的标签，指定为字符向量、字符向量元胞数组、字符串数组或分类数组。

示例: h = heatmap(rand(10,10),'YLabel','My Label')

示例: h.YLabel = 'My Label';

要创建一个多行标签，请指定字符向量元胞数组或字符串数组。数组中的每个元素对应一行文本。

示例: h.YLabel = {'My','Label'};

如果将标签指定为分类数组，MATLAB 将使用数组中的值，而不是类别。

如果使用表格数据创建图，默认图具有自动生成的标签。如果您不需要标签，请指定 ''。

默认情况下，热图支持对您指定的文本使用某些 TeX 标记。使用 TeX 标记可添加下标和上标，修改字体类型和颜色，并在文本中包括特殊字符。如果要在常规文本中使用 TeX 标记字符，如下划线 (_)，请在要包含的字符前插入反斜杠 (\)。反斜杠是 TeX 转义字符。有关详细信息，请参阅文本对象的Interpreter属性。

MissingDataLabel — 缺失数据图标的标签

'NaN' (默认) | 字符向量

缺失数据图标的标签，显示在颜色栏下面，指定为字符向量。如果您不希望显示标签，请使用空字符向量 ''。

默认情况下，热图支持对您指定的文本使用某些 TeX 标记。使用 TeX 标记可添加下标和上标，修改字体类型和颜色，并在文本中包括特殊字符。如果要在常规文本中使用 TeX 标记字符，如下划线 (_)，请在要包含的字符前插入反斜杠 (\)。反斜杠是 TeX 转义字符。有关详细信息，请参阅文本对象的Interpreter属性。

示例: h = heatmap(__,'MissingDataLabel','No data')

示例: h.MissingDataLabel = 'No data'

Interpreter — 文本解释器

'tex' (默认) | 'latex' | 'none'

自 R2023b 起

文本解释器，指定为下列值之一：

• 'tex' - 使用 TeX 标记子集解释字符。

• 'latex' - 使用 LaTeX 标记解释字符。

• 'none' - 显示字面字符。

heatmap 函数在显示图标题、轴标签或任何包含文本或符号的数据时使用解释器。

TeX 标记

默认情况下，MATLAB 支持一部分 TeX 标记。使用 TeX 标记可添加下标和上标，修改字体类型和颜色，并在文本中包括特殊字符。

修饰符会一直作用到文本结尾，但上标和下标除外，因为它们仅修饰下一个字符或花括号中的字符。当您将解释器设置为 'tex' 时，支持的修饰符如下所示。

修饰符	描述	示例
^{ }	上标	'text^{superscript}'
_{ }	下标	'text_{subscript}'
\bf	粗体	'\bf text'
\it	斜体	'\it text'
\sl	伪斜体（通常与斜体相同）	'\sl text'
\rm	常规字体	'\rm text'
\fontname{specifier}	字体名称 - 将 specifier 替换为字体系列的名称。您可以将此说明符与其他修饰符结合使用。	'\fontname{Courier} text'
\fontsize{specifier}	字体大小 - 将 specifier 替换为以磅为单位的数值标量值。	'\fontsize{15} text'
\color{specifier}	字体颜色 - 将 specifier 替换为以下颜色之一：red、green、yellow、magenta、blue、black、white、gray、darkGreen、orange 或 lightBlue。	'\color{magenta} text'
\color[rgb]{specifier}	自定义字体颜色 - 将 specifier 替换为三元素 RGB 三元组。	'\color[rgb]{0,0.5,0.5} text'

下表列出了 'tex' 解释器所支持的特殊字符。

字符序列	符号	字符序列	符号	字符序列	符号
\alpha	α	\upsilon	υ	\sim	~
\angle	∠	\phi	ϕ	\leq	≤
\ast	*	\chi	χ	\infty	∞
\beta	β	\psi	ψ	\clubsuit	♣
\gamma	γ	\omega	ω	\diamondsuit	♦
\delta	δ	\Gamma	Γ	\heartsuit	♥
\epsilon	ϵ	\Delta	Δ	\spadesuit	♠
\zeta	ζ	\Theta	Θ	\leftrightarrow	↔
\eta	η	\Lambda	Λ	\leftarrow	←
\theta	θ	\Xi	Ξ	\Leftarrow	⇐
\vartheta	ϑ	\Pi	Π	\uparrow	↑
\iota	ι	\Sigma	Σ	\rightarrow	→
\kappa	κ	\Upsilon	ϒ	\Rightarrow	⇒
\lambda	λ	\Phi	Φ	\downarrow	↓
\mu	µ	\Psi	Ψ	\circ	º
\nu	ν	\Omega	Ω	\pm	±
\xi	ξ	\forall	∀	\geq	≥
\pi	π	\exists	∃	\propto	∝
\rho	ρ	\ni	∍	\partial	∂
\sigma	σ	\cong	≅	\bullet	•
\varsigma	ς	\approx	≈	\div	÷
\tau	τ	\Re	ℜ	\neq	≠
\equiv	≡	\oplus	⊕	\aleph	ℵ
\Im	ℑ	\cup	∪	\wp	℘
\otimes	⊗	\subseteq	⊆	\oslash	∅
\cap	∩	\in	∈	\supseteq	⊇
\supset	⊃	\lceil	⌈	\subset	⊂
\int	∫	\cdot	·	\o	ο
\rfloor	⌋	\neg	¬	\nabla	∇
\lfloor	⌊	\times	x	\ldots	...
\perp	⊥	\surd	√	\prime	´
\wedge	∧	\varpi	ϖ	\0	∅
\rceil	⌉	\rangle	〉	\mid	|
\vee	∨	\langle	〈	\copyright	©

LaTeX 标记

要使用 LaTeX 标记，请将解释器设置为 'latex'。对于行内模式，用单美元符号 ($) 将标记括起来。对于显示模式，用双美元符号 ($$) 将标记括起来。

LaTeX 模式	示例	结果
行内	'$\int_1^{20} x^2 dx$'
显示	'$$\int_1^{20} x^2 dx$$'

显示的文本将使用默认的 LaTeX 字体样式。要更改字体样式，请使用 LaTeX 标记。

用于 LaTeX 解释器的文本最多可以包含 1200 个字符。对于多行文本，请在此数量的基础上每行减少约 10 个字符。

有关使用 TeX 和 LaTeX 的示例，请参阅图文本中的希腊字母和特殊字符。有关 LaTeX 系统的详细信息，请访问 LaTeX Project 网站：https://www.latex-project.org/。

颜色和样式

Colormap — 用于为热图单元格着色的颜色图

预定义的颜色图名称 | 由 RGB 三元组组成的 m×3 数组

用于为热图单元格着色的颜色图，指定为预定义的颜色图名称或定义 m 种不同颜色的 m×3 RGB（红、绿、蓝）三元组数组。您可以指定一种预定义的颜色图，也可以创建一种自定义的颜色图。

• 预定义的颜色图 - 以命令形式指定颜色图名称，例如 parula 或 summer。如需完整的选项列表，请参阅 colormap。

• 自定义颜色图 - 指定一个 m×3 RGB 三元组数组。

示例: h = heatmap(__,'Colormap',summer)

示例: h.Colormap = parula

ColorMethod — 用来计算颜色数据的方法

'count' | 'mean' | 'median' | 'sum' | 'max' | 'min' | 'none'

用来计算颜色数据值（存储在 ColorData 中）的方法，指定为 'count'、'mean'、'median'、'sum'、'max'、'min' 或 'none'。

如果您不想使用颜色数据表中的第三个变量，则将方法指定为 'count'。当方法为 'count' 时，热图不使用 ColorVariable 属性，而是计算每对 x 和 y 值出现在源表中的次数。当您使用表格数据而没有指定 ColorVariable 参数时，此值为默认值。

如果您要使用颜色数据表中的第三个变量，请将 ColorVariable 属性设置为要使用的变量，并将 ColorMethod 属性指定为下表中列出的方法之一。对于每对 x 和 y 值，这些方法使用源表的 ColorVariable 列中的对应值来计算数据。

方法	描述
'mean'	计算平均值。如果指定 ColorVariable 属性，则此值为默认值。
'median'	计算中位数值。
'sum'	计算各值的总和。
'max'	使用最大值。
'min'	使用最小值。
'none'	使用该值本身。每对 x 和 y 值在该表中的实例数不能超过一个。使用矩阵数据时，此值为默认值。

如果您要计算自己的合计数据矩阵，请使用 accumarray 函数。指定矩阵作为 heatmap 函数的输入。

示例: h = heatmap(__,'ColorMethod','median')

示例: h.ColorMethod = 'median'

ColorScaling — 颜色数据与颜色图颜色之间的映射

'scaled' (默认) | 'scaledcolumns' | 'scaledrows' | 'log'

颜色数据与颜色图颜色之间的映射，指定为下列值之一：

• 'scaled' - 将 ColorData 属性中小于或等于最小颜色范围的值映射到颜色图中的第一种颜色。将大于或等于最大颜色范围的值映射到最后一种颜色。ColorLimits 属性包含颜色范围值。

• 'scaledcolumns' - 将 ColorData 属性中的每一列归一化为介于 0 和 1 之间的值。将最小值映射到颜色图中的第一种颜色，将最大值映射到最后一种颜色。如果某一列中所有值都相同，则热图使用颜色图的中间颜色。

• 'scaledrows' - 将 ColorData 属性中的每一行归一化为介于 0 和 1 之间的值。将最小值映射到颜色图中的第一种颜色，将最大值映射到最后一种颜色。如果某一行中所有值都相同，则热图使用颜色图的中间颜色。

• 'log' - 在将 ColorData 属性中的值映射到颜色图中的颜色之前，计算每个值的对数。负值显示为缺失数据。但是，如果所有值都为负，则此选项使用 -log(-value)。

确定颜色映射时，热图将忽略 NaN、Inf 和 -Inf 值。

当 ColorScaling 设置为 'scaledcolumns' 或 'scaledrows' 时，颜色栏上的默认刻度标签的范围为从 0 到 1。热图中行或列中的最小值映射到颜色栏上的 0。行或列中的最大值映射到颜色栏上的 1。

示例: h = heatmap(__,'ColorScaling','scaledcolumns')

示例: h.ColorScaling = 'scaledcolumns'

ColorLimits — 颜色范围

二元素向量

颜色范围，指定为 [min max] 形式的二元素向量。颜色范围指示映射到颜色图中第一种和最后一种颜色的颜色数据值。

注意

min 和 max 的默认值反映应用 ColorScaling 选项后的数据范围。

示例: h = heatmap(__,'ColorLimits',[0 10])

示例: h.ColorLimits = [0 10]

MissingDataColor — 无数据值的单元格的颜色

[0.1500 0.1500 0.1500] (默认) | RGB 三元组 | 十六进制颜色代码 | 'r' | 'g' | 'b' | ...

无数据值的单元格的颜色，指定为 RGB 三元组、十六进制颜色代码、颜色名称或短名称。

RGB 三元组和十六进制颜色代码对于指定自定义颜色非常有用。

• RGB 三元组是包含三个元素的行向量，其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内，例如 [0.4 0.6 0.7]。

• 十六进制颜色代码是字符向量或字符串标量，以井号 (#) 开头，后跟三个或六个十六进制数字，范围可以是 0 到 F。这些值不区分大小写。因此，颜色代码 "#FF8800" 与 "#ff8800"、"#F80" 与 "#f80" 是等效的。

此外，还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称	短名称	RGB 三元组	十六进制颜色代码	外观
"red"	"r"	[1 0 0]	"#FF0000"
"green"	"g"	[0 1 0]	"#00FF00"
"blue"	"b"	[0 0 1]	"#0000FF"
"cyan"	"c"	[0 1 1]	"#00FFFF"
"magenta"	"m"	[1 0 1]	"#FF00FF"
"yellow"	"y"	[1 1 0]	"#FFFF00"
"black"	"k"	[0 0 0]	"#000000"
"white"	"w"	[1 1 1]	"#FFFFFF"

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

RGB 三元组	十六进制颜色代码	外观
[0 0.4470 0.7410]	"#0072BD"
[0.8500 0.3250 0.0980]	"#D95319"
[0.9290 0.6940 0.1250]	"#EDB120"
[0.4940 0.1840 0.5560]	"#7E2F8E"
[0.4660 0.6740 0.1880]	"#77AC30"
[0.3010 0.7450 0.9330]	"#4DBEEE"
[0.6350 0.0780 0.1840]	"#A2142F"

示例: h = heatmap(__,'MissingDataColor',[0.8 0.8 0.8])

示例: h.MissingDataColor = [0.8 0.8 0.8]

ColorbarVisible — 显示颜色栏

'on' (默认) | on/off 逻辑值

显示颜色栏，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，'off' 等效于 false。因此，您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

示例: h = heatmap(__,'ColorbarVisible','off')

示例: h.ColorbarVisible = 'off'

GridVisible — 显示网格线

'on' (默认) | on/off 逻辑值

显示网格线，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，'off' 等效于 false。因此，您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

示例: h = heatmap(__,'GridVisible','off')

示例: h.GridVisible = 'off'

CellLabelColor — 数据标签的文本颜色

'auto' (默认) | RGB 三元组 | 十六进制颜色代码 | 'r' | 'g' | 'b' | ...

数据标签的文本颜色，指定为 'auto'、RGB 三元组、十六进制颜色代码、颜色名称或短名称。默认值 'auto' 将根据每个热图单元格的颜色选择一种合适的文本颜色。如果不希望显示标签，请指定 'none'。

RGB 三元组和十六进制颜色代码对于指定自定义颜色非常有用。

• RGB 三元组是包含三个元素的行向量，其元素分别指定颜色中红、绿、蓝分量的强度。强度值必须位于 [0,1] 范围内，例如 [0.4 0.6 0.7]。

• 十六进制颜色代码是字符向量或字符串标量，以井号 (#) 开头，后跟三个或六个十六进制数字，范围可以是 0 到 F。这些值不区分大小写。因此，颜色代码 "#FF8800" 与 "#ff8800"、"#F80" 与 "#f80" 是等效的。

此外，还可以按名称指定一些常见的颜色。下表列出了命名颜色选项、等效 RGB 三元组和十六进制颜色代码。

颜色名称	短名称	RGB 三元组	十六进制颜色代码	外观
"red"	"r"	[1 0 0]	"#FF0000"
"green"	"g"	[0 1 0]	"#00FF00"
"blue"	"b"	[0 0 1]	"#0000FF"
"cyan"	"c"	[0 1 1]	"#00FFFF"
"magenta"	"m"	[1 0 1]	"#FF00FF"
"yellow"	"y"	[1 1 0]	"#FFFF00"
"black"	"k"	[0 0 0]	"#000000"
"white"	"w"	[1 1 1]	"#FFFFFF"

以下是 MATLAB 在许多类型的绘图中使用的默认颜色的 RGB 三元组和十六进制颜色代码。

RGB 三元组	十六进制颜色代码	外观
[0 0.4470 0.7410]	"#0072BD"
[0.8500 0.3250 0.0980]	"#D95319"
[0.9290 0.6940 0.1250]	"#EDB120"
[0.4940 0.1840 0.5560]	"#7E2F8E"
[0.4660 0.6740 0.1880]	"#77AC30"
[0.3010 0.7450 0.9330]	"#4DBEEE"
[0.6350 0.0780 0.1840]	"#A2142F"

示例: h = heatmap(__,'CellLabelColor','blue')

示例: h.CellLabelColor = 'blue'

CellLabelFormat — 数据标签的格式

'%0.4g' (默认) | 格式选项字符向量

数据标签的格式，指定为格式选项字符向量。

该字符向量的大多数元素都是可选的，但百分号和转换字符除外。按以下顺序构造字符向量：

• 一个或多个标志 - 选项。例如，在正值之前添加一个加号。要查看完整的选项列表，请参阅可选标志表。

• 字段宽度 - 刻度标签上要打印的最小字符数。请将字段宽度指定为整数值。如果刻度值中的有效位数小于字段宽度，则在标签上用空格填充。

• 精度 - 小数点右侧的位数或有效位数，具体取决于转换字符。将精度指定为一个整数值。

• 转换字符 - 值的类型。要查看完整的选项列表，请参阅转换字符表。如果指定的转换字符不适合数据，MATLAB 将覆盖指定的转换字符并使用 %e。

您还可以在格式的开头或末尾指定字面文本。要打印单引号，请使用 ''。要打印百分比字符，请使用 %%。

示例：h.CellLabelFormat = '%.2f' 使用带两个小数位的定点记数法显示值。

示例：h.CellLabelFormat ='$%.2f' 在每个值前面显示美元符号。

示例：h.CellLabelFormat = '%.2f lbs' 在每个值后面显示 lbs。

可选标志

标识符	描述	数值格式示例
+	为正值打印符号字符 (+)，例如 '+100'。	'%+4.4g'
0	用前导零而不是空格填充字段宽度，例如 '0100'。	'%04.4g'
–	左对齐，在值的末尾而不是开头用空格填充。例如，如果字段宽度为 4，则此标志将标签格式化为 '100 '，而不是 ' 100'。	'%-4.4g'
#	对于 %f、%e 和 %g 转换字符，即使精度为 0，也会打印小数点，例如 '100.'。对于 %g，不会删除尾随零。	'%#4.4g'

转换字符

标识符	描述	示例
d 或 i	底数为 10 的有符号整数。精度值指示有效位数。	'%.4d' 将 π 显示为 0003。
f	定点记数法。精度值指示小数位数。	'%.4f' 将 π 显示为 3.1416。
e	指数记数法。精度值指示小数位数。	'%.4e' 将 π 显示为 3.1416x100。
g	更精简版本的 e 或 f，不带尾随零。精度值指示最大小数位数。	'%.4g' 将 π 显示为 3.1416。

FontColor — 标题、轴标签和刻度标签的文本颜色

[0.1500 0.1500 0.1500] (默认) | 颜色名称 | RGB 三元组

标题、轴标签和刻度标签的文本颜色，指定为颜色名称或 RGB 三元组。

示例: h = heatmap(__,'FontColor','blue')

示例: h.FontColor = 'blue'

字体

FontName — 字体名称

系统支持的字体名称

字体名称，指定为系统支持的字体名称。默认字体取决于具体操作系统和区域设置。

示例: h = heatmap(__,'FontName','Cambria')

示例: h.FontName = 'Cambria'

FontSize — 字体大小

数值标量

标题、轴标签和单元格标签的字体大小，指定为标量值。默认字体取决于具体操作系统和区域设置。

标题和轴标签使用稍大的字体大小（放大 10%）。如果没有足够的空间显示每个单元格中的文本，文本可能会使用较小的字体大小或者根本不显示。

示例: h = heatmap(__,'FontSize',12)

示例: h.FontSize = 12

表数据

SourceTable — 源表

表 | 时间表

源表，以表或时间表的形式指定。

您可以使用 table 函数根据工作区变量创建表，也可以使用 readtable 函数以表的形式导入数据。您可以使用 timetable 函数根据工作区变量创建时间表。

注意

使用矩阵数据时，此属性将被忽略并且为只读。

XVariable — x 轴的表变量

字符向量 | 字符串 | 数值标量 | 逻辑向量

x 轴的表变量，指定为下列形式之一：

• 指示变量名称之一的字符向量或字符串。

• 指示表变量索引的数值标量。

• 包含一个 true 元素的逻辑向量。

与表变量关联的值必须组合为 categorical 函数能够接受的有限离散类别集合。如果这些值没有组合为有限类别集合，请使用 discretize 函数将它们组合在一起。

如果设置 XVariable 属性值，XData 和 XDisplayData 属性将自动更新为合适的值。

x 轴上显示的标签按字母顺序排列。您可以使用 XDisplayData、yDisplayData 或分类数组来自定义标签。有关示例，请参阅基于表格数据创建热图。

注意

使用矩阵数据时，此属性将被忽略并且为只读。

示例: h.XVariable = 'Location' 指定名为 'Location' 的变量。

YVariable — y 轴的表变量

字符向量 | 字符串 | 数值标量 | 逻辑向量

y 轴的表变量，指定为下列形式之一：

• 指示变量名称之一的字符向量或字符串。

• 指示表变量索引的数值标量。

• 包含一个 true 元素的逻辑向量。

与表变量关联的值必须组合为 categorical 函数能够接受的有限离散类别集合。如果这些值没有组合为有限类别集合，请使用 discretize 函数将它们组合在一起。

如果设置 YVariable 属性值，YData 和 YDisplayData 属性将自动更新为合适的值。

y 轴上显示的标签按字母顺序排列。您可以使用分类数组自定义标签。有关示例，请参阅基于表格数据创建热图。

注意

使用矩阵数据时，此属性将被忽略并且为只读。

示例: h.YVariable = 'Location' 指定名为 'Location' 的变量。

ColorVariable — 颜色数据的表变量

字符向量 | 字符串 | 数值标量 | 逻辑向量

颜色数据的表变量，指定为下列形式之一：

• 指示变量名称之一的字符向量或字符串。

• 指示表变量索引的数值标量。

• 包含一个 true 元素的逻辑向量。

与表变量关联的值必须为数值类型或 logical 类型。

当您指定颜色变量时，MATLAB 将更新 ColorData 属性值。此外，ColorMethod 属性会更改为 'mean'，除非您之前指定了不同的值。

注意

使用矩阵数据时，此属性将被忽略并且为只读。当 ColorMethod 属性设置为 'count' 时，也会忽略此属性。

示例: h = heatmap(__,'ColorVariable','Temperature')

示例: h.ColorVariable = 'Temperature'

矩阵数据

ColorData — 用于为每个热图单元格着色的数据

数值矩阵

用于为每个热图单元格着色的数据，指定为数值矩阵。

如果使用表格数据，则不能设置此属性。ColorData 值将根据您使用 ColorVariable 属性选择的表变量自动填充。

数据类型: double | single | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

XData — x 值

字符向量元胞数组 | 字符串数组 | 分类数组

与颜色数据矩阵列关联的 x 值，指定为字符向量元胞数组、字符串数组或分类数组。XDisplayData 属性控制图中沿 x 轴显示值的顺序。

如果更改 XData 属性值，XDisplayData 属性将自动更新为合适的值。

如果使用表格数据，则不能设置此属性。XData 值将根据您使用 XVariable 属性选择的表变量自动填充。

示例: h.XData = {'small','large','medium'}

数据类型: char | string | cell | categorical

YData — y 值

字符向量元胞数组 | 字符串数组 | 分类数组

与颜色数据矩阵行关联的 y 值，指定为字符向量元胞数组、字符串数组或分类数组。YDisplayData 属性控制图中沿 y 轴显示值的顺序。

如果更改 YData 属性值，YDisplayData 属性将自动更新为合适的值。

如果使用表格数据，则不能设置此属性。YData 值将根据您使用 YVariable 属性选择的表变量自动填充。

示例: h.YData = {'small','large','medium'}

数据类型: char | string | cell | categorical

显示的数据

ColorDisplayData — 已排序的颜色数据

矩阵

此 属性 为只读。

已排序的颜色数据，以值矩阵的形式返回，值的显示方式与在热图中相同。这些值基于 XDisplayData 和 YDisplayData 属性进行排序。

数据类型: double

XDisplayData — x 轴上值的显示顺序

字符向量元胞数组 | 字符串数组 | 分类数组

x 轴上值的显示顺序，指定为字符向量元胞数组、字符串数组或分类数组。您可以将此属性设置为 XData 中的值的子集、超集或置换。默认情况下，这些值与 XData 值相同。

如果您指定的值不在 XData 中，热图将显示一行 NaN 值或一行零值。

• 如果 ColorMethod 属性是 'sum' 或 'count'，热图将显示一行零值。

• 如果 ColorMethod 属性是 'mean'、'median' 或 'none'，热图将显示一行 NaN 值。

在创建对象的过程中，要将 XDisplayData 指定为名称-值对组，必须在指定 XDisplayLabels 或 XLimits 属性之前指定 XDisplayData 属性。使用 XDisplayLabels 属性更改显示的文本。

示例: h.XDisplayData = {'small','medium','large'}

数据类型: char | string | cell | categorical

YDisplayData — y 轴上值的显示顺序

字符向量元胞数组 | 字符串数组 | 分类数组

y 轴上值的显示顺序，指定为字符向量元胞数组、字符串数组或分类数组。您可以将此属性设置为 YData 中的值的子集、超集或置换。默认情况下，这些值与 YData 值相同。

如果您指定的值不在 YData 中，热图将显示一行 NaN 值或一行零值。

• 如果 ColorMethod 属性是 'sum' 或 'count'，热图将显示一行零值。

• 如果 ColorMethod 属性是 'mean'、'median' 或 'none'，热图将显示一行 NaN 值。

在创建对象的过程中，要将 YDisplayLabels 指定为名称-值对组，必须在指定 YDisplayData 或 YLimits 属性之前指定 YDisplayData 属性。使用 YDisplayLabels 属性更改显示的文本。

示例: h.YDisplayData = {'small','medium','large'}

数据类型: char | string | cell | categorical

XDisplayLabels — x 轴上值的标签

字符向量元胞数组 | 字符串数组 | 分类数组

x 轴值的标签，指定为字符向量元胞数组、字符串数组或分类数组。该数组必须是大小与 XDisplayData 向量相同的列向量。为 XDisplayData 中的每个值指定一个标签。默认情况下，这些值与 XDisplayData 值相同。当您将此属性指定为分类数组时，MATLAB 使用数组中的值，而不是类别。

如果您在 XDisplayData 属性中添加值、删除值或重新排列值，此属性将相应地更新，以维护值与标签的配对。在创建对象的过程中，要将 XDisplayLabels 和 XDisplayData 都指定为名称-值对组，必须先指定 XDisplayData 属性。

默认情况下，热图支持对您指定的文本使用某些 TeX 标记。使用 TeX 标记可添加下标和上标，修改字体类型和颜色，并在文本中包括特殊字符。如果要在常规文本中使用 TeX 标记字符，如下划线 (_)，请在要包含的字符前插入反斜杠 (\)。反斜杠是 TeX 转义字符。有关详细信息，请参阅文本对象的Interpreter属性。

示例: h.XDisplayLabels = {'SM','MED','LG'}

数据类型: char | string | cell | categorical

YDisplayLabels — y 轴上值的标签

字符向量元胞数组 | 字符串数组 | 分类数组

y 轴值的标签，指定为字符向量元胞数组、字符串数组或分类数组。该数组必须是大小与 YDisplayData 向量相同的列向量。为 YDisplayData 中的每个值指定一个标签。默认情况下，这些值与 YDisplayData 值相同。当您将此属性指定为分类数组时，MATLAB 使用数组中的值，而不是类别。

如果您在 YDisplayData 属性中添加值、删除值或重新排列值，此属性将相应地更新，以维护值与标签的配对。在创建对象的过程中，要将 YDisplayLabels 和 YDisplayData 都指定为名称-值对组，必须先指定 YDisplayData 属性。

默认情况下，热图支持对您指定的文本使用某些 TeX 标记。使用 TeX 标记可添加下标和上标，修改字体类型和颜色，并在文本中包括特殊字符。如果要在常规文本中使用 TeX 标记字符，如下划线 (_)，请在要包含的字符前插入反斜杠 (\)。反斜杠是 TeX 转义字符。有关详细信息，请参阅文本对象的Interpreter属性。

示例: h.YDisplayLabels = {'SM','MED','LG'}

数据类型: char | string | cell | categorical

XLimits — x 坐标轴范围

二元素行向量

x 坐标轴范围，指定为 XDisplayData 形式的二元素行向量。

在创建对象的过程中，要将 XLimits 和 XDisplayData 都指定为名称-值对组，必须先指定 XDisplayData 属性。

示例: h.XLimits = {'small','medium'}

数据类型: char | string | cell | categorical

YLimits — y 坐标轴范围

二元素行向量

y 坐标轴范围，指定为 YDisplayData 形式的二元素行向量。

在创建对象的过程中，要将 YLimits 和 YDisplayData 都指定为名称-值对组，必须先指定 YDisplayData 属性。

示例: h.YLimits = {'small','medium'}

数据类型: char | string | cell | categorical

位置

PositionConstraint — 保持不变的位置

"outerposition" | "innerposition"

在增加、删除或更改装饰元素时保持不变的位置属性，指定为下列值之一：

• "outerposition" - 在添加、删除或更改装饰元素（例如标题或轴标签）时，OuterPosition 属性保持不变。如需任何位置调整，MATLAB 会调整 InnerPosition 属性。

• "innerposition" - 在添加、删除或更改装饰元素（例如标题或轴标签）时，InnerPosition 属性保持不变。如需任何位置调整，MATLAB 会调整 OuterPosition 属性。

注意

当父容器为 TiledChartLayout 对象时，设置此属性不起作用。

OuterPosition — 外界大小和位置

[0 0 1 1] (默认) | 四元素向量

热图在父容器（通常为图窗、面板或选项卡）中的外部大小和位置，指定为 [left bottom width height] 形式的四元素向量。外部位置包括颜色栏、标题和轴标签。

• left 和 bottom 元素定义容器左下角到热图左下角的距离。

• width 和 height 元素是热图的维度，包括热图单元格以及文本和颜色栏周围的边距。

默认值 [0 0 1 1] 涵盖容器的整个内部。单位相对于容器的大小进行归一化。要更改单位，请设置 Units 属性。

注意

当父容器为 TiledChartLayout 对象时，设置此属性不起作用。

InnerPosition — 内界大小和位置

四元素向量

热图在父容器（通常为图窗、面板或选项卡）中的内部大小和位置，返回为 [left bottom width height] 形式的四元素向量。内部位置不包括颜色栏、标题和轴标签。

• left 和 bottom 元素定义容器左下角到热图左下角的距离。

• width 和 height 元素是热图的维度，只包括热图单元格。

注意

当父容器为 TiledChartLayout 对象时，设置此属性不起作用。

Position — 内界大小和位置

四元素向量

热图在父容器（通常为图窗、面板或选项卡）中的内部大小和位置，返回为 [left bottom width height] 形式的四元素向量。此属性等同于 InnerPosition 属性。

注意

当父容器为 TiledChartLayout 对象时，设置此属性不起作用。

Units — 位置单位

'normalized' (默认) | 'inches' | 'centimeters' | 'points' | 'pixels' | 'characters'

位置单位，指定为下列值之一：

Units	描述
'normalized'（默认值）	根据容器进行归一化，容器通常是图窗或面板。容器的左下角对应到 (0,0)，右上角对应到 (1,1)。
'inches'	英寸。
'centimeters'	厘米。
'characters'	基于图形根对象的默认 uicontrol 字体： 字符宽度 = 字母 x 的宽度。 字符高度 = 两个文本行的基线之间的距离。
'points'	字体磅数。一磅等于 1/72 英寸。
'pixels'	像素。 从 R2015b 开始，以像素为单位的距离不再依赖 Windows® 和 Macintosh 系统上的系统分辨率： 在 Windows 系统上，一个像素是 1/96 英寸。 在 Macintosh 系统上，一个像素是 1/72 英寸。 在 Linux® 系统上，一个像素的大小由系统分辨率确定。

在对象创建过程中将单位指定为名称-值对组时，您必须先设置 Units 属性，然后再指定要使用这些单位的属性（如 OuterPosition）。

Layout — 布局选项

空 LayoutOptions 数组 (默认) | TiledChartLayoutOptions 对象 | GridLayoutOptions 对象

布局选项，指定为 TiledChartLayoutOptions 或 GridLayoutOptions 对象。当图采用分块图布局或网格布局时，此属性非常有用。

要在分块图布局的网格中定位图，请设置 TiledChartLayoutOptions 对象的 Tile 和 TileSpan 属性。例如，假设有一个 3×3 分块图布局。布局的中心有一个包含若干图块的网格，外边缘四周各有一个图块。实际上，该网格不可见，外侧图块也不占用空间，除非您用坐标区或图填充它们。

以下代码将图 c 放置在网格的第三个图块中。

c.Layout.Tile = 3;

要使图占据多个图块，请将 TileSpan 属性指定为二元素向量。例如，此图占据了 2 行和 3 列的图块。

c.Layout.TileSpan = [2 3];

要将图放在四周的某个图块中，请将 Tile 属性指定为 "north"、"south"、"east" 或 "west"。例如，将值设置为 "east" 会将图放置在网格右侧的图块中。

c.Layout.Tile = "east";

要将图放入 App 内的一个布局中，请将此属性指定为 GridLayoutOptions 对象。有关在 App 中使用网格布局的详细信息，请参阅 uigridlayout。

如果图不是分块图布局或网格布局的子级（例如，如果它是图窗或面板的子级），则此属性为空且不起作用。

Visible — 可见性状态

'on' (默认) | on/off 逻辑值

可见性状态，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，'off' 等效于 false。因此，您可以使用此属性的值作为逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

• 'on' - 显示热图。

• 'off' - 隐藏热图而不将其删除。您仍然可以访问不可见的 HeatmapChart 对象的属性。

父级/子级

Parent — 父容器

Figure 对象 | Panel 对象 | Tab 对象 | TiledChartLayout 对象 | GridLayout 对象

父容器，指定为 Figure、Panel、Tab、TiledChartLayout 或 GridLayout 对象。

HandleVisibility — 对象句柄的可见性

'on' (默认) | 'off' | 'callback'

HeatmapChart 对象句柄在父级的 Children 属性中的可见性，指定为下列值之一：

• 'on' - 对象句柄始终可见。

• 'off' - 对象句柄始终不可见。该选项用于防止另一函数无意中对 UI 进行更改。要在执行该函数时暂时隐藏句柄，可将 HandleVisibility 设置为 'off'。

• 'callback' - 对象句柄在回调或回调所调用的函数中可见，但在从命令行调用的函数中不可见。此选项阻止通过命令行访问对象，但允许回调函数访问它。

如果父级的 Children 属性中未列出该对象，则通过搜索对象层次结构或查询句柄属性获取对象句柄的函数无法返回该对象。这包括 get、findobj、gca、gcf、gco、newplot、cla、clf 和 close。

隐藏的对象句柄仍有效。将根 ShowHiddenHandles 属性设置为 'on' 可以列出所有对象句柄，而不管它们的 HandleVisibility 属性设置是什么。

版本历史记录

在 R2017a 中推出

R2023b: 使用 Interpreter 属性控制显示文本的文本解释器

通过设置 Interpreter 属性，显示具有 TeX 标记、LaTeX 标记或不带标记的文本，如标题和标签。

R2020a: 不推荐使用 ActivePositionProperty

从 R2020a 开始，不推荐设置或获取 ActivePositionProperty。请改用 PositionConstraint 属性。

当前没有删除 ActivePositionProperty 的计划，但当您对图对象调用 set、get 或 properties 函数时，该属性不再列出。

要更新代码，请进行以下更改：

• 将 ActivePositionProperty 的所有实例替换为 PositionConstraint。

• 将所有对 "position" 选项的引用替换为 "innerposition" 选项。

另请参阅

heatmap

主题

• 访问属性值