IBChart(H) API

API

IBChart(H) Data Interface

IBChart(H)의 data interface에 대한 가이드 입니다.


Outline
Property
Data
EtcData


Outline

top

IBChart(H)의 Data Interface Schema는 Option, Data, EtcData 영역으로 구성되어있다. 데이터 형식은 JSON으로 권장한다. (XML도 호환)

Property Description
Option 차트의 데이터로 사용될 data 및 data들의 사용 및 표현을 정의한다. setOptions()
chart title, chart backgroundColor, series type, ...
Data 데이터로 사용될 실제 값을 설정한다.
[20,30,...], [[20,30,...],...], [{x:2,y:3},{x:3,y:5},...], ...
EtcData Data 이외의 데이터를 설정한다.

Data Interface JSON schema

{
    ibchart: {
        title: "Chart Title",
        subtitle: "subtitle",
        backgroundColor: "#FFFFFF",
        borderWidth: "1",
        borderColor: "#0000FF",
        zoomType: "x",
        etcData: [
            {key: "etc", value: 9.0}
        ],
        data: [{
            axisLabel: "A",
            series: [{
                seriesType : "line",
                seriesName: "중국",
                seriesColor: "blue",
                pointName: "하나",
                pointColor: "yellow",
                value: 10
            },{
                seriesType: "spline",
                seriesName: "호주",
                seriesColor: "red",
                pointName: "열하나",
                pointColor: "black",
                value: 11
            }]
        },{
            axisLabel: "B",
            series: [20,21]
        }]
    }
}

See


Data Interface XML schema

<IBChart Type='' backgroundColor='#FFFFFF' BorderWidth='1' BorderColor='#0000FF' ZoomType='x' Title='Chart Title' Subtitle='subtitle'>
    <Etc-Data>
        <Etc Key='etc'>9.0</Etc>
    </Etc-Data>
    <Data>
        <PointSet AxisLabel='A'>
            <Sereis SeriesType='line' SeriesName='중국' SeriesColor='blue' PointName='하나' PointColor='yellow'>10</Sereis>
            <Sereis SeriesType='spline' SeriesName='호주' SeriesColor='red' PointName='열하나' PointColor='black'>11</Sereis>
        </PointSet>
        <PointSet AxisLabel='B'>
            <Sereis>11</Sereis>
            <Sereis>21</Sereis>
        </PointSet>
    </Data>
</IBChart>

Deprecated See


Property

top

차트의 속성을 데이터와 동적으로 조회해서 적용한다.

{
    title: "Chart Title",
    subtitle: "subtitle",
    backgroundColor: "#FFFFFF",
    borderWidth: "1",
    borderColor: "#0000FF",
    zoomType: "x"
}

각 property에 대한 설명은 아래와 같다.

Property Description
title string optional
차트의 제목을 설정한다.
subtitle string optional
차트의 부제목을 설정한다.
backgroundColor string optional
차트의 배경색을 설정한다.
borderWidth string optional
차트의 윤곽선 두께를 설정한다.
borderColor string optional
차트의 윤곽선 색을 설정한다.
zoomType string optional
차트의 확대 가능한 축을 설정한다.
"x", "y", "xy"

Data

top

차트를 그리기 위해 필요한 x축, y축, z축에 대한 데이터를 동적으로 조회해서 적용한다.

{
    data: [{
            axisLabel: "A",
            series: []
    }]
}

각 property에 대한 설명은 아래와 같다.

Property Description
axisLabel string optional
X축의 명칭을 순서대로 설정한다.
기본값: x 값
series array required
차트에 그려질 시리즈 데이터를 설정한다.

series

series는 array로 구성되는데 index 순서로 시리즈가 만들어진다. 일의 자리 시리즈 A와 십의 자리 시리즈 B로 예를 들면 아래와 같다.

[{
    series: [{
        seriesType : "line",
        seriesName: "A",
        seriesColor: "blue",
        pointName: "하나",
        pointColor: "yellow",
        value: 1
    },{
        seriesType: "spline",
        seriesName: "B",
        seriesColor: "red",
        pointName: "열",
        pointColor: "black",
        value: 10
    }]
},{
    series: [2,20]
}]

각 property에 대한 설명은 아래와 같고 개별 시리즈 공통 설정(seriesType,seriesName,seriesColor)은 Data의 첫번째 series에만 설정하면 된다.

Property Description
seriesType string optional
시리즈의 종류를 설정한다.
seriesName string optional
시리즈의 이름을 설정한다.
seriesColor string optional
시리즈의 색을 설정한다.
pointName string optional
포인트의 이름을 설정한다.
pointColor string optional
포인트의 색을 설정한다.
value number array required
시리즈 포인트의 데이터를 설정한다.
숫자만 입력하면 y와 같고, 2차 배열 형태면 [x,y]와 같다. 또 3차 배열 형태면 [x,y,z]와 같다.

기본적으로 데이터는 숫자 배열로 입력 가능하다. (3개의 시리즈)

ex) x1: 0, x2: 2, x3: 3, y1: 1, y2: 10, y3: 100
[{
    series: [1,10,100]
}]

데이터는 object 형식으로 입력하거나 n차 배열로 입력이 가능하다. (3개의 시리즈)

ex) x1: 1, x2: 2, x3: 3, y1: 1, y2: 10, y3: 100
[{
    series: [[1,1],[2,10],[3,100]]
}]

or

[{
    series: [{
        x: 1,
        y: 1
    },{
        x: 2,
        y: 10
    },{
        x: 3,
        y: 100
    }]
}]

or

[{
    series: [{
        value: [1,1]
    },{
        value: [2,10]
    },{
        value: [3,100]
    }]
}]
ex) x1: 1, x2: 2, x3: 3, y1: 1, y2: 10, y3: 100, z1: 1, z2: 1, z3: 1
[{
    series: [[1,1,1],[2,10,1],[3,100,1]]
}]

or

[{
    series: [{
        x: 1,
        y: 1,
        z: 1
    },{
        x: 2,
        y: 10,
        z: 1
    },{
        x: 3,
        y: 100,
        z: 1
    }]
}]

or

[{
    series: [{
        value: [1,1,1]
    },{
        value: [2,10,1]
    },{
        value: [3,100,1]
    }]
}]

Etc Data

top

속성이나 데이터 이외의 정보를 담아서 차트에 포함 시킬 수 있다.

{
    etcData: [{
        key: "etc",
        value: 9.0
    }]
}

각 property에 대한 설명은 아래와 같다.

Property Description
etcData array object optional
data 이외의 데이터를 설정한다.