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

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,3 @@
+import { SeriesLegendParams } from '../types';
+
+export declare const SeriesLegend: import('@orbcharts/core').PluginConstructor<"series", string, SeriesLegendParams>;

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

@@ -43,3 +43,10 @@ export interface PieLabelsPluginParams {
     labelFn: ((d: ComputedDatumSeries) => string);
     labelColorType: ColorType;
 }
+export interface SeriesLegendParams {
+    position: 'top' | 'bottom' | 'left' | 'right';
+    justify: 'start' | 'center' | 'end';
+    padding: number;
+    gap: number;
+    rectRadius: number;
+}

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.26",
   "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.22",
     "d3": "^7.8.5",
     "rxjs": "^7.8.1"
   }

package/src/series/defaults.ts

@@ -1,9 +1,10 @@
 import type { ComputedDatumSeries, EventSeries, EventName, ColorType } from '@orbcharts/core'
-import {
+import type {
   BubblesPluginParams,
   PiePluginParams,
   PieEventTextsPluginParams,
-  PieLabelsPluginParams } from './types'
+  PieLabelsPluginParams,
+  SeriesLegendParams } from './types'
 
 export const DEFAULT_BUBBLES_PLUGIN_PARAMS: BubblesPluginParams = {
   force: {
@@ -80,3 +81,13 @@ export const DEFAULT_PIE_LABELS_PARAMS: PieLabelsPluginParams = {
   labelColorType: 'series',
   labelFn: d => String(d.value),
 }
+
+export const DEFAULT_SERIES_LEGEND_PARAMS: SeriesLegendParams = {
+  position: 'right',
+  justify: 'end',
+  padding: 28,
+  // offset: [0, 0],
+  gap: 10,
+  rectRadius: 0,
+  // highlightEvent: false
+}

package/src/series/index.ts

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

package/src/series/plugins/Bubbles.ts

@@ -506,8 +506,6 @@ export const Bubbles = defineSeriesPlugin('Bubbles', DEFAULT_BUBBLES_PLUGIN_PARA
     bubblesSelection$.next(bubblesSelection)
   })
 
-  // const highlight$ = highlightObservable({ datumList$: computedData$, fullChartParams$, event$: store.event$ })
-  const highlightSubscription = observer.seriesHighlight$.subscribe()
   combineLatest({
     bubblesSelection: bubblesSelection$,
     bubblesData: bubblesData$,
@@ -548,6 +546,5 @@ export const Bubbles = defineSeriesPlugin('Bubbles', DEFAULT_BUBBLES_PLUGIN_PARA
   
   return () => {
     destroy$.next(undefined)
-    highlightSubscription.unsubscribe()
   }
 })

package/src/series/plugins/Pie.ts

@@ -508,9 +508,6 @@ export const Pie = defineSeriesPlugin(pluginName, DEFAULT_PIE_PLUGIN_PARAMS)(({
   //     arcMouseover: data.arcMouseover
   //   })
   // })
-
-  // const highlight$ = highlightObservable({ datumList$: computedData$, fullChartParams$, event$: store.event$ })
-  const highlightSubscription = observer.seriesHighlight$.subscribe()
   
   combineLatest({
     pathSelection: pathSelection$,
@@ -598,6 +595,5 @@ export const Pie = defineSeriesPlugin(pluginName, DEFAULT_PIE_PLUGIN_PARAMS)(({
 
   return () => {
     destroy$.next(undefined)
-    highlightSubscription.unsubscribe()
   }
 })

package/src/series/plugins/PieLabels.ts

@@ -263,9 +263,6 @@ export const PieLabels = defineSeriesPlugin(pluginName, DEFAULT_PIE_LABELS_PARAM
     labelSelection$.next(labelSelection)
 
   })
-
-  // const highlight$ = highlightObservable({ datumList$: computedData$, fullChartParams$, event$: store.event$ })
-  const highlightSubscription = observer.seriesHighlight$.subscribe()
   
   combineLatest({
     labelSelection: labelSelection$,
@@ -284,6 +281,5 @@ export const PieLabels = defineSeriesPlugin(pluginName, DEFAULT_PIE_LABELS_PARAM
 
   return () => {
     destroy$.next(undefined)
-    highlightSubscription.unsubscribe()
   }
 })

package/src/series/plugins/SeriesLegend.ts

@@ -0,0 +1,457 @@
+import * as d3 from 'd3'
+import {
+  combineLatest,
+  map,
+  switchMap,
+  takeUntil,
+  Observable,
+  Subject } from 'rxjs'
+import {
+  defineSeriesPlugin } from '@orbcharts/core'
+import type {
+  ChartParams } from '@orbcharts/core'
+import type { SeriesLegendParams } from '../types'
+import { DEFAULT_SERIES_LEGEND_PARAMS } from '../defaults'
+import { getSeriesColor, getClassName } from '../../utils/orbchartsUtils'
+import { measureTextWidth } from '../../utils/commonUtils'
+
+
+// 第1層 - 定位的容器（絕對位置）
+interface Position {
+  x:number
+  y:number
+}
+
+// 第2層 - 圖例列表
+interface LegendList {
+  direction: 'row' | 'column'
+  width: number
+  height: number
+  translateX:number
+  translateY:number
+  list: LegendItem[][]
+}
+
+// 第3層 - 圖例項目
+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
+  // rectRadius: number
+}
+
+const pluginName = 'SeriesLegend'
+const boxClassName = getClassName(pluginName, 'box')
+const legendListClassName = getClassName(pluginName, 'legend-list')
+const itemClassName = getClassName(pluginName, 'item')
+
+function renderSeriesLegend ({ itemSelection, lengendList, seriesLabel, fullParams, fullChartParams }: {
+  itemSelection: d3.Selection<SVGGElement, LegendItem, any, any>
+  lengendList: LegendList
+  seriesLabel: string[]
+  fullParams: SeriesLegendParams
+  fullChartParams: ChartParams
+}) {
+  itemSelection
+    .each((d, i, g) => {
+      // 方塊
+      d3.select(g[i])
+        .selectAll('rect')
+        .data([d])
+        .join('rect')
+        .attr('width', fullChartParams.styles.textSize)
+        .attr('height', fullChartParams.styles.textSize)
+        .attr('fill', _d => _d.color)
+        .attr('rx', fullParams.rectRadius)
+      // 文字
+      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', fullChartParams.styles.textSize * 1.5)
+        .attr('font-size', fullChartParams.styles.textSize)
+        .text(d => d.text)
+    })
+}
+
+
+export const SeriesLegend = defineSeriesPlugin(pluginName, DEFAULT_SERIES_LEGEND_PARAMS)(({ selection, rootSelection, observer, subject }) => {
+  
+  const destroy$ = new Subject()
+
+  const seriesLabels$: Observable<string[]> = observer.SeriesDataMap$.pipe(
+    takeUntil(destroy$),
+    map(data => {
+      return Array.from(data.keys())
+    })
+  )
+
+  const lineDirection$ = observer.fullParams$.pipe(
+    takeUntil(destroy$),
+    map(data => {
+      return data.position === 'bottom' || data.position === 'top'
+        ? 'row'
+        : 'column'
+    })
+  )
+
+  const lineMaxSize$ = combineLatest({
+    fullParams: observer.fullParams$,
+    layout: observer.layout$
+  }).pipe(
+    takeUntil(destroy$),
+    map(data => {
+      return data.fullParams.position === 'bottom' || data.fullParams.position === 'top'
+        ? data.layout.rootWidth - 2 // 減2是避免完全貼到邊線上
+        : data.layout.rootHeight - 2
+    })
+  )
+
+  const boxPosition$ = combineLatest({
+    layout: observer.layout$,
+    fullParams: observer.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 boxSelection$: Observable<d3.Selection<SVGGElement, Position, any, any>> = boxPosition$.pipe(
+    takeUntil(destroy$),
+    map(data => {
+
+      return rootSelection
+        .selectAll<SVGGElement, Position>(`g.${boxClassName}`)
+        .data([data])
+        .join(
+          enter => {
+            return enter
+              .append('g')
+              .classed(boxClassName, true)
+              .attr('transform', d => `translate(${d.x}, ${d.y})`)
+          },
+          update => {
+            return update
+              .transition()
+              .attr('transform', d => `translate(${d.x}, ${d.y})`)
+          },
+          exit => exit.remove()
+        )
+    })
+  )
+
+  const lengendList$: Observable<LegendList> = combineLatest({
+    layout: observer.layout$,
+    fullParams: observer.fullParams$,
+    fullChartParams: observer.fullChartParams$,
+    seriesLabels: seriesLabels$,
+    lineDirection: lineDirection$,
+    lineMaxSize: lineMaxSize$
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d),
+    map(data => {
+      const list: LegendItem[][] = 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,
+        })
+        
+        return prev
+      }, [])
+
+      // 依list計算出來的排序位置來計算整體的偏移位置
+      const { width, height, translateX, translateY } = ((_data, _list) => {
+        let width = 0
+        let height = 0
+        let translateX = 0
+        let translateY = 0
+
+        if (!_list.length || !_list[0].length) {
+          return { width, height, translateX, translateY }
+        }
+
+        const firstLineLastItem = _list[0][_list[0].length - 1]
+        if (_data.lineDirection === 'column') {
+          width = _list.reduce((p, c) => {
+            const maxWidthInLine = c.reduce((_p, _c) => {
+              // 找出最寬的寬度
+              return _c.itemWidth > _p ? _c.itemWidth : _p
+            }, 0)
+            // 每行寬度加總
+            return p + maxWidthInLine
+          }, 0)
+          height = firstLineLastItem.translateY + _data.fullChartParams.styles.textSize + _data.fullParams.gap
+        } else {
+          width = firstLineLastItem.translateX + firstLineLastItem.itemWidth
+          height = (_data.fullChartParams.styles.textSize * _list.length) + (_data.fullParams.gap * (_list.length - 1))
+        }
+
+        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 }
+      })(data, list)
+
+      return {
+        direction: data.lineDirection,
+        width,
+        height,
+        translateX,
+        translateY,
+        list
+      }
+    })
+  )
+
+  const lengendListSelection$ = combineLatest({
+    boxSelection: boxSelection$,
+    fullParams: observer.fullParams$,
+    lengendList: lengendList$
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d),
+    map(data => {
+      return data.boxSelection
+        .selectAll<SVGGElement, SeriesLegendParams>('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$ = lengendListSelection$.pipe(
+    takeUntil(destroy$),
+    map(lengendListSelection => {
+      const legendListData = lengendListSelection.data()
+      const data = legendListData[0] ? legendListData[0].list.flat() : []
+      
+      return lengendListSelection
+        .selectAll<SVGGElement, string>(`g.${itemClassName}`)
+        .data(data)
+        .join(
+          enter => {
+            return enter
+              .append('g')
+              .classed(itemClassName, true)
+              .attr('cursor', 'default')
+          },
+          update => update,
+          exit => exit.remove()
+        )
+        .attr('transform', (d, i) => {
+          return `translate(${d.translateX}, ${d.translateY})`
+        })
+    })
+  )
+
+  combineLatest({
+    itemSelection: itemSelection$,
+    lengendList: lengendList$,
+    seriesLabels: seriesLabels$,
+    fullParams: observer.fullParams$,
+    fullChartParams: observer.fullChartParams$
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d),
+  ).subscribe(data => {
+    renderSeriesLegend({
+      itemSelection: data.itemSelection,
+      lengendList: data.lengendList,
+      seriesLabel: data.seriesLabels,
+      fullParams: data.fullParams,
+      fullChartParams: data.fullChartParams
+    })
+  })
+
+  return () => {
+    destroy$.next(undefined)
+  }
+})

package/src/series/types.ts

@@ -51,3 +51,13 @@ export interface PieLabelsPluginParams {
   labelFn: ((d: ComputedDatumSeries) => string)
   labelColorType: ColorType
 }
+
+export interface SeriesLegendParams {
+  position: 'top' | 'bottom' | 'left' | 'right'
+  justify: 'start' | 'center' | 'end'
+  padding: number
+  // offset: [number, number]
+  gap: number
+  rectRadius: number
+  // highlightEvent: boolean
+}

package/src/utils/orbchartsUtils.ts

@@ -9,7 +9,7 @@ export function getMinAndMaxValue (data: ComputedDatumBase[]): [number, number]
   return getMinAndMax(arr)
 }
 
-
+// 取得colorType顏色
 export function getColor (colorType: ColorType, fullChartParams: ChartParams) {
   const colors = fullChartParams.colors[fullChartParams.colorScheme]
   // 對應series資料中第1個顏色
@@ -22,6 +22,15 @@ export function getColor (colorType: ColorType, fullChartParams: ChartParams) {
     : colors.primary
 }
 
+// 取得Series顏色
+export function getSeriesColor (seriesIndex: number, fullChartParams: ChartParams) {
+  const colorIndex = seriesIndex < fullChartParams.colors[fullChartParams.colorScheme].series.length
+    ? seriesIndex
+    : seriesIndex % fullChartParams.colors[fullChartParams.colorScheme].series.length
+  return fullChartParams.colors[fullChartParams.colorScheme].series[colorIndex]
+}
+
+// 取得Datum顏色
 export function getDatumColor ({ datum, colorType, fullChartParams }: { datum: ComputedDatumBase, colorType: ColorType, fullChartParams: ChartParams }) {
   // 對應series資料中的顏色
   if (colorType === 'series') {