# @flourish/axes-highlights 中文文档

规范地址：https://npmcn.com/package/%40flourish/axes-highlights/

版本：5\.0\.0
npm 元数据更新时间：2026-11-02T11:46:41.960Z
中文译文更新时间：2026-11-15T01:11:29.785Z
软件包许可：LicenseRef-LICENSE

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40flourish/axes-highlights
原文对照：https://npmcn.com/package/%40flourish/axes-highlights/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：252 kB，24 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：4 个
- 首次发布：2021-02-16T11:38:46.401Z
- 最新版本发布：2026-11-02T11:46:41.751Z
- 近 30 天下载量：2278（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：23（近 12 个月 1 个）

## 中文简介

突出显示轴

## 安装

```sh
npm install @flourish/axes-highlights
```

也可以使用：`pnpm add @flourish/axes-highlights`、`yarn add @flourish/axes-highlights`、`bun add @flourish/axes-highlights`

## README

# 花粉轴亮点

本模块允许用户添加亮点来进行繁荣-图放出(或繁荣-轴)轴.

## 开始

### 1\. 安装

`npm install --save @flourish/axes-highlights`

### 2\. 添加设置和状态

```js
const state = {
    axes_highlights: {} // Add any properties to this object to override the default settings
}
```

```yaml
# template.yml
- property: axes_highlights
  import: "@flourish/axes-highlights"
```

### 3\. 初始化轴突

```js
import initAxesHighlights from "@flourish/axes-highlights";
var axes_highlights = initAxesHighlights(state.axes_highlights);
```

### 4\. 更新轴亮点

在模板的更新功能(例如. `updateGraphic`)通常将下列方法称为:

```js
let container = select(...);

axes_highlights
    .appendTo(container)
    .chartLayout(chart_layout)
    .update();
```

您需要使用的最低方法为 `appendTo`, (中文(简体) ), `chartLayout` 财务报告和审定财务报表 `update`。关于完整的配置,请参见“方法”.

`container` 是代表要显示的元素的 D3 选择。 您可能需要导入 `d3-transition` 模块 `container` 选择,这样可以进行转换。 (没有这个,轴线亮点可能根本不显示. )

这一基本实施将轴线突出部分附加在容器上(`container`) (中文(简体) ). 如果您想要在同一个母容器内附加多轴突出显示容器( 例如多个侧面), 您可以使用 `offset()` 设置轴突出显示容器的方法(见执行实例) [这里](https://github.com/kiln/template-line-bar-pie/pull/704)) (中文(简体) ). Axes 突起应该被附加在每面,所以例如LBP中,并被分散在每面组的facet.js文件中.

## 方法

### 轴 高光. animation 定义( 数字)

你想让动画拍多久? 等待一个数字.

### 轴 高光度. appendPattersTo( 选择)

轴突可以使用 SVG 模式来渲染. 在容器中通过,您希望图案被附加。 需要D3选择 如果不使用此选项, 它将默认为附件 To 容器 。 由于每面都叫出轴突起,一个具有多面的模板将图案附加到面板容器上会效率低下,因为这会导致图案被定义的次数超过必要的时间. 因此,如果您使用一个具有多个方面的模板,您应该呼叫 `appendPatternsTo` 仅仅在绘图函数中传递一次,传递一个包罗所有方(如 svg)的容器,这样所有轴突亮都使用相同的图案. 如果模板不包含多个方面, 您不需要使用这种方法, 因为默认效果应该很好 .

### 轴 高亮度. appendto( 选中)

附加到的父元素 。 我们倾向于使用 `fl-data-foreground` 组合为父(如果存在)。 譬如说. `.appendTo(select(".fl-data-foreground"))`。需要一个 d3 选择.

### 轴 高光.chartLayout(chart layout)

指定一个图表布局(或轴)实例来附加突现。 用于平面,边距,地块分化等(应为每平面1个).

期望它拥有以下属性,通常是其中的一部分: [@flourish/chart-layout (英语)](https://github.com/kiln/flourish-chart-layout) (或@flourish/axes)模块:

```
- xDatetimeParse
- yDatetimeParse
- margins
- plot_height
- plot_width
- xData
- yData
- xScale
- yScale
```

### 轴 高光. 面部Name (字符串)

Facet 名称,用于知道亮点是否应该适用于facet. 期待一个字符串.

### 轴 高光. 数字Parser( fn)

用来解析数字,例如:. `localization.getParser()`。用于分析一个轴是类型编号时的数字。 (如果轴是类型日期,我们使用图表布局(或轴)日期解析器和字符串不解析). 期待一个函数.

### 轴 高光.offset(对象)

向轴上突出显示容器相抵后增加。 期望含有 `x` 财务报告和审定财务报表 `y` 财产,例如:. `{x: 25, y: 10}`。 。 。 .

### 轴 高光. update( )

更新亮点!

### 轴 高光. x 残废( 布尔)

如果您想要禁用 x 突起( 例如当图表没有 x 轴时在 LBP) 。 期待一个布尔.

### 轴 高光. xExtendByStep( 布尔)

如果您想要扩展 x 区域亮点( 例如在 LBP 中, 区域会超出精确的 x 值, 因为它覆盖一列网格) 。 期待一个布尔.

### 轴 高光. y

如果您想要将 y 突出显示禁用( 例如当图表没有 y 轴时在 LBP) 。 期待一个布尔.

### 轴 高光.yExtendByStep(布尔)

如果您想要扩展 y 区域亮点( 例如, 在 LBP 中, 区域会超出精确的 y 值, 因为它覆盖一列网格) 。 期待一个布尔.

## 常见问题

### @flourish/axes-highlights 是什么？

突出显示轴

### 如何安装 @flourish/axes-highlights？

在项目目录运行 npm install @flourish/axes-highlights，或使用 pnpm add / yarn add / bun add。

### @flourish/axes-highlights 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/flourish\_\_axes-highlights 是否存在。

### @flourish/axes-highlights 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @flourish/axes-highlights 可以商用吗？

@flourish/axes-highlights 使用 LicenseRef-LICENSE 许可。声明的许可为 LicenseRef-LICENSE，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @flourish/axes-highlights 的下载量有多少？

根据 npm 官方下载统计，@flourish/axes-highlights 在 2026/10/15 – 2026/11/13 这 30 天内被下载 2,278 次，日均约 76 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @flourish/axes-highlights 还在维护吗？

最新版本 5\.0\.0 发布于 2026/11/02（13 天前）；至今共发布 23 个版本，其中过去 12 个月发布了 1 个；首次发布于 2021/02/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。