Stateflow.Annotation

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

Описание

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

Текст
Изображения
Уравнения с использованием команд TeX
Гиперссылки, которые открывают веб-сайт или выполняют MATLAB^® функции

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

Создание

Синтаксис

annotation = Stateflow.Annotation(parent)

Описание

пример

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

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

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

`parent` - Родительский элемент для новой аннотации
`Stateflow.Chart` | объекта `Stateflow.State` | объекта `Stateflow.Box` | объекта `Stateflow.Function` объект

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

Свойства

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

Содержимое

`Text` - Текст для аннотации
`'?'` (по умолчанию) | вектор символов

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

`Alignment` - Выравнивание текста
`'LEFT'` (по умолчанию) | `'CENTER'` | `'RIGHT'`

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

`Interpretation` - Формат текста
`'OFF'` (по умолчанию) | `'RICH'` | `'TEX'`

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

`PlainText` - Текст без форматирования
вектор символов

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

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

`IsImage` - Содержит ли аннотация изображение
`false` или 0 (по умолчанию) | `true` или 1

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

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

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

`Position` - Положение и размер аннотации
`[0 0 8 16]` (по умолчанию) | `[left top width height]`

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

`InternalMargins` - Пространство между текстом и границей аннотации
`[0 0 0 0]` (по умолчанию) | `[left top right bottom]`

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

`DropShadow` - Отображать ли тень вокруг аннотации
`false` или 0 (по умолчанию) | `true` или 1

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

`FixedHeight` - Фиксировать ли высоту аннотации
`false` или 0 (по умолчанию) | `true` или 1

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

true - Фиксирует высоту поля аннотации и скрывает содержимое, длиннее, чем поле.
false - Изменение размера аннотации по вертикали при добавлении содержимого.

`FixedWidth` - Фиксировать ли ширину аннотации
`false` или 0 (по умолчанию) | `true` или 1

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

true - Фиксирует ширину аннотации и переносит текст, который длиннее рамки.
false - Изменение размера окна аннотации по горизонтали при добавлении содержимого.

`BackgroundColor` - Цвет фона
`[1 1 1]` (по умолчанию) | `[red green blue]`

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

`ForegroundColor` - Цвет переднего плана
`[0 0 0]` (по умолчанию) | `[red green blue]`

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

`AutoBackgroundColor` - Использовать ли цвет фона по умолчанию
`true` или 1 (по умолчанию) | `false` или 0

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

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

`AutoForegroundColor` - Использовать ли цвет переднего плана по умолчанию
`true` или 1 (по умолчанию) | `false` или 0

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

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

`Font.Angle` - Угол шрифта
`'NORMAL'` (по умолчанию) | `'ITALIC'`

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

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

`Font.Weight` - Толщина шрифта
`'NORMAL'` (по умолчанию) | `'BOLD'`

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

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

`Font.Size` - Размер шрифта
скаляр

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

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

`Font.Name` - Название шрифта
`'Helvetica'` (по умолчанию) | вектор символов

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

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

Коллбэки

`ClickFcn` - Коллбэк по клику
`''` (по умолчанию) | вектор символов

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

`LoadFcn` - Коллбэк при нагрузке модели
`''` (по умолчанию) | вектор символов

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

`DeleteFcn` - Коллбэк при удалении
`''` (по умолчанию) | вектор символов

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

`UseDisplayTextAsClickCallback` - Использовать ли текст аннотации в качестве коллбэка
`false` или 0 (по умолчанию) | `true` или 1

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

Иерархия

`Chart` - График, содержащая аннотацию
`Stateflow.Chart` объект

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

График, содержащая аннотацию, заданная как Stateflow.Chart объект.

`Subviewer` - Подсредство просмотра для аннотации
`Stateflow.Chart` | объекта `Stateflow.State` | объекта `Stateflow.Box` | объекта `Stateflow.Function` объект

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

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

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

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

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

`Path` - Расположение родительского элемента в иерархии модели
вектор символов

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

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

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

`Description` - Описание
`''` (по умолчанию) | вектор символов

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

`Document` - Ссылка на документ
`''` (по умолчанию) | вектор символов

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

`Tag` - Определяемый пользователем тег
`[]` (по умолчанию) | любой тип данных |...

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

`Id` - Уникальный идентификатор
скаляр

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

Уникальный идентификатор, заданный как целочисленный скаляр. Используйте это свойство, чтобы отличить аннотацию от других объектов в модели. Значение этого свойства переназначается каждый раз, когда вы запускаете новый сеанс работы с 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');

См. также

Stateflow.Box | Stateflow.Chart | Stateflow.Function | Stateflow.State

Темы

Введенный в R2017b

Документация

Stateflow.Annotation

Описание

Создание

Синтаксис

Описание

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

parent - Родительский элемент для новой аннотации Stateflow.Chart | объекта Stateflow.State | объекта Stateflow.Box | объекта Stateflow.Function объект

Свойства

Содержимое

Text - Текст для аннотации '?' (по умолчанию) | вектор символов

Alignment - Выравнивание текста 'LEFT' (по умолчанию) | 'CENTER' | 'RIGHT'

Interpretation - Формат текста 'OFF' (по умолчанию) | 'RICH' | 'TEX'

PlainText - Текст без форматирования вектор символов

IsImage - Содержит ли аннотация изображение false или 0 (по умолчанию) | true или 1

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

Position - Положение и размер аннотации [0 0 8 16] (по умолчанию) | [left top width height]

InternalMargins - Пространство между текстом и границей аннотации [0 0 0 0] (по умолчанию) | [left top right bottom]

DropShadow - Отображать ли тень вокруг аннотации false или 0 (по умолчанию) | true или 1

FixedHeight - Фиксировать ли высоту аннотации false или 0 (по умолчанию) | true или 1

FixedWidth - Фиксировать ли ширину аннотации false или 0 (по умолчанию) | true или 1

BackgroundColor - Цвет фона [1 1 1] (по умолчанию) | [red green blue]

ForegroundColor - Цвет переднего плана [0 0 0] (по умолчанию) | [red green blue]

AutoBackgroundColor - Использовать ли цвет фона по умолчанию true или 1 (по умолчанию) | false или 0

AutoForegroundColor - Использовать ли цвет переднего плана по умолчанию true или 1 (по умолчанию) | false или 0

Font.Angle - Угол шрифта 'NORMAL' (по умолчанию) | 'ITALIC'

Font.Weight - Толщина шрифта 'NORMAL' (по умолчанию) | 'BOLD'

Font.Size - Размер шрифта скаляр

Font.Name - Название шрифта 'Helvetica' (по умолчанию) | вектор символов

Коллбэки

ClickFcn - Коллбэк по клику '' (по умолчанию) | вектор символов

LoadFcn - Коллбэк при нагрузке модели '' (по умолчанию) | вектор символов

DeleteFcn - Коллбэк при удалении '' (по умолчанию) | вектор символов

UseDisplayTextAsClickCallback - Использовать ли текст аннотации в качестве коллбэка false или 0 (по умолчанию) | true или 1

Иерархия

Chart - График, содержащая аннотацию Stateflow.Chart объект

Subviewer - Подсредство просмотра для аннотации Stateflow.Chart | объекта Stateflow.State | объекта Stateflow.Box | объекта Stateflow.Function объект

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

Path - Расположение родительского элемента в иерархии модели вектор символов

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

Description - Описание '' (по умолчанию) | вектор символов

Document - Ссылка на документ '' (по умолчанию) | вектор символов

Tag - Определяемый пользователем тег [] (по умолчанию) | любой тип данных |...

Id - Уникальный идентификатор скаляр

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

Примеры

Добавление текстовой аннотации к диаграмме

Добавление аннотации изображения к диаграмме

См. также

Темы

Документация Stateflow

Поддержка

`parent` - Родительский элемент для новой аннотации
`Stateflow.Chart` | объекта `Stateflow.State` | объекта `Stateflow.Box` | объекта `Stateflow.Function` объект

`Text` - Текст для аннотации
`'?'` (по умолчанию) | вектор символов

`Alignment` - Выравнивание текста
`'LEFT'` (по умолчанию) | `'CENTER'` | `'RIGHT'`

`Interpretation` - Формат текста
`'OFF'` (по умолчанию) | `'RICH'` | `'TEX'`

`PlainText` - Текст без форматирования
вектор символов

`IsImage` - Содержит ли аннотация изображение
`false` или 0 (по умолчанию) | `true` или 1

`Position` - Положение и размер аннотации
`[0 0 8 16]` (по умолчанию) | `[left top width height]`

`InternalMargins` - Пространство между текстом и границей аннотации
`[0 0 0 0]` (по умолчанию) | `[left top right bottom]`

`DropShadow` - Отображать ли тень вокруг аннотации
`false` или 0 (по умолчанию) | `true` или 1

`FixedHeight` - Фиксировать ли высоту аннотации
`false` или 0 (по умолчанию) | `true` или 1

`FixedWidth` - Фиксировать ли ширину аннотации
`false` или 0 (по умолчанию) | `true` или 1

`BackgroundColor` - Цвет фона
`[1 1 1]` (по умолчанию) | `[red green blue]`

`ForegroundColor` - Цвет переднего плана
`[0 0 0]` (по умолчанию) | `[red green blue]`

`AutoBackgroundColor` - Использовать ли цвет фона по умолчанию
`true` или 1 (по умолчанию) | `false` или 0

`AutoForegroundColor` - Использовать ли цвет переднего плана по умолчанию
`true` или 1 (по умолчанию) | `false` или 0

`Font.Angle` - Угол шрифта
`'NORMAL'` (по умолчанию) | `'ITALIC'`

`Font.Weight` - Толщина шрифта
`'NORMAL'` (по умолчанию) | `'BOLD'`

`Font.Size` - Размер шрифта
скаляр

`Font.Name` - Название шрифта
`'Helvetica'` (по умолчанию) | вектор символов

`ClickFcn` - Коллбэк по клику
`''` (по умолчанию) | вектор символов

`LoadFcn` - Коллбэк при нагрузке модели
`''` (по умолчанию) | вектор символов

`DeleteFcn` - Коллбэк при удалении
`''` (по умолчанию) | вектор символов

`UseDisplayTextAsClickCallback` - Использовать ли текст аннотации в качестве коллбэка
`false` или 0 (по умолчанию) | `true` или 1

`Chart` - График, содержащая аннотацию
`Stateflow.Chart` объект

`Subviewer` - Подсредство просмотра для аннотации
`Stateflow.Chart` | объекта `Stateflow.State` | объекта `Stateflow.Box` | объекта `Stateflow.Function` объект

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

`Path` - Расположение родительского элемента в иерархии модели
вектор символов

`Description` - Описание
`''` (по умолчанию) | вектор символов

`Document` - Ссылка на документ
`''` (по умолчанию) | вектор символов

`Tag` - Определяемый пользователем тег
`[]` (по умолчанию) | любой тип данных |...

`Id` - Уникальный идентификатор
скаляр