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 ложь). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом можно использовать значение этого свойства как логическое значение. Значение хранится как логическое значение включения - выключения типа OnOffSwitchState.

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

  • 'off' — Удалите выбор из аннотации.

Типы данных: логический | char | string

Текст

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

То же самое как Text.

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

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

То же самое как Name.

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

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

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

  • 'on' — Представьте разметку TeX.

  • 'off' — Не представляйте разметку TeX.

Опция, чтобы сделать аннотацию разметки в виде 'model' или 'markup'.

Примечание

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

Шрифт

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

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

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

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

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

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

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

Символьная толщина в виде одного из перечисленных в таблице значений.

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

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

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

ЗначениеОписание
'auto' Угол стандартного шрифта задан для аннотаций в диалоговом окне Font Styles. Чтобы открыть диалоговое окно Font Styles, на вкладке 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]' где rG, и b красные, зеленые, и синие значения цвета, нормированного к области значений 0.0 к 1.0.Полностью непрозрачный пользовательский цвет

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

Основной цвет аннотации в виде одного из значений перечислен в этой таблице.

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

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

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

  • 'on' — Отобразите падающую тень.

  • 'off' — Не отображайте падающую тень.

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

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

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

  • 'off' — Аннотация автоматически изменяет размер, чтобы вместить текстовые изменения.

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

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

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

Верхняя часть аннотации остается фиксированной, когда аннотация растет или уменьшается.

'middle'

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

'bottom'

Нижняя часть аннотации остается фиксированной, когда аннотация растет или уменьшается.

'cap'

Не рекомендуемый.

'baseline'

Не рекомендуемый.

Зависимости

Включить VerticalAlignment, установите FixedHeight к 'off'.

Опция, чтобы управлять шириной аннотации в виде 'on' или 'off', или числовой или логический 1 TRUE) или 0 ложь). Значение '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® холст перед любым изменением размеров холста. Положительные значения справа от и вниз от источника. Отрицательные величины слева от и от источника. Поддерживаемые координаты между-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, который выполняется, когда вы кликаете по аннотации в виде вектора символов или строкового скаляра.

Для получения дополнительной информации смотрите Партнера Нажимать Function с Аннотацией.

Зависимости

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

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

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

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

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

Для получения дополнительной информации смотрите Партнера Нажимать Function с Аннотацией.

Код 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
Для просмотра документации необходимо авторизоваться на сайте