BandSeries extends MarkerSeries
BandSeries의 기능을 사용하기 위해서는 'band'모듈이 필요하다. 자세한 설명은 guide/modules에서 확인할 수 있다.
Band 시리즈 모델.
type은 'band'이고,
설정 모델은 BandSeriesOptions이다.
BandSeries의 기능을 사용하기 위해서는 'band'모듈이 필요하다. 자세한 설명은 guide/modules에서 확인할 수 있다.
Properties
data: any (opens in a new tab) readonly
데이터포인터들을 생성하는 데 사용되는 값 목록.
default :undefined
index: number (opens in a new tab) readonly
차트 시리즈 목록에서 위치.
default :undefined
name: string (opens in a new tab) readonly
시리즈 이름.
시리즈 생성시 지정된 후 변경할 수 없다.
맵차트의 다른 구성 요소에서 이 시리즈를 참조할 때 사용되며,
레전드나 툴팁에서 시리즈를 나타내는 텍스트로도 사용된다.
default :undefined
pointLabel: DataPointLabel readonly
데이터포인트 label 설정 모델.
default :undefined
visible: boolean (opens in a new tab)
표시 여부.
options.visible 값을 그대로 return하는 것이 아니라,
undefined나 null 등으로 지정하는 경우 모델의 상태에 따라 true나 false로 해석될 수 있다.
설정의 경우 updateOptions({visible: value})로 지정하는 것과 동일하다.
default :undefined
Methods
addPoint(source, index?, duration?): DataPoint
데이터포인트를 하나 추가한다.
데이터포인트 하나를 제거하라면 removePoint를 사용한다.
| Parameter | Type | Description |
|---|---|---|
| source | any (opens in a new tab) | 데이터포인트 정보 |
| index | number (opens in a new tab) | 추가 위치. 0보다 적으면 마지막에 추가된다. |
| duration | number (opens in a new tab) | 0보다 큰값을 지정하면 애니메이션이 표시된다. |
return 생성된 데이터포인트 객체
addPointList(source, index?, duration?): Array (opens in a new tab)<DataPoint>
데이터포인트를 하나 이상 추가한다.
여러 데이터포인트 한꺼번에 제거하라면 removePointList를 사용한다.
| Parameter | Type | Description |
|---|---|---|
| source | Array (opens in a new tab)<any (opens in a new tab)> | 데이터포인트 정보 목록 |
| index | number (opens in a new tab) | 추가 위치. 0보다 적으면 마지막에 추가된다. |
| duration | number (opens in a new tab) | 0보다 큰값을 지정하면 애니메이션이 표시된다. |
return 생성된 데이터포인트 객체 목록
clearOptions(render?): BandSeries
명시적으로 설정된 모든 모델 설정 값들을 제거한다.
| Parameter | Type | Description |
|---|---|---|
| render | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true |
return 모델 객체 자신
clearStyle(render?): BandSeries
명시적으로 모델에 설정된 모든 style 값들을 제거한다.
| Parameter | Type | Description |
|---|---|---|
| render | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본값 false |
destroy(): null
객체가 소유한 참조 등을 해제하고 null을 리턴한다.
list = lis.destroy();return null
lock(): void (opens in a new tab)
rendering lock.
removeOption(prop, render?): BandSeries
명시적으로 설정된 모델 설정 값을 제거해서 모델의 기본 값이 적용되도록 한다.
| Parameter | Type | Description |
|---|---|---|
| prop | keyof (opens in a new tab) BandSeriesOptions | 설정 항목 이름 |
| render | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true |
return 모델 객체 자신
removePoint(p, duration?): void (opens in a new tab)
지정한 데이터포인트를 제거한다.
데이터포인트 하나를 추가하라면 addPoint를 사용한다.
| Parameter | Type | Description |
|---|---|---|
| p | string (opens in a new tab) | number (opens in a new tab) | DataPoint | 삭제할 데이터포인트 객체나 인덱스 또는 문자열 id |
| duration | number (opens in a new tab) | 0보다 크면 삭제 애니메이션 표시 |
removePointList(points, duration?): Array (opens in a new tab)<DataPoint>
복수 개 데이터포인트를 제거한다.
데이터포인트를 여러개 동시에 추가하라면 addPointList를 사용한다.
| Parameter | Type | Description |
|---|---|---|
| points | Array (opens in a new tab)<string (opens in a new tab) | number (opens in a new tab) | DataPoint> | |
| duration | number (opens in a new tab) | 0보다 크면 삭제 애니메이션 표시 |
setStyle(prop, value, render?): BandSeries
모델 css style 값을 변경한다.
value에 undefined나 null, ''을 지정하면 기존에 설정됐던 스타일 항목이 제거된다.
| Parameter | Type | Description |
|---|---|---|
| prop | string (opens in a new tab) | css 스타일 항목 이름. |
| value | any (opens in a new tab) | 적용할 스타일 값. |
| render | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본값 true |
setStyles(props, clear?, render?): BandSeries
여러 항목의 모델 css style 값들을 json 객체로 지정해서 동시에 변경한다.
value에 undefined나 null, ''을 지정하면 기존에 설정됐던 스타일 항목이 제거된다.
| Parameter | Type | Description |
|---|---|---|
| props | object (opens in a new tab) | 스타일 항목들과 값들이 설정된 json 객체 |
| clear | boolean (opens in a new tab) | true로 지정하면 기존 스타일 값을 모두 제거한다. 기본값 false |
| render | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본값 true |
toggleOption(prop, render?): BandSeries
boolean (opens in a new tab) 타입의 모델 설정 값을 반대 값으로 변경한다.
| Parameter | Type | Description |
|---|---|---|
| prop | keyof (opens in a new tab) BandSeriesOptions | 설정 항목 이름 |
| render | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true |
return 모델 객체 자신
updateOption(prop, value, render?, force?): BandSeries
하나의 속성 값을 설정한다.
여러 속성들을 한꺼번에 변경할 때는 updateOptions를 사용한다.
기본적으로 이전 값과 다른 경우에만 적용된다.
특히, 속성값이 객체인 경우 객체 속성만 바뀐 경우 적용되지 않는다.
바꾸고 싶다면 force 매개변수를 true로 지정해서 호출한다.
또, prop 매개변수가 하위 모델 이름인 경우 하위 모델의 updateOptions를 호출한 것과 동일하다.
| Parameter | Type | Description |
|---|---|---|
| prop | keyof (opens in a new tab) BandSeriesOptions | 설정 항목 이름 |
| value | any (opens in a new tab) | 설정 값 |
| render | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본값: true |
| force | boolean (opens in a new tab) | 지정한 값이 이전 값과 동일한 경우에도 적용한다. 기본값: false |
return 모델 객체 자신
updateOptions(source?, render?): BandSeries
모델 설정 값들을 변경한다.
| Parameter | Type | Description |
|---|---|---|
| source | BandSeriesOptions | 설정 옵션들이 포함된 json 객체 |
| render | boolean (opens in a new tab) | true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true |
return 모델 객체 자신