주요 콘텐츠

Simulink.Annotation

텍스트 주석, 이미지 주석, 영역 주석을 만들고 속성 지정

설명

주석은 모델에 설명 노트와 메모를 추가하는 데 사용할 수 있는 시각적 요소입니다. Simulink.Annotation 객체를 통해 프로그래밍 방식으로 주석에 액세스하고 주석을 수정할 수 있습니다.

기존 Simulink.Annotation 객체를 가져오려면 주석을 선택합니다. 그런 다음 getCurrentAnnotation 함수를 사용합니다.

생성

여러 가지 방법으로 Simulink.Annotation 객체를 만들 수 있습니다.

  • Annotation 객체를 프로그래밍 방식으로 만들려면 이 페이지에서 설명한 Simulink.Annotation 함수를 사용하십시오.

  • Annotation 객체를 대화형 방식으로 만들려면 Annotate Models 항목을 참조하십시오.

설명

a = Simulink.Annotation(sys,name)은 지정된 시스템이나 서브시스템에서 지정된 이름과 디폴트 속성을 갖는 주석을 만듭니다.

예제

a = Simulink.Annotation(path,Name,Value)는 이름-값 쌍을 사용하여 지정된 속성을 갖는 주석을 만듭니다. 예를 들어 Simulink.Annotation('model/annotation','BackgroundColor','yellow')는 배경이 노란색인 주석을 만듭니다. 여러 개의 이름-값 쌍을 지정할 수 있습니다. 각 속성 이름을 따옴표로 묶습니다.

예제

입력 인수

모두 확장

주석을 포함할 시스템 또는 서브시스템으로, 문자형 벡터 또는 string형 스칼라로 지정됩니다.

데이터형: char | string

새 주석의 이름으로, 문자형 벡터로 지정됩니다.

데이터형: char

새 주석의 경로로, 시스템 이름과 주석 이름으로 구성된 문자형 벡터 또는 string형 스칼라로 지정됩니다.

예: Simulink.Annotation('model/annotation')

데이터형: char | string

속성

모두 확장

상호 작용

주석을 선택하거나 선택 취소하는 옵션으로, 'on' 또는 'off', 혹은 숫자형 또는 논리값 1(true) 또는 0(false)으로 지정됩니다. 'on' 값은 true와 동일하고, 'off' 값은 false와 동일합니다. 따라서 이 속성의 값을 논리값으로 사용할 수 있습니다. 값은 OnOffSwitchState 유형의 on/off 논리값으로 저장됩니다.

  • 'on' — 주석을 선택합니다.

  • 'off' — 주석에서 선택을 제거합니다.

데이터형: logical | char | string

텍스트

주석의 텍스트로, 문자형 벡터 또는 string형 스칼라로 지정됩니다.

Text와 동일합니다.

데이터형: char | string

주석의 텍스트로, 문자형 벡터 또는 string형 스칼라로 지정됩니다.

Name과 동일합니다.

데이터형: char | string

텍스트 스타일 서식을 지정하는 옵션으로, 일반 텍스트의 경우 'off', 서식 있는 텍스트의 경우 'rich', LaTeX 명령이 포함된 텍스트의 경우 'tex'로 지정됩니다. 서식 지정 도구 모음을 사용하여 일반 텍스트 주석의 서식을 지정하면 주석이 서식 있는 텍스트 주석이 됩니다.

TeX 마크업을 렌더링하는 옵션으로, 'on' 또는 'off', 혹은 숫자형 또는 논리값 1(true) 또는 0(false)으로 지정됩니다. 'on' 값은 true와 동일하고, 'off' 값은 false와 동일합니다. 따라서 이 속성의 값을 논리값으로 사용할 수 있습니다. 값은 OnOffSwitchState 유형의 on/off 논리값으로 저장됩니다.

  • 'on' — TeX 마크업을 렌더링합니다.

  • 'off' —TeX 마크업을 렌더링하지 않습니다.

마크업 주석을 만드는 옵션으로, 'model' 또는 'markup'으로 지정됩니다.

참고

마크업 주석을 표시하려면 'ShowMarkup' 모델 파라미터를 'on'으로 설정하고, 마크업 주석을 숨기려면 'off'로 설정하십시오.

글꼴

이 속성은 일반 텍스트 주석에만 영향을 줍니다.

글꼴 이름으로, 문자형 벡터 또는 string형 스칼라로 지정됩니다. 디폴트 값 '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'짙은 녹색
'[r,g,b]'로 지정된 RGB 값 배열. 여기서 r, g, b는 범위 0.0 ~ 1.0으로 정규화된 색의 빨간색, 녹색, 파란색 값입니다.완전히 불투명한 사용자 지정 색

데이터형: char | string

주석의 전경색으로, 다음 표에 나열된 값 중 하나로 지정됩니다.

설명
'black'검은색
'white'흰색
'red'빨간색
'green'녹색
'blue'파란색
'cyan'녹청색
'magenta'자홍색
'yellow'노란색
'gray'회색
'lightBlue'연한 파란색
'orange'주황색
'darkGreen'짙은 녹색
'[r,g,b]'로 지정된 RGB 값 배열. 여기서 r, g, b는 범위 0.0 ~ 1.0으로 정규화된 색의 빨간색, 녹색, 파란색 값입니다.완전히 불투명한 사용자 지정 색

데이터형: char | string

그림자 효과를 표시하는 옵션으로, 'on' 또는 'off', 혹은 숫자형 또는 논리값 1(true) 또는 0(false)으로 지정됩니다. 'on' 값은 true와 동일하고, 'off' 값은 false와 동일합니다. 따라서 이 속성의 값을 논리값으로 사용할 수 있습니다. 값은 OnOffSwitchState 유형의 on/off 논리값으로 저장됩니다.

  • 'on' — 그림자 효과를 표시합니다.

  • 'off' — 그림자 효과를 표시하지 않습니다.

크기 및 위치

주석 높이를 제어하는 옵션으로, 'on' 또는 'off', 혹은 숫자형 또는 논리값 1(true) 또는 0(false)으로 지정됩니다. 'on' 값은 true와 동일하고, 'off' 값은 false와 동일합니다. 따라서 이 속성의 값을 논리값으로 사용할 수 있습니다. 값은 OnOffSwitchState 유형의 on/off 논리값으로 저장됩니다.

  • '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' — 주석의 크기가 텍스트 변경에 따라 조정되지 않습니다. 텍스트가 주석 경계 내에 다 들어가지 않으면 다음 줄로 줄 바꿈됩니다.

  • 'off' — 주석의 크기가 텍스트 변경에 따라 자동으로 조정됩니다.

주석의 크기를 대화형 방식으로 조정하면 이 파라미터가 'on'으로 설정됩니다.

주석 내 텍스트의 가로 정렬로, 표에 나열된 값 중 하나로 지정됩니다.

결과
'left' 주석의 텍스트가 왼쪽 정렬됩니다.
'center'주석의 텍스트가 가운데 정렬됩니다.
'right'주석의 텍스트가 오른쪽 정렬됩니다.

텍스트 경계 상자와 주석 테두리 사이의 여백으로, 1×4 배열로 지정됩니다. 이 배열은 텍스트와 주석의 각 면 사이의 여백을 제공합니다. 배열의 요소는 왼쪽, 위쪽, 오른쪽, 아래쪽 순으로 여백을 지정합니다([left top right bottom]).

지원되는 좌표는 -1073740824와 1073740823 사이(구간의 끝점 포함)입니다.

데이터형: double

주석의 위치로, 1×4 배열로 지정됩니다. 이 배열은 주석 면의 위치를 제공합니다(단위: 픽셀). 배열의 요소는 왼쪽, 위쪽, 오른쪽, 아래쪽 순으로 위치를 지정합니다([left top right bottom]).

원점은 캔버스 크기를 조정하지 않은 상태에서 Simulink® 편집기 캔버스의 왼쪽 상단 코너입니다. 양수 값은 원점에서 오른쪽, 아래쪽입니다. 음수 값은 원점에서 왼쪽, 위쪽입니다. 지원되는 좌표는 -1073740824와 1073740823 사이(구간의 끝점 포함)입니다.

종속성

  • 왼쪽 면의 위치를 그대로 두고 오른쪽 면의 위치만 프로그래밍 방식으로 옮기려면 FixedWidth'on'으로 설정해야 합니다.

  • 위쪽 면의 위치를 그대로 두고 아래쪽 면의 위치만 프로그래밍 방식으로 옮기려면 FixedHeight'on'으로 설정해야 합니다.

데이터형: double

메타데이터

주석에 대한 설명으로, 문자형 벡터 또는 string형 스칼라로 지정됩니다.

데이터형: char | string

주석에 대한 텍스트 태그로, 문자형 벡터 또는 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 코드로, 문자형 벡터 또는 string형 스칼라로 지정됩니다.

자세한 내용은 Add Hyperlinks to Annotations 항목을 참조하십시오.

종속성

UseDisplayTextAsClickCallback'on'으로 설정된 경우 ClickFcn 값은 NameText 값과 매칭됩니다.

데이터형: char | string

텍스트를 클릭 함수로 사용하는 옵션으로, 'on' 또는 'off', 혹은 숫자형 또는 논리값 1(true) 또는 0(false)으로 지정됩니다. 'on' 값은 true와 동일하고, 'off' 값은 false와 동일합니다. 따라서 이 속성의 값을 논리값으로 사용할 수 있습니다. 값은 OnOffSwitchState 유형의 on/off 논리값으로 저장됩니다.

  • 'on' — 주석을 클릭하면 Text로 지정된 주석 텍스트가 유효한 MATLAB 표현식으로 해석되어 실행됩니다.

  • 'off' — 주석을 클릭하면 ClickFcn으로 지정된 함수(사용 가능한 경우)가 실행됩니다. 클릭 함수가 지정되지 않으면 주석을 클릭해도 함수가 실행되지 않습니다.

자세한 내용은 Add Hyperlinks to Annotations 항목을 참조하십시오.

주석이 포함된 모델을 불러올 때 실행할 MATLAB 코드로, 문자형 벡터 또는 string형 스칼라로 지정됩니다. 자세한 내용은 Add Hyperlinks to Annotations 항목을 참조하십시오.

데이터형: char | string

프로그래밍 방식으로 주석을 삭제하기 전에 실행할 MATLAB 코드로, 문자형 벡터 또는 string형 스칼라로 지정됩니다.

자세한 내용은 Add Hyperlinks to Annotations 항목을 참조하십시오.

데이터형: char | string

정보(읽기 전용)

읽기 전용 속성입니다.

주석 유형으로, 'annotation'으로 반환됩니다.

읽기 전용 속성입니다.

주석의 유형으로, 텍스트 기반 참고 사항의 경우 'note_annotation', 영역의 경우 'area_annotation', 이미지의 경우 'image_annotation'으로 지정됩니다.

프로그래밍 방식으로 영역을 만들려면 Create Area 항목을 참조하십시오.

프로그래밍 방식으로 이미지만 있는 주석을 만들려면 setImage 항목을 참조하십시오.

읽기 전용 속성입니다.

주석이 이미지만 있는 주석인지 확인하며, 'on' 또는 'off'로 반환됩니다.

읽기 전용 속성입니다.

서식이 지정되지 않은 주석 내 텍스트로, 벡터로 반환됩니다.

읽기 전용 속성입니다.

주석 핸들로, double형으로 반환됩니다.

읽기 전용 속성입니다.

주석을 포함하는 시스템으로, 문자형 벡터로 지정됩니다.

읽기 전용 속성입니다.

주석 경로로, 문자형 벡터로 반환됩니다.

객체 함수

view주석 찾기
setImageSpecify image to display as annotation
delete주석 삭제

예제

모두 축소

이 예제에서는 프로그래밍 방식으로 주석을 만들고, 수정하고, 보는 방법을 보여줍니다.

새 모델을 엽니다.

open_system(new_system)

Simulink.Annotation 함수를 사용하여 디폴트 속성을 갖는 주석을 만듭니다.

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

Annotation with the text "This is an annotation"

주석을 만든 후 점 표기법을 사용하여 속성값을 설정합니다. 예를 들어 주석에 18포인트 글꼴과 노란색 배경을 적용합니다.

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

새 주석을 표시하고 잠시 강조 표시하려면 view 함수를 사용하십시오.

view(a)

The annotation with the text "This is an annotation" is highlighted in yellow.

CreateAnnotationModel이라는 이름의 새 모델을 만들고 엽니다.

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])은 지정된 위치에 영역 주석을 만듭니다.

대화형 방식으로 주석을 만들고 속성을 편집하려면 Annotate Models 항목을 참조하십시오.

버전 내역

R2006a 이전에 개발됨