API
ChartGeneralOptions

ChartGeneralOptions extends ChartItemOptions

맵차트 전체에 영향을 미치는 옵션들.

Options

alwaysMap: boolean (opens in a new tab)

false가 아닌 경우 첫번째 시리즈가 'map' 시리즈가 아니면 내부적으로 자동 추가한다.

default :true

animatable: boolean (opens in a new tab)

false로 설정하면 차트 애니메이션이 실행되지 않는다.
interactive가 false이면 이 옵션과 관계없이 애니메이션은 실행되지 않는다.

default :true

backgroundStyle: CSSStyles

맵차트 컨트롤의 배경 div 속성을 지정한다.
스타일 속성은 svg가 아니라 html css 속성들로 지정한다.

default :undefined

clickAction: ClickAction

맵 영역 등을 클릭하거나 tap했을 때 실행될 action.

  • 'center' 클릭한 위치가 표시 중앙이 되도록 지도를 옮긴다.
    지도가 표시 영역 안에 다 들어와 있으면 옮길 여지가 없어 아무 일도 일어나지 않는다. 확대해서 지도가 표시 영역보다 커진 상태에서만 결과가 보인다.
    단, 좌우로 끝없이 도는 scrollable 월드맵은 확대하지 않아도 가로 이동이 일어난다.
  • 'drilldown' 클릭한 영역이 포함된 맵시리즈가 drilldown 가능한 상태일 때, drilldown을 실행하고 클릭한 영역의 상세가 표시되도록 한다.
  • 'drillOrZoom' drilldown이 가능한 상태면 drilldown하고, 아니면 zoom-in 한다.
    드릴다운 최하위 단계에는 상세 지도가 없으므로 zoom-in으로 동작한다.
  • 'none' 아무 동작도 하지 않는다.
  • 'select' 클릭한 영역을 선택한다.
    맵시리즈의 selectable이 true여야 한다.
  • 'zoom' 클릭한 위치를 기준으로 zoom-in 한다.
    한 번에 확대되는 비율은 clickZoomFactor로 지정한다.

default :'none'

clickZoomFactor: number (opens in a new tab)

클릭 action이 zoom-in할 때 한 번에 확대되는 비율(%).
값이 클수록 크게 확대된다. 100이면 zoom이 100에서 200으로, 즉 2배가 된다.
clickAction과 dblClickAction에 'zoom'이나 'drillOrZoom'을 지정했을 때 사용된다.

default :100

clickable: boolean (opens in a new tab)

false로 설정하면 차트에 대한 클릭 동작이 비활성화된다.
onClick, 범례 클릭, 선택, 클릭 drilldown, 줌 패널 버튼 등 클릭 기반 기능이 모두 작동하지 않는다. [주의] 더블클릭 action은 이 옵션을 따르지 않는다.
interactive가 false이면 이 옵션과 관계없이 맵 클릭과 범례 클릭이 비활성화된다. 단, 줌 패널 버튼은 이 옵션만 따르므로 interactive가 false여도 동작한다.

default :true

dblClickAction: DblClickAction

맵 영역 등을 더블 클릭하거나 더블 tap했을 때 실행될 action.

  • 'center' 더블클릭한 위치가 표시 중앙이 되도록 지도를 옮긴다.
    지도가 표시 영역 안에 다 들어와 있으면 옮길 여지가 없어 아무 일도 일어나지 않는다. 확대해서 지도가 표시 영역보다 커진 상태에서만 결과가 보인다.
    단, 좌우로 끝없이 도는 scrollable 월드맵은 확대하지 않아도 가로 이동이 일어난다.
  • 'drilldown' 더블클릭한 영역이 포함된 맵시리즈가 drilldown 가능한 상태일 때, drilldown을 실행하고 더블클릭한 영역의 상세가 표시되도록 한다.
  • 'drillOrZoom' drilldown이 가능한 상태면 drilldown하고, 아니면 zoom-in 한다.
    드릴다운 최하위 단계에는 상세 지도가 없으므로 zoom-in으로 동작한다.
  • 'none' 아무 동작도 하지 않는다.
  • 'select' 더블클릭한 영역을 선택한다.
    맵시리즈의 selectable이 true여야 한다.
  • 'zoom' 더블클릭한 위치를 기준으로 zoom-in 한다.
    한 번에 확대되는 비율은 clickZoomFactor로 지정한다.

default :'none'

dragAction: DragAction

마우스 드래그 시 실행될 action.

  • 'default' 구 지도이면 회전하고, 스크롤 가능한 세계지도면 스크롤하고, 아니면 지도를 이동(pan) 시킨다.
  • 'select' 드래그로 결정된 영역에 포함된 area들을 선택한다.
    ctrl/cmd 키가 눌러진 상태가 아니면 기존 선택은 취소된다.
  • 'zoom' 드래그로 결정된 영역이 화면을 채우도록 zoom-in 한다.

default :'default'

draggable: boolean (opens in a new tab)

false로 설정하면 차트 드래그 동작이 비활성화된다.
dragAction으로 지정한 동작과 Globe 회전, 지도 이동이 모두 작동하지 않는다.
interactive가 false이면 이 옵션과 관계없이 드래그는 비활성화된다.

default :true

hoverable: boolean (opens in a new tab)

false로 설정하면 차트에 대한 호버 동작이 비활성화된다.
tooltip, crosshair 등 hover 기반 기능이 모두 작동하지 않는다.
interactive가 false이면 이 옵션과 관계없이 hover 상호작용은 비활성화된다.

default :true

interactive: boolean (opens in a new tab)

차트 전체 수준의 상호작용 여부를 지정한다.
false이면 hover, tooltip, crosshair, 맵 클릭, 선택, drilldown, 범례 클릭, 드래그, 휠 줌, 핀치 줌, 더블클릭이 차단된다. 상호작용은 아니지만 애니메이션도 함께 차단된다.
단, 줌 패널은 차트가 그린 UI 컨트롤이므로 이 옵션과 무관하게 표시되고 버튼도 동작한다. 드릴다운 패널은 type이 'button'일 때의 뒤로가기 버튼만 동작하며, 기본값인 'text'의 경로 텍스트는 차단된다.
패널 버튼까지 막으려면 clickable을 false로 지정한다.
true는 끄는 방향으로만 동작하는 이 옵션을 해제할 뿐이며, 각 옵션에 설정한 값이 그대로 적용된다.
interactive를 통해 개별 시리즈 수준에서 상호작용 여부를 지정할 수 있다.

default :true

locale: string (opens in a new tab)

로케일(언어) 설정.
지도 영역 이름이 로케일에 해당하는 feature 속성으로 표시된다. 'ko'는 'name' 속성을, 'en'은 'en-name'(없으면 'name-en', 'name' 순서) 속성을 사용한다. 맵소스에 nameKey가 명시되면 그 속성이 우선한다.
'en-US'처럼 지역이 포함된 코드는 2자리 언어 코드로 해석되고, 등록되지 않은 언어면 'ko'로 동작한다.
차트 생성 이후 updateOptions({ chart: { locale } })로 이 값을 변경하면 이미 로드된 지도의 영역 이름·데이터포인트 이름·범례 카테고리도 refetch 없이 다시 계산된다. 단, 데이터를 다시 가져오지는 않으므로 소스 feature에 해당 언어 속성이 없으면 'name'으로 폴백하고, nameKey가 명시된 맵소스의 영역 이름은 로케일과 무관하게 유지된다.

default :'ko'

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

default :undefined

onDrilldown: (args: OnDrillArgs) => void (opens in a new tab)

default :undefined

onDrillup: (args: OnDrillArgs) => void (opens in a new tab)

default :undefined

onSelectionChanged: (args: OnSelectionChangedArgs) => void (opens in a new tab)

default :undefined

resizeDelay: number (opens in a new tab)

차트 div 크기가 변경됐을 때 지정한 시간(밀리초) 이후에 다시 그린다.
0 이하면 대기 없이 바로 다시 그리기를 요청한다.

default :50밀리초

style: SVGStyleOrClass

스타일셋 혹은 class selector.

default :undefined

theme: string (opens in a new tab)

theme 이름.
realmap-style.css에 기본 theme이 정의되어 있다.

default :undefined

visible: boolean (opens in a new tab)

표시 여부.

default :true

wheelDisabled: boolean (opens in a new tab)

마우스 휠을 통한 줌인/아웃을 비활성화할지 여부.
true로 설정하면 줌 패널 버튼은 사용할 수 있지만 마우스 휠로는 줌 조절이 불가능하다.
interactive가 false이면 이 옵션과 관계없이 휠 줌은 비활성화된다.

default :false

wheelZoomFactor: number (opens in a new tab)

마우스 휠로 zoom할 때 확대되는 비율(%).
값이 클수록 크게 확대된다.
[주의] 같은 이름의 wheelZoomFactor는 값의 뜻이 반대다. 그쪽에 지정한 값은 예전 방식대로 해석되므로 함께 쓰지 않는다.

default :20

widgetGap: number (opens in a new tab)

legend, color scale 등의 위젯들이 표시되는 영역 내에서 위젯 사이의 간격.

default :8

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

legend, color scale 등의 위젯들이 표시되는 영역과 body 사이의 간격.
숫자 값이나 css margin 지정 방식의 문자열로 지정할 수 있다.

default :8