15.3.3.4 Свойства легенды

Свойства объектов legend (см. легенда):

Категории:

Выполнение обратного вызова | Компоновка | Внешний вид легенды | Идентификация объекта | Положение объекта | Внешний вид текста

Выполнение обратного вызова

itemhitfcn: def. [](0x0)

Функция обратного вызова, выполняемая при щелчке по элементу легенды. См. раздел «Обратные вызовы».

Функция обратного вызова должна иметь следующий прототип fcn (hlegend, evnt), где hlegend — дескриптор объекта легенды, а evnt — структура со следующими полями:

Peer

Дескриптор графического объекта, с которым связан выбранный элемент.

Region

Может иметь значение "icon" или "label" в зависимости от того, по какой части элемента щелкнули.

SelectionType

Одно из значений: "normal", "extend", "open" или "alt". См. "selectiontype" рисунка.

Source

Дескриптор объекта легенды.

EventName

Имя — "ItemHit".

Компоновка

autoupdate: "off" | {"on"}

Управляет автоматическим обновлением числа элементов легенды при добавлении объектов на родительские оси или удалении их с этих осей. Например:

## Create a single plot with its legend.
figure ();
plot (1:10);
legend ("Slope 1");
## Add another plot and specify its displayname so that
## the legend is correctly updated.
hold on;
plot ((1:10) * 2, "displayname", "Slope 2");
## Stop automatic updates for further plots.
legend ("autoupdate", "off");
plot ((1:10) * 3);

numcolumns: целое скалярное значение, по умолчанию 1

Задает число столбцов, используемых при компоновке элементов легенды. Например:

figure ();
plot (rand (30));
legend ("numcolumns", 3);

Установка numcolumns также принудительно задает для свойства numcolumnsmode значение "manual".

orientation: "horizontal" | {"vertical"}

Управляет вертикальным (по столбцам) или горизонтальным (по строкам) расположением элементов легенды.

Внешний вид легенды

box: "off" | {"on"}

Управляет отображением рамки вокруг легенды.

color: colorspec, по умолчанию [1 1 1]

Цвет фона легенды. См. colorspec.

edgecolor: colorspec, по умолчанию [0.1500 0.1500 0.1500]

Задает цвет контура легенды.

Идентификация объекта

title: графический дескриптор

Графический дескриптор текстового объекта заголовка.

Положение объекта

location: "best" | "bestoutside" | "east" | "eastoutside" | "none" | "north" | {"northeast"} | "northeastoutside" | "northoutside" | "northwest" | "northwestoutside" | "south" | "southeast" | "southeastoutside" | "southoutside" | "southwest" | "southwestoutside" | "west" | "westoutside"

Задает положение легенды.

position: вектор из четырех элементов

Задает положение легенды без учета ее заголовка. Четыре элемента вектора задают координаты нижнего левого угла, ширину и высоту легенды. Изменение этого свойства также переключает "location" на "none".

units: "centimeters" | "characters" | "inches" | {"normalized"} | "pixels" | "points"

Единицы измерения, используемые для интерпретации свойства "position".

Внешний вид текста

fontangle: "italic" | {"normal"}

Управляет начертанием шрифта: курсивным или обычным.

fontname: строка, по умолчанию "*"

Название шрифта, используемого для отображения текста. При задании этого свойства механизм отображения текста выполняет поиск соответствующего шрифта в системе. Если шрифт не найден, текст отображается шрифтом без засечек по умолчанию (таким же, как при значении "*" по умолчанию).

Примечание по программированию: в системах, где FontConfig не используется изначально (везде, кроме Linux), кэш шрифтов создается при установке Octave. После установки новых шрифтов необходимо вручную выполнить system ("fc-cache -fv").

fontsize: скалярное значение, по умолчанию 9

Размер шрифта, используемого для отображения текста. См. свойство fontunits. Установка fontsize также принудительно задает для свойства fontsizemode значение "manual".

fontunits: "centimeters" | "inches" | "normalized" | "pixels" | {"points"}

Единицы измерения, используемые для интерпретации свойства "fontsize".

fontweight: "bold" | {"normal"}

Управляет вариантом основного шрифта, используемого для отображения текста.

string: строка | массив ячеек со строками

Список подписей элементов легенды. Например:

figure ();
plot (rand (20));
## Let legend choose names automatically
hl = legend ();
## Selectively change some names
str = get (hl, "string");
str(1:5:end) = "Garbage";
set (hl, "string", str);

textcolor: colorspec, по умолчанию [0 0 0]

Задает цвет текста элементов легенды.