# @daykalif/g2plot-sankey

> Custom g2plot sankey full path chart

Latest version **1.0.6** (published 2022-02-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @daykalif/g2plot-sankey
pnpm add @daykalif/g2plot-sankey
yarn add @daykalif/g2plot-sankey
bun add @daykalif/g2plot-sankey
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2022-02-17 |
| First published | 2022-02-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 1.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | daykalif |
| Maintainers | daykalif |

## Links

- npm: https://www.npmjs.com/package/@daykalif/g2plot-sankey
- npm.io page: https://npm.io/package/@daykalif/g2plot-sankey

## Dependencies (2)

- [@antv/g2](https://npm.io/package/@antv/g2.md) ^4.1.46
- [size-sensor](https://npm.io/package/size-sensor.md) ^1.0.1

## Recent versions

- 1.0.6 (latest) — 2022-02-17
- 1.0.4 — 2022-02-15
- 1.0.3 — 2022-02-15
- 1.0.2 — 2022-02-11
- 1.0.1 — 2022-02-11
- 1.0.0 — 2022-02-11

## README

## G2Plot-Sankey-FullPath

### Install

> $ npm i --save @daykalif/g2plot-sankey

### Usage

```js
import { Sankey } from '@daykalif/g2plot-sankey/lib/plots/sankey';

// 全路径数据
export const PATH_DATA = [
  { path: '首次打开|你好|aa', value: 20 },
  { path: '首次打开|你好|', value: 5 },
  { path: '结果页|你好|借呗', value: 12 },
  { path: '结果页|你好|扫一扫|再见页', value: 10 },
  { path: '首次打开|首页 UV|', value: 8 },
  { path: '其他来源|首页 UV|', value: 17 },
  { path: '首次打开|首页 UV|扫一扫|再见页', value: 4 },
  { path: '首次打开|首页 UV|扫一扫|结束页', value: 9 },
];

export const ALIPAY_DATA = [
  {
    source: '首次打开',
    target: '你好',
    value: 25,
  },
  {
    source: '结果页',
    target: '你好',
    value: 22,
  },
  {
    source: '首次打开',
    target: '首页 UV',
    value: 21,
  },
  {
    source: '其他来源',
    target: '首页 UV',
    value: 17,
  },
  {
    source: '你好',
    target: '理财',
    value: 20,
  },
  {
    source: '你好',
    target: '借呗',
    value: 17,
  },
  {
    source: '你好',
    target: '扫一扫',
    value: 10,
  },
  {
    source: '首页 UV',
    target: '扫一扫',
    value: 13,
  },
  {
    source: '扫一扫',
    target: '再见页',
    value: 14,
  },
  {
    source: '扫一扫',
    target: '结束页',
    value: 9,
  },
  {
    source: '首页 UV',
    target: '流向',
    value: 25,
  },
];

const sankey = new Sankey('container', {
  height: 500,
  data: ALIPAY_DATA,
  sourceField: 'source',
  targetField: 'target',
  weightField: 'value',
  nodeWidth: 32,
  // 可选，不加默认为true，设为false全路径不生效
  // showFullPath: false,
  fullPathData: PATH_DATA,
  lossFieldValue: 'Loss',
  nodeSort: (a, b) => {
    if (b.name.indexOf('Loss') > -1) {
      return -1;
    }
    return 1;
  },
  linkSort: (a, b) => {
    if (b.target.name.indexOf('Loss') > -1) {
      return -1;
    }
    return 1;
  },
});

sankey.render();
```

### Preview

![sankey-fullPath](./src/assets/demo.png)

### Document & API

---

| Property     | Description            | Type                              | defaultValue |
| ------------ | ---------------------- | --------------------------------- | ------------ |
| PATH_DATA    | 高亮路径数据           | Array<{path:string,value:number}> | -            |
| showFullPath | 路径高亮是否生效(可选) | boolean                           | true         |
| formatData   | 格式化全路径数据       | (path_data)=>void                 | -            |

- 其余 API 与 G2Plot 桑基图配置保持一致

### License

---

MIT@[daykalif](https://github.com/daykalif)

---
_Source: https://npm.io/package/@daykalif/g2plot-sankey · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._