棒グラフ

{"data":[{"name":"Page A","uv":4000,"pv":2400,"amt":-2400},{"name":"Page B","uv":3000,"pv":1398,"amt":-2210},{"name":"Page C","uv":2000,"pv":9800,"amt":-2290}],"series":{"def":{"title":"Default","field":"uv","color":"oklch(0.49 0.13 268.85)"},"sec":{"title":"Secondary","field":"pv","color":"oklch(0.61 0.1 213.72)"}}}

目的

このコンポーネントを使用すると、棒グラフ（積み上げ棒グラフも含む）を作成できます。デフォルトでは、グリッド、軸、ラベル、ツールチップが有効になっています。ソースデータはdataフィールドに配列として渡され、表示される棒グラフはseriesフィールドにオブジェクトとして渡されます。デフォルトでは、dataオブジェクト内のnameフィールドがラベル生成に使用されます。列のサイズと色は、それぞれseriesフィールドとcolorフィールドで定義されます。棒グラフを積み上げるには、複数のシリーズに対してstackフィールドに同じ値を設定する必要があります。利用可能なすべての設定は、TBarConfig型で確認できます。

使用法

import { useState, useEffect } from 'react';
import { useBar } from 'effcharts/bar';

// カスタムWebコンポーネントを使用する前に定義してください
// 注意：SSRの場合、ブラウザがドキュメント本文を解析する前に呼び出す必要があります
// そのため、ドキュメントのヘッダーに別途定義スクリプトを追加する必要がある場合があります
const { observe } = useBar();

export const App = () => {
    const ref = useRef();
    const [config, setConfig] = useState(JSON.stringify({
        data: [
            {
                name: 'Page A',
                uv: 4000,
                pv: 2400,
                amt: -2400,
            },
            {
                name: 'Page B',
                uv: 3000,
                pv: 1398,
                amt: -2210,
            },
            {
                name: 'Page C',
                uv: 2000,
                pv: 9800,
                amt: -2290,
            }
        ],
        series: {
            def: {
                title: 'Default',
                field: 'uv',
                color: 'oklch(0.49 0.13 268.85)'
            },
            sec: {
                title: 'Secondary',
                field: 'pv',
                color: 'oklch(0.61 0.1 213.72)'
            }
        }
    }));
    useEffect(() => {
        // Webコンポーネントのイベントを監視できます
        const unobserve = observe((e) => {
            // イベントハンドラ
        }, ref.current);
        // そして、あなたは観察を中止することができます
        return () => unobserve();
    }, []);
    // JSXでWebコンポーネントを使用するだけです
    return <div ref={ref}>
        <effcharts-bar>
            {config}
        </effcharts-bar>
    </div>;
}

型

IBarChartAttrsインターフェースを使用してWebコンポーネントを宣言できます。また、TBarConfig型を使用してチャートの設定を検証することもできます。

import { HTMLAttributes } from 'react';
import { IBarChartAttrs, TBarConfig } from 'effcharts/bar';

type CustomElement<T> = Partial<T & HTMLAttributes<T> & { children: any }>;

// effchartsコンポーネントを宣言する
declare module 'react' {
  namespace JSX {
    interface IntrinsicElements {
        'effcharts-bar': CustomElement<IBarChartAttrs>;
    }
  }
}

// 設定を準備する
const config = {
    data: [
        {
            name: 'Page A',
            uv: 4000,
            pv: 2400,
            amt: -2400,
        },
        {
            name: 'Page B',
            uv: 3000,
            pv: 1398,
            amt: -2210,
        },
        {
            name: 'Page C',
            uv: 2000,
            pv: 9800,
            amt: -2290,
        }
    ],
    series: {
        def: {
            title: 'Default',
            field: 'uv',
            color: 'oklch(0.49 0.13 268.85)'
        },
        sec: {
            title: 'Secondary',
            field: 'pv',
            color: 'oklch(0.61 0.1 213.72)'
        }
    }
} satisfies TBarConfig;