@orbcharts/plugin-basic 4.0.0-pre-alpha.0

package/src/baseLayers/BaseLegend.ts

@@ -0,0 +1,684 @@
+import * as d3 from 'd3'
+import {
+  combineLatest,
+  map,
+  switchMap,
+  debounceTime,
+  takeUntil,
+  shareReplay,
+  distinctUntilChanged,
+  Observable,
+  Subject } from 'rxjs'
+import type { BaseLayerFn } from '../types/BaseLayer'
+import type { Layout, GraphicStyles } from '../types/PluginParams'
+import { createClassName, getColor, getColorScheme } from '../utils/orbchartsUtils'
+import { measureTextWidth } from '../utils/commonUtils'
+import { ColorType, Theme } from '@orbcharts/core'
+import { Placement } from '../types'
+
+export interface BaseLegendParams {
+    placement: Placement;
+    padding: number;
+    backgroundFill: ColorType;
+    backgroundStroke: ColorType;
+    textColorType: ColorType;
+    gap: number;
+    labelList: Array<{
+        listRectWidth: number;
+        listRectHeight: number;
+        listRectRadius: number;
+    }>;
+}
+
+interface BaseLegendContext {
+  rootSelection: d3.Selection<any, unknown, any, unknown>
+  pluginName: string
+  layerName: string
+  legendLabels$: Observable<string[]>
+  baseLegendParams$: Observable<BaseLegendParams>
+  layout$: Observable<Layout>
+  theme$: Observable<Theme>
+  fontSizePx$: Observable<number>
+}
+
+// 第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
+  listRectWidth: number
+  listRectHeight: number
+  listRectRadius: number
+}
+
+interface ListStyle {
+  listRectWidth: number
+  listRectHeight: number
+  listRectRadius: number
+}
+
+const noneLabelText = ' - ' // 沒有label時的預設文字
+
+const defaultListStyle: ListStyle = {
+  listRectWidth: 14,
+  listRectHeight: 14,
+  listRectRadius: 0,
+}
+
+function getSeriesColor (seriesIndex: number, theme: Theme) {
+  const colorIndex = seriesIndex < theme.colors[getColorScheme(theme.colorScheme)].data.length
+    ? seriesIndex
+    : seriesIndex % theme.colors[getColorScheme(theme.colorScheme)].data.length
+  return theme.colors[getColorScheme(theme.colorScheme)].data[colorIndex]
+}
+
+
+export const createBaseLegend: BaseLayerFn<BaseLegendContext> = ({
+  pluginName,
+  layerName,
+  rootSelection,
+  legendLabels$,
+  baseLegendParams$,
+  layout$,
+  theme$,
+  fontSizePx$
+}) => {
+
+  const rootPositionClassName = createClassName(pluginName, layerName, 'root-position')
+  const legendCardClassName = createClassName(pluginName, layerName, 'legend-card')
+  const legendListClassName = createClassName(pluginName, layerName, 'legend-list')
+  const legendItemClassName = createClassName(pluginName, layerName, 'legend-item')
+
+  const destroy$ = new Subject()
+
+  // const legendLabels$: Observable<string[]> = SeriesDataMap$.pipe(
+  //   takeUntil(destroy$),
+  //   map(data => {
+  //     return Array.from(data.keys())
+  //   })
+  // )
+
+  const SeriesLabelColorMap$ = combineLatest({
+    legendLabels: legendLabels$,
+    theme: theme$
+  }).pipe(
+    takeUntil(destroy$),
+    debounceTime(0),
+    map(data => {
+      const SeriesLabelColorMap: Map<string, string> = new Map()
+      let accIndex = 0
+      data.legendLabels.forEach((label, i) => {
+        if (!SeriesLabelColorMap.has(label)) {
+          const color = getSeriesColor(accIndex, data.theme)
+          SeriesLabelColorMap.set(label, color)
+          accIndex ++
+        }
+      })
+      return SeriesLabelColorMap
+    })
+  )
+
+  // 對應legendLabels是否顯示（只顯示不重覆的）
+  const visibleList$ = legendLabels$.pipe(
+    takeUntil(destroy$),
+    map(data => {
+      const AccSeriesLabelSet = new Set()
+      let visibleList: boolean[] = []
+      data.forEach(d => {
+        if (AccSeriesLabelSet.has(d)) {
+          visibleList.push(false) // 已存在則不顯示
+        } else {
+          visibleList.push(true)
+        }
+        AccSeriesLabelSet.add(d) // 累加已存在的seriesLabel
+      })
+      return visibleList
+    })
+  )
+
+  const position$: Observable<"top" | "bottom" | "left" | "right"> = baseLegendParams$.pipe(
+    takeUntil(destroy$),
+    map(data => {
+      const position: "top" | "bottom" | "left" | "right" = data.placement === 'top' || data.placement === 'top-start' || data.placement === 'top-end'
+        ? 'top'
+        : data.placement === 'bottom' || data.placement === 'bottom-start' || data.placement === 'bottom-end'
+          ? 'bottom'
+          : data.placement === 'left' || data.placement === 'left-start' || data.placement === 'left-end'
+            ? 'left'
+            : 'right'
+      return position
+    }),
+    distinctUntilChanged((a, b) => a === b),
+    shareReplay(1)
+  )
+
+  const justify$: Observable<"start" | "center" | "end"> = baseLegendParams$.pipe(
+    takeUntil(destroy$),
+    map(data => {
+      const justify: "start" | "center" | "end" = data.placement === 'top-start' || data.placement === 'bottom-start' || data.placement === 'left-start' || data.placement === 'right-start'
+        ? 'start'
+        : data.placement === 'top-end' || data.placement === 'bottom-end' || data.placement === 'left-end' || data.placement === 'right-end'
+          ? 'end'
+          : data.placement === 'top' || data.placement === 'bottom' || data.placement === 'left' || data.placement === 'right'
+          ? 'center'
+          : 'center'
+      return justify
+    }),
+    distinctUntilChanged((a, b) => a === b),
+    shareReplay(1)
+  )
+
+  const lineDirection$ = position$.pipe(
+    takeUntil(destroy$),
+    map(data => {
+      return data === 'bottom' || data === 'top'
+        ? 'row'
+        : 'column'
+    }),
+    distinctUntilChanged((a, b) => a === b),
+    shareReplay(1)
+  )
+
+  const lineMaxSize$ = combineLatest({
+    baseLegendParams: baseLegendParams$,
+    position: position$,
+    layout: layout$
+  }).pipe(
+    takeUntil(destroy$),
+    debounceTime(0),
+    map(data => {
+      const ourterSize = (data.baseLegendParams.padding) * 2 + (data.baseLegendParams.gap * 2) // 卡片離場景的間距 & 卡片內的間距
+
+      return data.position === 'bottom' || data.position === 'top'
+        ? data.layout.rootWidth - ourterSize
+        : data.layout.rootHeight - ourterSize
+    })
+  )
+
+  const rootPosition$ = combineLatest({
+    layout: layout$,
+    position: position$,
+    justify: justify$
+  }).pipe(
+    takeUntil(destroy$),
+    debounceTime(0),
+    map(data => {
+      let x = 0
+      let y = 0
+      if (data.position === 'bottom') {
+        y = data.layout.rootHeight
+        if (data.justify === 'start') {
+          x = 0
+        } else if (data.justify === 'center') {
+          x = data.layout.rootWidth / 2
+        } else if (data.justify === 'end') {
+          x = data.layout.rootWidth
+        }
+      } else if (data.position === 'right') {
+        x = data.layout.rootWidth
+        if (data.justify === 'start') {
+          y = 0
+        } else if (data.justify === 'center') {
+          y = data.layout.rootHeight / 2
+        } else if (data.justify === 'end') {
+          y = data.layout.rootHeight
+        }
+      } else if (data.position === 'top') {
+        y = 0
+        if (data.justify === 'start') {
+          x = 0
+        } else if (data.justify === 'center') {
+          x = data.layout.rootWidth / 2
+        } else if (data.justify === 'end') {
+          x = data.layout.rootWidth
+        }
+      } else if (data.position === 'left') {
+        x = 0
+        if (data.justify === 'start') {
+          y = 0
+        } else if (data.justify === 'center') {
+          y = data.layout.rootHeight / 2
+        } else if (data.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()
+        )
+    })
+  )
+
+  const defaultListStyle$ = baseLegendParams$.pipe(
+    takeUntil(destroy$),
+    map(data => {
+      return data.labelList[0] ? data.labelList[0] : defaultListStyle
+    })
+  )
+
+  // 先計算list內每個item
+  const lengendItems$: Observable<LegendItem[][]> = combineLatest({
+    visibleList: visibleList$,
+    baseLegendParams: baseLegendParams$,
+    legendLabels: legendLabels$,
+    lineDirection: lineDirection$,
+    lineMaxSize: lineMaxSize$,
+    defaultListStyle: defaultListStyle$,
+    SeriesLabelColorMap: SeriesLabelColorMap$,
+    fontSizePx: fontSizePx$
+  }).pipe(
+    takeUntil(destroy$),
+    debounceTime(0),
+    map(data => {
+      return data.legendLabels.reduce((prev: LegendItem[][], _current, currentIndex) => {
+        // visible為flase則不加入
+        if (!data.visibleList[currentIndex]) {
+          return prev
+        }
+
+        const currentText = _current !== '' ? _current : noneLabelText
+        
+        const textWidth = measureTextWidth(currentText, data.fontSizePx)
+        const itemWidth = (data.fontSizePx * 1.5) + textWidth
+        // const color = getSeriesColor(currentIndex, data.styles)
+        const color = data.SeriesLabelColorMap.get(_current)
+        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.fontSizePx + _data.baseLegendParams.gap
+              : 0
+            
+            if ((tempTranslateY + _data.fontSizePx) > _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.baseLegendParams.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.baseLegendParams.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.fontSizePx + _data.baseLegendParams.gap) * lineIndex
+          }
+          
+          return { translateX, translateY, lineIndex, itemIndex }
+        })(data, prev, lastItem)
+
+        if (!prev[lineIndex]) {
+          prev[lineIndex] = []
+        }
+
+        const listStyle = data.baseLegendParams.labelList[itemIndex] ? data.baseLegendParams.labelList[itemIndex] : data.defaultListStyle
+
+        prev[lineIndex].push({
+          id: currentText,
+          seriesLabel: currentText,
+          seriesIndex: currentIndex,
+          lineIndex,
+          itemIndex,
+          text: currentText,
+          itemWidth,
+          translateX,
+          translateY,
+          color,
+          listRectWidth: listStyle.listRectWidth,
+          listRectHeight: listStyle.listRectHeight,
+          listRectRadius: listStyle.listRectRadius
+        })
+        
+        return prev
+      }, [])
+    }),
+    shareReplay(1)
+  )
+
+  // 依list計算出來的排序位置來計算整體容器的尺寸
+  const lengendList$: Observable<LegendList> = combineLatest({
+    baseLegendParams: baseLegendParams$,
+    lineDirection: lineDirection$,
+    lengendItems: lengendItems$,
+    fontSizePx: fontSizePx$
+  }).pipe(
+    takeUntil(destroy$),
+    debounceTime(0),
+    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.baseLegendParams.gap * (_lengendItems.length - 1)
+          height = firstLineLastItem.translateY + _data.fontSizePx
+        } else {
+          width = firstLineLastItem.translateX + firstLineLastItem.itemWidth
+          height = (_data.fontSizePx * _lengendItems.length) + (_data.baseLegendParams.gap * (_lengendItems.length - 1))
+        }
+
+        return { width, height }
+      })(data, data.lengendItems)
+
+      return <LegendList>{
+        direction: data.lineDirection,
+        width,
+        height,
+        translateX: data.baseLegendParams.gap,
+        translateY: data.baseLegendParams.gap
+      }
+    }),
+    shareReplay(1)
+  )
+
+  const legendCard$: Observable<LegendCard> = combineLatest({
+    baseLegendParams: baseLegendParams$,
+    position: position$,
+    justify: justify$,
+    lengendList: lengendList$
+  }).pipe(
+    takeUntil(destroy$),
+    debounceTime(0),
+    map(data => {
+      const width = data.lengendList.width + (data.baseLegendParams.gap * 2)
+      const height = data.lengendList.height + (data.baseLegendParams.gap * 2)
+      let translateX = 0
+      let translateY = 0
+
+      if (data.position === 'left') {
+        if (data.justify === 'start') {
+          translateX = data.baseLegendParams.padding
+          translateY = data.baseLegendParams.padding
+        } else if (data.justify === 'center') {
+          translateX = data.baseLegendParams.padding
+          translateY = - height / 2
+        } else if (data.justify === 'end') {
+          translateX = data.baseLegendParams.padding
+          translateY = - height - data.baseLegendParams.padding
+        }
+      } else if (data.position === 'right') {
+        if (data.justify === 'start') {
+          translateX = - width - data.baseLegendParams.padding
+          translateY = data.baseLegendParams.padding
+        } else if (data.justify === 'center') {
+          translateX = - width - data.baseLegendParams.padding
+          translateY = - height / 2
+        } else if (data.justify === 'end') {
+          translateX = - width - data.baseLegendParams.padding
+          translateY = - height - data.baseLegendParams.padding
+        }
+      } else if (data.position === 'top') {
+        if (data.justify === 'start') {
+          translateX = data.baseLegendParams.padding
+          translateY = data.baseLegendParams.padding
+        } else if (data.justify === 'center') {
+          translateX = - width / 2
+          translateY = data.baseLegendParams.padding
+        } else if (data.justify === 'end') {
+          translateX = - width - data.baseLegendParams.padding
+          translateY = data.baseLegendParams.padding
+        }
+      } else {
+        if (data.justify === 'start') {
+          translateX = data.baseLegendParams.padding
+          translateY = - height - data.baseLegendParams.padding
+        } else if (data.justify === 'center') {
+          translateX = - width / 2
+          translateY = - height - data.baseLegendParams.padding
+        } else if (data.justify === 'end') {
+          translateX = - width - data.baseLegendParams.padding
+          translateY = - height - data.baseLegendParams.padding
+        }
+      }
+      // translateX += _data.baseLegendParams.offset[0]
+      // translateY += _data.baseLegendParams.offset[1]
+
+      return {
+        width,
+        height,
+        translateX,
+        translateY
+      }
+    })
+  )
+
+  const lengendCardSelection$ = combineLatest({
+    rootPositionSelection: rootPositionSelection$,
+    baseLegendParams: baseLegendParams$,
+    theme: theme$,
+    legendCard: legendCard$
+  }).pipe(
+    takeUntil(destroy$),
+    debounceTime(0),
+    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.baseLegendParams.backgroundFill, data.theme))
+            .attr('stroke', getColor(data.baseLegendParams.backgroundStroke, data.theme))
+        })
+    })
+  )
+
+
+  const lengendListSelection$ = combineLatest({
+    lengendCardSelection: lengendCardSelection$,
+    baseLegendParams: baseLegendParams$,
+    lengendList: lengendList$
+  }).pipe(
+    takeUntil(destroy$),
+    debounceTime(0),
+    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$,
+    baseLegendParams: baseLegendParams$,
+    theme: theme$,
+    lengendItems: lengendItems$,
+    fontSizePx: fontSizePx$
+  }).pipe(
+    takeUntil(destroy$),
+    debounceTime(0),
+    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.fontSizePx / 2
+          const transformRectWidth = - d.listRectWidth / 2
+          const transformRectHeight = - d.listRectHeight / 2
+          // 方塊
+          d3.select(g[i])
+            .selectAll('rect')
+            .data([d])
+            .join('rect')
+            .attr('x', rectCenterX)
+            .attr('y', rectCenterX)
+            .attr('width', _d => _d.listRectWidth)
+            .attr('height', _d => _d.listRectHeight)
+            .attr('transform', _d => `translate(${transformRectWidth}, ${transformRectHeight})`)
+            .attr('fill', _d => _d.color)
+            .attr('rx', _d => _d.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.fontSizePx * 1.5)
+            .attr('font-size', data.theme.fontSize)
+            .attr('fill', d => data.baseLegendParams.textColorType === 'data'
+              ? getSeriesColor(d.seriesIndex, data.theme)
+              : getColor(data.baseLegendParams.textColorType, data.theme))
+            .text(d => d.text)
+        })
+    })
+  )
+
+  itemSelection$.subscribe()
+
+  return () => {
+    rootSelection.select(`g.${rootPositionClassName}`).remove()
+    destroy$.next(undefined)
+  }
+}