API
API
Classes
RcChartControl

RcChartControl

RealChart ์ปจํŠธ๋กค.

Properties

body: RcBody

์ฐจํŠธ ์‹œ๋ฆฌ์ฆˆ, ๊ฒŒ์ด์ง€, annotation๋“ค์ด ๊ทธ๋ ค์ง€๋Š” plotting ์˜์—ญ ๋ชจ๋ธ.

gauge: RcChartGauge

์ฒซ๋ฒˆ์งธ ๊ฒŒ์ด์ง€.

<readonly> gaugeType: string (opens in a new tab)

๊ธฐ๋ณธ ๊ฒŒ์ด์ง€ ์ข…๋ฅ˜.
๊ฒŒ์ด์ง€์— type์„ ์ง€์ •ํ•˜์ง€ ์•Š์œผ๋ฉด ์ด ์†์„ฑ type์˜ ์‹œ๋ฆฌ์ฆˆ๋กœ ์ƒ์„ฑ๋œ๋‹ค.

<readonly> inverted: boolean (opens in a new tab)

true๋ฉด x์ถ•๊ณผ y์ถ•์„ ๋’ค๋ฐ”๊ฟ” ํ‘œ์‹œํ•œ๋‹ค.
์ฆ‰, true๋ฉด x์ถ•์ด ์ˆ˜์ง, y์ถ•์ด ์ˆ˜ํ‰์œผ๋กœ ๋ฐฐ์น˜๋œ๋‹ค.

legend: RcLegend

์ฐจํŠธ ๋ฒ”๋ก€ ๋ชจ๋ธ.

<readonly> polar: boolean (opens in a new tab)

true๋ฉด ์ฐจํŠธ๊ฐ€ ๊ทน์ขŒํ‘œ๊ณ„๋กœ ํ‘œ์‹œ๋œ๋‹ค. ๊ธฐ๋ณธ์€ ์ง๊ต์ขŒํ‘œ๊ณ„์ด๋‹ค. ๊ทน์ขŒํ‘œ๊ณ„์ผ ๋•Œ, x์ถ•์ด ์›ํ˜ธ์—, y์ถ•์€ ๋ฐฉ์‚ฌ์„ ์— ์œ„์น˜ํ•˜๊ณ , ์•„๋ž˜์˜ ์ œํ•œ ์‚ฌํ•ญ์ด ์žˆ๋‹ค.

  1. x์ถ•์€ ์ฒซ๋ฒˆ์งธ ์ถ• ํ•˜๋‚˜๋งŒ ์‚ฌ์šฉ๋œ๋‹ค.
  2. axis.position ์†์„ฑ์€ ๋ฌด์‹œ๋œ๋‹ค.
  3. chart, series์˜ inverted ์†์„ฑ์ด ๋ฌด์‹œ๋œ๋‹ค.
  4. ๊ทน์ขŒํ‘œ๊ณ„์— ํ‘œ์‹œํ•  ์ˆ˜ ์—†๋Š” series๋“ค์€ ํ‘œ์‹œ๋˜์ง€ ์•Š๋Š”๋‹ค.

series: RcChartSeries

์ฐจํŠธ์— ์„ค์ •๋œ ์ฒซ๋ฒˆ์งธ ์‹œ๋ฆฌ์ฆˆ.
์‹œ๋ฆฌ์ฆˆ ๊ฐœ์š” ๋ฐ ์‹œ๋ฆฌ์ฆˆ ์„ค์ •์„ ์ฐธ์กฐํ•œ๋‹ค.

subtitle: RcSubtitle

์ฐจํŠธ ๋ถ€์ œ๋ชฉ ๋ชจ๋ธ.

title: RcTitle

์ฐจํŠธ ํƒ€์ดํ‹€ ๋ชจ๋ธ.

<readonly> type: string (opens in a new tab)

๊ธฐ๋ณธ ์‹œ๋ฆฌ์ฆˆ ์ข…๋ฅ˜.
์‹œ๋ฆฌ์ฆˆ์— type์„ ์ง€์ •ํ•˜์ง€ ์•Š์œผ๋ฉด ์ด ์†์„ฑ type์˜ ์‹œ๋ฆฌ์ฆˆ๋กœ ์ƒ์„ฑ๋œ๋‹ค.

xAxis: RcChartAxis

์ฒซ๋ฒˆ์งธ x ์ถ•.

yAxis: RcChartAxis

์ฒซ๋ฒˆ์งธ y ์ถ•.

Methods

addSeries(source, animate): RcChartSeries

์‹œ๋ฆฌ์ฆˆ๋ฅผ ์ถ”๊ฐ€ํ•œ๋‹ค.

ParameterTypeDescription
sourceany (opens in a new tab)์‹œ๋ฆฌ์ฆˆ ์„ค์ • json.
animate=trueboolean (opens in a new tab)์• ๋‹ˆ๋ฉ”์ด์…˜ ์‹คํ–‰ ์—ฌ๋ถ€.

destroy(): void (opens in a new tab)

์ฐจํŠธ SVG๋ฅผ ๋ถ€๋ชจ div์—์„œ ์ œ๊ฑฐํ•˜๊ณ  ๊ด€๋ จ ๋ชจ๋ธ๋“ค๋„ ์ œ๊ฑฐํ•œ๋‹ค.
์ด ํ›„๋กœ๋Š” ๊ธฐ์กด ์ปจํŠธ๋กค์„ ์‚ฌ์šฉํ•  ์ˆ˜ ์—†๋‹ค.

export(options): void (opens in a new tab)

ํ˜„์žฌ ํ‘œ์‹œ ์ค‘์ธ ์ฐจํŠธ๋ฅผ PNG, JPG ๋˜๋Š” SVG ๋ฒกํ„ฐ ์ด๋ฏธ์ง€๋กœ ๋‹ค์šด๋กœ๋“œํ•œ๋‹ค.

chart.export({
     type: 'png',
     fileName: 'realchart'
})
ParameterType
optionsIRcExportOptions

getAnnotation(name): RcAnnotation

Annotation ์ด๋ฆ„์— ํ•ด๋‹นํ•˜๋Š” Annotation ๊ฐ์ฒด๋ฅผ ๋ฆฌํ„ดํ•œ๋‹ค.

ParameterTypeDescription
namestring (opens in a new tab)Annotation ์ด๋ฆ„

getGauge(name): RcChartGauge

๊ฒŒ์ด์ง€ ์ด๋ฆ„์— ํ•ด๋‹นํ•˜๋Š” ๊ฒŒ์ด์ง€ ๊ฐ์ฒด๋ฅผ ๋ฆฌํ„ดํ•œ๋‹ค.

ParameterTypeDescription
namestring (opens in a new tab)๊ฒŒ์ด์ง€ ์ด๋ฆ„

getSeries(name): RcChartSeries

์‹œ๋ฆฌ์ฆˆ ์ด๋ฆ„์— ํ•ด๋‹นํ•˜๋Š” ์‹œ๋ฆฌ์ฆˆ ๊ฐ์ฒด๋ฅผ ๋ฆฌํ„ดํ•œ๋‹ค.

ParameterTypeDescription
namestring (opens in a new tab)์‹œ๋ฆฌ์ฆˆ ์ด๋ฆ„

getXAxis(name): RcChartAxis

name ๋งค๊ฐœ๋ณ€์ˆ˜๊ฐ€ ๋ฌธ์ž์—ด์ด๋ฉด ์ง€์ •ํ•œ ์ด๋ฆ„์˜ x ์ถ•์„, ์ˆซ์ž์ด๋ฉด ํ•ด๋‹น index์— ์œ„์น˜ํ•˜๋Š” x ์ถ•์„ ๋ฆฌํ„ดํ•œ๋‹ค.

ParameterTypeDescription
namestring (opens in a new tab) | number (opens in a new tab)์ด๋ฆ„์ด๋‚˜ index

getYAxis(name): RcChartAxis

name ๋งค๊ฐœ๋ณ€์ˆ˜๊ฐ€ ๋ฌธ์ž์—ด์ด๋ฉด ์ง€์ •ํ•œ ์ด๋ฆ„์˜ y ์ถ•์„, ์ˆซ์ž์ด๋ฉด ํ•ด๋‹น index์— ์œ„์น˜ํ•˜๋Š” y ์ถ•์„ ๋ฆฌํ„ดํ•œ๋‹ค.

ParameterTypeDescription
namestring (opens in a new tab) | number (opens in a new tab)์ด๋ฆ„์ด๋‚˜ index

load(config, animate?, callback?): RcChartControl

๊ธฐ์กด ์„ค์ • ๋ชจ๋ธ์„ ์ œ๊ฑฐํ•˜๊ณ  ์ƒˆ๋กœ์šด ์„ค์ •์œผ๋กœ ์ฐจํŠธ๋ฅผ ์žฌ๊ตฌ์„ฑํ•œ๋‹ค.

ParameterType
configany (opens in a new tab)
animateboolean (opens in a new tab)
callback( | ...args | unknown (opens in a new tab) | [ | ] | ) | | => | | void (opens in a new tab)

removeSeries(series, animate): RcChartSeries

ParameterType
seriesstring (opens in a new tab) | RcChartSeries
animate=trueboolean (opens in a new tab)

render(): void (opens in a new tab)

๋‹ค์Œ rendering frame์„ ๊ธฐ๋‹ค๋ฆฌ์ง€ ์•Š๊ณ , ์ฐจํŠธ๋ฅผ ์ฆ‰์‹œ ๋‹ค์‹œ ๊ทธ๋ฆฐ๋‹ค.
์ฐจํŠธ rendering ์ž‘์—…์€ ์ž์› ์†Œ๋ชจ๊ฐ€ ๋งŽ๊ณ  ์†Œ์šฉ ์‹œ๊ฐ„๋„ ์ ์ง€ ์•Š์œผ๋ฏ€๋กœ, data๋‚˜ ์—ฌ๋Ÿฌ ๋ชจ๋ธ์„ ์ˆ˜์ •ํ•˜๋Š” ๊ฒฝ์šฐ ๋ชจ๋“  ์ž‘์—…์ด ์™„๋ฃŒ๋œ ํ›„ ํ•œ ๋ฒˆ ํ˜ธ์ถœํ•ด์•ผ ํ•œ๋‹ค. ๊ฐ€๋Šฅํ•˜๋ฉด ์ด ํ•จ์ˆ˜๋Š” ํ˜ธ์ถœํ•˜์ง€ ์•Š๊ณ  ์ฐจํŠธ ๊ธฐ๋ณธ ๋™์ž‘(๋‹ค์Œ frame์— ์ด์ „ ๋ณ€๊ฒฝ ์‚ฌํ•ญ๋“ค์„ ๋ชจ์•„์„œ ํ•œ ๋ฒˆ rendering)์œผ๋กœ ์‹คํ–‰๋˜๊ฒŒ ํ•ด์•ผ ํ•œ๋‹ค.

setParam(param, value, redraw?): void (opens in a new tab)

ParameterType
paramstring (opens in a new tab)
valueany (opens in a new tab)
redrawboolean (opens in a new tab)