Stateflow.Annotation

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

    Описание

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

    • Текст

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

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

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

    Для получения дополнительной информации смотрите, Добавляют Описательные Комментарии в Графике.

    Создание

    Описание

    пример

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

    Входные параметры

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

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

    Свойства

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

    Объекты API Stateflow имеют свойства, которые соответствуют значениям, которые вы устанавливаете в редакторе Stateflow. Чтобы получить доступ или изменить свойство, используйте запись через точку. Чтобы получить доступ или изменить несколько свойств для нескольких объектов API, используйте get и set функции, соответственно. Для получения дополнительной информации см. Изменение свойств и Вызов функций Объектов Stateflow.

    Содержимое

    Текст для аннотации в виде вектора символов.

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

    Формат текста аннотации в виде 'OFF', 'RICH', или 'TEX'.

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

    Текст аннотации, не форматируя в виде вектора символов.

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

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

    Графический внешний вид

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

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

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

    Зафиксировать ли высоту поля аннотации в виде числового или логической единицы (true) или 0 (false).

    • true — Фиксирует высоту поля аннотации и скрывает содержимое, которое более длинно, чем поле.

    • false — Изменяет размер поля аннотации вертикально, когда вы добавляете содержимое.

    Зафиксировать ли высоту поля аннотации в виде числового или логической единицы (true) или 0 (false).

    • true — Фиксирует ширину поля аннотации и сворачивает текст, который более длинен, чем поле.

    • false — Изменяет размер поля аннотации горизонтально, когда вы добавляете содержимое.

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

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

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

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

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

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

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

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

    Шрифт для текста аннотации в виде Stateflow.NoteFont объект с этими свойствами:

    • Name — Название шрифта в виде вектора символов. Это свойство доступно только для чтения. StateFont.Name свойство графика, который содержит аннотацию, устанавливает значение этого свойства.

    • Angle — Угол шрифта в виде 'NORMAL' или 'ITALIC'.

    • Weight — Толщина шрифта в виде 'NORMAL' или 'BOLD'.

    • Size — Размер шрифта в виде скаляра.

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

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

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

    Коллбэки

    Коллбэк по щелчку в виде вектора символов. Этот коллбэк содержит код MATLAB, чтобы выполниться, когда выполниться, когда вы кликаете по аннотации.

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

    Коллбэк в удаляет в виде вектора символов. Этот коллбэк содержит код MATLAB, чтобы выполниться, прежде чем вы удалите аннотацию.

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

    Иерархия

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

    Стройте диаграмму, который содержит аннотацию в виде Stateflow.Chart объект.

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

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

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

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

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

    Местоположение родительского элемента аннотации в иерархии модели в виде вектора символов.

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

    Описание для аннотации в виде вектора символов.

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

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

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

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

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

    getParentИдентифицируйте родительский элемент объекта
    dialogОткрытое диалоговое окно свойств
    viewЭкранный объект в редактировании среды
    fitToViewУвеличьте масштаб графического объекта
    setImageВставьте изображение в аннотацию

    Примеры

    свернуть все

    Добавьте аннотацию в графике 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