@orbcharts/plugins-basic 3.0.0-alpha.25 → 3.0.0-alpha.27

package/dist/src/base/BaseLegend.d.ts

@@ -0,0 +1,15 @@
+import { BasePluginFn } from './types';
+import { ColorType } from '@orbcharts/core';
+
+export interface BaseLegendParams {
+    position: 'top' | 'bottom' | 'left' | 'right';
+    justify: 'start' | 'center' | 'end';
+    padding: number;
+    backgroundFill: ColorType;
+    backgroundStroke: ColorType;
+    gap: number;
+    listRectWidth: number;
+    listRectHeight: number;
+    listRectRadius: number;
+}
+export declare const createBaseLegend: BasePluginFn;

package/dist/src/base/types.d.ts

@@ -0,0 +1,3 @@
+export interface BasePluginFn {
+    (pluginName: string, context: any): () => void;
+}

package/dist/src/grid/defaults.d.ts

@@ -1,4 +1,4 @@
-import { LinesPluginParams, GroupAreaPluginParams, DotsPluginParams, BarsPluginParams, BarStackPluginParams, BarsTrianglePluginParams, GroupingAxisParams, ValueAxisParams, ValueStackAxisParams, ScalingAreaParams } from './types';
+import { LinesPluginParams, GroupAreaPluginParams, DotsPluginParams, BarsPluginParams, BarStackPluginParams, BarsTrianglePluginParams, GroupingAxisParams, ValueAxisParams, ValueStackAxisParams, ScalingAreaParams, GridLegendParams } from './types';
 
 export declare const DEFAULT_LINES_PLUGIN_PARAMS: LinesPluginParams;
 export declare const DEFAULT_DOTS_PLUGIN_PARAMS: DotsPluginParams;
@@ -10,3 +10,4 @@ export declare const DEFAULT_GROUPING_AXIS_PLUGIN_PARAMS: GroupingAxisParams;
 export declare const DEFAULT_VALUE_AXIS_PLUGIN_PARAMS: ValueAxisParams;
 export declare const DEFAULT_VALUE_STACK_AXIS_PLUGIN_PARAMS: ValueStackAxisParams;
 export declare const DEFAULT_SCALING_AREA_PLUGIN_PARAMS: ScalingAreaParams;
+export declare const DEFAULT_GRID_LEGEND_PARAMS: GridLegendParams;

package/dist/src/grid/index.d.ts

@@ -5,6 +5,7 @@ export { Bars } from './plugins/Bars';
 export { BarStack } from './plugins/BarStack';
 export { BarsTriangle } from './plugins/BarsTriangle';
 export { Dots } from './plugins/Dots';
+export { GridLegend } from './plugins/GridLegend';
 export { GroupAxis } from './plugins/GroupAxis';
 export { ValueAxis } from './plugins/ValueAxis';
 export { ValueStackAxis } from './plugins/ValueStackAxis';

package/dist/src/grid/plugins/GridLegend.d.ts

@@ -0,0 +1 @@
+export declare const GridLegend: import('@orbcharts/core').PluginConstructor<"grid", string, import('..').GridLegendParams>;

package/dist/src/grid/types.d.ts

@@ -1,4 +1,5 @@
 import { ColorType } from '@orbcharts/core';
+import { BaseLegendParams } from '../base/BaseLegend';
 
 export interface LinesPluginParams {
     lineCurve: string;
@@ -71,3 +72,5 @@ export interface ValueStackAxisParams extends ValueAxisParams {
 }
 export interface ScalingAreaParams {
 }
+export interface GridLegendParams extends BaseLegendParams {
+}

package/dist/src/series/defaults.d.ts

@@ -1,6 +1,7 @@
-import { BubblesPluginParams, PiePluginParams, PieEventTextsPluginParams, PieLabelsPluginParams } from './types';
+import { BubblesPluginParams, PiePluginParams, PieEventTextsPluginParams, PieLabelsPluginParams, SeriesLegendParams } from './types';
 
 export declare const DEFAULT_BUBBLES_PLUGIN_PARAMS: BubblesPluginParams;
 export declare const DEFAULT_PIE_PLUGIN_PARAMS: PiePluginParams;
 export declare const DEFAULT_PIE_EVENT_TEXTS_PARAMS: PieEventTextsPluginParams;
 export declare const DEFAULT_PIE_LABELS_PARAMS: PieLabelsPluginParams;
+export declare const DEFAULT_SERIES_LEGEND_PARAMS: SeriesLegendParams;

package/dist/src/series/index.d.ts

@@ -4,3 +4,4 @@ export { Bubbles } from './plugins/Bubbles';
 export { Pie } from './plugins/Pie';
 export { PieEventTexts } from './plugins/PieEventTexts';
 export { PieLabels } from './plugins/PieLabels';
+export { SeriesLegend } from './plugins/SeriesLegend';

package/dist/src/series/plugins/SeriesLegend.d.ts

@@ -0,0 +1 @@
+export declare const SeriesLegend: import('@orbcharts/core').PluginConstructor<"series", string, import('..').SeriesLegendParams>;

package/dist/src/series/types.d.ts

@@ -1,4 +1,5 @@
 import { ComputedDatumSeries, EventSeries, EventName, ColorType } from '@orbcharts/core';
+import { BaseLegendParams } from '../base/BaseLegend';
 
 export type ScaleType = 'area' | 'radius';
 export interface BubblesPluginParams {
@@ -43,3 +44,5 @@ export interface PieLabelsPluginParams {
     labelFn: ((d: ComputedDatumSeries) => string);
     labelColorType: ColorType;
 }
+export interface SeriesLegendParams extends BaseLegendParams {
+}

package/dist/src/utils/orbchartsUtils.d.ts

@@ -2,6 +2,7 @@ import { AxisPosition, ColorType, ChartParams, ComputedDatumBase } from '@orbcha
 
 export declare function getMinAndMaxValue(data: ComputedDatumBase[]): [number, number];
 export declare function getColor(colorType: ColorType, fullChartParams: ChartParams): string;
+export declare function getSeriesColor(seriesIndex: number, fullChartParams: ChartParams): string;
 export declare function getDatumColor({ datum, colorType, fullChartParams }: {
     datum: ComputedDatumBase;
     colorType: ColorType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orbcharts/plugins-basic",
-  "version": "3.0.0-alpha.25",
+  "version": "3.0.0-alpha.27",
   "description": "plugins for OrbCharts",
   "author": "Blue Planet Inc.",
   "license": "Apache-2.0",
@@ -31,10 +31,11 @@
     "@types/d3": "^7.4.0",
     "ts-loader": "^9.4.2",
     "typescript": "^5.0.4",
+    "vite": "^5.3.5",
     "vite-plugin-dts": "^3.7.3"
   },
   "dependencies": {
-    "@orbcharts/core": "^3.0.0-alpha.21",
+    "@orbcharts/core": "^3.0.0-alpha.24",
     "d3": "^7.8.5",
     "rxjs": "^7.8.1"
   }

package/src/base/BaseLegend.ts

@@ -0,0 +1,543 @@
+import * as d3 from 'd3'
+import {
+  combineLatest,
+  map,
+  switchMap,
+  takeUntil,
+  Observable,
+  Subject } from 'rxjs'
+import type { BasePluginFn } from './types'
+import type {
+  ChartParams, Layout, ColorType } from '@orbcharts/core'
+import { getSeriesColor, getClassName, getColor } from '../utils/orbchartsUtils'
+import { measureTextWidth } from '../utils/commonUtils'
+
+export interface BaseLegendParams {
+  position: 'top' | 'bottom' | 'left' | 'right'
+  justify: 'start' | 'center' | 'end'
+  padding: number
+  // offset: [number, number]
+  backgroundFill: ColorType
+  backgroundStroke: ColorType
+  gap: number
+  listRectWidth: number
+  listRectHeight: number
+  listRectRadius: number
+  // highlightEvent: boolean
+}
+
+// 第1層 - 定位的容器
+interface RootPosition {
+  x:number
+  y:number
+}
+
+// 第2層 - 卡片
+interface LegendCard {
+  width: number
+  height: number
+  translateX:number
+  translateY:number
+}
+
+// 第3層 - 圖例列表
+interface LegendList {
+  direction: 'row' | 'column'
+  width: number
+  height: number
+  translateX:number
+  translateY:number
+  // list: LegendItem[][]
+}
+
+// 第4層 - 圖例項目
+interface LegendItem {
+  id: string // seriesLabel
+  seriesLabel: string
+  seriesIndex: number
+  lineIndex: number
+  itemIndex: number // 行內的item
+  text: string
+  itemWidth: number
+  translateX: number
+  translateY: number
+  color: string
+  // fontSize: number
+  // listRectRadius: number
+}
+
+export const createBaseLegend: BasePluginFn = (pluginName: string, {
+  rootSelection,
+  seriesLabels$,
+  fullParams$,
+  layout$,
+  fullChartParams$
+}: {
+  rootSelection: d3.Selection<any, unknown, any, unknown>
+  seriesLabels$: Observable<string[]>
+  fullParams$: Observable<BaseLegendParams>
+  layout$: Observable<Layout>
+  fullChartParams$: Observable<ChartParams>
+}) => {
+
+  const rootPositionClassName = getClassName(pluginName, 'root-position')
+  const legendCardClassName = getClassName(pluginName, 'legend-card')
+  const legendListClassName = getClassName(pluginName, 'legend-list')
+  const legendItemClassName = getClassName(pluginName, 'legend-item')
+
+  const destroy$ = new Subject()
+
+  // const seriesLabels$: Observable<string[]> = SeriesDataMap$.pipe(
+  //   takeUntil(destroy$),
+  //   map(data => {
+  //     return Array.from(data.keys())
+  //   })
+  // )
+
+  const lineDirection$ = fullParams$.pipe(
+    takeUntil(destroy$),
+    map(data => {
+      return data.position === 'bottom' || data.position === 'top'
+        ? 'row'
+        : 'column'
+    })
+  )
+
+  const lineMaxSize$ = combineLatest({
+    fullParams: fullParams$,
+    layout: layout$
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d),
+    map(data => {
+      const ourterSize = (data.fullParams.padding) * 2 + (data.fullParams.gap * 2) // 卡片離場景的間距 & 卡片內的間距
+
+      return data.fullParams.position === 'bottom' || data.fullParams.position === 'top'
+        ? data.layout.rootWidth - ourterSize
+        : data.layout.rootHeight - ourterSize
+    })
+  )
+
+  const rootPosition$ = combineLatest({
+    layout: layout$,
+    fullParams: fullParams$,
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d),
+    map(data => {
+      let x = 0
+      let y = 0
+      if (data.fullParams.position === 'bottom') {
+        y = data.layout.rootHeight
+        if (data.fullParams.justify === 'start') {
+          x = 0
+        } else if (data.fullParams.justify === 'center') {
+          x = data.layout.rootWidth / 2
+        } else if (data.fullParams.justify === 'end') {
+          x = data.layout.rootWidth
+        }
+      } else if (data.fullParams.position === 'right') {
+        x = data.layout.rootWidth
+        if (data.fullParams.justify === 'start') {
+          y = 0
+        } else if (data.fullParams.justify === 'center') {
+          y = data.layout.rootHeight / 2
+        } else if (data.fullParams.justify === 'end') {
+          y = data.layout.rootHeight
+        }
+      } else if (data.fullParams.position === 'top') {
+        y = 0
+        if (data.fullParams.justify === 'start') {
+          x = 0
+        } else if (data.fullParams.justify === 'center') {
+          x = data.layout.rootWidth / 2
+        } else if (data.fullParams.justify === 'end') {
+          x = data.layout.rootWidth
+        }
+      } else if (data.fullParams.position === 'left') {
+        x = 0
+        if (data.fullParams.justify === 'start') {
+          y = 0
+        } else if (data.fullParams.justify === 'center') {
+          y = data.layout.rootHeight / 2
+        } else if (data.fullParams.justify === 'end') {
+          y = data.layout.rootHeight
+        }
+      }
+      
+      return {
+        x,
+        y
+      }
+    })
+  )
+  
+  const rootPositionSelection$: Observable<d3.Selection<SVGGElement, RootPosition, any, any>> = rootPosition$.pipe(
+    takeUntil(destroy$),
+    map(data => {
+
+      return rootSelection
+        .selectAll<SVGGElement, RootPosition>(`g.${rootPositionClassName}`)
+        .data([data])
+        .join(
+          enter => {
+            return enter
+              .append('g')
+              .classed(rootPositionClassName, true)
+              .attr('transform', d => `translate(${d.x}, ${d.y})`)
+          },
+          update => {
+            return update
+              .transition()
+              .attr('transform', d => `translate(${d.x}, ${d.y})`)
+          },
+          exit => exit.remove()
+        )
+    })
+  )
+
+  // 先計算list內每個item
+  const lengendItems$: Observable<LegendItem[][]> = combineLatest({
+    fullParams: fullParams$,
+    fullChartParams: fullChartParams$,
+    seriesLabels: seriesLabels$,
+    lineDirection: lineDirection$,
+    lineMaxSize: lineMaxSize$
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d),
+    map(data => {
+      return data.seriesLabels.reduce((prev: LegendItem[][], current, currentIndex) => {
+        const textWidth = measureTextWidth(current, data.fullChartParams.styles.textSize)
+        const itemWidth = (data.fullChartParams.styles.textSize * 1.5) + textWidth
+        const color = getSeriesColor(currentIndex, data.fullChartParams)
+        const lastItem: LegendItem | null = prev[0] && prev[0][0]
+          ? prev[prev.length - 1][prev[prev.length - 1].length - 1]
+          : null
+
+        const { translateX, translateY, lineIndex, itemIndex } = ((_data, _prev, _lastItem) => {
+          let translateX = 0
+          let translateY = 0
+          let lineIndex = 0
+          let itemIndex = 0
+
+          if (_data.lineDirection === 'column') {
+            let tempTranslateY = _lastItem
+              ? _lastItem.translateY + _data.fullChartParams.styles.textSize + _data.fullParams.gap
+              : 0
+            
+            if ((tempTranslateY + _data.fullChartParams.styles.textSize) > _data.lineMaxSize) {
+              // 換行
+              lineIndex = _lastItem.lineIndex + 1
+              itemIndex = 0
+              translateY = 0
+              // 前一行最寬寬度
+              const maxItemWidthInLastLine = _prev[_prev.length - 1].reduce((p, c) => {
+                return c.itemWidth > p ? c.itemWidth : p
+              }, 0)
+              translateX = _lastItem.translateX + maxItemWidthInLastLine + _data.fullParams.gap
+            } else {
+              lineIndex = _lastItem ? _lastItem.lineIndex : 0
+              itemIndex = _lastItem ? _lastItem.itemIndex + 1 : 0
+              translateY = tempTranslateY
+              translateX = _lastItem ? _lastItem.translateX : 0
+            }
+          } else {
+            let tempTranslateX = _lastItem
+              ? _lastItem.translateX + _lastItem.itemWidth + _data.fullParams.gap
+              : 0
+            if ((tempTranslateX + itemWidth) > _data.lineMaxSize) {
+              // 換行
+              lineIndex = _lastItem.lineIndex + 1
+              itemIndex = 0
+              translateX = 0
+            } else {
+              lineIndex = _lastItem ? _lastItem.lineIndex : 0
+              itemIndex = _lastItem ? _lastItem.itemIndex + 1 : 0
+              translateX = tempTranslateX
+            }
+            translateY = (_data.fullChartParams.styles.textSize + _data.fullParams.gap) * lineIndex
+          }
+          
+          return { translateX, translateY, lineIndex, itemIndex }
+        })(data, prev, lastItem)
+
+        if (!prev[lineIndex]) {
+          prev[lineIndex] = []
+        }
+
+        prev[lineIndex].push({
+          id: current,
+          seriesLabel: current,
+          seriesIndex: currentIndex,
+          lineIndex,
+          itemIndex,
+          text: current,
+          itemWidth,
+          translateX,
+          translateY,
+          color,
+        })
+        console.log('items', prev)
+        return prev
+      }, [])
+    })
+  )
+
+  // 依list計算出來的排序位置來計算整體容器的尺寸
+  const lengendList$: Observable<LegendList> = combineLatest({
+    fullParams: fullParams$,
+    fullChartParams: fullChartParams$,
+    lineDirection: lineDirection$,
+    lengendItems: lengendItems$
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d),
+    map(data => {
+      // 依list計算出來的排序位置來計算整體容器的偏移位置
+      const { width, height } = ((_data, _lengendItems) => {
+        let width = 0
+        let height = 0
+
+        if (!_lengendItems.length || !_lengendItems[0].length) {
+          return { width, height }
+        }
+
+        const firstLineLastItem = _lengendItems[0][_lengendItems[0].length - 1]
+        if (_data.lineDirection === 'column') {
+          width = _lengendItems.reduce((p, c) => {
+            const maxWidthInLine = c.reduce((_p, _c) => {
+              // 找出最寬的寬度
+              return _c.itemWidth > _p ? _c.itemWidth : _p
+            }, 0)
+            // 每行寬度加總
+            return p + maxWidthInLine
+          }, 0)
+          width += _data.fullParams.gap * (_lengendItems.length - 1)
+          height = firstLineLastItem.translateY + _data.fullChartParams.styles.textSize
+        } else {
+          width = firstLineLastItem.translateX + firstLineLastItem.itemWidth
+          height = (_data.fullChartParams.styles.textSize * _lengendItems.length) + (_data.fullParams.gap * (_lengendItems.length - 1))
+        }
+
+        return { width, height }
+      })(data, data.lengendItems)
+
+      return {
+        direction: data.lineDirection,
+        width,
+        height,
+        translateX: data.fullParams.gap,
+        translateY: data.fullParams.gap
+      }
+    })
+  )
+
+  const legendCard$: Observable<LegendCard> = combineLatest({
+    fullParams: fullParams$,
+    lengendList: lengendList$
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d),
+    map(data => {
+      const width = data.lengendList.width + (data.fullParams.gap * 2)
+      const height = data.lengendList.height + (data.fullParams.gap * 2)
+      let translateX = 0
+      let translateY = 0
+
+      if (data.fullParams.position === 'left') {
+        if (data.fullParams.justify === 'start') {
+          translateX = data.fullParams.padding
+          translateY = data.fullParams.padding
+        } else if (data.fullParams.justify === 'center') {
+          translateX = data.fullParams.padding
+          translateY = - height / 2
+        } else if (data.fullParams.justify === 'end') {
+          translateX = data.fullParams.padding
+          translateY = - height - data.fullParams.padding
+        }
+      } else if (data.fullParams.position === 'right') {
+        if (data.fullParams.justify === 'start') {
+          translateX = - width - data.fullParams.padding
+          translateY = data.fullParams.padding
+        } else if (data.fullParams.justify === 'center') {
+          translateX = - width - data.fullParams.padding
+          translateY = - height / 2
+        } else if (data.fullParams.justify === 'end') {
+          translateX = - width - data.fullParams.padding
+          translateY = - height - data.fullParams.padding
+        }
+      } else if (data.fullParams.position === 'top') {
+        if (data.fullParams.justify === 'start') {
+          translateX = data.fullParams.padding
+          translateY = data.fullParams.padding
+        } else if (data.fullParams.justify === 'center') {
+          translateX = - width / 2
+          translateY = data.fullParams.padding
+        } else if (data.fullParams.justify === 'end') {
+          translateX = - width - data.fullParams.padding
+          translateY = data.fullParams.padding
+        }
+      } else {
+        if (data.fullParams.justify === 'start') {
+          translateX = data.fullParams.padding
+          translateY = - height - data.fullParams.padding
+        } else if (data.fullParams.justify === 'center') {
+          translateX = - width / 2
+          translateY = - height - data.fullParams.padding
+        } else if (data.fullParams.justify === 'end') {
+          translateX = - width - data.fullParams.padding
+          translateY = - height - data.fullParams.padding
+        }
+      }
+      // translateX += _data.fullParams.offset[0]
+      // translateY += _data.fullParams.offset[1]
+
+      return {
+        width,
+        height,
+        translateX,
+        translateY
+      }
+    })
+  )
+
+  const lengendCardSelection$ = combineLatest({
+    rootPositionSelection: rootPositionSelection$,
+    fullParams: fullParams$,
+    fullChartParams: fullChartParams$,
+    legendCard: legendCard$
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d),
+    map(data => {
+      return data.rootPositionSelection
+        .selectAll<SVGGElement, BaseLegendParams>('g')
+        .data([data.legendCard])
+        .join(
+          enter => {
+            return enter
+              .append('g')
+              .classed(legendCardClassName, true)
+              .attr('transform', d => `translate(${d.translateX}, ${d.translateY})`)
+          },
+          update => {
+            return update
+              .transition()
+              .attr('transform', d => `translate(${d.translateX}, ${d.translateY})`)
+          },
+          exit => exit.remove()
+        )
+        .each((d, i, g) => {
+          const rect = d3.select(g[i])
+            .selectAll('rect')
+            .data([d])
+            .join('rect')
+            .attr('width', d => d.width)
+            .attr('height', d => d.height)
+            .attr('fill', getColor(data.fullParams.backgroundFill, data.fullChartParams))
+            .attr('stroke', getColor(data.fullParams.backgroundStroke, data.fullChartParams))
+        })
+    })
+  )
+
+
+  const lengendListSelection$ = combineLatest({
+    lengendCardSelection: lengendCardSelection$,
+    fullParams: fullParams$,
+    lengendList: lengendList$
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d),
+    map(data => {
+      return data.lengendCardSelection
+        .selectAll<SVGGElement, BaseLegendParams>('g')
+        .data([data.lengendList])
+        .join(
+          enter => {
+            return enter
+              .append('g')
+              .classed(legendListClassName, true)
+              .attr('transform', d => `translate(${d.translateX}, ${d.translateY})`)
+          },
+          update => {
+            return update
+              .transition()
+              .attr('transform', d => `translate(${d.translateX}, ${d.translateY})`)
+          },
+          exit => exit.remove()
+        )
+    })
+  )
+
+  const itemSelection$ = combineLatest({
+    lengendListSelection: lengendListSelection$,
+    fullParams: fullParams$,
+    fullChartParams: fullChartParams$,
+    lengendItems: lengendItems$
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d),
+    map(data => {
+      const items = data.lengendItems[0] ? data.lengendItems.flat() : []
+      
+      return data.lengendListSelection
+        .selectAll<SVGGElement, string>(`g.${legendItemClassName}`)
+        .data(items)
+        .join(
+          enter => {
+            return enter
+              .append('g')
+              .classed(legendItemClassName, true)
+              .attr('cursor', 'default')
+          },
+          update => update,
+          exit => exit.remove()
+        )
+        .attr('transform', (d, i) => {
+          return `translate(${d.translateX}, ${d.translateY})`
+        })
+        .each((d, i, g) => {
+          const rectCenterX = data.fullChartParams.styles.textSize / 2
+          const rectWidth = data.fullParams.listRectWidth
+          const rectHeight = data.fullParams.listRectHeight
+          // 方塊
+          d3.select(g[i])
+            .selectAll('rect')
+            .data([d])
+            .join('rect')
+            .attr('x', rectCenterX)
+            .attr('y', rectCenterX)
+            .attr('width', rectWidth)
+            .attr('height', rectHeight)
+            .attr('transform', `translate(${- rectWidth / 2}, ${- rectHeight / 2})`)
+            .attr('fill', _d => _d.color)
+            .attr('rx', data.fullParams.listRectRadius)
+          // 文字
+          d3.select(g[i])
+            .selectAll('text')
+            .data([d])
+            .join(
+              enter => {
+                return enter
+                  .append('text')
+                  .attr('dominant-baseline', 'hanging')
+              },
+              update => {
+                return update
+              },
+              exit => exit.remove()
+            )
+            .attr('x', data.fullChartParams.styles.textSize * 1.5)
+            .attr('font-size', data.fullChartParams.styles.textSize)
+            .text(d => d.text)
+        })
+    })
+  )
+
+  itemSelection$.subscribe()
+
+  return () => {
+    destroy$.next(undefined)
+  }
+}

package/src/base/types.ts

@@ -0,0 +1,3 @@
+export interface BasePluginFn {
+  (pluginName: string, context: any): () => void // return unsubscribe function
+}