Future Tech Blog
フューチャー技術ブログ

Vue.jsで最速に始めるCheetah Grid


はじめに

2019年入社、TIG所属の吉野貴大です。

今回、記事を投稿することになったキッカケは、フューチャー発のOSSであるCheetah Gridを使用した業務システム開発に携わったことです。

また、Cheetah Gridの公式ドキュメントは英語のみで、現時点では日本語の解説記事が少ないこともあり、業務システム開発で使いやすいと思われるCheetah Gridの機能を紹介していきます。

内容

Cheetah Gridの入門として、業務システム開発で利用する際のCheetah Gridについて、各コンポーネントの概要と簡単な使い方を実装付きで説明します。

  • 細かいコンポーネントの属性や高度なコンポーネント(c-grid-layout-rowとc-grid-header)については説明しません
  • Cheetah GridのAPIにはJavaScript版とVue.js版がありますが、Vue.jsのみについて説明します

Cheetah Gridとは

Cheetah Gridは、扱うデータ件数が多くても高速にテーブル描画ができるJavaScriptのコンポーネントで、1,000,000件のデータを約0.1秒で描画することができます。対応言語はJavaScriptでVue.jsとしても利用することができます。

デモページでその表示速度を体験することができます。

業務システムでCheetah Gridを使用するメリットを紹介します。

  1. 大量データでも高速に描画することができる
  2. 業務部品がコンポーネント化してあるため、同じような処理が多い業務処理を開発する際に、実装方法を統一することができる
    • 次の章で詳しく説明します

Cheetah Gridのコンポーネントについて

Cheetah Gridが提供しているコンポーネントを利用することで、大量のデータの参照、登録、更新、削除の手助けをすることができます。

既存のグリッドを表現する方法としてHTMLのtableがあります。tableは、グリッドを表現する際にtrタグやthタグ、tdタグを使用しなければならず階層が多くなり複雑な構成になってしまいます。また、業務システムで頻繁に要求される行のセルに入力項目を作る部品や、行データの中から1つ選択する部品を表現する際には、どちらも異なる処理なのにもかかわらずinputタグを使用して表現します。加えて、inputタグには最低限の入力やチェック機能しか備わっていません(他の処理はDOMを使用する)。

それに比べてCheetah Gridでは、業務システムに要求される部品を1つのコンポーネントで指定することができることで、可読性が良く、また、1つのコンポーネントで多くの属性が備わっているため、様々な処理を行うことができます。

本記事では、Vue.jsで利用できるCheetah Gridのコンポーネントについて紹介と、実装例を説明します。

利用可能なVueコンポーネント

コンポーネント名 概要
c-grid Gridを定義する
c-grid-column カラムの値を表示する
c-grid-column-group 定義したカラムをヘッダーをグループ化する
c-grid-button-column ボタンを表示する
c-grid-check-column チェックボックスを表示する
c-grid-input-column 入力項目を表示する
c-grid-menu-column プルダウンメニューを表示する
c-grid-link-column リンクを表示する
c-grid-icon-column アイコンを表示する
c-grid-percent-complete-bar-column 割合を色で表現して表示する
c-grid-radio-column ラジオボタンを表示する
c-grid-layout-row 複雑なレイアウトを作成する
c-grid-header 複雑なヘッダー構成などを作成する時に使用する

コンポーネントを使用して実際に作成した画面がこちらです。

今回作成した一覧のカラム名は、「ID」、「選択」、「削除」、「データ(データ1、データ2)」「種別」、「詳細」、「割合」、「アイコン」としています。

コード実装例

開発環境

  • Node.js(v14.4.0)
  • npm(6.14.5)
  • Nuxt.js(v2.13.3)
  • Cheetah Grid(0.22.3)
  • npmでCheetah Gridを使用するには、下記のコマンドを実行してください。
1
npm install -S cheetah-grid

全体のソースコード

はじめに全体のソースコードを記載します。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<template>
<div>
<div style="height: 500px; border: solid 1px #ddd; margin: 50px">
<c-grid :data="records"
:frozen-col-count="1">
<c-grid-column field="id"
width= "50">
ID
</c-grid-column>
<c-grid-radio-column field="selected"
width="50">
選択
</c-grid-radio-column>
<c-grid-button-column caption="削除"
width="50"
@click="onDeleted">
削除
</c-grid-button-column>
<c-grid-check-column field="checked"
width="70">
フラグ
</c-grid-check-column>
<c-grid-column-group caption="データ">
<c-grid-input-column field="data1"
width="20%"
min-width="150">
データ1
</c-grid-input-column>
<c-grid-input-column field="data2"
width= "20%"
min-width="150">
データ2
</c-grid-input-column>
</c-grid-column-group>
<c-grid-menu-column field="type"
:options="[{label: '種別1', value: 1},
{label: '種別2', value: 2},
{label: '種別3', value: 3}]">
種別
</c-grid-menu-column>
<c-grid-link-column href="link"
:icon="getLinkIcon">
詳細
</c-grid-link-column>
<c-grid-percent-complete-bar-column field="percent"
:max="100"
:min="0">
割合
</c-grid-percent-complete-bar-column>
<c-grid-icon-column field="iconNum"
icon-class-name="material-icons"
icon-content="grade">
アイコン
</c-grid-icon-column>
</c-grid>
</div>
<div class="grid-sample"></div>
</div>
</template>
<script>
import * as cGridAll from 'vue-cheetah-grid'
export default {
name: 'service',
components: {
...cGridAll
},
mounted() {
this.setRecord()
},
data () {
return {
records: []
}
},
methods: {
/**
* 削除ボタン押下イベント
*
* @param {object} rec 行データ
* @return {void}
**/
onDeleted(rec) {
const vm = this
vm.records.splice(vm.records.indexOf(rec), 1);
},
/**
* 一覧に表示するデータを作成する
*
* @return {void}
**/
setRecord () {
const vm = this
for (let i=0; i < 1000; i++) {
vm.records.push({
selected: false,
checked: false,
id: i+1,
data1: `サンプル1-${i+1}`,
data2: `サンプル2-${i+1}`,
type: Math.floor(Math.random() * 3) + 1,
link: "https://future-architect.github.io/cheetah-grid/documents/api/vue/components/CGridLinkColumn.html",
iconNum: 1,
percent: Math.round(Math.random() * 100)
})
}
},
/**
* c-grid-link-columnに表示するアイコンを取得する
*
* @return {object} アイコン情報
**/
getLinkIcon () {
return {
className: 'material-icons',
content: 'input'
}
}
}
}
</script>

c-grid

c-gridは、Cheetah Gridを使用するための土台となるコンポーネントです。
data属性に一覧に表示したいリストデータを指定し、リストの各要素は列に表示するデータを保持するオブジェクトです。
data属性以外にもfrozen-col-countdisabledreadonlyなど多くの属性があるので、グリッド全体の設定を定義することができます。

1
2
3
4
<c-grid :data="records"
:frozen-col-count="1">
<!-- ここでCheetah Gridの各Vueコンポーネントを使って列項目を定義する -->
</c-grid>

一覧に表示するデータは以下のように作成しています。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
export default {
data() {
records: []
},
methods: {
setRecords () {
const vm = this
for (let i=0; i < 1000; i++) {
vm.records.push({
selected: false,
checked: false,
id: i+1,
data1: `サンプル1-${i+1}`,
data2: `サンプル2-${i+1}`,
type: Math.floor(Math.random() * 3) + 1,
link: "https://future-architect.github.io/cheetah-grid/documents/api/vue/components/CGridLinkColumn.html",
iconNum: 1,
percent: Math.round(Math.random() * 100)
})
}
}
}
}

c-grid-column

c-grid-columnは、field属性にデータのプロパティ名を指定することで値を列に表示することができます。
width属性で横幅の指定ができます。
列見出しはタグのテキスト部に書くことで表示できます。

1
2
3
4
<c-grid-column field="id"
width= "50">
ID
</c-grid-column>

c-grid-column-group

c-grid-column-groupは、カラムヘッダをまとめることができます。

「データ」というカラム内に、「データ1」と「データ2」を多段で表示しています。caption属性で全体のカラム名を決めます、また、今回は、c-grid-input-columnを使用していますが、それ以外のコンポーネントも配置することができます。

1
2
3
4
5
6
7
8
9
10
11
12
<c-grid-column-group caption="データ">
<c-grid-input-column field="data1"
width="20%"
min-width="150">
データ1
</c-grid-input-column>
<c-grid-input-column field="data2"
width= "20%"
min-width="150">
データ2
</c-grid-input-column>
</c-grid-column-group>

c-grid-button-column

c-grid-button-columnは、カラム内にボタンを配置することができます。
業務システムでは、ボタンによって処理を制御することが度々ありますが、今回は、c-grid-button-columnを使用して削除ボタンを作成しました。
@click属性で押下後の処理を定義することができます。

1
2
3
4
5
<c-grid-button-column caption="削除"
width="50"
@click="onDeleted">
削除
</c-grid-button-column>

c-grid-check-column

c-grid-check-columnでは、1つのチェックボックスを実現することができます。

fieldに指定したプロパティにチェック状態に対応した値が設定されます。チェック値は、プロパティの初期値に応じて、設定される値が異なります。(設定値)。

1
2
3
4
<c-grid-check-column field="checked"
width="70">
フラグ
</c-grid-check-column>

c-grid-input-column

c-grid-input-columnは、「表示」、「入力」のどちらも行うことができます。一覧内のデータを直接入力できることで一覧データの登録や更新を、一括で行う画面の開発ができます。

1
2
3
4
5
6
7
8
9
10
<c-grid-input-column field="data1"
width="20%"
min-width="150">
データ1
</c-grid-input-column>
<c-grid-input-column field="data2"
width= "20%"
min-width="150">
データ2
</c-grid-input-column>

c-grid-menu-column

c-grid-menu-columnは、options属性に与えられたリストから1つを選択することができます。

決まったデータ群から選択させたい場合などに使用することができ、設定するデータはoptions属性にオブジェクトのリストを指定し、labelvalueで表示させる文字列、データを定義することでプルダウンメニューを表示します。

1
2
3
4
5
6
<c-grid-menu-column field="type"
:options="[{label: '種別1', value: 1},
{label: '種別2', value: 2},
{label: '種別3', value: 3}]">
種別
</c-grid-menu-column>

c-grid-link-columnは、列の値自体をリンクとすることができます。

今回は、リンクにアイコンを設定しました。href属性には、遷移先の情報(URL)などを設定したプロパティを指定します。

1
2
3
4
<c-grid-link-column href="link"
:icon="getLinkIcon">
詳細
</c-grid-link-column>

c-grid-icon-column

c-grid-icon-columnでは、アイコンを表示することができる。

今回は、material-iconsを使用してgradeを表示しています。field属性にアイコンの表示数を指定することで複数アイコンを表示することができます。

1
2
3
4
5
<c-grid-icon-column field="iconNum"
icon-class-name="material-icons"
icon-content="grade">
アイコン
</c-grid-icon-column>

c-grid-percent-complete-bar-column

c-grid-percent-complete-bar-columnでは、割合を表示することができます。field属性に指定した数字が、max属性、min属性間でどのくらいの割合なのかを示すことができます。

1
2
3
4
5
<c-grid-percent-complete-bar-column field="percent"
:max="100"
:min="0">
割合
</c-grid-percent-complete-bar-column>

c-grid-radio-column

c-grid-radio-columnでは、ラジオボタンを表示することができます。一覧データ中から、1つを対象に選ぶ場合などで使用することができます。

1
2
3
4
<c-grid-radio-column field="selected"
width="50">
選択
</c-grid-radio-column>

実装してみて

Cheetah Gridで一覧情報の例を実装してみて、あらかじめ処理を行ってくれる属性多く用意されており、HTMLなどと比べて業務システム開発で使用する一覧情報を実装することが容易でした。

1,000,000件のデータを表示する際にもほぼストレスなく表示することができ、ユーザに対しても満足度が高いものが作成できると考えます。

さいごに

今回は、業務で使用したCheetah Gridについて、基本的な内容を説明しました。あらかじめ用意されているコンポーネントの属性を使用して、Web画面で利用するグリッドを表現できます。

また、本記事で触れてませんが業務で役に立つ機能に「Excel貼り付け」や「一括入力」の機能があります。Excel貼り付けは業務のデータをExcelでまとめていたものをシステムに移行する際に、手入力ではなくコピペで貼り付けることができます。一括入力は大量にあるデータ1つ1つチェックをつけるのではなく、一括でチェックできる機能を実現します。

今回は、Cheetah Gridが提供している単体コンポーネントの使用方法を説明しましたが、単体で使用するのではなくいくつかのコンポーネントを組み合わせることでより柔軟なグリッドを表示することが可能です。

ぜひ、皆さん利用してみてください!