API
RouteSeries

RouteSeries extends Series

Route 시리즈 모델.
type'route'이고, 설정 모델은 RouteSeriesOptions이다.

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) readonly

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

default :undefined

Methods

addPoint(source, index?, duration?): DataPoint

데이터포인트를 하나 추가한다.
데이터포인트 하나를 제거하라면 removePoint를 사용한다.

ParameterTypeDescription
sourceany (opens in a new tab)데이터포인트 정보
index=-1number (opens in a new tab)추가 위치. 0보다 적으면 마지막에 추가된다.
duration=ADD_DURATIONnumber (opens in a new tab)0보다 큰값을 지정하면 애니메이션이 표시된다.

return 생성된 데이터포인트 객체

addPointList(source, index?, duration?): Array (opens in a new tab)<DataPoint>

데이터포인트를 하나 이상 추가한다.
여러 데이터포인트 한꺼번에 제거하라면 removePointList를 사용한다.

ParameterTypeDescription
sourceArray (opens in a new tab)<any (opens in a new tab)>데이터포인트 정보 목록
index=-1number (opens in a new tab)추가 위치. 0보다 적으면 마지막에 추가된다.
duration=ADD_DURATIONnumber (opens in a new tab)0보다 큰값을 지정하면 애니메이션이 표시된다.

return 생성된 데이터포인트 객체 목록

clearOptions(render?): RouteSeries

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

ParameterTypeDescription
render=trueboolean (opens in a new tab)true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true

return 모델 객체 자신

clearStyle(render?): RouteSeries

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

ParameterTypeDescription
render=falseboolean (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?): RouteSeries

명시적으로 설정된 모델 설정 값을 제거해서 모델의 기본 값이 적용되도록 한다.

ParameterTypeDescription
propkeyof (opens in a new tab) RouteSeriesOptions설정 항목 이름
render=trueboolean (opens in a new tab)true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true

return 모델 객체 자신

removePoint(p, duration?): void (opens in a new tab)

지정한 데이터포인트를 제거한다.
데이터포인트 하나를 추가하라면 addPoint를 사용한다.

ParameterTypeDescription
pstring (opens in a new tab) | number (opens in a new tab) | DataPoint삭제할 데이터포인트 객체나 인덱스 또는 문자열 id
duration=REMOVE_DURATIONnumber (opens in a new tab)0보다 크면 삭제 애니메이션 표시

removePointList(points, duration?): Array (opens in a new tab)<DataPoint>

복수 개 데이터포인트를 제거한다.
데이터포인트를 여러개 동시에 추가하라면 addPointList를 사용한다.

ParameterTypeDescription
pointsArray (opens in a new tab)<string (opens in a new tab) | number (opens in a new tab) | DataPoint>
duration=REMOVE_DURATIONnumber (opens in a new tab)0보다 크면 삭제 애니메이션 표시

setStyle(prop, value, render?): RouteSeries

모델 css style 값을 변경한다.

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

setStyles(styles, render?): RouteSeries

여러 항목의 모델 css style 값들을 json 객체로 지정해서 동시에 변경한다.

ParameterTypeDescription
stylesany (opens in a new tab)스타일 항목들과 값들이 설정된 json 객체
render=trueboolean (opens in a new tab)true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true

toggleOption(prop, render?): RouteSeries

boolean (opens in a new tab) 타입의 모델 설정 값을 반대 값으로 변경한다.

ParameterTypeDescription
propkeyof (opens in a new tab) RouteSeriesOptions설정 항목 이름
render=trueboolean (opens in a new tab)true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true

return 모델 객체 자신

updateOption(prop, value, render?): RouteSeries

모델 설정 값을 변경한다.

ParameterTypeDescription
propkeyof (opens in a new tab) RouteSeriesOptions설정 항목 이름
valueany (opens in a new tab)설정 값
render=trueboolean (opens in a new tab)true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본값: true

return 모델 객체 자신

updateOptions(source?, render?): RouteSeries

모델 설정 값들을 변경한다.

ParameterTypeDescription
sourceRouteSeriesOptions설정 옵션들이 포함된 json 객체
render=trueboolean (opens in a new tab)true로 지정하면 옵션 변경 시 맵차트를 다시 그린다. 기본갑 true

return 모델 객체 자신