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

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

Категории: ¶

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

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

itemhitfcn: def. [](0x0) ¶

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

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

Peer

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

Region

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

SelectionType

Один из "normal", "extend", "open", или "alt". См. тип выделения Figure.

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: скалярное целое число, def. 1 ¶

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

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

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

orientation: "horizontal" | {"vertical"} ¶

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

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

box: "off" | {"on"} ¶

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

color: цветовое задание, def. [1 1 1] ¶

Цвет фона легенды. См. цветовое задание.

edgecolor: цветовое задание, def. [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: строка, def. "*" ¶

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

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

fontsize: скаляр, def. 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: цветовое задание, def. [0 0 0] ¶

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