logo

F2

  • 教程
  • 组件API
  • 图表示例
  • 所有产品antv logo arrow
  • 5.0.3
  • 顶层 API - F2
  • 组件 - Component
  • 画布 - Canvas
  • 时间轴 - Timeline
  • 图表 - Chart
    • 图表 - Chart
    • 几何标记 - Geometry
    • 线 - Line
    • 区间 - Interval
    • 点 - Point
    • 面积 - Area
    • K 线图 - Candlestick
    • 坐标轴 - Axis
    • 图例 - Legend
    • 提示 - tooltip
    • 标注 - Guide
    • 滚动条 - ScrollBar

标注 - Guide

上一篇
提示 - tooltip
下一篇
滚动条 - ScrollBar

Resources

Ant Design
Galacea Effects
Umi-React 应用开发框架
Dumi-组件/文档研发工具
ahooks-React Hooks 库

社区

体验科技专栏
seeconfSEE Conf-蚂蚁体验科技大会

帮助

GitHub
StackOverflow

more products更多产品

Ant DesignAnt Design-企业级 UI 设计语言
yuque语雀-知识创作与分享工具
EggEgg-企业级 Node 开发框架
kitchenKitchen-Sketch 工具集
GalaceanGalacean-互动图形解决方案
xtech蚂蚁体验科技
© Copyright 2025 Ant Group Co., Ltd..备案号:京ICP备15032932号-38

Loading...

提示和标注, 主要用于在图表上标识额外的标记注解。目前内置 PointGuide 点标注、TextGuide 文本标注、TagGuide 标注、ImageGuide 图片标注和 LineGuide 线标注,也可以自定义标注。

Usage

import { Canvas, Chart, Interval, TextGuide } from '@antv/f2';
const data = [
{ genre: 'Sports', sold: 5 },
{ genre: 'Strategy', sold: 10 },
{ genre: 'Action', sold: 20 },
{ genre: 'Shooter', sold: 20 },
{ genre: 'Other', sold: 40 },
];
<Canvas context={context}>
<Chart data={data}>
<Axis field="genre" />
<Interval x="genre" y="sold" />
{data.map((item) => {
const { sold } = item;
return (
<TextGuide
records={[item]}
content={`${sold}`}
attrs={{
fill: '#000',
fontSize: '24px',
}}
offsetY={-20}
offsetX={-15}
/>
);
})}
</Chart>
</Canvas>;

Props

records: Array

数据项

可传入具体数据项,表示在改数据位置标注内容

<Guide records={[{ genre: 'Sports', sold: 5 }]}>

比例值

可传入比例值,可选值: 'min' | 'median' | 'max' | '0%' | '50%' | '100'

// 表示在 genre 的最小值,sold 的最大值位置标注内容
<Guide records={[{ genre: 'min', sold: 'max' }]}>

style

标注样式

PointGuide

标注点

offsetX: number

x 轴偏移量

offsetY: number

y 轴偏移量

TextGuide

文本标注

content: string

文本内容

offsetX: number

x 轴偏移量

offsetY: number

y 轴偏移量

TagGuide

标签标注

content: string

文本内容

offsetX: number

x 轴偏移量

offsetY: number

y 轴偏移量

direct: string

可选值为:

'tl' | 'tc' | 'tr'
'cl' | | 'cr'
'bl' | 'bc' | 'br'

background: Attrs

类型为绘图属性:图形属性

triggerRef: any

tagGuide 实例

textStyle: TextAttr

类型为绘图属性:文本属性 文本样式文本样式

ImageGuide

图片标注

src: string

图片地址

attrs

图片属性 更多详见:绘图属性 - ShapeAttrs

offsetX: number

x 轴偏移量

offsetY: number

y 轴偏移量

LineGuide

辅助线标注

offsetX: number

x 轴偏移量

offsetY: number

y 轴偏移量

demo 示例

  • 文本标注
  • 点标注
  • 图片标注
  • 辅助线
  • 自定义标注内容