API
MapWidgetCaptionOptions

MapWidgetCaptionOptions

범례나 scale의 title 설정 옵션.

Options

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

display'stack'가 될 때 수평 배치.
지정하지 않거나 잘못 지정하면 'left'로 적용된다.

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

default :undefined

autoContrast: boolean (opens in a new tab)

텍스트가 data point 내부에 표시되는 경우 포인트 색상과 대조되도록 표시한다.
밝게 표시할 때는 lightStyle을 적용하고, 어둡게 표시할 때는 darkStyle이 적용된다. lightStyle이 지정되지 않으면 'rm-text-light'이, darkStyle이 지정되지 않으면 'rm-text-dark'가 기본 적용된다.

default :undefined

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

default :undefined

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

default :undefined

display: 'auto' | 'inline' | 'stack'

타이틀 표시 위치.

  • 'auto' 범례나 scale 항목들의 배치에 따라 자동 배치한다.
    항목들이 수직 배치이면 'stack', 수평 배치이면 'inline'이 적용된다.
  • 'inline' 타이틀이나 footer를 항목들의 좌/우에 배치한다.
  • 'stack' 타이틀이나 footer를 항목들의 위/아래에 배치한다.

default :undefined

effect: 'background' | 'none' | 'outline'

  • 'background' 텍스트 배경 상자를 표시한다.
    배경 상자에 backgroundStyle이 적용된다. 스타일이 적용되지 않으면 기본 'rm-text-background'이 적용된다.
  • 'none' 효과 없음.
  • 'outline' 텍스트 색상과 대조되는 색상으로 텍스트 외곽을 구분 표시한다.

default :undefined

gap: number (opens in a new tab)

타이틀과 범례 아이템들 사이의 간격.
타당한 값으로 지정하지 않으면 display'linine'이 될 때 10, 아니면 5 픽셀로 적용된다.

default :undefined

iconGap: number (opens in a new tab)

default :2

iconPosition: 'bottom' | 'default' | 'left' | 'right' | 'top'

  • 'bottom'
  • 'default'
  • 'left'
  • 'right'
  • 'top'

default :'default'

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

default :undefined

numberFormat: string (opens in a new tab)

label이 숫자일 때 표시 형식.

default :'#,##0.#'

numberSymbols: string (opens in a new tab)

축의 tick 간격이 1000 이상인 큰 수를 표시할 때 이 속성에 지정한 symbol을 이용해서 축약형으로 표시한다.

default :'k,M,G,T,P,E'

prefix: string (opens in a new tab)

label 문자열 앞에 추가되는 문자열.

default :undefined

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

스타일셋 혹은 class selector.

default :undefined

suffix: string (opens in a new tab)

label 문자열 끝에 추가되는 문자열.

default :undefined

text: string (opens in a new tab)

rich text format을 지정할 수 있다.

default :undefined

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

display'inline'이 될 때 수직 배치.
지정하지 않거나 잘못 지정하면 'middle'로 적용된다.

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

default :undefined

visible: boolean (opens in a new tab)

표시 여부.

default :true