CandlestickSeriesOptions extends LowRangedSeriesOptions
subinterfaces OhlcSeriesOptions
Candlestick 시리즈.
type은 'candlestick'이다.
주식을 비롯한 유가증권과 파생상품, 환율 등의 가격 움직임을 보여주는 시리즈.
data는 아래 형식들로 전달할 수 있다.
[주의] 데이터포인트 구성에 필요한 모든 값을 제공하지 않으면 null이 된다.
[주의] high와 y값은 동일한 값이다.
단일값 또는 단일값 배열
| 형식 | 설명 |
|---|---|
| y | 단일 숫자면 low, y값. x 값은 순서에 따라 자동 결정. |
| [] | 빈 배열이면 null. x 값은 순서에 따라 자동 결정. |
| [min, low, mid, high | y] |
| [x, min, low, mid, high | y] |
json 배열
| Series 속성 | 설명 |
|---|---|
xField | 속성 값, 또는 'x', 'name', 'label' 속성들 중 순서대로 값이 설정된 것이 x 값이 된다. |
lowField | 속성 값, 또는 'low' 속성 값이 low 값이 된다. |
openField | 속성 값, 또는 'open' 속성 값이 open 값이 된다. |
closeField | 속성 값, 또는 'mid' 속성 값이 close 값이 된다. |
highField | 속성 값, 또는 'high' 속성 값이 high 값이 된다. 지정하지 않으면 yField 값이 사용된다. |
yField | 속성 값, 또는 'y', 'value' 속성들 중 순서대로 값이 설정된 것이 y 값이 된다. |
colorField | 속성 값, 또는 'color' 속성 값으로 데이터포인트의 개별 색상으로 지정된다. |
Options
closeField: string (opens in a new tab)
json 객체나 배열로 전달되는 데이터포인트 정보에서 종료(close) 값을 지정하는 속성명이나 인덱스.
undefined이면, data point의 값이 array일 때는 항목 수가 5이상이면 3, 아니면 2, 객체이면 'close'.
default :undefined
clusterable: boolean (opens in a new tab)
구분 배치가 가능한 둘 이상의 시리즈나 시리즈그룸이 표시 중일 때 구분 배치할 지 여부.
명시적 false로 지정하지 않는 한 무리 배치한다.
즉, 복수 개의 시리즈나 시리즈그룹의 데이터포인트들이 겹치지 않고 차레대로 표시된다.
default :undefined
col: number (opens in a new tab)
분할 모드일 때 시리즈가 표시될 pane의 수평 index.
default :undefined
color: string (opens in a new tab) | number (opens in a new tab)
데이터 포인트 기본 색.
숫자로 지정하면 정수로 변환된 값에 해당하는 팔레트 색상으로 설정된다.
'var(--color-n)'으로 지정한 것과 동일하며, 1 ~ 12 사이의 값으로 지정한다.
pointColors나 pointStyleCallback으로 설정된 색상이 이 속성으로 설정한 색상보다 우선한다.
default :undefined
colorField: string (opens in a new tab)
undefined이면, data point의 값이 객체일 때 'color'.
default :undefined
data: any (opens in a new tab)
데이터포인터들을 생성하는 데 사용되는 값 목록.
default :undefined
declineStyle: SVGStyles | string (opens in a new tab)
값이 하락한 데이터포인트에 적용되는 스타일셋 또는 css selector (opens in a new tab).
default :undefined
highField: string (opens in a new tab)
json 객체나 배열로 전달되는 데이터포인트 정보에서 최고(high) 값을 지정하는 속성명이나 인덱스.
undefined이면, yField 값으로 대체되거나 data point의 값이 array일 때는 항목 수가 5이상이면 4, 아니면 3, 객체이면 'high'.
default :undefined
hoverEffect: 'none' | 'default'
데이터포인트 hover 효과.
default :undefined
hoverStyle: SVGStyles | string (opens in a new tab)
데이터포인트 위에 마우스가 있을 때 적용되는
스타일셋 또는 css selector (opens in a new tab).
default :undefined
label: string (opens in a new tab)
이 시리즈를 나타내는 텍스트.
레전드나 툴팁에서 시리즈를 대표한다.
이 속성이 지정되지 않으면 name이 사용된다.
default :undefined
loadAnimation: 'default' | 'reveal' | 'grow' | 'spread' | 'fadein'
차트 설정 로드 시 실행되는 animation 종류.
default :undefined
lowField: string (opens in a new tab)
json 객체나 배열로 전달되는 데이터포인트 정보에서 최저(low) 값을 지정하는 속성명이나 인덱스.
undefined이면, data point의 값이 array일 때는 항목 수가 5이상이면 1, 아니면 0, 객체이면 'low'.
default :undefined
minPointWidth: number (opens in a new tab)
default :undefined
name: string (opens in a new tab)
시리즈 이름.
시리즈 생성시 지정된 후 변경할 수 없다.
차트의 다른 구성 요소에서 이 시리즈를 참조할 때 사용되며,
레전드나 툴팁에서 시리즈를 나타내는 텍스트로도 사용된다.
default :undefined
noClip: boolean (opens in a new tab)
true로 지정하면 body를 벗어난 data point 영역도 표시된다.
값을 지정하지 않으면 polar 차트에서는 true, 직교 차트에서는 false이다.
group에 포함되면 group의 noClip 설정을 따른다.
또, 값을 지정하지 않으면 버블시리즈는 최대한 버블들이 표시되도록 한다.
default :undefined
onPointClick: (args: DataPointCallbackArgs) => boolean (opens in a new tab)
데이터 point가 클릭될 때 호출되는 이벤트 콜백.
명시적 true를 리턴하면 기본 동작이 진행되지 않는다.
default :undefined
onPointHover: (args: DataPointCallbackArgs) => void (opens in a new tab)
마우스가 데이터 point 위에 올라가거나 빠져나갈 때 호출되는 이벤트 콜백.
빠져나가는 경우 args 매개변수는 null이다.
default :undefined
onPointsLoaded: (series: object (opens in a new tab), firstTime: boolean (opens in a new tab)) => void (opens in a new tab)
데이터포인트들이 새로 로드된 후 호출된다.
default :undefined
openField: string (opens in a new tab)
json 객체나 배열로 전달되는 데이터포인트 정보에서 시작(open) 값을 지정하는 속성명이나 인덱스.
undefined이면, data point의 값이 array일 때는 항목 수가 5이상이면 2, 아니면 1, 객체이면 'open'.
default :undefined
pointColors: string (opens in a new tab) | Array (opens in a new tab)<string (opens in a new tab)>
데이터 포인트별 색들을 지정한다.
색 배열로 지정하거나, 'colors' asset으로 등록된 이름을 지정할 수 있다.
pointStyleCallback으로 설정된 색상이나 데이터포인트별로 지정한 색상이 이 속성으로 설정한 색상보다 우선한다.
default :undefined
pointLabel: boolean (opens in a new tab) | DataPointLabelOptions
데이터포인트 label 옵션.
단순히 boolean (opens in a new tab) 값으로 설정하면 visible 속성에 적용된다.
default :undefined
pointPadding: number (opens in a new tab)
이 시리즈의 point가 차지하는 영역 중에서 point bar 양쪽 끝에 채워지는 빈 영역의 크기.
point가 차지할 원래 크기에 대한 상대 값으로서, 0 ~ 0.5 사이의 비율 값으로 지정한다.
default :undefined한 카테고리에 cluster 가능한 시리즈가 하나만 표시되면 0.25, group에 포함된 경우 0.1, 여러 시리즈와 같이 표시되면 0.2.
pointPos: number (opens in a new tab)
default :undefined
pointStyle: SVGStyles | string (opens in a new tab)
모든 데이터포인트에 적용되는 스타일셋 또는 css selector (opens in a new tab).
style로 설정되는 시리즈의 inline 스타일이
데이터포인터에 적용되지 않는 경우 이 속성을 사용할 수 있다.
pointColors나 color가 설정되면 이 속성으로 설정된 색상은 무시된다.
또, pointStyleCallback으로 설정된 스타일이 이 속성 스타일보다 우선한다.
default :undefined
pointStyleCallback: (args: DataPointCallbackArgs) => SVGStyles|string (opens in a new tab)
데이터포인트의 동적 스타일 콜백.
default :undefined
pointWidth: number (opens in a new tab)
시리즈가 그룹에 포함되지 않거나,
포함된 그룹의 layout이 DEFAULT이거나 특별히 설정되지 않아서,
그룹에 포함된 시리즈들의 data point가 옆으로 나열되어 표시될 때,
포인트 표시 영역 내에서 이 시리즈의 포인트가 차지하는 영역의 상대 크기.
예를 들어 이 시리즈의 속성값이 1이고 다른 시리즈의 값이 2이면 다른 시리즈의 data point가 두 배 두껍게 표시된다.
또, 그룹에 포함되고 그룹의 layout이 DEFAULT
default :undefined
row: number (opens in a new tab)
분할 모드일 때 시리즈가 표시될 pane의 수직 index.
default :undefined
style: SVGStyles | string (opens in a new tab)
스타일셋 또는 css selector (opens in a new tab).
default :undefined
tooltipCallback: (args: any (opens in a new tab)) => string (opens in a new tab)
default :undefined
tooltipText: string (opens in a new tab)
default :'<b>${name}</b><br>최저:<b>${lowValue}</b><br>시가: <b>${openValue}</b><br>종가: <b>${closeValue}</b><br>고가: <b>${highValue}</b>'
trendline: TrendlineOptions
추세선 옵션.
default :undefined
type: 'candlestick' | 'ohlc'
'candlestick''ohlc'
default :undefined
viewRangeValue: 'x' | 'y' | 'z'
ranges가 적용되는 값.
지정하지 않으면 시리즈 종류에 띠라 자동 적용된다.
'line' 시리즈 계열은 'x', 나머지는 'y'가 된다.
현재 'z'은 range는 bubble 시리즈에만 적용할 수 있다.
default :undefined
viewRanges: ValueRangeList | Array (opens in a new tab)<ValueRange>
값 범위 목록.
범위별로 다른 스타일을 적용할 수 있다.
범위들은 중첩될 수 없다.
default :undefined
visible: boolean (opens in a new tab)
표시 여부.
default :true
visibleInLegend: boolean (opens in a new tab)
명시적 false로 지정하면 legend에 표시하지 않는다.
default :undefined
visibleInNavigator: boolean (opens in a new tab)
true로 지정하면 시리즈 내비게이터에 표시한다.
default :undefined
visibleThreshold: number (opens in a new tab)
포인터가 차지하는 너비가 이 값 미만이면 표시하지 않는다.
default :undefined
xAxis: string (opens in a new tab) | number (opens in a new tab)
그룹에 포함되면 그룹 설정을 따른다.
default :undefined
xField: string (opens in a new tab) | number (opens in a new tab)
json 객체나 배열로 전달되는 데이터포인트 정보에서 x 값을 지정하는 속성명이나 인덱스.
undefined이면, data point의 값이 array일 때는 0, 객체이면 'x'.
default :undefined
xStart: any (opens in a new tab)
연결된 x축이 연속 축(카테고리축이 아닌)일 때, x축 값이 설정되지 않은 첫번째 데이터 point에 설정되는 x값.
이 후에는 xStep씩 증가시키면서 설정한다.
이 속성이 지정되지 않은 경우 xStart가 적용된다.
default :undefined
xStep: string (opens in a new tab) | number (opens in a new tab)
연결된 x축이 연속 축(카테고리축이 아닌)일 때, x축 값이 설정되지 않은 데이터 point에 지정되는 x값의 간격.
첫번째 값은 xStart로 설정한다.
time 축일 때, 정수 값 대신 시간 단위('y', 'm', 'w', 'd', 'h', 'n', 's')로 지정할 수 있다.
이 속성이 지정되지 않으면 xStep이 적용된다.
default :undefined
yAxis: string (opens in a new tab) | number (opens in a new tab)
그룹에 포함되면 그룹 설정을 따른다.
default :undefined
yField: string (opens in a new tab) | number (opens in a new tab) | Function (opens in a new tab)
json 객체나 배열로 전달되는 데이터포인트 정보에서 y 값을 지정하는 속성명이나 인덱스.
undefined이면, data point의 값이 array일 때는 1, 객체이면 'y'.
default :undefined
zField: string (opens in a new tab) | number (opens in a new tab) | Function (opens in a new tab)
json 객체나 배열로 전달되는 데이터포인트 정보에서 z 값을 지정하는 속성명이나 인덱스.
undefined이면, data point의 값이 array일 때는 2, 객체이면 'z'.
default :undefined
zOrder: number (opens in a new tab)
시리즈 표시 순서를 지정할 수 있다.
값이 클 수록 나중에(위에) 표시된다.
default :undefined