API
CircularGauge

CircularGauge extends ValueGauge

원형 게이지 모델.
options 모델은 CircularGaugeOptions이다.
label의 기본 위치의 x는 원호의 좌위 최대 각 위치를 연결한 지점, y는 중심 각도의 위치.

Properties

label: CircularGaugeLabel readonly

label.

default :undefined

options: CircularGaugeOptions readonly

차트를 생성할 때나 updateOptions 등을 통해 이 모델 객체에 설정된 옵션 값들과 기본 설정값들이 포함된 원본 설정 객체(복사본이 아니다).
리턴된 객체의 속성값들을 가져올 수 있지만, 속성들을 직접 수정하는 것은 권장되는 방법이 아니다. updateOptionsupdateOption 등을 사용해서 옵션들을 변경해야 한다.

default :undefined

visible: boolean (opens in a new tab) readonly

표시 여부.
설정 옵션의 visible 값을 그대로 return하는 것이 아니라, undefinednull 등으로 지정하는 경우 모델의 상태에 따라 truefalse로 해석될 수 있다.
설정의 경우 updateOption으로 지정하는 것과 동일하다.

model.updateOption('visible', value);
model.updateOptions({
    visible: value
});

default :undefined

Methods

clearOptions(render?): CircularGauge

updateOptionsupdateOption 등을 통해 설정된 모든 옵션 값들을 제거하거나, 전역 기본값이 존재하는 경우 그 값으로 되돌린다.

ParameterTypeDescription
render=trueboolean (opens in a new tab)true(기본값)으로 지정하면 차트를 다시 그린다.

return 객체 자신.

destroy(): null

객체가 소유한 참조 등을 해제하고 null을 리턴한다.

model = model.destroy();

return null

loadOptions(source): CircularGauge

기존 옵션 값들을 모두 제거하고 source에 지정한 값들로 새로 구성한다.

chart.legend.loadOptions({
     visible: true,
     location: 'right
})
ParameterTypeDescription
sourceCircularGaugeOptions설정 정보 객체 혹은 단일값.

return 이 객체 자신.

removeOption(prop, render?): CircularGauge

지정한 속성에 설정한 값이 있으면 제거하고, 기본값으로(있다면) 되돌린다.

ParameterTypeDescription
propkeyof (opens in a new tab) CircularGaugeOptions속성 이름.
render=trueboolean (opens in a new tab)true(기본값)으로 지정하면 차트를 다시 그린다.

return 객체 자신.

saveOptions(recursive?): any (opens in a new tab)

이 모델 객체에 설정된 전역 기본값과 다른 옵션 값들이 포함된 사본 객체로 리턴한다.
options 객체에는 전역 기본값들도 포함되어 있다.

const options = chart.legend.saveOptions();
console.log(options);
ParameterTypeDescription
recursive=trueboolean (opens in a new tab)기본값 true이면 하위 모델의 옵션들도 포함된다.

return 옵션 사본 객체.

setStyle(prop, value, render?): CircularGauge

모델 css style 값을 변경한다.
value에 undefinednull, ''을 지정하면 기존에 설정됐던 스타일 항목이 제거된다.

ParameterTypeDescription
propstring (opens in a new tab)css 스타일 항목 이름.
valueany (opens in a new tab)적용할 스타일 값.
render=trueboolean (opens in a new tab)true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본값 true

setStyles(props, clear?, render?): CircularGauge

여러 항목의 모델 css style 값들을 json 객체로 지정해서 동시에 변경한다.
value에 undefinednull, ''을 지정하면 기존에 설정됐던 스타일 항목이 제거된다.

ParameterTypeDescription
propsobject (opens in a new tab)스타일 항목들과 값들이 설정된 json 객체
clear=falseboolean (opens in a new tab)true로 지정하면 기존 스타일 값을 모두 제거한다. 기본값 false
render=trueboolean (opens in a new tab)true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본값 true

toggleOption(prop, render?): CircularGauge

Boolean 타입의 설정값을 변경한다.
지정 가능한 설정 값 목록은 Configuration API 페이지에서 확인할 수 있다.

chart.getSeries('ser02').toggleOption('visible');
ParameterTypeDescription
propkeyof (opens in a new tab) CircularGaugeOptions설정 속성 이름.
render=trueboolean (opens in a new tab)true로 지정하면 chart를 다시 그린다. false로 지정하고 여러 설정 후에 render를 호출해서 다시 그리게 할 수도 있다. 기본값은 true.

return 객체 자신.

updateOption(prop, value, render?, force?): CircularGauge

하나의 속성 값을 설정한다.
여러 속성들을 한꺼번에 변경할 때는 updateOptions를 사용한다. 기본적으로 이전 값과 다른 경우에만 적용된다. 특히, 속성값이 객체인 경우 객체 속성만 바뀐 경우 적용되지 않는다. 바꾸고 싶다면 force 매개변수를 true로 지정해서 호출한다.
또, prop 매개변수가 하위 모델 이름인 경우 하위 모델의 updateOptions를 호출한 것과 동일하다.

ParameterTypeDescription
propkeyof (opens in a new tab) CircularGaugeOptions
valueany (opens in a new tab)
render=trueboolean (opens in a new tab)true로 지정하면 설정 후 차트를 다시 그린다.
force=falseboolean (opens in a new tab)지정한 값이 이전 값과 동일한 경우에도 적용한다.

return 객체 자신.

updateValue(value): void (opens in a new tab)

게이지의 값을 변경한다.

ParameterType
valueany (opens in a new tab)