개발 Guide
RealChart 라이브러리 사용 개요 및 주의 사항들
javascript로 작성된 예제 코드 부분을 제외하고,
Api 문서는 정확한 자료형이 표시되는 typescript 스타일로 설명되어 있다.
업무용 앱의 신뢰성을 위해 최대한 자료형에 맞게 Api를 사용해야 한다.
기본적으로 OOP(객체지향 프로그래밍)에 기반 설계되고 구현되었다.
Api 문서에는 base 클래스, 계승된 메소드 및 속성 등이 명시되어 있다.
Namespace
RealChart 라이브러리의 네임스페이스는 RealChart 이다.
const chart = RealChart.createChart(document, 'realchart', config);주의 사항
- Api 문서에 공개되지 않은 숨겨진 클래스나 함수 및 속성 등을 사용해서는 안된다. 특히,'$'나 '_'로 시작하는 함수나 속성 및 객체는 내부 구현 상황에 따라 언제든 변경될 수 있으므로 절대 접근(호출, 수정)해서는 안된다.
- Api에 명시된 자료형대로 매개변수나 속성 값을 지정해야 한다.
- Api에 명시된 enum (opens in a new tab) 타입이나 string literal union (opens in a new tab) 타입에 포함되지 않은 값을 사용해서는 안된다.
Typescript
RealChart 라이브러리는 typescript로 개발됐을 뿐 아니라, typescript로 사용할 때 최상의 도움을 받을 수 있도록 작성되었다. 특히, 차트 설정 json 객체를 구성할 때 명시적인 타입 단언('type assersion') (opens in a new tab)으로 라이브러리의 타입 정보를 최대한 활용할 수 있고, 의도하지 않은 typescript 에러를 방지할 수 있다.
// ChartConfiguration으로 타입을 지정하면 차트 설정 json에 항목을 지정할 때 마다
// typescript 코드 편집기가 도움을 제공한다.
const config: ChartConfiguration = {
series: {
type: line,
...
}
}
const chart = RealChart.createChart(document, 'realchart', config);