SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

高機能JavaScriptグリッド部品「SpreadJS」の活用(PR)

「SpreadJS」のスプレッドシートをReact+ASP.NET Coreで活用してデータ集計するWebページを作ろう

  • このエントリーをはてなブックマークに追加

 本記事では、ExcelライクなスプレッドシートをWebページに表示できるグレープシティのJavaScriptライブラリー「SpreadJS」を、JavaScriptライブラリーReactと組み合わせて利用する例を紹介します。サーバー側はマイクロソフトのASP.NET CoreでWeb APIを作成して、Web APIから取得したデータをSpreadJSで表示させます。

  • このエントリーをはてなブックマークに追加

はじめに

 SpreadJSは、ExcelライクなスプレッドシートをWebページに表示できる、グレープシティのJavaScriptライブラリです。記事執筆時点の最新版は2022年7月に公開された「V15.1J」です。

図1 SpreadJSの製品ページ(https://www.grapecity.co.jp/developer/spreadjs)
図1 SpreadJSの製品ページ

 SpreadJSの活用法は過去記事でも紹介してきましたが、今回はクライアント(Webページ)にSpreadJSとReactを組み合わせて利用し、ASP.NET Coreでサーバー側に実装したWeb APIからデータを取得してスプレッドシートに表示する実装例を紹介します。スプレッドシートならではの機能として、計算式を設定して最大値などのデータ集計を行う方法も説明します。

対象読者

  • ExcelライクなスプレッドシートをWebページで実現したい方
  • ASP.NET CoreのWeb API実装を体験したい方
  • SpreadJSを試したいReactユーザーの方

必要な環境

 本記事のサンプルコードは、以下の環境で動作を確認しています。

  • Windows 10 64bit版
  • SpreadJS 15.1.4
  • Microsoft Visual Studio Community 2022 17.3.5
  • Node.js 16.17.1 64bit版
  • Microsoft Edge 105.0.1343.53

 サンプルコードに含まれるソリューションファイル(*.sln)をVisual Studio 2022で開くことで、ソースコードの確認や実行が行えます。

SpreadJSを組み込むVisual Studioのプロジェクトを確認

 本記事では、Visual Studio 2022に含まれる「React.js での ASP.NET Core」プロジェクトテンプレートから生成したプロジェクト(図2)を元に、SpreadJSを実装します。

図2 Visual Studio 2022で生成できるReactアプリの実行結果(P001ReactPlain)
図2 Visual Studio 2022で生成できるReactアプリの実行結果(P001ReactPlain)

 このプロジェクトにはReactによるクライアント側の実装と、ASP.NET CoreでWeb APIを提供するサーバー側の実装が両方含まれています。プロジェクト構成の詳細は過去記事の説明も参考にしてください。ここでは概要のみを述べます。

 プロジェクトの<プロジェクト名>/ClientAppフォルダーにクライアント側(React)の実装が含まれます。コンポーネントの実装が含まれるのは、その中のsrc/componentsフォルダーです(図3)。

図3 ReactプロジェクトのP001ReactPlain/ClientApp/src/componentsフォルダー(P001ReactPlain)
図3 ReactプロジェクトのP001ReactPlain/ClientApp/src/componentsフォルダー(P001ReactPlain)

 componentフォルダー内には、表1のファイルが含まれます。Layout.jsがページ全体に対応し、その中にNavMenu.jsによる画面上部メニューが表示されます。Home.js、Counter.js、FetchData.jsの各コンポーネントは、画面上部メニューの「Home」「Counter」「Fetch data」リンクをクリック時に表示されるページ内容に対応します。

表1 componentsフォルダーに含まれるファイル(P001ReactPlain)
No. ファイル名 役割
1 Counter.js Counterページに対応するコンポーネントファイル
2 FetchData.js Fetch dataページに対応するコンポーネントファイル
3 Home.js Homeページに対応するコンポーネントファイル
4 Layout.js ページ全体の表示に対応するコンポーネントファイル
5 NavMenu.css 画面上部メニューのスタイルシート
6 NavMenu.js 画面上部メニューのコンポーネントファイル

 本記事では、Home.js、Counter.js、FetchData.jsと横並びにコンポーネントのファイルを1つ追加して、その中でSpreadJSを表示するように実装していきます。

過去1カ月の気温をスプレッドシートに表示するWebページを作る

 本記事でSpreadJSに表示する題材は、過去1カ月の最高気温・最低気温です。これらをサーバー側のWeb APIで提供し、それをSpreadJSで表示するように実装していきます(図4)。

 このサンプルでは最高気温・最低気温そのもの以外に、SpreadJSのスプレッドシート機能を利用して、クライアント側で最大値・最小値・平均値を集計して表示します。なお、同じ題材をAngularで実現したサンプルを過去記事で説明しているので参考にしてください。

図4 SpreadJSで気温のデータを表示するサンプル(P002ReactSpreadJS)
図4 SpreadJSで気温のデータを表示するサンプル(P002ReactSpreadJS)

 表示するデータは、気象庁の「過去の気象データ・ダウンロード」から、2022年8月の東京のデータをCSVファイルでダウンロードして利用します。ダウンロードしたCSVファイルは事前に内容の整形とヘッダー付加を行い、図5の状態にしておきます。

図5 Web APIで提供する気温のデータ(P002ReactSpreadJS/P002ReactSpreadJS/data.csv)
図5 Web APIで提供する気温のデータ(P002ReactSpreadJS/P002ReactSpreadJS/data.csv)

 以下では、このデータをWebページ上に表示する実装を、サーバー側(ASP.NET Coreで実装するWeb API)とクライアント側(React、SpreadJS)とに分けて説明していきます。

サーバー側の実装

 サーバー側には、図5のCSVファイルを読みだして、戻り値として返却するWeb APIを実装します。このサーバー側の実装内容は、クライアント側にAngularを利用した過去記事のサンプルと同じものです。

 まず、サーバー側でCSVファイルを読み出せるように、NuGet パッケージ マネージャーで「CsvHelper」パッケージを検索してインストールします。

図6 CsvHelperパッケージをインストール(P002ReactSpreadJS)
図6 CsvHelperパッケージをインストール(P002ReactSpreadJS)

 次に、Web APIのクラスが配置されるControllers配下にC#のファイルを生成して、Web API処理をリスト1の通り実装します。

[リスト1]Web APIの実装(P002ReactSpreadJS/P002ReactSpreadJS/Controllers/TemperatureController.cs)
// 気温Web APIのコントローラー ...(1)
[Route("api/[controller]")]
[ApiController]
public class TemperatureController : ControllerBase
{
    // GET時の処理 ...(2)
    [HttpGet]
    public object Get()
    {
        // CSVファイルを読み込むReaderを生成 ...(3)
        using (var reader = new StreamReader("data.csv"))
        {
            // CSV内容を読み込むReaderを生成 ...(4)
            using (var csv = new CsvReader(reader,
                new CsvConfiguration(CultureInfo.InvariantCulture)))
            {
                // CSVファイルからレコードを取得して返却 ...(5)
                var records = csv.GetRecords<TemperatureData>();
                return records.ToList();
            }
        }
    }
}

 クラスに付与した(1)の[Route("api/[controller]")]、[ApiController]属性により、「api/Temperature」というパスに対応するWeb APIであることを指定します。Getメソッド(2)に付与した[HttpGet]属性は、HTTP GET時の処理であることを表します。

 Getメソッド内では(3)および(4)でCSV内容を読み込むCsvReaderを生成し、(5)で内容をレコードのリストにして返却します。ASP.NET Coreの処理により、リスト内容がJSON文字列に変換されてAPIの戻り値として返却されます。

 リスト1(5)のcsv.GetRecordsメソッドで型設定されるTemperatureDataは、日時、最高気温、最低気温のプロパティを含むクラスです(リスト2)。csv.GetRecordsメソッドは、クラスのプロパティ名(date, maxTemperature, minTemperature)を識別して、同じ名前のヘッダーを持つCSVの列からデータを各プロパティに設定します。

[リスト2]CSVの読み取りに用いるTemperatureDataクラス(P002ReactSpreadJS/P002ReactSpreadJS/Controllers/TemperatureController.cs)
public class TemperatureData
{
    // 日時
    public DateTime date { get; set; }
    // 最高気温
    public double maxTemperature { get; set; }
    // 最低気温
    public double minTemperature { get; set; }
}

クライアント側の実装

 次に、クライアント側の実装を行っていきます。ReactプロジェクトにSpreadJSを追加する方法が公式ドキュメントで案内されているので、その手順に従って進めます。最初にClientAppフォルダーでリスト3のコマンドを実行して、プロジェクトにSpreadJSを追加します。

[リスト3]SpreadJSパッケージをプロジェクトに追加するコマンド
npm install @grapecity/spread-sheets-react        # ...React用モジュール
npm install @grapecity/spread-sheets-resources-ja # ...日本語リソース

 Webページ表示時、最初に実行されるindex.jsに、リスト4の通り記述します。(1)でSpreadJSのCSSとJavaScriptをインポートします。(2)はカルチャの設定で、日本語(ja-jp)を設定します。(3)はライセンスキーの設定です。ライセンスキーを設定しない場合は、トライアル版である旨の透かしがスプレッドシートに表示されます。

[リスト4]SpreadJSの初期設定を行う実装(P002ReactSpreadJS/P002ReactSpreadJS/ClientApp/src/index.js)
// SpreadJSをインポート ...(1)
import'@grapecity/spread-sheets/styles/gc.spread.sheets.excel2016darkGray.css';
import * as GC from '@grapecity/spread-sheets';
// カルチャ設定 ...(2)
GC.Spread.Common.CultureManager.culture('ja-jp');
// ライセンスキー設定 ...(3)
GC.Spread.Sheets.LicenseKey = '<ライセンスキー>';

 次に、スプレッドシートを表示するSpreadSampleコンポーネントに対応するファイルSpreadSample.jsを追加して、リスト5の通り実装します。

[リスト5]SpreadSampleコンポーネントの実装(P002ReactSpreadJS/P002ReactSpreadJS/ClientApp/src/app/components/SpreadSample.js)
// SpreadJSをインポート ...(1)
import { SpreadSheets, Worksheet, Column } from '@grapecity/spread-sheets-react';
import '@grapecity/spread-sheets-resources-ja/dist/gc.spread.sheets.resources.ja.min.js';
export class SpreadSample extends Component {
  // コンストラクター ...(2)
  constructor(props) {
    super(props);
    // スプレッドシートの表示サイズ ...(3)
    this.hostStyle = { width: '100%', height: '500px' };
    // 状態を保持 ...(4)
    this.state = { temperatures: [] };
    // workbookInitメソッドをthisにバインド ...(5)
    this.workbookInit = this.workbookInit.bind(this);
  }
  // 表示内容 ...(6)
  render() {
    return (
      // SpreadSheets:スプレッドシート全体を表す ...(7)
      <SpreadSheets hostStyle={this.hostStyle}
        workbookInitialized={this.workbookInit}>
        {/*WorkSheet:ワークシートを表す ...(8)*/}
        <Worksheet name='気温' dataSource={this.state.temperatures}
          autoGenerateColumns={false}>
          {/*Column:ワークシートの1列を表す ...(9)*/}
          <Column headerText='日時' dataField='date' width={200}></Column>
          <Column headerText='最高気温' dataField='maxTemperature' width={100}
            formatter='#.0'></Column>
          <Column headerText='最低気温' dataField='minTemperature' width={100}
            formatter='#.0'></Column>
        </Worksheet>
      </SpreadSheets>
    );
  }
  // ワークブック初期化後の処理 ...(10)
  async workbookInit(spread) {
    // Web APIからデータ取得 ...(11)
    const response = await fetch('/api/Temperature');
    const data = await response.json();
    // データをstateに保持 ...(12)
    this.setState({ temperatures: data });
    // ワークシートを装飾 ...(13)
    this.decorateWorksheet(spread);
  }
(略:後述)
}

 まず(1)で、SpreadJSと日本語リソースのパッケージをインポートします。コンストラクター(2)では、(3)でスプレッドシートの表示サイズ、(4)ではコンポーネントの状態(state)を記述します。このコンポーネントでは、スプレッドシートに表示する温度データ配列temperaturesを状態に持ちます(初期値は空配列です)。(5)は後述するworkbookInitメソッド内において、thisでコンポーネントを参照するための記述です。

 表示内容を記述するrenderメソッド(6)では、まずスプレッドシート全体を表す<SpreadSheets>コンポーネント(7)を記述します。スプレッドシートの表示スタイルを表すhostStyleには(3)のサイズ指定を反映します。また、workbookInitializedはスプレッドシート初期化時のイベントハンドラーメソッドで、後ほど実装するworkbookInitメソッドを呼ぶようにします。

 <SpreadSheets>内に、1つのワークシートに対応した<Worksheet>コンポーネント(8)を記述します。nameはワークシートの名前、dataSourceは(4)で状態(state)に定義したtemperatures変数を指定します。autoGenerateColumnsにはfalseを設定して、データに合わせて自動で列が生成されないようにします。

 <Worksheet>内には(9)の通り、データを表示する列に対応した<Column>コンポーネントを、列の数だけ記述します。dataFieldはデータの属性名、headerTextはヘッダー部の文言、widthは列の幅指定、formatterはデータの表示フォーマットです。formatterの"#.0"は、数字を小数第一位まで表示することを表します。

 ワークブック初期化後に実行されるworkbookInitメソッド(10)では、(11)のfetchメソッドでWeb API(/api/Temperature)からデータを取得して、取得したデータを(12)のsetStateメソッドで状態(state)のtemperaturesに格納します。(13)については後述します。

 ここまでで追加したSpreadSampleコンポーネントを表示できるようにするため、パス(ルート)を設定するAppRoute.jsに、リスト6の内容を追加して、SpreadSampleコンポーネントに「/spread-sample」のパスを割り当てます。

[リスト6]SpreadSampleコンポーネントのルート設定(P002ReactSpreadJS/P002ReactSpreadJS/ClientApp/src/AppRoute.js)
const AppRoutes = [
(略)
  {
    path: '/spread-sample',
    element: <SpreadSample />
  }
];

 リスト6で追加したパスを、画面上部のページ切替リンクに対応するNavMenuコンポーネントのrenderメソッド内に、リスト7の通り設定します。

[リスト7]SpreadSampleコンポーネントへのリンク(P002ReactSpreadJS/P002ReactSpreadJS/ClientApp/src/components/NavMenu.js)
<NavItem>
  <NavLink tag={Link} className="text-dark" to="/spread-sample">SpreadJS</NavLink>
</NavItem>

スプレッドシートのヘッダー行に集計行を追加

 次に、スプレッドシートのヘッダー行に集計行を追加します。リスト5(13)のdecorateWorksheetメソッドを、リスト8の通り実装します。

[リスト8]集計行を表示するクライアント側の実装(P002ReactSpreadJS/P002ReactSpreadJS/ClientApp/src/components/SpreadSample.js)
decorateWorksheet(spread) {
  // ワークシートを取得 ...(1)
  const sheet = spread.getActiveSheet();
  // ヘッダーが4行になるよう設定 ...(2)
  sheet.setRowCount(4, GC.Spread.Sheets.SheetArea.colHeader);
  // 最大値ヘッダー行のスタイルを定義 ...(3)
  const style1 = new GC.Spread.Sheets.Style();
  style1.backColor = '#ffe6d5';
  style1.foreColor = '#ff0000';
  style1.formatter = "#.0";
  // 最大値ヘッダー行に文字を指定 ...(4)
  sheet.setValue(0, 0, '最大値', GC.Spread.Sheets.SheetArea.colHeader);
  // 最大値ヘッダー行にスタイルを指定 ...(5)
  sheet.setStyle(0, -1, style1, GC.Spread.Sheets.SheetArea.colHeader);
  // 最大値ヘッダー行に数式を指定 ...(6)
  // 2列目:「=MAX(<シート名>!B:B)」、3列目:「=MAX(<シート名>!C:C)」
  sheet.setFormula(0, 1, `=MAX(${sheet.name()}!B:B`,
    GC.Spread.Sheets.SheetArea.colHeader);
  sheet.setFormula(0, 2, `=MAX(${sheet.name()}!C:C`,
    GC.Spread.Sheets.SheetArea.colHeader);
(以下略:最小値と平均値の行をヘッダーに設定)
}

 引数に渡されるSpreadJSのオブジェクトspeadのgetActiveSheetメソッド(1)で、処理対象のワークシートを取得します。(2)ではsheet.setRowCountメソッドで、ヘッダー行が4行になるように指定しています。

 (3)でGC.Spread.Sheets.StyleクラスのオブジェクトにbackColor(背景色)、foreColor(文字色)、formatter(表示フォーマット)を設定します。

 (4)のsetValueメソッドでセルの値を、(5)のsetStyleメソッドでセルのスタイルを、(6)のsetFormulaメソッドでセルの数式を、それぞれヘッダー行に設定します。各メソッドの第1引数は行番号、第2引数は列番号、第3引数は設定値です。第4引数にはGC.Spread.Sheets.SheetArea.colHeaderを設定して、ヘッダー行に対する処理であることを表します。(5)の第2引数(列番号)「-1」は、すべての列への指定を意味します。

 以上の実装により、図4のスプレッドシートをWebブラウザーに表示できます。Web APIから取得できるのは最高気温と最低気温の生データだけですが、SpreadJSのスプレッドシート機能により、最大値・最小値・平均値をクライアント側の処理により表示できます。

まとめ

 本記事では、グレープシティのJavaScriptスプレッドシート部品SpreadJSを、クライアント側にReact、サーバー側にASP.NET Coreの環境で利用する方法を説明しました。SpreadJSが提供するスプレッドシート、ワークシート、列のReactコンポーネントにより、SpreadJSの機能をReactの一部のように透過的に利用できます。また、SpreadJSのExcelライクなスプレッドシート機能を生かして、取得したデータをクライアント側で集計して表示できます。

参考資料

この記事は参考になりましたか?

  • このエントリーをはてなブックマークに追加

この記事は参考になりましたか?

この記事をシェア

  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/16727 2022/11/02 12:00

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング