自定义主题

自定义主题

G2 提供了自定义主题机制以允许用户切换、定义图表主题。包括:

  • 定义全新的主题结构
  • 基于已有主题结构,切换不同的主题样式表

定义全新的主题结构

  1. import { registerTheme, Chart } from '@antv/g2';
  2. // Step 1: 注册主题
  3. registerTheme('newTheme', {
  4. defaultColor: 'red',
  5. });
  6. // Step 2: 使用
  7. chart.theme('newTheme');

主题属性

下表列出了组成主题的大配置项上的具体属性:

| | defaultColor | string | 主题色 | | padding | number | number[] | | fontFamily | string | 图表字体 | | colors | string[] | 分类颜色色板,分类个数小于 10 时使用 | | colors20 | string[] | 分类颜色色板,分类个数大于 10 时使用 | | columnWidthRatio | number | 一般柱状图宽度占比,0 - 1 范围数值 | | maxColumnWidth | number | 柱状图最大宽度,像素值 | | minColumnWidth | number | 柱状图最小宽度,像素值 | | roseWidthRatio | number | 玫瑰图占比,0 - 1 范围数值 | | multiplePieWidthRatio | number | 多层饼图/环图占比,_0 - 1 范围数值 | | shapes | object | 配置每个 geometry 映射的 shape 类型 | | sizes | number | 配置 geometry 映射 size 范围 | | geometries | object | 配置每个 Geometry 下每个 shape 的样式,包括默认样式以及各个状态下的样式 | | components | object | 配置坐标轴,图例,tooltip, annotation 的主题样式 | | labels | object | 配置 Geometry 下 label 的主题样式 | | innerLabels | object | 配置 Geometry 下展示在图形内部的 labels 的主题样式 | | pieLabels | object | 配置饼图 labels 的主题样式 |

关于以上每个属性的结构及内容,详见G2 主题配置项详解。

自定义主题样式表

对于图表主题,很多时候只是想切换样式风格,比如更改颜色、字体大小、边框粗细等,并不需要更改主题结构,这个时候就可以通过自定义主题样式表,然后应用于默认的主题结构即可。

  1. import { getStyleSheet, getTheme, registerStyleSheet, registerTheme } from '[email protected]/g2';
  2. // 定义并注册 dark 的主题样式表
  3. registerStyleSheet('dark', {});
  4. // 基于默认的主题结构,应用 dark 主题样式表定义全新的暗黑色系主题
  5. registerTheme('dark', 'dark');
  6. // 使用
  7. chart.theme('dark');

自定义主题 - 图1

主题样式表结构

我们整理了完整的主题样式表结构,详见 API 类型定义。

G2 主题配置项详解

基础配置

  • 主题色: defaultColor
  • 字体:fontFamily
  • 图表内边距:padding,默认 ‘auto’ 自动计算

图形属性映射

  • 色板:colors
  • 形状:shapes,定义每个几何标记对应的 shapes 列表
  • 大小: sizes,映射的图形大小范围

图形样式

因为 G2 的图形是由 Geometry + Shape 组成的:

| | point | - ‘circle’- ‘square’- ‘bowtie’- ‘diamond’- ‘hexagon’- ‘triangle’- ‘triangle-down’- ‘hollow-circle’- ‘hollow-square’- ‘hollow-bowtie’- ‘hollow-diamond’- ‘hollow-hexagon’- ‘hollow-triangle’- ‘hollow-triangle-down’- ‘cross’- ‘tick’- ‘plus’- ‘hyphen’- ‘line’ | hollow 开头的图形都是空心的。 image.png

image.png

| line | - ‘line’- ‘dot’- ‘dash’- ‘smooth’- ‘hv’- ‘vh’- ‘hvh’- ‘vhv’ | ‘hv’, ‘vh’, ‘hvh’, ‘vhv’ 用于绘制阶梯线图。 image.png

| area | - ‘area’- ‘smooth’- ‘line’- ‘smooth-line’ | ‘area’ 和 ‘smooth-line’ 是填充内容的区域图,其他图表是空心的线图。 image.png

| interval | - ‘rect’- ‘hollow-rect’- ‘line’- ‘tick’- ‘funnel’- ‘pyramid’ | ‘hollow-rect’ 是空心的矩形,’line’ 和 ‘tick’ 都是线段,’funnel’ 用于绘制漏斗图;’pyramid’ 用于绘制金字塔图。 image.png

| polygon | - ‘polygon’ | polygon:多边形。 image.png

| schema | - ‘box’- ‘candle’ | 目前仅支持箱须图(‘box’)、K 线图(‘candle’)。 image.png

image.png

| edge | - ‘line’- ‘vhv’- ‘smooth’- ‘arc’ | vhv:直角折线,arc:弧线,分为笛卡尔坐标系、极坐标系、带权重和不带权重四种情况。 image.png

所以在配置图形样式时,需要以 Geometry 名称 + Shape 名称为 token,进行样式定义,目前主题开放的配置可用于定义图形的默认显示样式,active 的样式,inactive 的样式以及 selected 的样式。

TODO:搞个截图吧

> 以上配置定义的是 interval 这个几何标记下 rect 形状在各个状态下的样式。通常我们只需要为各个 Geometry 设置一个或者两个样式(填充或者描边的样式)即可,Geometry 下的各个 shapes 复用即可,除非某个 shape 样式特殊。

图表组件

所有的图表组件样式,定义在 components 属性下。

坐标轴

G2 的坐标轴根据坐标系类型的不同进行了类型划分,但是每种类型下的配置属性是相同的。

  • 对于直角坐标系,我们提供了上、下、左、右四个方向的坐标轴配置。
  • 对于极坐标系,我们提供了半径轴和圆弧轴的两个坐标轴的配置。

image.png 每个坐标轴可配置的属性如下:

| | title | 坐标轴标题,可以控制:1. 是否展示 1. 标题的显示位置 1. 标题文本的样式 | | label | 坐标轴文本,可以控制:1. 是否展示 1. 是否自动隐藏或者自动旋转 1. 文本的样式 | | line | 坐标轴线,可以控制:1. 是否展示 1. 线的样式 | | grid | 网格线,可以控制:1. 是否展示 1. 网格线的样式 | | tickLine | 坐标轴刻度线,可以控制:1. 是否展示 1. 刻度线的长度 1. 刻度线的样式 1. 刻度线是否和文本对齐 | | subTickLine | 坐标轴自刻度线,可以控制:1. 是否展示 1. 刻度线的样式 |

图例

G2 中图例分为连续图例和分类图例两种,同样主题中也为这两种类型的图例提供了配置。

  • 分类图例,针对分类图例,可以配置如下属性:

image.png

| | title | 图例标题,可以控制:1. 是否展示 1. 标题文本的样式 | | marker | 图例项 marker,可以控制:1. 形状 1. 样式 | | itemName | 图例项文本,可以控制:1. 文本样式 1. 间距 |

  • 连续图例,针对连续图例,可以配置一下属性:

image.png

| | title | 图例标题,可以控制:1. 是否展示 1. 标题文本的样式 | | track | 选择范围的色块样式 | | rail | 图例滑轨(背景)的样式配置项 | | label | 文本的样式配置 | | handler | 滑块的样式配置 |

Tooltip

针对 tooltip,主题开放的配置为:

  • marker 的样式
  • crosshairs 的样式
  • tooltip 整个内容框的样式配置

image.png

Annotation

G2 在主题中提供了以下 7 种 Annotation 的样式配置:

| | arc | 弧线 | image.png

| line | 辅助线,带文本 | image.png

| text | 标注文本 | image.png

| region | 辅助区域 | image.png

| dataMarker | 带点、线及文本的图形标记 | image.png

| dataRegion | 带区域及文本的图形标记 | image.png

Labels

图形标签,在 G2 主题中,分为以下三类:

| | labels | 通用 labels,可以配置文本的距离及样式 | image.png

| innerLabels | 显示在图形内部的文本,可以配置文本的距离及样式 | image.png

| pieLabels | 饼图文本的样式,可以配置文本的距离、样式以及文本连接线的样式 | image.png