From 5fa95af9ef71e200abf5d551d8742ab918840153 Mon Sep 17 00:00:00 2001 From: Hitoshi Kuroyanagi Date: Mon, 18 Mar 2019 14:55:42 +0900 Subject: [PATCH] docs: Translate docs to japanese #400 (#458) * tlanslate landing page to Japanese #400 * tlanslate guide to Japanese #400 * tlanslate api docs to Japanese #400 --- docs/ja/README.md | 14 +- docs/ja/api/README.md | 130 +++++++++++ docs/ja/guide/README.md | 479 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 616 insertions(+), 7 deletions(-) diff --git a/docs/ja/README.md b/docs/ja/README.md index 8b915350..bc86bceb 100644 --- a/docs/ja/README.md +++ b/docs/ja/README.md @@ -1,14 +1,14 @@ --- home: true heroImage: /vue-chartjs.png -actionText: Get Started → +actionText: 初めに → actionLink: /guide/ features: -- title: Easy - details: Easy for both beginners and pros 🙌 -- title: Extendable - details: Simple to use, easy to extend 💪 -- title: Powerfull - details: With the full power of chart.js 💯 +- title: 簡単 + details: 初心者にもプロにも簡単に始められる 🙌 +- title: 拡張性 + details: シンプルに使えて、拡張も簡単 💪 +- title: 強力 + details: chart.jsのフルパワーを持っている 💯 footer: MIT Licensed | Copyright © 2018-present Jakub Juszczak --- diff --git a/docs/ja/api/README.md b/docs/ja/api/README.md index e69de29b..e5289368 100644 --- a/docs/ja/api/README.md +++ b/docs/ja/api/README.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`ミックスインが使用されている場合、以下のイベントが発行されます。 + +| Event名 | 説明| +|---|---| +| `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` でアクセスできます。 diff --git a/docs/ja/guide/README.md b/docs/ja/guide/README.md index e69de29b..3e9c32f0 100644 --- a/docs/ja/guide/README.md +++ b/docs/ja/guide/README.md @@ -0,0 +1,479 @@ +# 最初に + +**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` or `npm install vue-chartjs chart.js --save` + +::: tip +Vue.jsの Version 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をインポートしてextendします。この方法で異なるデータのチャートを表示するときに柔軟性が大幅に向上します。 +コンポーネントをカプセル化し、プロパティを使用してコンポーネント内のデータに渡したり、コンポーネント内に直接データを記述することができます。ただし直接コンポーネント内にデータを記述した場合は再利用ができません。 + +パッケージ全体または各モジュールを個別にインポートできます。 インポートしたものを `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コンポーネントによって提供され、2つのパラメータを受け付けています。 どちらも`Object`です。 最初のものは表示するデータで、二番目のものはオプションを格納するオブジェクトです。 + +チャート毎に必要なオブジェクト構造は公式 [Chart.js docs](http://www.chartjs.org/docs/latest/#creating-a-chart)をチェックしてください。 + +### Vue シングルファイルコンポーネント + +本ドキュメントのほとんどの例はjavascriptファイルを基に記述されていて、 `.vue`ファイルの例はありません。 これはあなたが、たいてい必要なのは ` + + +``` + +::: danger Template タグはマージできません +`.vue`ファイルに`