条形图

目的

此组件允许创建条形图（包括堆叠条形图）。默认情况下，它已启用网格、坐标轴、标签和工具提示。源数据以数组形式存储在 data 字段中，而显示的条形图则以对象形式存储在 series 字段中。默认情况下，数据对象中的 name 字段用于生成关联的标签。列宽和颜色分别在 series 的 field 和 color 字段中定义。要将列堆叠起来，需要为多个 series 设置相同的 stack 字段值。您可以在 TBarConfig 类型中找到所有可用的设置。

用法

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

// 使用前定义自定义 Web 组件
// 注意，对于服务端渲染 (SSR)，需要在浏览器解析文档主体之前调用它
// 因此，您可能需要在文档头部添加单独的定义脚本。
const { observe, getConfig } = useBar();

export const App = () => {
    const ref = useRef();
    const [config, setConfig] = useState(getConfig({
        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: 'blue'
            },
            sec: {
                title: 'Secondary',
                field: 'pv',
                color: 'green'
            }
        }
    }));
    useEffect(() => {
        // 您可以观察 Web 组件事件
        const unobserve = observe((e) => {
            // 事件处理程序
        }, ref.current);
        // 你可以停止收听事件
        return () => unobserve();
    }, []);
    // 只需在 JSX 中使用 Web 组件即可
    return <div ref={ref}>
        <effcharts-bar config={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: 'blue'
        },
        sec: {
            title: 'Secondary',
            field: 'pv',
            color: 'green'
        }
    }
} satisfies TBarConfig;