API
SankeySeries

SankeySeries extends MarkerSeries

SankeySeries의 기능을 사용하기 위해서는 'sankey'모듈이 필요하다. 자세한 설명은 guide/modules에서 확인할 수 있다.


Sankey 시리즈 모델.
type'sankey'이고, 설정 모델은 SankeySeriesOptions이다.

SankeySeries의 기능을 사용하기 위해서는 'sankey'모듈이 필요하다. 자세한 설명은 guide/modules에서 확인할 수 있다.


Properties

data: any (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하는 것이 아니라, undefinednull 등으로 지정하는 경우 모델의 상태에 따라 truefalse로 해석될 수 있다.
설정의 경우 updateOptions({visible: value})로 지정하는 것과 동일하다.

default :undefined

Methods

clearOptions(render?): SankeySeries

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

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

return 모델 객체 자신

clearStyle(render?): SankeySeries

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

ParameterTypeDescription
renderboolean (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?): SankeySeries

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

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

return 모델 객체 자신

setStyle(prop, value, render?): SankeySeries

모델 css style 값을 변경한다.

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

setStyles(styles, render?): SankeySeries

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

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

toggleOption(prop, render?): SankeySeries

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

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

return 모델 객체 자신

updateOption(prop, value, render?): SankeySeries

모델 설정 값을 변경한다.

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

return 모델 객체 자신

updateOptions(source?, render?): SankeySeries

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

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

return 모델 객체 자신