Sankey Chart

通过连接节点与按权重分配的带状路径追踪阶段间流向。

适用场景

  • 当界面需要以下行为时使用 Sankey Chart:通过连接节点与按权重分配的带状路径追踪阶段间流向。

安装

选择安装方式,用法示例将同步更新导入路径。

$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/sankey-chart.json https://orvui.efu.me/r/tabs.json

首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。

示例

预览

Income statement, Q3 data
FlowValueShare of source
Subscriptions to Revenue$70M100.0%
Services to Revenue$17M100.0%
Marketplace to Revenue$14M100.0%
Revenue to Cost of revenue$36M35.6%
Revenue to Gross profit$65M64.4%
Gross profit to R&D$22M33.8%
Gross profit to Sales & marketing$17M26.2%
Gross profit to G&A$7M10.8%
Gross profit to Operating profit$19M29.2%

状态与事件

需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。

组件状态绑定
组件Vue 绑定更新事件
SankeyChartv-model:activeIdnull | stringupdate:activeId

可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。

API 参考

SankeyChart

nodes
readonly SankeyNode[]
—
links
readonly SankeyLink[]
—
label?
string
"Sankey chart"
formatValue?
(value: number) => string
formatNumber
colors?
readonly string[]
SANKEY_COLORS
nodeWidth?
number
12
nodePadding?
number
16
activeId?
null | string
—
defaultActiveId?
null | string
null
className?
string
—

事件

update:activeId
—
@update:activeId
activeChange
—
@activeChange

插槽

default
() => VNodeChild
#default

SankeyChartPlot

showValues?
boolean
true

SankeyChartTooltip

side?
"top" | "bottom" | "left" | "right"
"top"

插槽

default
—

作用域参数: active

#default

无障碍

为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。

常见问题

如何配置 Sankey Chart?
通过 nodes、links、label、formatValue、colors、nodeWidth、nodePadding、activeId、defaultActiveId、className 配置 Sankey Chart;API 表列出其类型与默认值。
如何连接到应用状态?
监听 update:activeId、activeChange,将组件连接到应用状态。
可以在服务端渲染吗?
可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。

更新于