Создание и определение свойств аннотаций к тексту, изображению и областям
Аннотации являются визуальными элементами, которые можно использовать, чтобы добавить описательные примечания и выноски к модели. Вы можете программно получить доступ и изменить их как Simulink.Annotation
объекты.
создает аннотацию со свойствами, заданными с помощью пар "имя-значение". Для примера, a
= Simulink.Annotation(path
,Name,Value
)Simulink.Annotation('model/annotation','BackgroundColor','yellow')
создает аннотацию с желтым фоном. Можно задать несколько пары "имя-значение". Заключайте каждое имя свойства в кавычки.
sys
- Система или подсистема, содержащая аннотациюСистема или подсистема, содержащие аннотацию, заданную в виде вектора символов или строкового скаляра.
Типы данных: char
| string
name
- Имя новой аннотацииИмя новой аннотации, заданное как вектор символов.
Типы данных: char
path
- Путь к новой аннотацииПуть к новой аннотации, заданный как вектор символов или строковый скаляр, состоящий из имени системы и имени аннотации.
Пример: Simulink.Annotation('model/annotation')
Типы данных: char
| string
Selected
- Опция выбора аннотации'off'
(по умолчанию) | логическое значение включения/выключенияОпция для выбора или отмены выбора аннотации, заданная как 'on'
или 'off'
, или числовой или логический 1
(true
) или 0
(false
). Значение 'on'
эквивалентно true
, и 'off'
эквивалентно false
. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа OnOffSwitchState
.
'on'
- Выберите аннотацию.
'off'
- Удалить выделение из аннотации.
Типы данных: logical
| char
| string
Name
- Текст аннотацииТекст аннотации, заданный как вектор символов или строковый скаляр.
То же, что и Text
.
Типы данных: char
| string
Text
- Текст аннотацииТекст аннотации, заданный как вектор символов или строковый скаляр.
То же, что и Name
.
Типы данных: char
| string
Interpreter
- Опция форматирования стиля текста'off'
(по умолчанию) | 'rich'
| 'tex'
Опция форматирования стиля текста, заданная как 'off'
для простого текста, 'rich'
для форматированного текста или 'tex'
для текста, который содержит команды LaTeX. При форматировании аннотации обычного текста с помощью панели инструментов форматирования аннотация становится аннотацией форматированного текста.
TeXMode
- Опция визуализации разметки TeX'off'
(по умолчанию) | логическое значение включения/выключенияОпция визуализации разметки TeX, заданная как 'on'
или 'off'
, или числовой или логический 1
(true
) или 0
(false
). Значение 'on'
эквивалентно true
, и 'off'
эквивалентно false
. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа OnOffSwitchState
.
'on'
- Визуализация разметки TeX.
'off'
- Не отображать разметку TeX.
MarkupType
- Опция для создания аннотации разметки'model'
(по умолчанию) | 'markup'
Опция для создания аннотации разметки, заданная как 'model'
или 'markup'
.
Примечание
Установите 'ShowMarkup'
моделировать параметр в 'on'
для отображения аннотаций или 'off'
разметки чтобы скрыть аннотации разметки.
FontName
- Название шрифта'auto'
(по умолчанию) | символьный вектор | строковый скалярЭто свойство влияет только на аннотации простого текста.
Название шрифта, заданное как вектор символов или строковый скаляр. Значение по умолчанию, 'auto'
, использует шрифт по умолчанию, заданный для аннотаций в диалоговом окне Стилей шрифта. Чтобы открыть диалоговое окно Стилей шрифта, на вкладке Format, нажмите кнопку Font Properties стрелы, а затем нажмите Fonts for Model.
Типы данных: char
| string
FontSize
- Размер шрифта, в точках-1
(по умолчанию) | числовой скалярЭто свойство влияет только на аннотации простого текста.
Размер шрифта, в точках, задается как числовой скаляр. Значение по умолчанию, -1
, использует размер шрифта по умолчанию для аннотаций, заданных в диалоговом окне Стилей шрифта. Чтобы открыть диалоговое окно Стилей шрифта, на вкладке Format, нажмите кнопку Font Properties стрелы, а затем нажмите Fonts for Model.
Типы данных: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
FontWeight
- Толщина символов'auto'
(по умолчанию) | 'normal'
| 'bold'
| 'light'
| 'demi'
Это свойство влияет только на аннотации простого текста.
Толщина символов, заданная как одно из значений, перечисленных в таблице.
Значение | Описание |
---|---|
'auto'
| Значение веса по умолчанию для аннотаций, заданное в диалоговом окне Стилей шрифта. Чтобы открыть диалоговое окно Стилей шрифта, на вкладке Format, нажмите кнопку Font Properties стрелы, а затем нажмите Fonts for Model. |
'normal' | Нормальная толщина шрифта. |
'bold' | Полужирный шрифт. |
'light' | Не рекомендуется. |
'demi' | Не рекомендуется. |
FontAngle
- Угол шрифта аннотации'auto'
(по умолчанию) | 'normal'
| 'italic'
| 'oblique'
Это свойство влияет только на аннотации простого текста.
Угол шрифта аннотации, заданный как одно из значений, перечисленных в таблице.
Значение | Описание |
---|---|
'auto'
| Угол шрифта по умолчанию, заданный для аннотаций в диалоговом окне Стилей шрифта. Чтобы открыть диалоговое окно Стилей шрифта, на вкладке Format, нажмите кнопку Font Properties стрелы, а затем нажмите Fonts for Model. |
'normal' | Обычный шрифт. |
'italic' | Курсивный шрифт. |
'oblique' | Косой шрифт (обычно тот же, что и италический шрифт). |
BackgroundColor
- Цвет фона аннотации'white'
(по умолчанию) | массив значений RGB | 'automatic'
(прозрачный) | 'black'
| 'red'
| 'green'
| 'blue'
| ...Цвет фона аннотации, заданный как одно из значений, перечисленных в этой таблице.
Значение | Описание |
---|---|
'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
ForegroundColor
- Цвет аннотации переднего плана'black'
(по умолчанию) | массив значений RGB | 'white'
| 'red'
| 'green'
| 'blue'
| ...Цвет аннотации переднего плана, заданный как одно из значений, перечисленных в этой таблице.
Значение | Описание |
---|---|
'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
DropShadow
- Опция отображения отбрасываемой тени'off'
(по умолчанию) | логическое значение включения/выключенияОпция отображения отбрасываемой тени, заданная как 'on'
или 'off'
, или числовой или логический 1
(true
) или 0
(false
). Значение 'on'
эквивалентно true
, и 'off'
эквивалентно false
. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа OnOffSwitchState
.
'on'
- Отобразите отбрасываемую тень.
'off'
- Не отображать отбрасываемую тень.
FixedHeight
- Опция управления высотой аннотации'off'
(по умолчанию) | логическое значение включения/выключенияОпция для управления высотой аннотации, заданная как 'on'
или 'off'
, или числовой или логический 1
(true
) или 0
(false
). Значение 'on'
эквивалентно true
, и 'off'
эквивалентно false
. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа OnOffSwitchState
.
'on'
- Размер аннотации не изменяется для изменения текста. Видимый текст может быть усечен.
'off'
- Размер аннотации автоматически изменяется с учетом изменений текста.
Интерактивное изменение размера аннотации устанавливает этот параметр равным 'on'
.
VerticalAlignment
- Вертикальная якорная точка аннотации'top'
(по умолчанию) | 'middle'
| 'bottom'
| 'cap'
| 'baseline'
Вертикальная опорная точка аннотации, заданная как одно из значений, перечисленных в этой таблице.
Значение | Описание |
---|---|
'top' | Верхняя часть аннотации остается фиксированной при увеличении или сокращении аннотации. |
'middle' | Середина аннотации остается фиксированной при увеличении или сокращении аннотации. |
'bottom' | Нижняя часть аннотации остается фиксированной при увеличении или сокращении аннотации. |
'cap' | Не рекомендуется. |
'baseline' | Не рекомендуется. |
Чтобы включить VerticalAlignment
, задать FixedHeight
на 'off'
.
FixedWidth
- Опция управления шириной аннотации'off'
(по умолчанию) | логическое значение включения/выключенияОпция для управления шириной аннотации, заданная как 'on'
или 'off'
, или числовой или логический 1
(true
) или 0
(false
). Значение 'on'
эквивалентно true
, и 'off'
эквивалентно false
. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа OnOffSwitchState
.
'on'
- Размер аннотации не изменяется для изменения текста. Когда текст не помещается внутри границ аннотации, он переносится на следующую линию.
'off'
- Размер аннотации автоматически изменяется с учетом изменений текста.
Интерактивное изменение размера аннотации устанавливает этот параметр равным 'on'
.
HorizontalAlignment
- Горизонтальное выравнивание текста в аннотации'left'
(по умолчанию) | 'center'
| 'right'
Горизонтальное выравнивание текста в аннотации в виде одного из значений, перечисленных в таблице.
Значение | Результат |
---|---|
'left' | Текст в аннотации остается выровненным. |
'center' | Текст в аннотации имеет центр. |
'right' | Текст в аннотации обоснован правильно. |
InternalMargins
- Пространство между ограничивающим прямоугольником и границами[0 0 0 0]
(по умолчанию) | массив 1x4Пространство между ограничивающим прямоугольником текста и границами аннотации, заданное как массив 1x4. Массив предоставляет пространство между текстом и каждой стороной аннотации. Элементы массива задают пространство с левой, верхней, правой и нижней сторон по порядку ([left top right bottom]
).
Поддерживаемые координаты находятся между -1073740824 и 1073740823 включительно.
Типы данных: double
Position
- Расположение аннотации[0 0 28 14]
(по умолчанию) | массив 1x4Расположение аннотации, заданное как массив 1x4. Массив содержит положения сторон аннотации в пикселях. Элементы массива задают местоположения левой, верхней, правой и нижней сторон по порядку ([left top right bottom]
).
Этот источник является верхним левым углом Simulink® Холст редактора перед любым изменением размера холста. Положительные значения расположены справа от начала координат и вниз от него. Отрицательные значения - слева и вверх от источника. Поддерживаемые координаты находятся между -1073740824 и 1073740823 включительно.
Чтобы программно переместить положение правой стороны, не перемещая левую сторону на ту же величину, FixedWidth
должно быть установлено в 'on'
.
Чтобы программно переместить положение нижней стороны, не перемещая верхнюю сторону на ту же величину, FixedHeight
должно быть установлено в 'on'
.
Типы данных: double
Description
- Описание аннотацииОписание аннотации, заданное как вектор символов или строковый скаляр.
Типы данных: char
| string
Tag
- Текстовый тег для аннотацииТег для аннотации, заданный как вектор символов или строковый скаляр.
Типы данных: char
| string
UserData
- Данные для связи с аннотациейДанные для связи с аннотацией.
Типы данных: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| logical
| char
| string
| struct
| table
| cell
| function_handle
| categorical
| datetime
| duration
| calendarDuration
| fi
ClickFcn
- MATLAB® код, который выполняется при нажатии аннотацииКод MATLAB, который выполняется при нажатии аннотации, задается как вектор символов или строковый скаляр.
Для получения дополнительной информации смотрите Сделать аннотации интерактивными.
Когда UseDisplayTextAsClickCallback
установлено в 'on'
, а ClickFcn
значение соответствует Name
и Text
значение.
Типы данных: char
| string
UseDisplayTextAsClickCallback
- Опция использовать текст как функцию нажатия кнопки'off'
(по умолчанию) | логическое значение включения/выключенияОпция использовать текст как функцию click, заданную как 'on'
или 'off'
, или числовой или логический 1
(true
) или 0
(false
). Значение 'on'
эквивалентно true
, и 'off'
эквивалентно false
. Таким образом, можно использовать значение этого свойства как логическое значение. Значение сохранено в виде логического значения on/off типа OnOffSwitchState
.
'on'
- При нажатии аннотации запускается текст аннотации, заданный как Text
, которое интерпретируется как допустимое выражение MATLAB.
'off'
- Нажатие аннотации запускает функцию, заданную ClickFcn
, при наличии. Если функция click не задана, то при нажатии аннотации функция не запускается.
Для получения дополнительной информации смотрите Сделать аннотации интерактивными.
LoadFcn
- код MATLAB, который должен выполняться, когда модель содержит нагрузки аннотацииКод MATLAB для выполнения, когда загружена модель, содержащая аннотацию, заданная как вектор символов или строковый скаляр. Для получения дополнительной информации смотрите Сделать аннотации интерактивными.
Типы данных: char
| string
DeleteFcn
- Код MATLAB, который будет выполнен перед программным удалением аннотацииКод MATLAB для выполнения перед программным удалением аннотации, заданный как вектор символов или строковый скаляр.
Для получения дополнительной информации смотрите Сделать аннотации интерактивными.
Типы данных: char
| string
Type
- Тип аннотации'annotation'
(по умолчанию)Это свойство доступно только для чтения.
Тип аннотации, возвращенный как 'annotation'
.
AnnotationType
- Тип аннотации'note_annotation'
| 'area_annotation'
| 'image_annotation'
Это свойство доступно только для чтения.
Тип аннотации, заданный как 'note_annotation'
для текстового примечания, 'area_annotation'
для области, или 'image_annotation'
для изображения.
Для программного создания области смотрите Создание области программно.
Для программного создания аннотации только для изображений смотрите setImage
.
IsImage
- Проверить, является ли аннотация аннотацией только для изображений'off'
(по умолчанию) | 'on'
Это свойство доступно только для чтения.
Проверить, является ли аннотация аннотацией только для изображений, можно следующим образом 'on'
или 'off'
.
PlainText
- Текст в аннотацииЭто свойство доступно только для чтения.
Текст в аннотации, без форматирования, возвращается как вектор.
Handle
- Указатель на аннотациюЭто свойство доступно только для чтения.
Указатель на аннотацию, возвращенный как двойной.
Parent
- Система, содержащая аннотациюЭто свойство доступно только для чтения.
Система, содержащая аннотацию, возвращенная как вектор символов.
Path
- Путь к аннотацииЭто свойство доступно только для чтения.
Путь к аннотации, возвращенный как вектор символов.
Программно создавайте, изменяйте и просматривайте аннотацию.
Откройте новую модель.
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])
создает аннотацию области в заданном положении.
Для интерактивного создания аннотации и редактирования ее свойств смотрите Описание моделей с помощью примечаний и аннотаций.
У вас есть измененная версия этого примера. Вы хотите открыть этот пример с вашими правками?
1. Если смысл перевода понятен, то лучше оставьте как есть и не придирайтесь к словам, синонимам и тому подобному. О вкусах не спорим.
2. Не дополняйте перевод комментариями “от себя”. В исправлении не должно появляться дополнительных смыслов и комментариев, отсутствующих в оригинале. Такие правки не получится интегрировать в алгоритме автоматического перевода.
3. Сохраняйте структуру оригинального текста - например, не разбивайте одно предложение на два.
4. Не имеет смысла однотипное исправление перевода какого-то термина во всех предложениях. Исправляйте только в одном месте. Когда Вашу правку одобрят, это исправление будет алгоритмически распространено и на другие части документации.
5. По иным вопросам, например если надо исправить заблокированное для перевода слово, обратитесь к редакторам через форму технической поддержки.