Simulink.Annotation

Создание и определение свойств аннотаций к тексту, изображению и областям

Описание

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

Создание

Описание

пример

a = Simulink.Annotation(sys,name) создает аннотацию с заданным именем и свойствами по умолчанию в указанной системе или подсистеме.

пример

a = Simulink.Annotation(path,Name,Value) создает аннотацию со свойствами, заданными с помощью пар "имя-значение". Для примера, Simulink.Annotation('model/annotation','BackgroundColor','yellow') создает аннотацию с желтым фоном. Можно задать несколько пары "имя-значение". Заключайте каждое имя свойства в кавычки.

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

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

Система или подсистема, содержащие аннотацию, заданную в виде вектора символов или строкового скаляра.

Типы данных: char | string

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

Типы данных: char

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

Пример: Simulink.Annotation('model/annotation')

Типы данных: char | string

Свойства

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

Участие

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

  • 'on' - Выберите аннотацию.

  • 'off' - Удалить выделение из аннотации.

Типы данных: logical | char | string

Текст

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

То же, что и Text.

Типы данных: char | string

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

То же, что и Name.

Типы данных: char | string

Опция форматирования стиля текста, заданная как 'off' для простого текста, 'rich' для форматированного текста или 'tex' для текста, который содержит команды LaTeX. При форматировании аннотации обычного текста с помощью панели инструментов форматирования аннотация становится аннотацией форматированного текста.

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

  • 'on' - Визуализация разметки TeX.

  • 'off' - Не отображать разметку TeX.

Опция для создания аннотации разметки, заданная как 'model' или 'markup'.

Примечание

Установите 'ShowMarkup' моделировать параметр в 'on' для отображения аннотаций или 'off' разметки чтобы скрыть аннотации разметки.

Шрифт

Это свойство влияет только на аннотации простого текста.

Название шрифта, заданное как вектор символов или строковый скаляр. Значение по умолчанию, 'auto', использует шрифт по умолчанию, заданный для аннотаций в диалоговом окне Стилей шрифта. Чтобы открыть диалоговое окно Стилей шрифта, на вкладке Format, нажмите кнопку Font Properties стрелы, а затем нажмите Fonts for Model.

Типы данных: char | string

Это свойство влияет только на аннотации простого текста.

Размер шрифта, в точках, задается как числовой скаляр. Значение по умолчанию, -1, использует размер шрифта по умолчанию для аннотаций, заданных в диалоговом окне Стилей шрифта. Чтобы открыть диалоговое окно Стилей шрифта, на вкладке Format, нажмите кнопку Font Properties стрелы, а затем нажмите Fonts for Model.

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

Это свойство влияет только на аннотации простого текста.

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

ЗначениеОписание
'auto' Значение веса по умолчанию для аннотаций, заданное в диалоговом окне Стилей шрифта. Чтобы открыть диалоговое окно Стилей шрифта, на вкладке Format, нажмите кнопку Font Properties стрелы, а затем нажмите Fonts for Model.
'normal'Нормальная толщина шрифта.
'bold'Полужирный шрифт.
'light'Не рекомендуется.
'demi'Не рекомендуется.

Это свойство влияет только на аннотации простого текста.

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

ЗначениеОписание
'auto' Угол шрифта по умолчанию, заданный для аннотаций в диалоговом окне Стилей шрифта. Чтобы открыть диалоговое окно Стилей шрифта, на вкладке Format, нажмите кнопку Font Properties стрелы, а затем нажмите Fonts for Model.
'normal'Обычный шрифт.
'italic'Курсивный шрифт.
'oblique'Косой шрифт (обычно тот же, что и италический шрифт).

Цвета и эффекты

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

ЗначениеОписание
'automatic'Прозрачный
'black'Черный
'white'Белый
'red'Красный
'green'Зеленый
'blue'Синий
'cyan'Голубой
'magenta'Пурпурный
'yellow'Желтый
'gray'Серый
'lightBlue'Светло-синий
'orange'Оранжевый
'darkGreen'Темно-зеленый
Массив значений RGB, заданный как '[r,g,b]' где r, g, и b красные, зеленые и синие значения цвета нормированы к области значений 0.0 на 1.0.Полностью непрозрачный пользовательский цвет

Типы данных: char | string

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

ЗначениеОписание
'black'Черный
'white'Белый
'red'Красный
'green'Зеленый
'blue'Синий
'cyan'Голубой
'magenta'Пурпурный
'yellow'Желтый
'gray'Серый
'lightBlue'Светло-синий
'orange'Оранжевый
'darkGreen'Темно-зеленый
Массив значений RGB, заданный как '[r,g,b]' где r, g, и b красные, зеленые и синие значения цвета нормированы к области значений 0.0 на 1.0.Полностью непрозрачный пользовательский цвет

Типы данных: char | string

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

  • 'on' - Отобразите отбрасываемую тень.

  • 'off' - Не отображать отбрасываемую тень.

Размер и положение

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

  • 'on' - Размер аннотации не изменяется для изменения текста. Видимый текст может быть усечен.

  • 'off' - Размер аннотации автоматически изменяется с учетом изменений текста.

Интерактивное изменение размера аннотации устанавливает этот параметр равным 'on'.

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

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

Верхняя часть аннотации остается фиксированной при увеличении или сокращении аннотации.

'middle'

Середина аннотации остается фиксированной при увеличении или сокращении аннотации.

'bottom'

Нижняя часть аннотации остается фиксированной при увеличении или сокращении аннотации.

'cap'

Не рекомендуется.

'baseline'

Не рекомендуется.

Зависимости

Чтобы включить VerticalAlignment, задать FixedHeight на 'off'.

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

  • 'on' - Размер аннотации не изменяется для изменения текста. Когда текст не помещается внутри границ аннотации, он переносится на следующую линию.

  • 'off' - Размер аннотации автоматически изменяется с учетом изменений текста.

Интерактивное изменение размера аннотации устанавливает этот параметр равным 'on'.

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

ЗначениеРезультат
'left' Текст в аннотации остается выровненным.
'center'Текст в аннотации имеет центр.
'right'Текст в аннотации обоснован правильно.

Пространство между ограничивающим прямоугольником текста и границами аннотации, заданное как массив 1x4. Массив предоставляет пространство между текстом и каждой стороной аннотации. Элементы массива задают пространство с левой, верхней, правой и нижней сторон по порядку ([left top right bottom]).

Поддерживаемые координаты находятся между -1073740824 и 1073740823 включительно.

Типы данных: double

Расположение аннотации, заданное как массив 1x4. Массив содержит положения сторон аннотации в пикселях. Элементы массива задают местоположения левой, верхней, правой и нижней сторон по порядку ([left top right bottom]).

Этот источник является верхним левым углом Simulink® Холст редактора перед любым изменением размера холста. Положительные значения расположены справа от начала координат и вниз от него. Отрицательные значения - слева и вверх от источника. Поддерживаемые координаты находятся между -1073740824 и 1073740823 включительно.

Зависимости

  • Чтобы программно переместить положение правой стороны, не перемещая левую сторону на ту же величину, FixedWidth должно быть установлено в 'on'.

  • Чтобы программно переместить положение нижней стороны, не перемещая верхнюю сторону на ту же величину, FixedHeight должно быть установлено в 'on'.

Типы данных: double

Метаданные

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

Типы данных: char | string

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

Типы данных: char | string

Данные для связи с аннотацией.

Типы данных: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | string | struct | table | cell | function_handle | categorical | datetime | duration | calendarDuration | fi

Функции обратного вызова

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

Для получения дополнительной информации смотрите Сделать аннотации интерактивными.

Зависимости

Когда UseDisplayTextAsClickCallback установлено в 'on', а ClickFcn значение соответствует Name и Text значение.

Типы данных: char | string

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

  • 'on' - При нажатии аннотации запускается текст аннотации, заданный как Text, которое интерпретируется как допустимое выражение MATLAB.

  • 'off' - Нажатие аннотации запускает функцию, заданную ClickFcn, при наличии. Если функция click не задана, то при нажатии аннотации функция не запускается.

Для получения дополнительной информации смотрите Сделать аннотации интерактивными.

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

Типы данных: char | string

Код MATLAB для выполнения перед программным удалением аннотации, заданный как вектор символов или строковый скаляр.

Для получения дополнительной информации смотрите Сделать аннотации интерактивными.

Типы данных: char | string

Информация (только для чтения)

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

Тип аннотации, возвращенный как 'annotation'.

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

Тип аннотации, заданный как 'note_annotation' для текстового примечания, 'area_annotation' для области, или 'image_annotation' для изображения.

Для программного создания области смотрите Создание области программно.

Для программного создания аннотации только для изображений смотрите setImage.

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

Проверить, является ли аннотация аннотацией только для изображений, можно следующим образом 'on' или 'off'.

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

Текст в аннотации, без форматирования, возвращается как вектор.

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

Указатель на аннотацию, возвращенный как двойной.

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

Система, содержащая аннотацию, возвращенная как вектор символов.

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

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

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

viewНайти аннотацию
setImageЗадайте изображение для отображения в виде аннотации
deleteУдалить аннотацию

Примеры

свернуть все

Программно создавайте, изменяйте и просматривайте аннотацию.

Откройте новую модель.

open_system(new_system)

Создайте аннотацию со свойствами по умолчанию с помощью Simulink.Annotation функция.

a = Simulink.Annotation(gcs,'This is an annotation.');

После создания аннотации используйте запись через точку для того, чтобы задать значения свойств. Например, примените к аннотации шрифт с 18 точками и светло-синий фон.

a.FontSize = 18;
a.BackgroundColor = 'lightBlue';

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

view(a)

Программно создайте аннотацию с пользовательскими свойствами.

Откройте модель.

new_system('CreateAnnotationModel')
open_system('CreateAnnotationModel')

Создайте аннотацию с пользовательскими свойствами, заданными как разделенные разделенными запятой парами, состоящие из свойства и значения при помощи Simulink.Annotation функция. Например, примените к аннотации шрифт с 18 точками и светло-синий фон.

a = Simulink.Annotation('CreateAnnotationModel/This is an annotation.',...
'FontSize',18,'BackgroundColor','lightblue');

Совет

  • Чтобы программно изменить существующую аннотацию, используйте find_system функцию, чтобы получить указатель на аннотацию, затем используйте get_param функция для получения объекта. Для примера:

    h = find_system(gcs,'FindAll','on','Type','annotation');
    a1 = get_param(h(1),'Object');
  • Если аннотация вызвала выполняющийся в данный момент обратного вызова, используйте getCallbackAnnotation чтобы определить, какая аннотация вызвала его. Функция возвращает соответствующее Annotation объект. Эта функция также полезна, если вы записываете функцию обратного вызова в отдельный файл MATLAB, который содержит несколько обратных вызовов.

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

Вы также можете создавать аннотации, используя add_block функция. Для примера:

  • add_block('built-in/Note','model/This is a note.','BackgroundColor','yellow') создает аннотацию примечания с желтым фоном.

  • add_block('built-in/Area','model/This is an Area.','Position',[120,100,230,200]) создает аннотацию области в заданном положении.

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

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