@g9tm/lynxcontrols-charts 2.3.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/catalog/cards/G9BarChart.md +17 -0
- package/catalog/cards/G9CandleChart.md +17 -0
- package/catalog/cards/G9ChartBox.md +17 -0
- package/catalog/cards/G9Donut.md +16 -0
- package/catalog/cards/G9FanChart.md +17 -0
- package/catalog/cards/G9Gauge.md +16 -0
- package/catalog/cards/G9Heatmap.md +17 -0
- package/catalog/cards/G9LineChart.md +17 -0
- package/catalog/cards/G9Radar.md +15 -0
- package/catalog/cards/G9Sparkline.md +15 -0
- package/catalog/cards/G9StackedBarChart.md +17 -0
- package/catalog/catalog.json +2508 -0
- package/catalog/index.md +15 -0
- package/dist/.tsbuildinfo +1 -1
- package/dist/charts.css +14 -7
- package/dist/charts.css.map +1 -1
- package/package.json +7 -5
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# G9BarChart
|
|
2
|
+
|
|
3
|
+
`import { G9BarChart } from '@g9tm/lynxcontrols-charts';`
|
|
4
|
+
|
|
5
|
+
Bars (SAC hourly, G9Hub admin BarChart, ShopManager Bars).
|
|
6
|
+
|
|
7
|
+
Props:
|
|
8
|
+
- `values`: number[]
|
|
9
|
+
- `tooltip?`: (index: number) => void
|
|
10
|
+
- `yFormat?`: (v: number) => void
|
|
11
|
+
- `color?`: color
|
|
12
|
+
- `everyX?`: number
|
|
13
|
+
- `height?`: number = 180
|
|
14
|
+
- `highlightIndex?`: number
|
|
15
|
+
- `legend?`: object[]
|
|
16
|
+
|
|
17
|
+
Example: `<G9BarChart values={values} />`
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# G9CandleChart
|
|
2
|
+
|
|
3
|
+
`import { G9CandleChart } from '@g9tm/lynxcontrols-charts';`
|
|
4
|
+
|
|
5
|
+
Candlesticks (Riskara Candles): success colour up, error colour down, the last close dashed.
|
|
6
|
+
|
|
7
|
+
Props:
|
|
8
|
+
- `candles`: object[]
|
|
9
|
+
- `tooltip?`: (index: number) => void
|
|
10
|
+
- `yFormat?`: (v: number) => void
|
|
11
|
+
- `everyX?`: number
|
|
12
|
+
- `height?`: number = 180
|
|
13
|
+
- `legend?`: object[]
|
|
14
|
+
- `width?`: number
|
|
15
|
+
- `xLabels?`: string[]
|
|
16
|
+
|
|
17
|
+
Example: `<G9CandleChart candles={candles} />`
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# G9ChartBox
|
|
2
|
+
|
|
3
|
+
`import { G9ChartBox } from '@g9tm/lynxcontrols-charts';`
|
|
4
|
+
|
|
5
|
+
A chart in its frame (SAC kit ChartBox): y labels on the end side in the reading direction (right in RTL), x labels under, a legend, and a tooltip that follows the finger to the nearest slot.
|
|
6
|
+
|
|
7
|
+
Props:
|
|
8
|
+
- `build`: (width: number, height: number, palette: G9PaletteValues) => void
|
|
9
|
+
- `deps`: {}[]
|
|
10
|
+
- `tooltip?`: (index: number) => void
|
|
11
|
+
- `yFormat?`: (v: number) => void
|
|
12
|
+
- `everyX?`: number
|
|
13
|
+
- `height?`: number = 180
|
|
14
|
+
- `legend?`: object[]
|
|
15
|
+
- `width?`: number
|
|
16
|
+
|
|
17
|
+
Example: `<G9ChartBox build={build} deps={deps} />`
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# G9Donut
|
|
2
|
+
|
|
3
|
+
`import { G9Donut } from '@g9tm/lynxcontrols-charts';`
|
|
4
|
+
|
|
5
|
+
A donut with its legend and shares (SAC DonutBox, Riskara Donut); at most about six slices read well.
|
|
6
|
+
|
|
7
|
+
Props:
|
|
8
|
+
- `slices`: object[]
|
|
9
|
+
- `children?`: ReactNode
|
|
10
|
+
- `size?`: number = 160
|
|
11
|
+
- `legend?`: boolean = true
|
|
12
|
+
- `thickness?`: number = 18
|
|
13
|
+
- `width?`: number
|
|
14
|
+
- `accessibilityLabel?`: string
|
|
15
|
+
|
|
16
|
+
Example: `<G9Donut slices={slices} />`
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# G9FanChart
|
|
2
|
+
|
|
3
|
+
`import { G9FanChart } from '@g9tm/lynxcontrols-charts';`
|
|
4
|
+
|
|
5
|
+
A forecast fan (Riskara FanBox).
|
|
6
|
+
|
|
7
|
+
Props:
|
|
8
|
+
- `points`: object[]
|
|
9
|
+
- `tooltip?`: (index: number) => void
|
|
10
|
+
- `yFormat?`: (v: number) => void
|
|
11
|
+
- `color?`: color
|
|
12
|
+
- `everyX?`: number
|
|
13
|
+
- `height?`: number = 180
|
|
14
|
+
- `legend?`: object[]
|
|
15
|
+
- `width?`: number
|
|
16
|
+
|
|
17
|
+
Example: `<G9FanChart points={points} />`
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# G9Gauge
|
|
2
|
+
|
|
3
|
+
`import { G9Gauge } from '@g9tm/lynxcontrols-charts';`
|
|
4
|
+
|
|
5
|
+
A gauge on a spectrum arc (Riskara Gauge, ShopChat Needle).
|
|
6
|
+
|
|
7
|
+
Props:
|
|
8
|
+
- `value`: number
|
|
9
|
+
- `children?`: ReactNode
|
|
10
|
+
- `size?`: number = 200
|
|
11
|
+
- `stops?`: string[]
|
|
12
|
+
- `thickness?`: number
|
|
13
|
+
- `width?`: number
|
|
14
|
+
- `accessibilityLabel?`: string
|
|
15
|
+
|
|
16
|
+
Example: `<G9Gauge value={1} />`
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# G9Heatmap
|
|
2
|
+
|
|
3
|
+
`import { G9Heatmap } from '@g9tm/lynxcontrols-charts';`
|
|
4
|
+
|
|
5
|
+
An hour × weekday heatmap (SAC HeatmapBox), row labels on the start side.
|
|
6
|
+
|
|
7
|
+
Props:
|
|
8
|
+
- `grid`: number[][]
|
|
9
|
+
- `colLabels?`: string[]
|
|
10
|
+
- `color?`: color
|
|
11
|
+
- `everyCol?`: number = 3
|
|
12
|
+
- `height?`: number = 160
|
|
13
|
+
- `rowLabels?`: string[]
|
|
14
|
+
- `width?`: number
|
|
15
|
+
- `accessibilityLabel?`: string
|
|
16
|
+
|
|
17
|
+
Example: `<G9Heatmap grid={grid} />`
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# G9LineChart
|
|
2
|
+
|
|
3
|
+
`import { G9LineChart } from '@g9tm/lynxcontrols-charts';`
|
|
4
|
+
|
|
5
|
+
Lines and areas over time (SAC sales, Riskara LineBox, G9Hub insights).
|
|
6
|
+
|
|
7
|
+
Props:
|
|
8
|
+
- `series`: object[]
|
|
9
|
+
- `tooltip?`: (index: number) => void
|
|
10
|
+
- `yFormat?`: (v: number) => void
|
|
11
|
+
- `everyX?`: number
|
|
12
|
+
- `height?`: number = 180
|
|
13
|
+
- `legend?`: boolean
|
|
14
|
+
- `max?`: number
|
|
15
|
+
- `min?`: number
|
|
16
|
+
|
|
17
|
+
Example: `<G9LineChart series={series} />`
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# G9Radar
|
|
2
|
+
|
|
3
|
+
`import { G9Radar } from '@g9tm/lynxcontrols-charts';`
|
|
4
|
+
|
|
5
|
+
A radar of dimensions (Riskara risk DNA radar) with labels at the axis ends.
|
|
6
|
+
|
|
7
|
+
Props:
|
|
8
|
+
- `labels`: string[]
|
|
9
|
+
- `values`: number[]
|
|
10
|
+
- `size?`: number = 280
|
|
11
|
+
- `color?`: color
|
|
12
|
+
- `width?`: number
|
|
13
|
+
- `accessibilityLabel?`: string
|
|
14
|
+
|
|
15
|
+
Example: `<G9Radar labels={labels} values={values} />`
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# G9Sparkline
|
|
2
|
+
|
|
3
|
+
`import { G9Sparkline } from '@g9tm/lynxcontrols-charts';`
|
|
4
|
+
|
|
5
|
+
A tiny trend (SAC/Riskara/ShopManager sparklines) — for KPI tiles (`G9Kpi trend={…}`).
|
|
6
|
+
|
|
7
|
+
Props:
|
|
8
|
+
- `values`: number[]
|
|
9
|
+
- `color?`: color
|
|
10
|
+
- `height?`: number = 30
|
|
11
|
+
- `kind?`: 'line' | 'bars'
|
|
12
|
+
- `width?`: number
|
|
13
|
+
- `accessibilityLabel?`: string
|
|
14
|
+
|
|
15
|
+
Example: `<G9Sparkline values={values} />`
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# G9StackedBarChart
|
|
2
|
+
|
|
3
|
+
`import { G9StackedBarChart } from '@g9tm/lynxcontrols-charts';`
|
|
4
|
+
|
|
5
|
+
Stacked bars with a legend of the parts (SAC channel mix by day).
|
|
6
|
+
|
|
7
|
+
Props:
|
|
8
|
+
- `parts`: string[]
|
|
9
|
+
- `stacks`: number[][]
|
|
10
|
+
- `tooltip?`: (index: number) => void
|
|
11
|
+
- `yFormat?`: (v: number) => void
|
|
12
|
+
- `colors?`: string[]
|
|
13
|
+
- `everyX?`: number
|
|
14
|
+
- `height?`: number = 180
|
|
15
|
+
- `width?`: number
|
|
16
|
+
|
|
17
|
+
Example: `<G9StackedBarChart parts={parts} stacks={stacks} />`
|