exponenta event banner

Stateflow. Аннотация

Аннотация в диаграмме, состоянии, поле или функции

    Описание

    Использовать Stateflow.Annotation объекты для включения описательных комментариев в диаграмму. Аннотации могут содержать любую комбинацию:

    • Текст

    • Изображения

    • Уравнения с помощью команд TeX

    • Гиперссылки, открывающие веб-сайт или выполняющие функции MATLAB ®

    Дополнительные сведения см. в разделе Добавление описательных комментариев в диаграмму.

    Создание

    Описание

    пример

    annotation = Stateflow.Annotation(parent) создает Stateflow.Annotation в родительской диаграмме, состоянии, поле или графической функции.

    Входные аргументы

    развернуть все

    Родительский элемент для новой аннотации, указанный как объект API Stateflow ® одного из следующих типов:

    Свойства

    развернуть все

    Содержание

    Текст для аннотации, заданный как символьный вектор.

    Выравнивание текста аннотации, указанное как 'LEFT', 'CENTER', или 'RIGHT'.

    Формат текста аннотации, указанный как 'OFF', 'RICH', или 'TEX'.

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

    Текст аннотации без форматирования, заданный как символьный вектор.

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

    Содержит ли аннотация изображение, указанное как числовое или логическое 1 (true) или 0 (false).

    Графический образ

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

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

    Отображать ли тень вокруг поля аннотации, указанного как числовой или логический 1 (true) или 0 (false).

    Необходимо ли фиксировать высоту поля аннотации, указанного как числовой или логический 1 (true) или 0 (false).

    • true - фиксирует высоту рамки аннотации и скрывает содержимое, которое длиннее рамки.

    • false - изменение размеров поля аннотации по вертикали при добавлении содержимого.

    Необходимо ли фиксировать высоту поля аннотации, указанного как числовой или логический 1 (true) или 0 (false).

    • true - фиксирует ширину рамки аннотации и переносит текст, который длиннее рамки.

    • false - изменяет размер поля аннотации по горизонтали при добавлении содержимого.

    Цвет фона для аннотации, заданный как трехэлементный числовой вектор формы [red green blue] определяет значения красного, зеленого и синего цветов. Каждый элемент должен находиться в диапазоне от 0 до 1. Это свойство применяется только в том случае, если AutoBackgroundColor свойство - false.

    Цвет переднего плана для аннотации, заданный как трехэлементный числовой вектор формы [red green blue] определяет значения красного, зеленого и синего цветов. Каждый элемент должен находиться в диапазоне от 0 до 1. Это свойство применяется только в том случае, если AutoForegroundColor свойство - false.

    Следует ли использовать цвет фона по умолчанию, заданный как числовой или логический 1 (true) или 0 (false).

    • true - использовать цвет по умолчанию, заданный ChartColor свойства диаграммы, содержащей аннотацию.

    • false - Использовать цвет, указанный BackgroundColor свойства аннотации.

    Следует ли использовать цвет переднего плана по умолчанию, заданный как числовой или логический 1 (true) или 0 (false).

    • true - использовать цвет по умолчанию, заданный StateLabelColor свойства диаграммы, содержащей аннотацию.

    • false - Использовать цвет, указанный ForegroundColor свойства аннотации.

    Угол шрифта для текста аннотации, указанный как 'NORMAL' или 'ITALIC'.

    Пример: annotation.Font.Angle = 'ITALIC';

    Вес шрифта для текста аннотации, указанный как 'NORMAL' или 'BOLD'.

    Пример: annotation.Font.Weight = 'BOLD';

    Размер шрифта для текста аннотации, указанный как скаляр. StateFont.Size свойство диаграммы, содержащее аннотацию, задает начальное значение этого свойства.

    Пример: annotation.Font.Size = 10;

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

    Имя шрифта для текста аннотации, заданного как символьный вектор. StateFont.Name свойство диаграммы, содержащее аннотацию, задает значение этого свойства.

    Отзывы

    Обратный вызов при щелчке, заданный как символьный вектор. Этот обратный вызов содержит код MATLAB для выполнения при нажатии на аннотацию.

    Обратный вызов при загрузке модели, заданный как символьный вектор. Этот обратный вызов содержит код MATLAB для выполнения при загрузке модели, содержащей аннотацию.

    Обратный вызов при удалении, указанный как символьный вектор. Этот обратный вызов содержит код MATLAB для выполнения перед удалением аннотации.

    Использовать ли текст аннотации в качестве обратного вызова, заданного как числовой или логический 1 (true) или 0 (false). Если это свойство включено, содержимое Text используется в качестве обратного вызова при щелчке на аннотации.

    Иерархия

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

    Диаграмма, содержащая аннотацию, заданную как Stateflow.Chart объект.

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

    Вложенный просмотр для аннотации, указанный как Stateflow.Chart, Stateflow.State, Stateflow.Box, или Stateflow.Function объект. Вложенный просмотр - это диаграмма или вложенная диаграмма, в которой можно графически просмотреть аннотацию.

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

    Машина, содержащая аннотацию, заданную как Stateflow.Machine объект.

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

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

    Идентификация

    Описание аннотации, указанное как символьный вектор.

    Ссылка на документ для аннотации, указанная как символьный вектор.

    Пользовательский тег для аннотации, указанный как данные любого типа.

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

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

    Функции объекта

    classhandleПредоставить дескриптор класса для объекта
    dialogДиалоговое окно «Открыть свойства»
    fitToViewУвеличение графического объекта
    getВозврат структуры MATLAB, содержащей параметры свойств объекта или массива объектов
    setЗадать свойства с заданными значениями
    setImageВставка изображения в аннотацию
    upВозврат родителя объекта
    viewЭкранный объект в среде редактирования

    Примеры

    свернуть все

    Добавление аннотации в диаграмму ch. Установить для его содержимого значение 'This is an annotation.'

    annotation = Stateflow.Annotation(ch);
    annotation.Text = 'This is an annotation';

    Добавление аннотации в диаграмму ch. Использовать файл myImageFile.png, которая находится в папке myfolder/annotation_images, в качестве изображения для аннотации.

    annotation = Stateflow.Annotation(ch);
    setImage(annotation, ...
        fullfile('myfolder','annotation_images','myImageFile.png');
    Представлен в R2017b