Skip to content
GRAPHIC WALKER
APIリファレンス
TableWalker

TableWalker

TableWalkerは、列プロファイリング、フィルタリング、ソート機能を備えたインタラクティブなデータテーブルをレンダリングします。各列の統計サマリーをオプションで表示するデータの表形式ビューを提供します。

import { TableWalker } from '@kanaries/graphic-walker';

プロパティ

データプロパティ

プロパティ必須説明
dataRecord<string, any>[]はい*クライアント側モード用のデータレコード配列。
fieldsIMutField[]はい各列を記述するフィールド定義。
computationIComputationFunctionはい*サーバー側計算関数。dataの代替。

*data(クライアント側)またはcomputation(サーバー側)のいずれかを指定してください。

テーブル設定

プロパティデフォルト説明
pageSizenumber20ページあたりの行数。
hideProfilingbooleanfalse列プロファイリング(分布バー)を非表示。
hidePaginationAtOnepagebooleanfalseすべてのデータが1ページに収まる場合にページネーションコントロールを非表示。
displayOffsetnumber0行番号表示のオフセット。
disableFilterbooleanfalse列フィルタリングを無効化。
disableSortingbooleanfalse列ソートを無効化。
hideSemanticTypebooleanfalse列のセマンティックタイプインジケーターを非表示。

外観プロパティ

プロパティデフォルト説明
appearance'media' | 'light' | 'dark''media'ダークモード設定。
vizThemeConfigIThemeKey | GWGlobalConfigundefinedビジュアル要素のテーマ。
uiThemeIUIThemeConfigundefinedカスタムUIカラー。

Refプロパティ

プロパティ説明
tableFilterRefReact.Ref<{ getFilters: () => IVisFilter[] }>現在のフィルター状態にアクセスするためのref。
storeRefReact.RefObject<VizSpecStore>内部可視化ストアへのref。
onMetaChange(fid: string, meta: Partial<IMutField>) => voidフィールドメタデータ変更時のコールバック。

i18nプロパティ

プロパティ説明
i18nLangstring言語コード。
i18nResourcesRecord<string, Record<string, string>>カスタム翻訳。

スタイリング

プロパティ説明
classNamestringルート要素のCSSクラス。
styleReact.CSSPropertiesインラインスタイル。デフォルトは{ width: '100%', height: '100%' }

使用例

基本的なテーブル

import { TableWalker } from '@kanaries/graphic-walker';
 
function DataTable({ data, fields }) {
  return (
    <div style={{ height: '600px' }}>
      <TableWalker data={data} fields={fields} />
    </div>
  );
}

読み取り専用テーブル

<TableWalker
  data={data}
  fields={fields}
  disableFilter
  disableSorting
  hideProfiling
  pageSize={50}
/>

フィルターへのアクセス

import { useRef } from 'react';
 
function FilteredTable({ data, fields }) {
  const filterRef = useRef(null);
 
  const handleGetFilters = () => {
    if (filterRef.current) {
      const filters = filterRef.current.getFilters();
      console.log('Active filters:', filters);
    }
  };
 
  return (
    <>
      <button onClick={handleGetFilters}>Get Filters</button>
      <TableWalker
        data={data}
        fields={fields}
        tableFilterRef={filterRef}
      />
    </>
  );
}