CircleBarSeries extends BarSeriesBase

CirleBar 시리즈.
type은 'circlebar'이고, 설정 모델은 CircleBarSeriesOptions이다.

Properties

canPolar: boolean (opens in a new tab) readonly

polar가 적용 가능한 시리즈 인지 여부

default :undefined

col: number (opens in a new tab) readonly

col

default :undefined

data: any (opens in a new tab) readonly

데이터포인터들을 생성하는 데 사용되는 값 목록.

default :undefined

index: number (opens in a new tab) readonly

차트나 시리즈그룹 내에서 위치.

default :undefined

isWidget: boolean (opens in a new tab) readonly

widget 시리즈 인지 여부

default :undefined

name: string (opens in a new tab) readonly

시리즈 이름.
시리즈 생성시 지정된 후 변경할 수 없다. 차트의 다른 구성 요소에서 이 시리즈를 참조할 때 사용되며, 레전드나 툴팁에서 시리즈를 나타내는 텍스트로도 사용된다.

default :undefined

options: CircleBarSeriesOptions readonly

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

default :undefined

pointCount: number (opens in a new tab) readonly

시리즈에 설정된 데이터포인트 개수.

default :undefined

row: number (opens in a new tab) readonly

row

default :undefined

trendline: Trendline readonly

추세선 설정 모델.

default :undefined

visible: boolean (opens in a new tab) readonly

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

model.updateOption('visible', value);

model.updateOptions({
    visible: value
});

default :undefined

visiblePointCount: number (opens in a new tab) readonly

시리즈에 설정된 데이터포인트들 중 표시 중인 것들의 개수.

default :undefined

visiblePoints: Array (opens in a new tab)<DataPoint> readonly

시리즈에 설정된 데이터포인트들 중 표시 중인 것들의 목록.

default :undefined

Methods

addPoint(source, animate?): DataPoint

데이터포인트를 추가한다.

return 실제 추가된 데이터포인트 객체.

addPoints(source, animate?): Array (opens in a new tab)<DataPoint>

하나 이상의 데이터포인트들을 추가한다.

return 실제 추가된 데이터포인트 객체 배열.

bool(prop, def?, fallback?): boolean (opens in a new tab)

boolean (opens in a new tab) 타입의 옵션 값에 특화된 prop() 메서드. prop()과 달리 boolean (opens in a new tab)으로 변환해서 반환한다.

return boolean (opens in a new tab) 타입의 옵션 값.

boolAt(path, def?, fallback?): boolean (opens in a new tab)

점(dot) 표기법으로 경로를 지정해서 boolean (opens in a new tab) 타입의 옵션 값을 반환한다.

return 경로에 해당하는 boolean (opens in a new tab) 타입의 옵션 값 또는 false

clean(recursive?): this

_op에 명시적으로 설정되어 있지만 값이 현재 defaults와 동일한 항목들을 제거해 _op를 minimal delta 상태로 정규화한다.

[주의] 대부분의 경우 호출할 필요가 없다.

• 효과 값(prop/num/props)은 영향 없음.
• 직렬화(saveOptions)도 어차피 defaults와 같은 값을 필터링하므로 결과가 동일하다. 즉 외부 저장 결과는 clean 전후가 같다.

clean이 실제로 차이를 만드는 경우는 다음과 같다.

• _op의 메모리 사용을 줄이고 싶을 때(loadOptions로 큰 source를 읽어들인 직후 등).
• getOption()/saveOption()처럼 _op의 own value를 그대로 반환하는 API의 결과를 "사용자가 명시했는가"의 의미로 사용해야 할 때(예: 디자이너 UI의 "기본값 사용 중" 표시). 이 경우 clean 후에는 defaults와 같은 값들이 undefined로 보고된다.

return 모델 객체 자신

clearOptions(recursive?, render?): this

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

return 객체 자신.

clearStyle(render?): CircleBarSeries

명시적으로 모델에 설정된 모든 style 값들을 제거한다.

dispose(): null

객체를 해제하고 null을 반환한다.
사용 예: this._obj = this._obj.dispose();

return null

getOption(option): any (opens in a new tab)

옵션 값을 읽는다.
prop()과 달리 효과 값이 아닌 명시적으로 설정된 값만 읽는다. 설정되지 않은 옵션은 undefined를 반환한다.

return 명시적으로 설정된 값 또는 undefined

getOptionAt(path): any (opens in a new tab)

점(dot) 표기법으로 경로를 지정해서 옵션 값을 읽는다.

return 경로에 해당하는 옵션 값 또는 undefined

getPointAt(xValue, yValue?): DataPoint

지정한 x축 값에 위치한 첫번째 데이터포인트를 리턴한다.
전달되는 데이터포인트 정보는 리턴 시점의 복사본이다.

return 데이터포인트 객체.

getPointsByRange(from, to): Array (opens in a new tab)<DataPoint>

지정한 x축 범위 내에 있는 데이터포인트들을 리턴한다.

getTooltipHeaderColor(point): string (opens in a new tab)

툴팁 헤더 색상을 반환한다.
null을 반환하면 TooltipView 기본 색상 로직이 사용된다.

getValueAt(xValue, prop?): number (opens in a new tab)

xValue에 해당하는 첫번째 데이터포인터의 yValue를 리턴한다.

return prop로 지정한 데이터포인트 값.

getVisiblePoint(index): DataPoint

시리즈에 설정된 데이터포인트들 중 표시 중인 index번째 포인트 객체.

init(): this

특정 부모에 마운팅되지 않은 독립된 옵션 객체를 초기화한다.

initAndLoad(source): this

특정 부모에 마운팅되지 않은 독립된 옵션 객체를 초기화하고, source 객체로부터 옵션 값을 읽어서 설정한다.

loadOptions(source, clear?): this

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

chart.legend.loadOptions({
     visible: true,
     location: 'right
})

return 이 객체 자신.

num(prop, def?): number (opens in a new tab)

숫자 옵션 효과 값. 문자열('30px')은 parseFloat 결과를 반환한다.

numAt(path, def?): number (opens in a new tab)

점(dot) 표기법으로 경로를 지정해서 숫자 타입의 옵션 값을 반환한다.

return 경로에 해당하는 숫자 타입의 옵션 값 또는 NaN

prop(prop, def?): CircleBarSeriesOptions | \[ | K | ]

옵션의 효과 값(effective value)을 반환한다.
명시적으로 설정된 값이 있으면 그 값을, 없으면 클래스의 defaults에 정의된 기본값을 반환한다.
옵션 값을 읽을 때는 options.prop 직접 접근 대신 이 메서드를 사용한다.

propAt(path, def?): any (opens in a new tab)

점(dot) 표기법으로 경로를 지정해서 옵션의 효과 값(effective value)을 반환한다.

return 경로에 해당하는 옵션 값 또는 undefined

propIs(prop, value): boolean (opens in a new tab)

옵션 값이 특정 값과 일치하는지 여부를 반환한다.

return 일치 여부

propIsNot(prop, value): boolean (opens in a new tab)

옵션 값이 특정 값과 일치하지 않는지 여부를 반환한다.

return 불일치 여부

props(props): Pick

지정한 옵션들의 효과 값(effective value)을 묶어서 반환한다.
여러 옵션을 destructuring으로 한꺼번에 읽을 때 사용한다.

const { color, radius } = this.props('color', 'radius');

removeAt(path, render?): any (opens in a new tab)

명시적으로 설정된 하위 모델의 설정 값을 제거해서 모델의 기본 값이 적용되도록 한다.
path 매개변수는 하위 모델의 속성 이름을 점(.)으로 구분해서 지정한다. 예를 들어, "axis.x"는 axis 모델의 x 속성을 의미한다.
render와 force 매개변수는 toggleOption과 동일하다.

removePoint(p, animate?): boolean (opens in a new tab)

데이터포인트를 제거한다.
p 매개변수에 데이터포인트 대신 값을 지정하면, 그 값이 xValue와 동일한 첫번째 데이터포인트를 찾는다.
'bubble' 시리즈 처럼 x, y 두 위치가 필요한 경우 [xValue, yValue] 형태로 지정한다.

return 실제로 제거되면 true를 리턴한다.

removePointAt(index, animate?): boolean (opens in a new tab)

시리즈의 데이터포인트 목록 중 index에 위치한 데이터포인트를 제거한다.

return 제거되면 true

removePoints(pts, animate?): number (opens in a new tab)

지정한 데이터포인트들를 제거한다. pts 매개변수에 데이터포인트 대신 값들을 지정하면, 그 값이 xValue와 동일한 첫번째 데이터포인트를 찾는다.
'bubble' 시리즈 처럼 x, y 두 위치가 필요한 경우 [xValue, yValue] 형태로 지정한다.

return 실제로 제거되면 데이터포인트 개수.

removePointsAt(indices, animate?): number (opens in a new tab)

여러 데이터포인트들을 index 목록에 따라 제거한다.

return 실제로 제거되면 데이터포인트 개수.

saveOption(prop): CircleBarSeriesOptions | \[ | K | ] | { | | baseValue | : | | any (opens in a new tab) | ; | belowStyle | : | | any (opens in a new tab) | ; | clusterable | : | | any (opens in a new tab) | ; | color | : | | any (opens in a new tab) | ; | colorByPoint | : | | any (opens in a new tab) | ; | colorField | : | | any (opens in a new tab) | ; | data | : | | any (opens in a new tab) | ; | decayDuration | : | | any (opens in a new tab) | ; | depth | : | | any (opens in a new tab) | ; | distance | : | | any (opens in a new tab) | ; | hoverEffect | : | | any (opens in a new tab) | ; | hoverStyle | : | | any (opens in a new tab) | ; | iconField | : | | any (opens in a new tab) | ; | interactive | : | | any (opens in a new tab) | ; | label | : | | any (opens in a new tab) | ; | legendKey | : | | any (opens in a new tab) | ; | loadAnimation | : | | any (opens in a new tab) | ; | minPointWidth | : | | any (opens in a new tab) | ; | name | : | | any (opens in a new tab) | ; | noClip | : | | any (opens in a new tab) | ; | nullAsBase | : | | any (opens in a new tab) | ; | onPointClick | : | | any (opens in a new tab) | ; | onPointHover | : | | any (opens in a new tab) | ; | onPointsLoaded | : | | any (opens in a new tab) | ; | paddingRate | : | | any (opens in a new tab) | ; | pointColors | : | | any (opens in a new tab) | ; | pointLabel | : | | any (opens in a new tab) | ; | pointOffset | : | | any (opens in a new tab) | ; | pointPadding | : | | any (opens in a new tab) | ; | pointStyle | : | | any (opens in a new tab) | ; | pointStyleCallback | : | | any (opens in a new tab) | ; | pointWidth | : | | any (opens in a new tab) | ; | style | : | | any (opens in a new tab) | ; | tooltipCallback | : | | any (opens in a new tab) | ; | tooltipDetail | : | | any (opens in a new tab) | ; | tooltipDetailCallback | : | | any (opens in a new tab) | ; | tooltipText | : | | any (opens in a new tab) | ; | trendline | : | | any (opens in a new tab) | ; | type | : | | any (opens in a new tab) | ; | viewRangeValue | : | | any (opens in a new tab) | ; | viewRanges | : | | any (opens in a new tab) | ; | visible | : | | any (opens in a new tab) | ; | visibleInLegend | : | | any (opens in a new tab) | ; | visibleInNavigator | : | | any (opens in a new tab) | ; | xAxis | : | | any (opens in a new tab) | ; | xField | : | | any (opens in a new tab) | ; | xStart | : | | any (opens in a new tab) | ; | xStep | : | | any (opens in a new tab) | ; | yAxis | : | | any (opens in a new tab) | ; | yField | : | | any (opens in a new tab) | ; | zField | : | | any (opens in a new tab) | ; | zOrder | : | | any (opens in a new tab) | ; | | }

옵션 값을 읽는다.
prop()과 달리 효과 값이 아닌 명시적으로 설정된 값만 읽는다. 설정되지 않은 옵션은 undefined를 반환한다.

return 명시적으로 설정된 값 또는 undefined

saveOptions(props?, recursive?, includeDefs?, force?): Partial

이 모델 객체에 설정된 전역 기본값과 다른 옵션 값들이 포함된 사본 객체로 리턴한다.
options는 delta(명시 설정)만 담는다. 효과 값은 prop으로 읽는다.

return 옵션 사본 객체.

saveTo(target, props?, recursive?, includeDefs?, force?): Partial

모델의 설정 값을 target 객체에 복사해서 저장한다.

setStyle(prop, value, render?): CircleBarSeries

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

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

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

toggleAt(path, render?): any (opens in a new tab)

boolean (opens in a new tab) 타입의 모델 설정 값을 반대 값으로 변경한다.
path 매개변수는 하위 모델의 속성 이름을 점(.)으로 구분해서 지정한다. 예를 들어, "axis.x"는 axis 모델의 x 속성을 의미한다.
render와 force 매개변수는 toggleOption과 동일하다.

updateAt(path, value, render?, force?): any (opens in a new tab)

하위 모델의 설정 값을 변경한다.
path 매개변수는 하위 모델의 속성 이름을 점(.)으로 구분해서 지정한다. 예를 들어, "axis.x"는 axis 모델의 x 속성을 의미한다.
render와 force 매개변수는 updateOption과 동일하다.

updateData(data): void (opens in a new tab)

시리즈 data 원본을 변경하고 데이터포인트들을 다시 생성한다.
[주의] x축이 카테고리 축이고, x축의 categories 속성이 명시적으로 설정되지 않았다면, 이 함수 호출 후 카테고리가 변경될 수 있다.

updateOptions(source?, render?): this

하나 이상의 option 설정을 하고, 차트가 다시 그려지도록 한다.
ROptionable stock 구현을 사용하되, visible 변경 시 _visibleChanged를 통지한다.

updatePoint(p, props, animate?): boolean (opens in a new tab)

데이터포인터의 값들을 변경한다.
p 매개변수에 데이터포인트 대신 값을 지정하면, 그 값이 xValue와 동일한 첫번째 데이터포인트를 찾는다.
시리즈에 data를 지정하는 것과 동일한 방식으로 데이터포인트의 값(들)을 변경할 수 있다.
[주의] json으로 필드값(들)을 지정할 때는 시리즈에 지정된 field 이름 속성들과 같은 이름으로 값들을 지정해야 한다.

const x = '신흥동';
const p = chart.series.getPointAt(x)

chart.series.updatePoint(p, v + 10);

return 변경됐으면 true.