exponenta event banner

Simulink. Аннотация

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

Описание

Аннотации - это визуальные элементы, которые можно использовать для добавления описательных примечаний и выносок в модель. К ним можно получить программный доступ и изменить их как 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. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл 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. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл OnOffSwitchState.

  • 'on' - Тонировать разметку TeX.

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

Параметр для создания пометки, указанный как 'model' или 'markup'.

Примечание

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

Шрифт

Это свойство влияет только на аннотации обычного текста.

Имя шрифта, указанное как вектор символа или скаляр строки. Значение по умолчанию, 'auto'использует шрифт по умолчанию, заданный для аннотаций в диалоговом окне «Стили шрифтов». Чтобы открыть диалоговое окно «Стили шрифтов», на вкладке «Формат» нажмите кнопку со стрелкой «Свойства шрифта» и выберите «Шрифты для модели».

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

Это свойство влияет только на аннотации обычного текста.

Размер шрифта в точках, указанный как числовой скаляр. Значение по умолчанию, -1использует размер шрифта по умолчанию для аннотаций, заданных в диалоговом окне «Стили шрифтов». Чтобы открыть диалоговое окно «Стили шрифтов», на вкладке «Формат» нажмите кнопку со стрелкой «Свойства шрифта» и выберите «Шрифты для модели».

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

Это свойство влияет только на аннотации обычного текста.

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

СтоимостьОписание
'auto' Вес по умолчанию для аннотаций, указанный в диалоговом окне «Стили шрифтов». Чтобы открыть диалоговое окно «Стили шрифтов», на вкладке «Формат» нажмите кнопку со стрелкой «Свойства шрифта» и выберите «Шрифты для модели».
'normal'Обычный вес шрифта.
'bold'Жирный вес шрифта.
'light'Не рекомендуется.
'demi'Не рекомендуется.

Это свойство влияет только на аннотации обычного текста.

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

СтоимостьОписание
'auto' Угол шрифта по умолчанию, заданный для аннотаций в диалоговом окне «Стили шрифтов». Чтобы открыть диалоговое окно «Стили шрифтов», на вкладке «Формат» нажмите кнопку со стрелкой «Свойства шрифта» и выберите «Шрифты для модели».
'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. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл OnOffSwitchState.

  • 'on' - Отображение тени.

  • 'off' - Не отображать тень.

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

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

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

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

Интерактивное изменение размера аннотации задает для этого параметра значение 'on'.

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

СтоимостьОписание
'top'

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

'middle'

Середина аннотации остается фиксированной по мере роста или сжатия аннотации.

'bottom'

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

'cap'

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

'baseline'

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

Зависимости

Позволить VerticalAlignment, комплект FixedHeight кому 'off'.

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

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

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

Интерактивное изменение размера аннотации задает для этого параметра значение 'on'.

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

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

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

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

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

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

Начало координат - это верхний левый угол холста Simulink ® Editor перед изменением размера холста. Положительные значения находятся справа от начала координат и вниз от него. Отрицательные значения находятся слева от начала координат и вверх от него. Поддерживаемые координаты находятся в диапазоне от -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

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

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

  • 'off' - При щелчке на аннотации запускается функция, указанная в ClickFcn, если доступно. Если функция щелчка не указана, при щелчке аннотации функция не запускается.

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

Код 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