API
AnnotationOptions

AnnotationOptions extends ChartItemOptions

subinterfaces ImageAnnotationOptions, ShapeAnnotationOptions, TextAnnotationOptions

차트 시리즈게이지로 표현이 부족하거나 특별히 강조할 내용이 있을 때, 보조로 표시할 수 있는 텍스트이미지 또는 도형.

Options

align: 'center' | 'left' | 'right'

수평 배치.

  • 'center' 영역 가운데로 정렬한다.
  • 'left' 왼쪽으로 정렬한다.
  • 'right' 오른쪽으로 정렬한다.

default :'left'anchor가 지정되면 'center', 아니면 'left'

anchor: string (opens in a new tab)

어노테이션 배치 기준이 되는 차트 구성 요소.
현재, 같은 영역(body 혹은 chart)에 포함된 게이지나 다른 어노테이션의 이름을 지정할 수 있다.

default :undefined

backgroundStyle: SVGStyles | string (opens in a new tab)

배경 스타일.
경계 및 배경 색, padding 스타일을 지정할 수 있다.

default :undefined

front: boolean (opens in a new tab)

true로 지정하면 시리즈나 게이지들 위에 표시된다.

default :false

height: string (opens in a new tab) | number (opens in a new tab)

Annotation 높이.
픽셀 단위의 고정 값이나, plot 영역에 대한 상태 크기롤 지정할 수 있다.

default :undefined

name: string (opens in a new tab)

어노테이션 이름.
동적으로 어노테이션을 다루기 위해서는 반드시 지정해야 한다.

default :false

noClip: boolean (opens in a new tab)

true로 지정하면 상위 영역을 벗어난 부분도 표시되게 한다.
body에 포함된 경우 body 영역, chart에 포함되고 scope이 'chart'일 때 chart 영역.

default :undefined

offsetX: string (opens in a new tab) | number (opens in a new tab)

alignverticalAlign으로 지정된 위치에서 실제 표시될 위치의 수평 간격.
값이 양수일 때, anchor가 지정된 경우 anchor 아이템으 밖으로 멀어지고, 아니면 영역 경계 안쪽으로 멀어진다. 또, anchor가 지정된 경우 '0.5w' 등으로 이 어노테이션의 너비를 기준으로 한 크기로 지정할 수 있다.

default :0

offsetY: string (opens in a new tab) | number (opens in a new tab)

alignverticalAlign으로 지정된 위치에서 실제 표시될 위치의 수직 간격.
값이 양수일 때, anchor가 지정된 경우 anchor 아이템으 밖으로 멀어지고, 아니면 영역 경계 안쪽으로 멀어진다. 또, anchor가 지정된 경우 '0.5h' 처럼 이 어노테이션의 너비를 기준으로 한 크기로 지정할 수 있다.

default :0

rotation: number (opens in a new tab)

회전 각도.
0 ~ 360 사이의 값으로 지정한다.

default :undefined

scope: 'chart' | 'container'

어노테이션 배치 기준.
[주의]body에 설정된 annoation에는 적용되지 않는다.

  • 'chart' container에서 padding을 적용한 영역을 기준으로 표시한다.
  • 'container' container 전체 영역을 기준으로 표시한다.

default :'chart'

style: SVGStyles | string (opens in a new tab)

스타일셋 또는 css selector (opens in a new tab).

default :undefined

type: 'image' | 'shape' | 'text'

  • 'image'
  • 'shape'
  • 'text'

default :undefined

verticalAlign: 'bottom' | 'middle' | 'top'

수직 배치.

  • 'bottom'
  • 'middle'
  • 'top'

default :top

visible: boolean (opens in a new tab)

표시 여부.

default :true

width: string (opens in a new tab) | number (opens in a new tab)

Annotation 너비.
픽셀 단위의 고정 값이나, plot 영역에 대한 상태 크기롤 지정할 수 있다.

default :undefined

x1: number (opens in a new tab) | Date (opens in a new tab)

body 어노테이션일 경우, x 축을 기준으로 지정하는 수평(inverted일 때 수직) 위치.
chart에 지정된 어노테이션에서는 무시된다.

default :undefined

x2: number (opens in a new tab) | Date (opens in a new tab)

body 어노테이션일 경우, x 축을 기준으로 지정하는 수평(inverted일 때 수직) 위치.
chart에 지정된 어노테이션에서는 무시된다.

default :undefined

y1: number (opens in a new tab) | Date (opens in a new tab)

body 어노테이션일 경우, y 축을 기준으로 지정하는 수직(inverted일 때 수평) 위치.
chart에 지정된 어노테이션에서는 무시된다.

default :undefined

y2: number (opens in a new tab) | Date (opens in a new tab)

body 어노테이션일 경우, y 축을 기준으로 지정하는 수직(inverted일 때 수평) 위치.
chart에 지정된 어노테이션에서는 무시된다.

default :undefined