Расположение относительно осей, заданное как одно из значений местоположения, перечисленных в этой таблице.

Пример: legend('Location','northeastoutside')

Ориентация, заданная как одно из следующих значений:

Пример: legend('Orientation','horizontal')

Количество столбцов в виде положительного целого числа. Если элементов легенды недостаточно для заполнения заданного количества столбцов, количество отображаемых столбцов может быть меньше.

Используйте Orientation свойство для управления отображением элементов легенды в порядке вдоль каждого столбца или вдоль каждой строки.

Пример: lgd.NumColumns = 3

Режим выбора для NumColumns значение, заданное как одно из следующих значений:

Пользовательское расположение и размер, заданные как четырехэлементный вектор формы [left bottom width height]. Первые два значения, left и bottomзадайте расстояние от нижнего левого угла рисунка до нижнего левого угла легенды. Последние два значения, width и height, задайте размерности легенды. The Units свойство определяет модули.

Если вы задаете Position свойство, затем MATLAB^® автоматически изменяет Location свойство к 'none'.

Пример: legend({'A','B'},'Position',[0.2 0.6 0.1 0.2])

Позиционные модули, заданные как одно из значений в этой таблице.

Все модули измерения выполняются из левого нижнего угла окна контейнера.

Это свойство влияет на Position свойство. Если вы меняете модули, рекомендуется вернуть ей значение по умолчанию после завершения расчетов, чтобы предотвратить влияние на другие функции, которые предполагают Units является значением по умолчанию.

Если вы задаете Position и Units свойства как Name,Value пар при создании объекта, тогда важен порядок спецификации. Если вы хотите определить позицию с конкретными модулями, то вы должны задать Units свойство перед Position свойство.

Опции размещения, заданные как TiledChartLayoutOptions объект. Это свойство полезно, когда легенда находится в размещении мозаичного графика.

Чтобы поместить легенду в сетку размещения мозаичного графика, установите Tile свойство на TiledChartLayoutOptions объект. Для примера рассмотрим плиточный график размещения 3 на 3. Размещение имеет сетку плиток в центре, и четыре плитки по внешним краям. На практике сетка невидима, и внешние плитки не занимают пространства, пока вы не заполняете их осями или другими объектами.

Этот код помещает легенду lgd в третьей плитке сетки..

lgd.Layout.Tile = 3;

Чтобы поместить легенду в одну из окружающих плиток, задайте Tile свойство как 'north', 'south', 'east', или 'west'. Для примера установите значение 'east' помещает легенду в плитку справа от сетки.

lgd.Layout.Tile = 'east';

Если легенда не является дочерним элементом мозаичного графика размещения (для примера, если она является дочерним элементом рисунка), то это свойство пустое и не имеет никакого эффекта.

Автоматическое обновление элементов легенды для отражения текущего состояния осей, заданное как 'on' или 'off', или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

Пример: legend({'A','B'},'AutoUpdate','off')

Текст для меток легенды, заданный как массив ячеек из векторов символов, строковых массивов или категориального массива. Чтобы включить специальные символы или греческие буквы в метки, используйте разметку TeX. Таблицу опций см. в Interpreter свойство.

Заголовок легенды, возвращенный как текстовый объект легенды. Чтобы добавить заголовок легенды, установите String свойство текстового объекта legend. Чтобы изменить внешний вид заголовка, например стиль шрифта или цвет, задайте свойства текста легенды. Список см. в разделе Свойства текста.

plot(rand(3));
lgd = legend('line 1','line 2','line 3');
lgd.Title.String = 'My Legend Title';
lgd.Title.FontSize = 12;

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

plot(rand(3));
lgd = legend('line 1','line 2','line 3');
title(lgd,'My Legend Title','FontSize',12)

Текстовый интерпретатор, заданный в качестве одного из следующих значений:

Синтаксис TeX

По умолчанию MATLAB поддерживает подмножество разметки TeX. Используйте разметку TeX, чтобы добавить суперскрипты и индексы, изменить тип и цвет шрифта и включить в текст специальные символы.

Модификаторы остаются в эффекте до конца текста. Верхние и нижние индексы являются исключением, поскольку они изменяют только следующий символ или символы в фигурных скобках. Когда вы устанавливаете интерпретатор на 'tex', поддерживаемые модификаторы следующие.

В этой таблице перечислены поддерживаемые специальные символы для 'tex' интерпретатор.

Разметка LaTeX

Чтобы использовать разметку LaTeX, установите значение интерпретатора 'latex'. Для встроенного режима окружите разметку одинарными долларовыми знаками ($). Для режима отображения окружите разметку знаками в два доллара ($$).

'$\int_1^{20} x^2 dx$'

'$$\int_1^{20} x^2 dx$$'

Отображаемый текст использует стиль шрифта LaTeX по умолчанию. The FontName, FontWeight, и FontAngle свойства не имеют эффекта. Для изменения стиля шрифта используйте разметку LaTeX.

Максимальный размер текста, который можно использовать с интерпретатором LaTeX, составляет 1200 символов. Для многострочного текста это уменьшается примерно на 10 символов на линию.

Для примеров, которые используют TeX и LaTeX, смотрите греческие буквы и специальные символы в тексте графика. Для получения дополнительной информации о системе LaTeX, смотрите веб-сайт проекта LaTeX в https://www.latex-project.org/.

Название шрифта, заданное как поддерживаемое название шрифта шрифта или 'FixedWidth'. Для правильного отображения и печати текста необходимо выбрать шрифт, поддерживаемый системой. Шрифт по умолчанию зависит от операционной системы и локали.

Чтобы использовать шрифт фиксированной ширины, который хорошо выглядит в любой локали, используйте 'FixedWidth'. Шрифт фиксированной ширины опирается на корень FixedWidthFontName свойство. Установка корневого FixedWidthFontName свойство приводит к немедленному обновлению отображения, чтобы использовать новый шрифт.

Размер шрифта, заданный как скалярное значение, больше нуля в модули точки. Размер шрифта по умолчанию зависит от конкретной операционной системы и локали.

Если вы меняете размер шрифта осей, MATLAB автоматически устанавливает размер шрифта шкалы палитры равным 90% от размера шрифта осей. Если вы вручную задаете размер шрифта шкалы палитры, то изменение размера шрифта осей не влияет на шкалу палитры.

Толщина символов, заданная как 'normal' или 'bold'.

MATLAB использует FontWeight свойство для выбора шрифта из доступных в вашей системе. Не все шрифты имеют жирный вес. Поэтому установка полужирного шрифта веса все еще может привести к нормальной толщине шрифта.

Наклон символов, заданный как 'normal' или 'italic'.

Не все шрифты имеют оба стилей шрифта. Поэтому курсив шрифта может выглядеть так же, как и обычный шрифт.

Цвет текста, заданный как триплет RGB, шестнадцатеричный код цвета, название цвета или краткое имя. Цвет по умолчанию черный со значением [0 0 0].

Для пользовательского цвета укажите триплет RGB или шестнадцатеричный код цвета.

Кроме того, вы можете задать имена некоторых простых цветов. В этой таблице перечислены именованные опции цвета, эквивалентные триплеты RGB и шестнадцатеричные цветовые коды.

Вот триплеты RGB и шестнадцатеричные цветовые коды для цветов по умолчанию, которые MATLAB использует во многих типах графиков.

Пример: [0 0 1]

Пример: 'blue'

Пример: '#0000FF'

Цвет фона, заданный как триплет RGB, шестнадцатеричный код цвета, название цвета или краткое имя. Значение по умолчанию [1 1 1] соответствует белому.

Для пользовательского цвета укажите триплет RGB или шестнадцатеричный код цвета.

Кроме того, вы можете задать имена некоторых простых цветов. В этой таблице перечислены именованные опции цвета, эквивалентные триплеты RGB и шестнадцатеричные цветовые коды.

Вот триплеты RGB и шестнадцатеричные цветовые коды для цветов по умолчанию, которые MATLAB использует во многих типах графиков.

Пример: legend({'A','B'},'Color','y')

Пример: legend({'A','B'},'Color',[0.8 0.8 1])

Пример: legend({'A','B'},'Color','#D9A2E9')

Цвет контура рамки, заданный как триплет RGB, шестнадцатеричный код цвета, название цвета или краткое имя. Значение по умолчанию [0.15 0.15 0.15] соответствует тёмно-серому.

Для пользовательского цвета укажите триплет RGB или шестнадцатеричный код цвета.

Кроме того, вы можете задать имена некоторых простых цветов. В этой таблице перечислены именованные опции цвета, эквивалентные триплеты RGB и шестнадцатеричные цветовые коды.

Вот триплеты RGB и шестнадцатеричные цветовые коды для цветов по умолчанию, которые MATLAB использует во многих типах графиков.

Пример: legend({'A','B'},'EdgeColor',[0 1 0])

Отображение контура коробки, заданное как 'on' или 'off', или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

Пример: legend({'A','B'},'Box','off')

Ширина контура куба, заданная как положительное значение в модули точки. Одна точка равна 1/72 дюйма.

Пример: 1.5

Состояние видимости, заданное как 'on' или 'off', или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

Контекстное меню, заданное как ContextMenu объект. Используйте это свойство для отображения контекстного меню при щелчке правой кнопкой мыши по объекту. Создайте контекстное меню с помощью uicontextmenu функция.

Состояние выбора, заданное как 'on' или 'off', или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

Отображение указателей выделения, заданное как 'on' или 'off', или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

Коллбэк, который выполняется при клике по элементам легенды, заданным как одно из следующих значений:

Если вы задаете это свойство с помощью указателя на функцию, то MATLAB передает Legend объект и структура данных о событиях в качестве первого и второго входных параметров в функцию. В этой таблице описываются поля в структуре данных о событиях.

Пример

Можно создавать интерактивные легенды, чтобы при клике по элементу легенды связанный график каким-то образом обновлялся. Например, можно переключить видимость графика или изменить ее ширину линии. Установите ItemHitFcn свойство легенды для функции обратного вызова, которая управляет изменением графиков. В этом примере показов, как переключить видимость графика, когда вы нажимаете значок графика или метку в легенде. Он создает функцию обратного вызова, которая изменяет Visible свойство графика любому из 'on' или 'off'.

Скопируйте следующий код в новый файл функции и сохраните его как hitcallback_ex1.m либо в текущей папке, либо в папке на пути поиска файлов MATLAB. Два входных параметров, src и evnt, являются объектом легенды и структурой данных о событиях. MATLAB автоматически передает эти входы в функцию обратного вызова при клике элемента легенды. Используйте Peer поле структуры данных о событиях для доступа к свойствам объекта графика, связанного с кликнутым элементом легенды.

function hitcallback_ex1(src,evnt)

if strcmp(evnt.Peer.Visible,'on')
    evnt.Peer.Visible = 'off';
else 
    evnt.Peer.Visible = 'on';
end

end

Затем постройте график четырех линий, создайте легенду и присвойте объект легенды переменной. Установите ItemHitFcn свойство объекта legend в функцию обратного вызова. Щелкните элементы легенды, чтобы показать или скрыть связанный график. Метка легенды изменяется на серую при скрытии графика.

plot(rand(4));
l = legend('Line 1','Line 2','Line 3','Line 4');
l.ItemHitFcn = @hitcallback_ex1;

Коллбэк по клику мыши, заданный как одно из следующих значений:

Используйте это свойство для выполнения кода при клике по объекту. Если вы задаете это свойство с помощью указателя на функцию, то MATLAB передает два аргумента в функцию обратного вызова при выполнении коллбэка:

Дополнительные сведения о том, как использовать указатели на функцию для определения функций обратного вызова, см. в разделе «Определение коллбэка».

Функция создания объектов, заданная в качестве одного из следующих значений:

Для получения дополнительной информации об указании коллбэка как указателя на функцию, массива ячеек или вектора символов, см. Раздел «Определение коллбэка».

Это свойство задает функцию обратного вызова, которая должна выполняться, когда MATLAB создает объект. MATLAB инициализирует все значения свойств перед выполнением CreateFcn коллбэк. Если вы не задаете CreateFcn свойство, затем MATLAB выполняет функцию создания по умолчанию.

Установка CreateFcn свойство в существующем компоненте не имеет никакого эффекта.

Если вы задаете это свойство как указатель на функцию или массив ячеек, можно получить доступ к объекту, который создается с помощью первого аргумента функции обратного вызова. В противном случае используйте gcbo функция для доступа к объекту.

Функция удаления объектов, заданная в качестве одного из следующих значений:

Для получения дополнительной информации об указании коллбэка как указателя на функцию, массива ячеек или вектора символов, см. Раздел «Определение коллбэка».

Это свойство задает функцию обратного вызова, которая должна выполняться, когда MATLAB удаляет объект. MATLAB выполняет DeleteFcn коллбэк перед уничтожением свойств объекта. Если вы не задаете DeleteFcn свойство, затем MATLAB выполняет функцию удаления по умолчанию.

Если вы задаете это свойство как указатель на функцию или массив ячеек, можно получить доступ к удаляемому объекту с помощью первого аргумента функции обратного вызова. В противном случае используйте gcbo функция для доступа к объекту.

Прерывание коллбэка, заданное как 'on' или 'off', или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

Это свойство определяет, можно ли прерывать выполняемый коллбэк. Существует два состояния коллбэка:

Всякий раз, когда MATLAB вызывает коллбэк, этот коллбэк пытается прервать текущий коллбэк. The Interruptible свойство объекта, имеющего текущий коллбэк, определяет, разрешено ли прерывание. The Interruptible свойство имеет два возможных значения:

Постановка в очередь коллбэков, заданная как 'queue' или 'cancel'. The BusyAction свойство определяет, как MATLAB обрабатывает выполнение прерываний обратного вызова. Существует два состояния коллбэка:

Всякий раз, когда MATLAB вызывает коллбэк, этот коллбэк пытается прервать текущий коллбэк. The Interruptible свойство объекта, имеющего текущий коллбэк, определяет, разрешено ли прерывание. Если прерывание не разрешено, то BusyAction свойство объекта, имеющего прерывание обратного вызова, определяет, будет ли оно сброшено или помещено в очередь. Это возможные значения BusyAction свойство:

Возможность осуществить захват кликов мыши, заданная как одно из следующих значений:

Ответ на захваченные клики мыши, заданный как 'on' или 'off', или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа matlab.lang.OnOffSwitchState.

Это свойство доступно только для чтения.

Статус удаления, возвращенный как логическое значение включения/выключения типа matlab.lang.OnOffSwitchState.

MATLAB устанавливает BeingDeleted свойство к 'on' когда DeleteFcn коллбэк начинает выполняться. The BeingDeleted свойство остается установленным на 'on' пока объект компонента не перестанет существовать.

Проверьте значение BeingDeleted свойство, чтобы убедиться, что объект не будет удален до запроса или изменения.

Родительский контейнер, заданный как Figure объект, Panel объект, Tab объект, или TiledChartLayout объект.

The Legend объект должен иметь тот же родительский элемент, что и связанные оси. Если вы меняете родительский элемент связанных осей, то Legend объект автоматически обновляется, чтобы использовать тот же родительский элемент.

У объекта нет дочерних элементов. Вы не можете задать это свойство.

Видимость указателя на объект в Children свойство родительского элемента, заданное в качестве одного из следующих значений:

Если объект не указан в Children свойство родительского элемента, тогда функции, которые получают указатели на объекты путем поиска иерархии объектов или запросов свойств указателя, не могут вернуть его. Примеры таких функций включают в себя get, findobj, gca, gcf, gco, newplot, cla, clf, и close функций.

Скрытые указатели на объекты все еще действительны. Установите корневой ShowHiddenHandles свойство к 'on' список всех указателей на объекты независимо от их HandleVisibility настройка свойств.

Это свойство доступно только для чтения.

Тип графического объекта, возвращенный как 'legend'. Используйте это свойство для поиска всех объектов заданного типа в иерархии графического изображения.

Идентификатор объекта, заданный как вектор символов или строковый скаляр. Можно задать уникальное Tag значение, которое служит идентификатором для объекта. Когда вам нужен доступ к объекту в другом месте вашего кода, вы можете использовать findobj функция для поиска объекта на основе Tag значение.

Пользовательские данные, заданные как любой массив MATLAB. Для примера можно задать скаляр, вектор, матрицу, массив ячеек, символьный массив, таблицу или структуру. Используйте это свойство для хранения произвольных данных на объекте.

Если вы работаете в App Designer, создайте общие или частную собственность в приложении, чтобы делиться данными вместо использования UserData свойство. Для получения дополнительной информации см. раздел «Обмен данными в приложениях App Designer».