API
HtmlButtonOptions

HtmlButtonOptions extends ChartItemOptions

HTML 버튼 옵션

Options

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

수평 배치.

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

default :'center'

autoWidth: boolean (opens in a new tab)

버튼의 너비를 내용에 맞게 자동 조절할지 여부.

default :false

height: number (opens in a new tab)

버튼의 픽셀 단위 높이.
지정하지 않으면 내용에 맞게 자동 조절된다.

default :undefined

hint: string (opens in a new tab)

버튼에 마우스를 올렸을 때 표시되는 툴팁 문자열.

default :undefined

hintMode: 'custom' | 'default'

버튼의 hint 표시 방식.

  • 'custom' 스타일로 구현된 커스텀 툴팁 모드 사용.
    버튼 위에 마우스를 올렸을 때 custom 툴팁이 즉시 표시된다.
  • 'default' 브리우저 기본 툴팁 모드 사용.

default :HtmlButtonHintMode.CUSTOM

hoverEffect: 'auto' | 'background' | 'image'

버튼에 마우스 커서를 올렸을 때의 효과.

  • 'auto' hoverImageUrl이 설정되면 'image', 그렇지 않으면 'background' 모드로 동작한다.
  • 'background' 마우스가 올라가면 배경색이 변경된다.
  • 'image' hoverImageUrl이 설정되면 마우스를 올렸을 때 이미지가 변경된다.

default :undefined

hoverImageUrl: string (opens in a new tab)

버튼에 마우스 커서를 올렸을 때 표시되는 이미지의 URL.

default :undefined

imageHeight: number (opens in a new tab)

버튼에 표시되는 이미지의 픽셀 단위 높이.

default :undefined

imageUrl: string (opens in a new tab)

버튼에 표시되는 이미지의 URL.

default :undefined

imageWidth: number (opens in a new tab)

버튼에 표시되는 이미지의 픽셀 단위 너비.

default :undefined

offsetX: number (opens in a new tab)

alignverticalAlign으로 지정된 위치에서 실제 표시될 위치의 수평 간격.
값이 양수이면 차트 안쪽으로 멀어진다.

default :0

offsetY: number (opens in a new tab)

alignverticalAlign으로 지정된 위치에서 실제 표시될 위치의 수직 간격.
값이 양수이면 차트 안쪽으로 멀어진다.

default :0

onClick: (args: HtmlButtonClickArgs) => void (opens in a new tab)

버튼 클릭 시 호출되는 함수.

default :undefined

scope: 'chart' | 'container'

버튼 표시 위치 기준.

  • 'chart' 차트 영역 기준.
  • 'container' 차트 컨트롤 전체 기준.

default :'container'

text: string (opens in a new tab)

버튼에 표시되는 텍스트.

default :undefined

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

수직 배치.

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

default :'middle'

visible: boolean (opens in a new tab)

표시 여부.

default :true

width: number (opens in a new tab)

버튼의 픽셀 단위 너비.
지정하지 않으면 내용에 맞게 자동 조절된다.

default :undefined