diff --git a/website/src/kr/api/index.md b/website/src/kr/api/index.md new file mode 100644 index 00000000..7aba967d --- /dev/null +++ b/website/src/kr/api/index.md @@ -0,0 +1,130 @@ +# 코딩 레퍼런스 + +## Props + +`vue-chartjs`가 제공하는 컴포넌트들은 몇 가지 기본적인 속성들을 정의한다. `확장`하고 있기 때문에, 그들은 * 보이지 않는 *이지만, 그 값을 덮어 쓸 수 있습니다 : + +| Prop 이름 | 설명 | +|---|---| +| width | 차트 폭 | +| height | 차트 높이 | +| chart-id | canvas 요소의 id | +| css-classes | 둘러싸는 div css 클래스 (문자열) | +| styles | 둘러싸는 div 의 css 클래스 (객체) | +| plugins | chartjs 플러그인 (배열) | + +## Events + +`reactData` 또는 `reactProp` 믹스 인이 사용되면 다음 이벤트가 발행됩니다. + +| 이벤트 이름 | 설명 | +|---|---| +| `chart:render` | 믹스 인이 완전히 렌더링 될 때 | +| `chart:destroy` | 믹스인이 차트 오브젝트 인스턴스를 삭제할 때 | +| `chart:update` | 믹스 인이 다시 렌더링 대신 업데이트를 할 때 | +| `labels:update` | labels가 설정되면 | +| `xlabels:update` | xlabels가 설정되면 | +| `ylabels:update` | ylabels가 설정되면 | + +## Global Methods +전역 메소드는 가져오고 사용합니다. + +### generateChart + +- **Type:** `Function` +- **Arguments**: `chart-id`, `chart-type` +- **Usage:** + +```js +import { generateChart } from 'vue-chartjs' +// First argument is the chart-id, second the chart type. +const CustomLine = generateChart('custom-line', 'LineWithLine') +``` + +## Instance Methods + +인스턴스 메소드는 독자적인 차트 컴퍼넌트내에서 사용할 수가 있습니다. + + +### generateLegend() + +HTML 범례를 만드는 도우미 함수 + +- **Type:** `Function` +- **Arguments**: `none` +- **Usage:** + +```js{11} +import { Line } from 'vue-chartjs' + +export default { + extends: Line, + props: ['datasets', 'options'] + data: () => ({ + htmlLegend: null + }) + mounted () { + this.renderChart(this.datasets, this.options) + this.htmlLegend = this.generateLegend() + } +} + +``` + +### 플러그인 추가 + +Chart.js에서는 글로벌 플러그인과 인라인 플러그인을 정의할 수 있습니다. 글로벌 플러그인은 [Chart.js docs] (http://www.chartjs.org/docs/latest/developers/plugins.html)에서 설명한대로 'vue-chartjs'에서도 잘 작동합니다. . + + +인라인 플러그인을 추가하려는 경우를 대비하여 `vue-chartjs`는 `addPlugin()`이라는 헬퍼 메소드를 노출합니다. + +`renderChart()` 메소드 앞에 `addPlugin()` 을 호출해야합니다. + +- **Type:** `Function` +- **Arguments**: `Array` of Plugins +- **Usage:**### 플러그인 추가 + +```js +mounted () { + this.addPlugin({ + id: 'my-plugin', + beforeInit: function (chart) { + .... + } + }) +} +``` + +### renderChart() + +Chart.js의 인스턴스를 만들고 그립니다. + +- **Type:** `Function` +- **Arguments**: `Chart Data`, `Chart Options` +- **Usage:** + +```js +mounted () { + this.renderChart({ + labels: ['January', 'February'], + datasets: [ + { + label: 'Data One', + backgroundColor: '#f87979', + data: [40, 20] + } + ]}, + { + responsive: true + } + ) +} +``` + +## Chart.js 객체 + +독자적인 차트 컴퍼넌트내로부터 Chart.js 의 오브젝트에는 `this.$data._chart` 로 액세스 할 수 있습니다. + +## Canvas + +Canvas 요소는 `this.$refs.canvas`로 액세스 할 수 있습니다. \ No newline at end of file diff --git a/website/src/kr/guide/index.md b/website/src/kr/guide/index.md new file mode 100644 index 00000000..9d2b111b --- /dev/null +++ b/website/src/kr/guide/index.md @@ -0,0 +1,487 @@ +# 시작하기 + +**vue-chartjs**는 [Chart.js](https://github.com/chartjs/Chart.js)를 vue에서 사용하기 위한 래퍼입니다. 재사용 가능한 차트 구성 요소를 쉽게 만들 수 있습니다. + +## 처음에 + +`vue-chartjs` 너무 힘들지 않고 vue 안에서 chart.js를 사용할 수 있습니다. 간단한 차트를 가능한 한 빨리 시작하고 실행하고 싶은 사람에게 이상적입니다. + +chart.js의 기본 로직을 추상화하고 있지만 게시 된 chart.js의 객체를 사용하여 유연하게 사용자 정의 할 수 있습니다. + +## 설치 + +### NPM + +`npm`을 사용하여 `vue-chartjs`를 설치할 수 있습니다. 그러나 프로젝트에 대한 종속성으로 `chart.js`를 추가해야합니다. 왜냐하면 `Chart.js`는 peerDependency이기 때문입니다. 따라서 Chart.js 버전을 완전히 제어할 수 있습니다. + +`yarn add vue-chartjs chart.js@2.9.4` or `npm install vue-chartjs chart.js@2.9.4 --save` + +::: tip +Vue.js의 버전 1.x를 사용하는 경우 `legacy` 태그를 사용하십시오. 그러나 vue의 버전 1은 더 이상 유지 보수되지 않습니다. + +`yarn add vue-chartjs@legacy` +::: + +### 브라우저 + +브라우저에서 직접 `vue-chartjs`를 사용할 수 있습니다. +먼저 `Chart.js` 스크립트를 추가하고`vue-chartjs` 스크립트를 추가하십시오. + +``html + + +`` + +## 통합 + +`Chart.js`에서 사용 가능한 모든 차트 유형은 명명된 컴포넌트로 내보내져 그대로 가져올 수 있습니다. 이러한 컴포넌트는 일반적인 Vue 컴포넌트이지만 그것을 `확장`해야합니다. + +`vue-chartjs` 뒤에 있는 아이디어는 최대한의 유연성과 확장성을 가지며 사용하기 쉬운 컴포넌트를 제공하는 것이다. 이것을 실현하려면 , 독자적인 *Chart Component* 를 작성해, 그것을 `vue-chartjs` 컴퍼넌트해 제공하도록 확장할 필요가 있습니다. + +확장하면 차트 구성 요소의 메서드와 논리가 자체 차트 구성 요소에 병합됩니다. + +## 첫 번째 차트 만들기 + +BaseChart를 가져오고 확장합니다. 이 방법으로 다른 데이터의 차트를 볼 때 유연성이 크게 향상됩니다. +구성 요소를 캡슐화하고 속성을 사용하여 구성 요소의 데이터에 전달하거나 구성 요소에 직접 데이터를 설명할 수 있습니다. 다만 직접 컴퍼넌트내에 데이터를 기술했을 경우는 재이용을 할 수 없습니다. + +전체 패키지 또는 각 모듈을 개별적으로 가져올 수 있습니다. 가져온 것을 `extends:` 또는 `mixins:[]`를 사용하여 지정합니다. 또한 `mounted()` 후크에서 `this.renderChart()`를 호출합니다. 이제 차트 인스턴스가 생성됩니다. + + +``js {1,4,6} +import { Bar } from 'vue-chartjs' + +export default { + extends: Bar, + mounted () { + this.renderChart(data, options) + } +} +`` + +:::tip +`extends: Bar` 또는 `mixins: [Bar]` 어느 쪽의 기술 방법으로도 사용할 수 있습니다. +::: + +this.renderChart() 메서드는 Bar 구성 요소에서 제공하며 두 개의 매개 변수를 허용합니다. 둘 다 `Object`입니다. 첫 번째는 표시할 데이터이고 두 번째는 옵션을 저장하는 개체입니다. + +각 차트에 필요한 객체 구조는 공식 [Chart.js docs] (http://www.chartjs.org/docs/latest/#creating-a-chart)을 확인하십시오. + +### Vue 단일 파일 구성 요소 + +이 문서의 대부분의 예는 javascript 파일을 기반으로 작성되었으며 `.vue` 파일의 예는 없습니다. 이것은 당신이 ' + + +`` + +::: danger Template 태그는 병합할 수 없습니다. +`.vue` 파일에 `