Annotation extends ChartItem
subclasses TextAnnotation
, ImageAnnotation
, ShapeAnnotation
, HtmlAnnotation
Annotation 모델들의 기반 클래스.
옵션
모델은 $1이고,
맵차트 설정
에서 'annotation'
항목으로 설정한다.
const config = {
annotation: [{
type: 'image',
name: 'image1',
}],
};
또, Chart.getAnnotation
으로
모델 객체를 가져올 수 있다.
const annotation = chart.getAnnotation('image1');
annotation.visible = false;
Annotation 개요
페이지를 참조한다.
Properties
name: string
(opens in a new tab) readonly
어노테이션 이름.
동적으로 어노테이션을 다루기 위해서는 반드시 지정해야 한다.
default :undefined
visible: boolean
(opens in a new tab) readonly
표시 여부.
options.visible 값을 그대로 return하는 것이 아니라,
undefined나 null 등으로 지정하는 경우 모델의 상태에 따라 true나 false로 해석될 수 있다.
설정의 경우 updateOptions
({visible: value}
)로 지정하는 것과 동일하다.
default :undefined
Methods
clearOptions(render?): Annotation
명시적으로 설정된 모든 모델 설정 값들을 제거한다..
Parameter | Type | Description |
---|---|---|
render=true | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true |
return 모델 객체 자신
clearStyle(render?): Annotation
명시적으로 모델에 설정된 모든 style 값들을 제거한다.
Parameter | Type | Description |
---|---|---|
render=false | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 false |
destroy(): null
객체가 소유한 참조 등을 해제하고 null을 리턴한다.
list = lis.destroy();
return null
getOffset(w, h): IPoint
처음 표시될 때 실행될 에니메이션 설정 정보.
Parameter | Type |
---|---|
w | number (opens in a new tab) |
h | number (opens in a new tab) |
removeOption(prop, render?): Annotation
명시적으로 설정된 모델 설정 값을 제거해서 모델의 기본 값이 적용되도록 한다.
Parameter | Type | Description |
---|---|---|
prop | keyof (opens in a new tab)
| 설정 항목 이름 |
render=true | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true |
return 모델 객체 자신
setStyle(prop, value, render?): Annotation
모델 css style 값을 변경한다.
Parameter | Type | Description |
---|---|---|
prop | string (opens in a new tab) | css 스타일 항목 이름. |
value | any (opens in a new tab) | 적용할 스타일 값. |
render=true | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true |
setStyles(styles, render?): Annotation
여러 항목의 모델 css style 값들을 json 객체로 지정해서 동시에 변경한다.
Parameter | Type | Description |
---|---|---|
styles | any (opens in a new tab) | 스타일 항목들과 값들이 설정된 json 객체 |
render=true | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true |
toggleOption(prop, render?): Annotation
boolean (opens in a new tab) 타입의 모델 설정 값을 반대 값으로 변경한다.
Parameter | Type | Description |
---|---|---|
prop | keyof (opens in a new tab)
| 설정 항목 이름 |
render=true | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true |
return 모델 객체 자신
updateOption(prop, value, render?): Annotation
모델 설정 값을 변경한다.
Parameter | Type | Description |
---|---|---|
prop | keyof (opens in a new tab)
| 설정 항목 이름 |
value | any (opens in a new tab) | 설정 값 |
render=true | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true |
return 모델 객체 자신
updateOptions(source?, render?): Annotation
모델 설정 값들을 변경한다.
Parameter | Type | Description |
---|---|---|
source |
| 설정 옵션들이 포함된 json 객체 |
render=true | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true |
return 모델 객체 자신