TextAnnotation extends Annotation

Text Annotation 모델.
type은 'text'이고,, 설정 모델은 TextAnnotationOptions이다.

Properties

name: string (opens in a new tab) readonly

어노테이션 이름.
생성 옵션에서 설정한 후 변경하지 말아야 한다. annotation.name으로 설정한다.

const config = {
     annotation: [{
         name: 'title'
     }]
};

실행 시간에 Chart.getAnnotation으로 모델 객체에 접근하기 위해서는 반드시 지정해야 한다.

const annotation = chart.getAnnotation('name');
annotation.visible = false;

default :undefined

options: TextAnnotationOptions readonly

차트를 생성할 때나 updateOptions 등을 통해 이 모델 객체에 설정된 옵션 값들과 기본 설정값들이 포함된 원본 설정 객체(복사본이 아니다).
리턴된 객체의 속성값들을 가져올 수 있지만, 속성들을 직접 수정하는 것은 권장되는 방법이 아니다. updateOptions나 updateOption 등을 사용해서 옵션들을 변경해야 한다.

default :undefined

visible: boolean (opens in a new tab)

표시 여부.
설정 옵션의 visible 값을 그대로 return하는 것이 아니라, undefined나 null 등으로 지정하는 경우 모델의 상태에 따라 true나 false로 해석될 수 있다.
설정의 경우 updateOption으로 지정하는 것과 동일하다.

model.updateOption('visible', value);

model.updateOptions({
    visible: value
});

default :undefined

Methods

clearOptions(render?): TextAnnotation

updateOptions나 updateOption 등을 통해 설정된 모든 옵션 값들을 제거하거나, 전역 기본값이 존재하는 경우 그 값으로 되돌린다.

return 객체 자신.

destroy(): null

객체가 소유한 참조 등을 해제하고 null을 리턴한다.

model = model.destroy();

return null

loadOptions(source): TextAnnotation

기존 옵션 값들을 모두 제거하고 source에 지정한 값들로 새로 구성한다.

chart.legend.loadOptions({
     visible: true,
     location: 'right
})

return 이 객체 자신.

removeOption(prop, render?): TextAnnotation

지정한 속성에 설정한 값이 있으면 제거하고, 기본값으로(있다면) 되돌린다.

return 객체 자신.

saveOptions(recursive?): any (opens in a new tab)

이 모델 객체에 설정된 전역 기본값과 다른 옵션 값들이 포함된 사본 객체로 리턴한다.
options 객체에는 전역 기본값들도 포함되어 있다.

const options = chart.legend.saveOptions();
console.log(options);

return 옵션 사본 객체.

toggleOption(prop, render?): TextAnnotation

Boolean 타입의 설정값을 변경한다.
지정 가능한 설정 값 목록은 Configuration API 페이지에서 확인할 수 있다.

chart.getSeries('ser02').toggleOption('visible');

return 객체 자신.

updateOption(prop, value, render?): TextAnnotation

하나의 속성 값을 설정한다.
여러 속성들을 한꺼번에 변경할 때는 updateOptions를 사용한다.

return 객체 자신.

updateOptions(source?, render?): TextAnnotation

하나 이상의 option 설정을 하고, 차트가 다시 그려지도록 한다.

chart.legend.updateOptions({
    gap: 10,
    lineGap: 20
});

권장하는 방식은 아니지만, options의 값들을 직접 수정한 후에도 이 메소드를 호출해서 내부의 값들이 다시 계산되도록 해야 한다.

chart.legend.options.gap = 10,
chart.legend.options.lineGap = 20,
chart.legend.updateOptions();

return 객체 자신.