ColorScaleOptions extends ScaleOptions

맵 area 등에 표시되는 색상 범위를 표시한다.

Options

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

수평 배치.
값을 지정하지 않으면, 기본값이 location이 'body'일 때는 'left', 'left', 'right'일 때는 'center'이다.

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

default :undefined

background: MapWidgetBackgroundOptions

범례나 scale의 배경 설정 옵션.

default :undefined

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

bar 길이.
수평으로 표시될 때 bar의 너비, 수직일 때는 높이가 된다. 숫자로 지정하면 pixel 수, '%'로 지정하면 scale이 표시될 수 있는 최대 크기에 대한 백분율로 설정된다.

default :undefined

barWidth: number (opens in a new tab)

scale bar 폭.
수평으로 표시될 때 bar의 높이, 수직일 때는 너비가 된다.

default :12

display: 'both' | 'legend' | 'scale'

true로 지정하면 scale view 대신, color step들을 legend view의 항목들로 표시한다.

• 'both' scale bar와 legend에 동시 표시한다.
  
• 'legend' legend 항목들로 표시한다.
  
• 'scale' scale bar로 표시한다.
  

default :undefined

footer: MapWidgetCaptionOptions

범례나 scale의 footer 설정 옵션.

default :undefined

group: string (opens in a new tab)

이 위젯이 표시될 위젯 그룹 이름.
그룹에 포함되지 않은 위젯은 location 설정에 따라 위젯 섹션이나 body 영역에 표시된다.

default :undefined

integralSteps: boolean (opens in a new tab)

minValue, maxValue로 지정한 값이나, 계산된 최소/최대 값을 기준으로 stepCount 속성 등에 따라 정수 배수로 분리한다.
steps가 지정되면 이 속성은 무시된다.

default :undefined

inverted: boolean (opens in a new tab)

step의 방향을 바꿔 표시한다.
true면 오른쪽에 왼쪽으로, 또는 위쪽에서 아래쪽으로 최소에서 최대값으로 흐르게 표시한다.

default :undefined

layout: 'auto' | 'horizontal' | 'vertical'

• 'auto' color scale이 맵차트 좌우에 배치되면 item들을 수직으로 배치하고, color scale이 맵차트 상하에 배치되면 item들을 수평으로 배치한다.
• 'horizontal' item들을 수평으로 배치한다.
• 'vertical' item들을 수직으로 배치한다.

default :undefined

location: 'body' | 'bottom' | 'left' | 'right' | 'top'

범례나 scale 표시 위치.

• 'body' 맵차트 본체 영역 내부에 표시한다.
• 'bottom' 맵차트 본체 아래 표시한다.
• 'left' 맵차트 본체 왼쪽에 표시한다.
• 'right' 맵차트 본체 오른쪽에 표시한다.
• 'top' 맵차트 타이틀 아래 표시한다.

default :'bottom'

logBase: number (opens in a new tab)

steps가 지정되지 않고, 2 이상의 값으로 지정하면, 데이터포인트 값들을 이 속성값을 base로 하는 log 값으로 변환해서 표시한다.

default :undefined

marker: ColorScaleMarkerOptions

현재 선택된 데이터포인트의 색상의 위치를 표시하는 marker 설정 옵션.

default :undefined

maxColor: string (opens in a new tab)

최대값 쪽 color.
colors를 지정하면 이 속성은 무시된다. 또, steps가 지정되면 각 step에 지정된 색 범위가 우선 적용된다. 지정하지 않으면 'black'로 적용된다.

default :undefined

maxValue: number (opens in a new tab)

기준 최대값.
이 값을 지정하지 않고 series가 설정되면 그 시리즈의 최대값을 사용한다.

default :undefined

minColor: string (opens in a new tab)

최소값 쪽 color.
colors를 지정하면 이 속성은 무시된다. 또, steps가 지정되면 각 step에 지정된 색 범위가 우선 적용된다. 지정하지 않으면 'white'로 적용된다.

default :'#fff'

minValue: number (opens in a new tab)

기준 최소값.
이 값을 지정하지 않고 series가 설정되면 그 시리즈의 최소값을 사용한다.

default :undefined

name: string (opens in a new tab)

시리즈에서 참조하는 범례나 스케일 이름.

default :undefined

nullStep: ColorScaleNullOptions

지정되지 않은 값들을 표시하는 데 적용되는 색상을 지시하는 별도의 step 설정 옵션.

default :undefined

offsetX: number (opens in a new tab)

범례 또는 scale과 (location이 body일 때)body 또는 맵차트 경계 사이의 수평 간격.

default :0

offsetY: number (opens in a new tab)

범례 또는 scale과 (location이 body일 때)body 또는 맵차트 경계 사이의 수직 간격.

default :0

order: number (opens in a new tab)

그룹 내에서 배치 순서.
값을 지정하지 않거나 잘못 지정하면 마자믹에 배치된다.

default :undefined

reversed: boolean (opens in a new tab)

Step 상자들과 tick lable들의 위치를 바꿔 표시한다.
true면 label이 step 상자 왼쪽이나 위쪽에 표시된다.

default :undefined

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

minValue나 maxValue를 지정하지 않는 경우 범위 기준값을 계산할 시리즈의 이름이나 index.
이 속성을 지정하지 않으면 첫 번째 map 시리즈의 범위를 계산한다.

default :undefined

stepCount: number (opens in a new tab)

1 이상 지정한 값으로 scale을 구분해서 표시한다.
steps가 지정되면 이 속성은 무시된다.

default :undefined

stepLine: ColorScaleStepLineOptions

Step 상자와 label 사이의 연결선 설정 옵션.

default :undefined

steps: Array (opens in a new tab)<ColorScaleStep>

명시적으로 색상 스텝들을 지정한다.
이 속성이 지정되면 stepMode를 포함, step 관련된 속성들이 모두 무시된다. 가능한 연속된 값 배치로 지정해야 한다. 겹치는 경우 나중에 지정된 step이 우선하고, 어느 step에도 포함되지 않는 값일 경우 series 기본 색상이 적용된다.

default :undefined

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

스타일셋 혹은 class selector.

default :undefined

tick: ColorScaleTickOptions

Step 상자 옆에 표시되는 label 설정 옵션.

default :undefined

title: MapWidgetCaptionOptions

범례나 scale의 타이틀 설정 옵션.

default :undefined

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

수직 배치.
값을 지정하지 않으면, 기본값이 location이 'body'일 때는 'top', 'top', 'bottom'일 때는 'middle'이다.

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

default :undefined

visible: boolean (opens in a new tab)

표시 여부.

default :true