Histogram2 Properties

Histogram2 внешний вид и поведение

Histogram2 свойства управляют внешним видом и поведением гистограммы. Изменяя значения свойств, можно изменить аспекты гистограммы. Используйте запись через точку для ссылки на конкретный объект и свойство:

h = histogram2(randn(10,1),randn(10,1));
c = h.NumBins;
h.NumBins = [4 7];

Интервалы

расширить все

Количество интервалов в каждой размерности, заданное как двухэлементный вектор положительных целых чисел, [nX nY]. Если вы не задаете NumBins, затем histogram2 автоматически вычисляет, сколько интервалов использовать на основе значений в X и Y.

Пример: histogram2(X,Y,[10 20])

Пример: h.NumBins = [10 20]

Ширина интервалов в каждой размерности, заданная как двухэлементный вектор. Первый элемент в векторе задает ширину интервалов в x -размерности, а второй элемент задает ширину интервалов в y -размерности.

Когда вы задаете BinWidth, затем histogram2 может использовать максимум 1024 интервала (210) вдоль каждой размерности. Если вместо этого заданная ширина интервала требует больше интервалов, то histogram2 использует большую ширину интервала, соответствующую максимальному количеству интервалов.

Пример: histogram2(X,Y,'BinWidth',[5 10]) использует интервалы с размером 5 в x-размерность и размер 10 в y-размерность.

Границы интервала по x-размеру, заданные как вектор. Xedges(1) является первым ребром первого интервала по x-размеру и Xedges(end) является внешним краем последнего интервала.

Значение [X(k),Y(k)] находится в (i,j)th bin, если Xedges(i)X(k) <Xedges(i+1) и Yedges(j)Y(k) <Yedges(j+1). Последние интервалы в каждой размерности также включают последнее (внешнее) ребро. Для примера, [X(k),Y(k)] падает в ith bin в последней строке, если Xedges(end-1)X(k)Xedges(end) и Yedges(i)Y(k) <Yedges(i+1).

Типы данных: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

Границы интервала по y-размеру, заданные как вектор. Yedges(1) является первым ребром первого интервала по y-размеру и Yedges(end) является внешним краем последнего интервала.

Значение [X(k),Y(k)] находится в (i,j)th bin, если Xedges(i)X(k) <Xedges(i+1) и Yedges(j)Y(k) <Yedges(j+1). Последние интервалы в каждой размерности также включают последнее (внешнее) ребро. Для примера, [X(k),Y(k)] падает в ith bin в последней строке, если Xedges(end-1)X(k)Xedges(end) и Yedges(i)Y(k) <Yedges(i+1).

Типы данных: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

Пределы интервала в x-размерность, заданная как двухэлементный вектор, [xbmin,xbmax]. Вектор указывает первые и последние границы интервала в x-размерность.

histogram2 строит графики только тех данных, которые попадают в пределы интервала включительно, Data(Data(:,1)>=xbmin & Data(:,1)<=xbmax).

Режим выбора для пределов интервала в x-размерность, заданная как 'auto' или 'manual'. Значение по умолчанию 'auto', так что пределы интервала автоматически подстраиваются под данные вдоль оси X.

Если вы явным образом задаете XBinLimits или XBinEdges, затем XBinLimitsMode автоматически устанавливается на 'manual'. В этом случае задайте XBinLimitsMode как 'auto' для пересмотра пределов интервала по данным.

Пределы интервала в y-размерность, заданная как двухэлементный вектор, [ybmin,ybmax]. Вектор указывает первые и последние границы интервала в y-размерность.

histogram2 строит графики только тех данных, которые попадают в пределы интервала включительно, Data(Data(:,2)>=ybmin & Data(:,2)<=ybmax).

Режим выбора для пределов интервала в y-размерность, заданная как 'auto' или 'manual'. Значение по умолчанию 'auto', так что пределы интервала автоматически подстраиваются под данные по оси Y.

Если вы явным образом задаете YBinLimits или YBinEdges, затем YBinLimitsMode автоматически устанавливается на 'manual'. В этом случае задайте YBinLimitsMode как 'auto' для пересмотра пределов интервала по данным.

Алгоритм Биннинга, заданный как одно из значений в этой таблице.

ЗначениеОписание
'auto'Значение по умолчанию 'auto' алгоритм выбирает ширину интервала, чтобы охватить диапазон данных и показать форму базового распределения.
'scott'Правило Скотта оптимально, если данные близки к совместному нормальному распределению. Это правило подходит и для большинства других распределений. В нем используется интервал размером [3.5*std(X(:))*numel(X)^(-1/4), 3.5*std(Y(:))*numel(Y)^(-1/4)].
'fd'Правило Фридмена—Диакониса менее чувствительно к выбросам в данных и может быть более подходящим для данных с тяжелохвостыми распределениями. В нем используется интервал размером [2*IQR(X(:))*numel(X)^(-1/4), 2*IQR(Y(:))*numel(Y)^(-1/4)], где IQR - межквартильная область значений.
'integers'Целочисленное правило полезно с целочисленными данными, так как оно создает интервал для каждой пары целых чисел X и Y. Он использует ширину интервала 1 для каждой размерности и помещает границы интервала между целыми числами. Чтобы избежать случайного создания слишком большого количества интервалов, можно использовать это правило для создания предела 1024 интервалов (210). Если область значений данных для любой размерности больше 1024, то целочисленное правило использует более широкие интервалы вместо этого.

Примечание

Если вы задаете NumBins, XBinEdges, YBinEdges, BinWidth, XBinLimits, или YBinLimits свойства, затем BinMethod для свойства задано значение 'manual'.

Пример: histogram2(X,Y,'BinMethod','integers') создает двухмерную гистограмму с интервалами с центром от целых чисел.

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

Пример: histogram2(X,Y,'ShowEmptyBins','on') включает отображение пустых интервалов.

Данные

расширить все

Данные для распределения между интервалами, заданные как матрица размера m-by- 2. The X и Y входы к histogram2 соответствуют столбцам в Data, то есть Data(:,1) является X(:) и Data(:,2) является Y(:).

histogram2 игнорирует все NaN значения. Точно так же,histogram2 игнорирует Inf и -Inf значения, если только границы интервала не заданы явно Inf или -Inf как граница интервала. Хотя NaN, Inf, и -Inf значения обычно не строятся, они все еще включаются в нормализационные расчеты, которые включают общее количество элементов данных, таких как 'probability'.

Типы данных: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

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

Значения Bin, возвращенные как числовая матрица. Если Normalization является 'count', затем (i,j)вторая запись в Values определяет количество интервалов для интервала, x ребер которого [Xedges(i), Xedges(i+1)] и чьи < reservedrangesplaceholder1 > ребра [Yedges(j), Yedges(j+1)].

В зависимости от значения Normalization, а Values вместо этого свойство может содержать нормализованный вариант количеств интервалов.

Схема включения интервала для различных пронумерованных интервалов в Values, а также их относительная ориентация по отношению к x оси и y оси,

Для примера, (1,1) интервал включает значения, которые падают на первое ребро в каждой размерности, а последний интервал в правом нижнем углу включает значения, которые падают на любой из его ребер.

Тип нормализации, заданный как одно из значений в таблице.

ЗначениеОписание
'count'

Схема нормализации по умолчанию. Высота каждой полосы - это количество наблюдений в каждом интервале. Сумма высот штриха равна numel(X) и numel(Y).

'probability'

Высота каждого бара является относительным количеством наблюдений (количество наблюдений в бине/Общее количество наблюдений). Сумма высот штриха 1.

'countdensity'

Высота каждой полосы: (Количество наблюдений в интервале )/( Площадь интервала). Объем (Height * Area) каждой полосы - это количество наблюдений в интервале. Сумма штриховых объемов равна numel(X) и numel(Y).

'pdf'

Оценка функции плотности вероятностей. Высота каждой полосы равна, (Количество наблюдений в интервале )/( Общее количество наблюдений * Площадь интервала). Объем каждого бруса является относительным количеством наблюдений. Сумма штриховых объемов 1.

'cumcount'

Высота каждой полосы - это совокупное количество наблюдений в каждом интервале и всех предыдущих интервалах как в x, так и в y размерностях. Высота последней полосы равна numel(X) и numel(Y).

'cdf'

Оценка функции кумулятивной плотности. Высота каждой полосы равна совокупному относительному количеству наблюдений в каждом интервале и всех предыдущих интервалах как в x, так и в y размерностях. Высота последней полоски 1.

Пример: histogram2(X,Y,'Normalization','pdf') строит графики оценки функции плотности вероятностей для X и Y.

Количества интервалов, заданные как матрица. Используйте этот вход, чтобы передать количества интервалов в histogram2 когда вычисление количества интервалов выполняется отдельно, и вы не хотите histogram2 для выполнения любого раскладывания данных.

counts должна быть матрицей размера [nbinsX nbinsY] таким образом задается количество интервалов для каждого интервала.

Количество интервалов в x -dimension length(XBinEdges)-1, и количество интервалов в y -размерности length(YBinEdges)-1.

По сравнению с Values свойство, BinCounts не нормирован. Если Normalization является 'count', затем Values и BinCounts являются эквивалентными.

Пример: histogram2('XBinEdges',-1:1,'YBinEdges',-2:2,'BinCounts',[1 2 3 4; 5 6 7 8])

Режим выбора счетчиков интервалов задается как 'auto' или 'manual'. Значение по умолчанию 'auto', так что количества интервалов автоматически вычисляются из Data, XBinEdges, и YBinEdges.

Если вы задаете BinCounts, затем BinCountsMode автоматически устанавливается на 'manual'. Точно так же, если вы задаете Data, затем BinCountsMode автоматически устанавливается на 'auto'.

Цвет и укладка

расширить все

Стиль отображения гистограммы, заданный как 'bar3' или 'tile'. Задайте 'tile' отображение гистограммы как прямоугольного массива плиток с цветами, указывающими значения интервала.

Значение по умолчанию 'bar3' отображает гистограмму с использованием 3-D полос.

Пример: histogram2(X,Y,'DisplayStyle','tile') строит гистограмму как прямоугольный массив плиток.

Цвет гистограммы в виде одного из следующих значений:

  • 'none' - Штанги не заполнены.

  • 'flat' - Цвета баров варьируются в зависимости от высоты. Бары с разной высотой имеют разные цвета. Цвета выбираются из рисунка или осей.

  • 'auto' - Цвет панели выбирается автоматически (по умолчанию).

  • Триплет 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'

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

    Триплет 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'

Если вы задаете DisplayStyle как 'stairs', затем histogram2 не использует FaceColor свойство.

Пример: histogram2(X,Y,'FaceColor','g') создает гистограмму, график с зелеными полосами.

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

  • 'none' - Ребра не рисуются.

  • 'auto' - Цвет каждого ребра выбирается автоматически.

  • Триплет 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'

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

    Триплет 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'

Пример: histogram2(X,Y,'EdgeColor','r') создает гистограмму, график с красными ребрами.

Прозрачность строк гистограммы, заданная как скалярное значение между 0 и 1 включительно. histogram2 использует ту же прозрачность для всех полос гистограммы. Значение 1 означает полностью непрозрачный и 0 означает полностью прозрачный (невидимый).

Пример: histogram2(X,Y,'FaceAlpha',0.5) создает двухмерный график гистограммы с полупрозрачными полосами.

Прозрачность ребер гистограммы в виде скалярного значения между 0 и 1 включительно. Значение 1 означает полностью непрозрачный и 0 означает полностью прозрачный (невидимый).

Пример: histogram2(X,Y,'EdgeAlpha',0.5) создает двухмерный график гистограммы с полупрозрачными ребрами.

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

ЗначениеОписание
'lit'

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

Это значение по умолчанию, когда DisplayStyle является 'bar3'.

'flat'

Гистограммы не освещаются автоматически. При наличии других световых объектов эффект подсветки равномерен по граням стержня.

'none'

Гистограммы не освещаются автоматически, и огни не влияют на гистограммы.

FaceLighting можно только 'none' когда DisplayStyle является 'tile'.

Пример: histogram2(X,Y,'FaceLighting','none') отключает подсветку полос гистограммы.

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

Стиль линииОписаниеРезультирующая линия
'-'Сплошная линия

'--'Штриховая линия

':'Пунктирная линия

'-.'Штрих-пунктирная линия

'none'Нет линииНет линии

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

Пример: 1.5

Типы данных: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Индекс ряда, заданный как целое число, больше или равное 0. Это свойство полезно для переназначения цветов лица нескольких Histogram2 объекты так, чтобы они совпадали друг с другом. По умолчанию в SeriesIndex свойство Histogram2 объект является числом, которое соответствует его порядку создания, начиная с 1.

MATLAB использует номер для вычисления индексов для назначения цветов при вызове функций построения графика. Индексы относятся к строкам массивов, хранящихся в ColorOrder свойство осей.

MATLAB автоматически обновляет цвет лица Histogram2 объект, когда вы меняете его SeriesIndex, или когда вы меняете ColorOrder свойство на осях. Однако следующие условия должны быть верными, чтобы изменения имели любой эффект:

  • The FaceColor свойство на Histogram2 для объекта задано значение 'auto'.

  • The SeriesIndex свойство на Histogram2 объект больше 0.

  • The NextSeriesIndex свойство объекта axes больше 0.

Легенда

расширить все

Текст, используемый легендой, задается как вектор символов. Текст появляется рядом со значком гистограммы 2.

Пример: 'Text Description'

Для многострочного текста создайте вектор символов с помощью sprintf с новым символом линии \n.

Пример: sprintf('line one\nline two')

Кроме того, вы можете задать текст легенды, используя legend функция.

  • Если вы задаете текст как входной параметр к legend function, затем легенда использует заданный текст и устанавливает DisplayName свойство с тем же значением.

  • Если вы не задаете текст как входной параметр к legend function, тогда легенда использует текст в DisplayName свойство. По умолчанию DisplayName - вектор символов, представляющая имена переменных x и y входных данных, используемых для создания гистограммы. Если один или оба входов не имеют имен переменных, то DisplayName пуст, ''.

Если на DisplayName свойство не содержит никакого текста, тогда легенда генерирует вектор символов. Вектор символов имеет форму 'dataN', где N - номер, присвоенный объекту histogram2 на основе его расположения в списке записей легенды.

Если вы редактируете в интерактивном режиме вектор символов в существующей легенде, MATLAB обновляет DisplayName свойство редактируемого вектора символов.

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

Управление включения объекта в легенду или исключения из нее, возвращаемое как Annotation объект. Установите базовую IconDisplayStyle свойство одному из следующих значений:

  • 'on' - Включить объект в легенду (по умолчанию).

  • 'off' - Не включать объект в легенду.

Например, чтобы исключить графический объект, go, из легенды установите IconDisplayStyle свойство к 'off'.

go.Annotation.LegendInformation.IconDisplayStyle = 'off';

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

Интерактивность

расширить все

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

  • 'on' - Отобразите объект.

  • 'off' - Скрыть объект, не удаляя его. Вы по-прежнему можете получить доступ к свойствам невидимого объекта.

Всплывающая подсказка данных, заданное как DataTipTemplate объект. Можно управлять содержимым, которое появляется в всплывающей подсказке, изменяя свойства базового DataTipTemplate объект. Список свойств см. в разделе Свойства DataTipTemplate.

Пример изменения всплывающих подсказок см. в разделе Создание пользовательских всплывающих подсказок.

Примечание

The DataTipTemplate объект не возвращается findobj или findallи не копируется copyobj.

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

Примечание

Если на PickableParts для свойства задано значение 'none' или если HitTest для свойства задано значение 'off', тогда контекстное меню не отображается.

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

  • 'on' - Выбран. Если вы кликните объект в режиме редактирования графика, то MATLAB устанавливает его Selected свойство к 'on'. Если на SelectionHighlight свойство также установлено в 'on'MATLAB отображает указатели выделения вокруг объекта.

  • 'off' - Не выбран.

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

  • 'on' - Отображать указатели выделения, когда Selected для свойства задано значение 'on'.

  • 'off' - Никогда не отображать указатели выделения, даже когда Selected для свойства задано значение 'on'.

Коллбэки

расширить все

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

  • Указатель на функцию

  • Массив ячеек, содержащий указатель на функцию и дополнительные аргументы

  • Вектор символов, являющийся действительной командой или функцией MATLAB, которая оценивается в базовом рабочем пространстве (не рекомендуется)

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

  • Объект, выбранный кликом мыши - Доступ к свойствам объекта, выбранного кликом мыши, из функции обратного вызова.

  • Данные о событиях - Пустой аргумент. Замените его на символ тильды (~) в определении функции, чтобы указать, что этот аргумент не используется.

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

Примечание

Если на PickableParts для свойства задано значение 'none' или если HitTest для свойства задано значение 'off', тогда этот коллбэк не выполняется.

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

  • Указатель на функцию.

  • Массив ячеек, в котором первый элемент является указателем на функцию. Последующие элементы массива ячеек являются аргументами, которые передаются в функцию обратного вызова.

  • Вектор символов, содержащий допустимое выражение MATLAB (не рекомендуемый). MATLAB оценивает это выражение в базовом рабочем пространстве.

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

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

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

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

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

  • Указатель на функцию.

  • Массив ячеек, в котором первый элемент является указателем на функцию. Последующие элементы массива ячеек являются аргументами, которые передаются в функцию обратного вызова.

  • Вектор символов, содержащий допустимое выражение MATLAB (не рекомендуемый). MATLAB оценивает это выражение в базовом рабочем пространстве.

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

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

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

Контроль выполнения обратного вызова

расширить все

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

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

  • Обратный коллбэк running - это актуальный на данный момент коллбэк.

  • Обратный коллбэк interrupting - это коллбэк, который пытается прервать текущий коллбэк.

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

  • Значение 'on' позволяет другим коллбэкам прерывать коллбэки объекта. Прерывание происходит в следующей точке, где MATLAB обрабатывает очередь, например, когда есть drawnow, figure, uifigure, getframe, waitfor, или pause команда.

    • Если текущий коллбэк содержит одну из этих команд, MATLAB останавливает выполнение коллбэка в этой точке и выполняет прерывание обратного вызова MATLAB возобновляет выполнение текущего коллбэка после завершения прерывания обратного вызова.

    • Если текущий коллбэк не содержит одну из этих команд, MATLAB завершает выполнение коллбэка без прерывания.

  • Значение 'off' блокирует все попытки прерывания. The BusyAction свойство объекта, имеющего прерывание обратного вызова, определяет, отменяется ли прерывание обратного вызова или помещается в очередь.

Примечание

Прерывание и выполнение коллбэка происходят по-разному в таких ситуациях:

  • Если прерывание обратного вызова является DeleteFcn, CloseRequestFcn или SizeChangedFcn коллбэк, тогда прерывание происходит независимо от Interruptible значение свойства.

  • Если текущий коллбэк выполняющегося в данного момента, waitfor function, тогда прерывание происходит независимо от Interruptible значение свойства.

  • Timer объекты выполняются в соответствии с расписанием независимо от Interruptible значение свойства.

Когда происходит прерывание, MATLAB не сохраняет состояние свойств или отображения. Для примера, объект, возвращенный gca или gcf команда может измениться при выполнении другого коллбэка.

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

  • Обратный коллбэк running - это актуальный на данный момент коллбэк.

  • Обратный коллбэк interrupting - это коллбэк, который пытается прервать текущий коллбэк.

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

  • 'queue' - помещает прерывание обратного вызова в очередь вызовов, подлежащих обработке после концов обратного коллбэка.

  • 'cancel' - Не выполняет прерывание обратного вызова.

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

  • 'visible' - Захватывать клики мыши только при условии видимости. The Visible свойство должно быть установлено в 'on'. The HitTest свойство определяет, Histogram2 ли объект реагирует на нажатие кнопки или если это делает предок.

  • 'none' - Невозможно захватить клики мыши. Кликнув по Histogram2 объект передает нажатие кнопки объекту за ним в текущем виде окна рисунка. The HitTest свойство Histogram2 объект не влияет.

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

  • 'on' - Запуск ButtonDownFcn коллбэк Histogram2 объект. Если вы определили ContextMenu Свойство активируйте контекстное меню.

  • 'off' - Инициируйте коллбэки для ближайшего предка Histogram2 объект, который имеет одно из следующего:

    • HitTest значение свойства установлено в 'on'

    • PickableParts набор свойств установлен таким образом, чтобы оно позволяло предку захватывать клики мыши

Примечание

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

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

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

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

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

Родитель/ребенок

расширить все

Родительский элемент, заданный как Axes, Group, или Transform объект.

Дети, вернулись как пустой GraphicsPlaceholder массив или DataTip объектный массив. Используйте это свойство для просмотра списка всплывающих подсказок, нанесенных на график.

Вы не можете добавить или удалить дочерние элементы, используя Children свойство. Чтобы добавить дочерний элемент в этот список, установите Parent свойство DataTip объект объекту графика.

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

  • 'on' - указатель на объект всегда отображается.

  • 'off' - указатель на объект всегда невидим. Эта опция используется для предотвращения непреднамеренных изменений другой функцией. Установите HandleVisibility на 'off' временно скрыть указатель во время выполнения этой функции.

  • 'callback' - Указатель на объект виден из коллбэков или функций, вызываемых коллбэками, но не из функций, инициируемых из командной строки. Эта опция блокирует доступ к объекту в командной строке, но позволяет функциям обратного вызова обращаться к нему.

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

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

Идентификаторы

расширить все

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

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

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

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

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

Вопросы совместимости

расширить все

Не рекомендуемый запуск в R2020a

Введенный в R2015b
Для просмотра документации необходимо авторизоваться на сайте