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

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

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);

box: "off" | {"on"}

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

color: colorspec, def. [1 1 1]

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

edgecolor: colorspec, def. [0.1500 0.1500 0.1500]

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

fontangle: "italic" | {"normal"}

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

fontname: строка, def. "*"

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

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

fontsize: скаляр, def. 9

Размер шрифта, используемого для рендеринга текста. См. свойство fontunits.

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

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

fontweight: "bold" | {"normal"}

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

itemhitfcn: def. [](0x0)

Функция обратного вызова, которая выполняется при нажатии на элемент легенды. См. раздел обратных вызовов.

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

Peer

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

Region

Может быть "icon" или "label" в зависимости от того, какая часть элемента была нажата.

SelectionType

Одно из значений "normal", "extend", "open", или "alt". См. Свойство фигуры "selectiontype".

Source

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

EventName

Имя — "ItemHit".

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

Управление расположением легенды.

numcolumns: скалярное целое число, def. 1

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

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

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

orientation: "horizontal" | {"vertical"}

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

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

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

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, def. [0 0 0]

Управление цветом текстовых строк элементов легенды.

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

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

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

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