@orbcharts/plugins-basic 3.0.2 → 3.0.3

package/src/multiValue/plugins/OrdinalAux.ts

@@ -0,0 +1,661 @@
+import * as d3 from 'd3'
+import {
+  // of,
+  iif,
+  debounceTime,
+  EMPTY,
+  combineLatest,
+  switchMap,
+  map,
+  filter,
+  first,
+  takeUntil,
+  distinctUntilChanged,
+  shareReplay,
+  Subject,
+  Observable } from 'rxjs'
+import {
+  defineMultiValuePlugin } from '../../../lib/core'
+import type { DefinePluginConfig } from '../../../lib/core-types'
+import type {
+  ColorType,
+  TransformData,
+  DataFormatterMultiValue,
+  ChartParams,
+  Layout,
+} from '../../../lib/core-types'
+import { DEFAULT_ORDINAL_AUX_PARAMS } from '../defaults'
+import { parseTickFormatValue } from '../../utils/d3Utils'
+import { measureTextWidth } from '../../utils/commonUtils'
+import { getColor, getClassName, getUniID } from '../../utils/orbchartsUtils'
+import { d3EventObservable } from '../../utils/observables'
+import { ordinalPositionObservable } from '../multiValueObservables'
+import type { OrdinalAuxParams } from '../../../lib/plugins-basic-types'
+import { multiValueSelectionsObservable } from '../multiValueObservables'
+import { renderTspansOnAxis } from '../../utils/d3Graphics'
+import { LAYER_INDEX_OF_AUX } from '../../const'
+
+interface LineDatum {
+  id: string
+  x1: number
+  x2: number
+  y1: number
+  y2: number
+  dashArray: string
+  colorType: ColorType
+}
+
+interface LabelDatum {
+  id: string
+  text: string
+  textArr: string[]
+  textWidth: number
+  textHeight: number
+  colorType: ColorType
+  textColorType: ColorType
+  x: number
+  y: number
+  rectWidth: number
+  rectHeight: number
+  rectX: number
+  rectY: number
+  textX: number
+  textY: number
+}
+
+interface ValueLabelData {
+  text: string
+  textArr: string[]
+}
+
+const pluginName = 'OrdinalAux'
+const labelClassName = getClassName(pluginName, 'label-box')
+
+const rectPaddingWidth = 6
+const rectPaddingHeight = 3
+
+const pluginConfig: DefinePluginConfig<typeof pluginName, typeof DEFAULT_ORDINAL_AUX_PARAMS> = {
+  name: pluginName,
+  defaultParams: DEFAULT_ORDINAL_AUX_PARAMS,
+  layerIndex: LAYER_INDEX_OF_AUX,
+  validator: (params, { validateColumns }) => {
+    const result = validateColumns(params, {
+      showLine: {
+        toBeTypes: ['boolean']
+      },
+      showLabel: {
+        toBeTypes: ['boolean']
+      },
+      lineDashArray: {
+        toBeTypes: ['string']
+      },
+      lineColorType: {
+        toBeOption: 'ColorType'
+      },
+      labelColorType: {
+        toBeOption: 'ColorType'
+      },
+      labelTextColorType: {
+        toBeOption: 'ColorType'
+      },
+      labelTextFormat: {
+        toBeTypes: ['Function']
+      },
+      labelPadding: {
+        toBeTypes: ['number']
+      },
+    })
+    return result
+  }
+}
+
+function createValueLabelData (groupLabels: string[], tickFormat: (text: any) => string): ValueLabelData[] {
+  return groupLabels.map((_text, i) => {
+    const text = parseTickFormatValue(_text, tickFormat)
+    const textArr = typeof text === 'string' ? text.split('\n') : [text]
+    
+    return {
+      text,
+      textArr
+    }
+  })
+}
+
+function createLineData ({ axisX, layout, fullParams }: {
+  axisX: number
+  // axisY: number
+  layout: Layout
+  fullParams: OrdinalAuxParams
+}): LineDatum[] {
+  if ((axisX >= 0 && axisX <= layout.width) === false) {
+    return []
+  }
+  return [
+    {
+      id: 'line-x',
+      x1: axisX,
+      x2: axisX,
+      y1: 0,
+      y2: layout.height,
+      dashArray: fullParams.lineDashArray ?? 'none',
+      colorType: fullParams.lineColorType
+    },
+  ]
+}
+
+function createLabelData ({ valueLabelData, axisX, xValue, fullParams, textSizePx, layout, rowAmount }: {
+  valueLabelData: ValueLabelData[]
+  axisX: number
+  // axisY: number
+  xValue: number
+  // yValue: number
+  fullParams: OrdinalAuxParams
+  textSizePx: number
+  layout: Layout
+  // columnAmount: number
+  rowAmount: number
+}): LabelDatum[] {
+  if ((axisX >= 0 && axisX <= layout.width) === false) {
+    return []
+  }
+
+
+  // x
+  const xX = axisX
+  const xY = - fullParams.labelPadding * rowAmount // rowAmount 是為了把外部 container 的變形逆轉回來
+  // const xText = fullParams.labelTextFormat(xValue)
+  // const xTextArr = xText.split('\n')
+  const xText = valueLabelData[xValue] ? valueLabelData[xValue].text : ''
+  const xTextArr = valueLabelData[xValue] ? valueLabelData[xValue].textArr : []
+  const xMaxLengthText = xTextArr.reduce((acc, current) => current.length > acc.length ? current : acc, '')
+  const xTextWidth = measureTextWidth(xMaxLengthText, textSizePx)
+  const xTextHeight = textSizePx * xTextArr.length
+  const xRectWidth = xTextWidth + (rectPaddingWidth * 2)
+  const xRectHeight = xTextHeight + (rectPaddingHeight * 2)
+  const xRectX = - xRectWidth / 2
+  const xRectY = - rectPaddingHeight
+  const xTextX = xRectX + rectPaddingWidth
+  const xTextY = xRectY + rectPaddingHeight
+  return [
+    {
+      id: 'label-x',
+      x: xX,
+      y: xY - xRectHeight / 2,
+      text: xText,
+      textArr: xTextArr,
+      textWidth: xTextWidth,
+      textHeight: xTextHeight,
+      colorType: fullParams.labelColorType,
+      textColorType: fullParams.labelTextColorType,
+      rectWidth: xRectWidth,
+      rectHeight: xRectHeight,
+      rectX: xRectX,
+      rectY: xRectY,
+      textX: xTextX,
+      textY: xTextY
+    },
+  ]
+}
+
+function renderLine ({ selection, pluginName, lineData, fullParams, fullChartParams }: {
+  selection: d3.Selection<any, string, any, unknown>
+  pluginName: string
+  lineData: LineDatum[]
+  fullParams: OrdinalAuxParams
+  fullChartParams: ChartParams
+}) {
+  const gClassName = getClassName(pluginName, 'auxline')
+  const auxLineSelection = selection
+    .selectAll<SVGLineElement, LineDatum>(`line.${gClassName}`)
+    .data(lineData)
+    .join(
+      enter => {
+        return enter
+          .append('line')
+          .classed(gClassName, true)
+          .style('stroke-width', 1)
+          .style('pointer-events', 'none')
+          .style('vector-effect', 'non-scaling-stroke')
+          .attr('x1', d => d.x1)
+          .attr('y1', d => d.y1)
+          .attr('x2', d => d.x2)
+          .attr('y2', d => d.y2)
+      },
+      update => {
+        const updateSelection = update
+          .transition()
+          .duration(50)
+          .attr('x1', d => d.x1)
+          .attr('y1', d => d.y1)
+          .attr('x2', d => d.x2)
+          .attr('y2', d => d.y2)
+        return updateSelection
+      },
+      exit => exit.remove()
+    )
+    .style('stroke', d => getColor(d.colorType, fullChartParams))
+    .style('stroke-dasharray', d => d.dashArray)
+
+  return auxLineSelection
+}
+
+function removeLine (selection: d3.Selection<any, string, any, unknown>) {
+  const update = selection
+    .selectAll<SVGLineElement, LineDatum>('line')
+    .data([])
+
+  update.exit().remove()
+}
+
+function renderLabel ({ selection, labelData, fullParams, fullDataFormatter, fullChartParams, textReverseTransform, textSizePx }: {
+  selection: d3.Selection<any, string, any, unknown>
+  labelData: LabelDatum[]
+  fullParams: OrdinalAuxParams
+  fullDataFormatter: DataFormatterMultiValue
+  fullChartParams: ChartParams
+  // gridAxesReverseTransformValue: string
+  textReverseTransform: string
+  textSizePx: number
+}) {
+  // const rectHeight = textSizePx + 6
+
+  const axisLabelSelection = selection
+    .selectAll<SVGGElement, LabelDatum>(`g.${labelClassName}`)
+    .data(labelData)
+    .join(
+      enter => {
+        return enter
+          .append('g')
+          .classed(labelClassName, true)
+          .style('cursor', 'pointer')
+          .attr("transform", (d, i) => {
+            return `translate(${d.x}, ${d.y})`
+          })
+      },
+      update => {
+        const updateSelection = update
+          .transition()
+          .duration(50)
+          .attr("transform", (d, i) => {
+            return `translate(${d.x}, ${d.y})`
+          })
+        return updateSelection
+      },
+      exit => exit.remove()
+    )
+    .each((datum, i, n) => {
+      const gSelection = d3.select(n[i])
+
+      // -- rect --
+      const rect = gSelection
+        .selectAll<SVGRectElement, LabelDatum>('rect')
+        .data([datum])
+        .join(
+          enter => enter.append('rect')
+            .style('cursor', 'pointer')
+            .attr('rx', 5)
+            .attr('ry', 5),
+          update => update,
+          exit => exit.remove()
+        )
+        .attr('width', d => `${d.rectWidth}px`)
+        .attr('height', d => `${d.rectHeight}px`)
+        .attr('fill', d => getColor(d.colorType, fullChartParams))
+        .attr('x', d => d.rectX)
+        .attr('y', d => d.rectY)
+        .style('transform', textReverseTransform)
+
+      // -- text --
+      const text = gSelection
+        .selectAll<SVGTextElement, LabelDatum>('text')
+        .data([datum])
+        .join(
+          enter => enter.append('text')
+            .style('dominant-baseline', 'hanging')
+            .style('cursor', 'pointer')
+            .style('pointer-events', 'none'),
+          update => update,
+          exit => exit.remove()
+        )
+        .style('transform', textReverseTransform)
+        .attr('fill', d => getColor(d.textColorType, fullChartParams))
+        .attr('font-size', fullChartParams.styles.textSize)
+        .attr('x', d => d.textX)
+        .attr('y', d => d.textY)
+        .each((d, i, n) => {
+          renderTspansOnAxis(d3.select(n[i]), {
+            textArr: datum.textArr,
+            textSizePx,
+            groupAxisPosition: i === 0
+              ? 'bottom' // x axis
+              : 'left', // y axis
+            isContainerRotated: false
+          })
+        })
+      
+      // -- 第二次文字寬度（因為原本計算的文字寬度有可能因為字體差異會有誤差） --
+      // 取得文字寬度
+      let textWidthArr: number[] = []
+      text.selectAll('tspan')
+        .each((d, i, n) => {
+          const tspan = d3.select(n[i])
+          const textNode: SVGTextElement = tspan.node() as SVGTextElement
+          if (textNode && textNode.getBBox()) {
+            textWidthArr.push(textNode.getBBox().width)
+          }
+        })
+      const maxTextWidth = Math.max(...textWidthArr)
+      // 依文字寬度設定矩形寬度
+      rect.attr('width', maxTextWidth + rectPaddingWidth * 2)
+
+    })
+
+  return axisLabelSelection
+}
+
+function removeLabel (selection: d3.Selection<any, string, any, unknown>) {
+  const gUpdate = selection
+    .selectAll<SVGGElement, LabelDatum>(`g.${labelClassName}`)
+    .data([])
+
+  gUpdate.exit().remove()
+}
+
+
+export const OrdinalAux = defineMultiValuePlugin(pluginConfig)(({ selection, rootSelection, name, subject, observer }) => {
+  const destroy$ = new Subject()
+
+  let isLabelMouseover: boolean = false
+
+  const rootRectSelection: d3.Selection<SVGRectElement, any, any, any> = rootSelection
+    .insert('rect', 'g')
+    .classed(getClassName(pluginName, 'rect'), true)
+    .attr('opacity', 0)
+
+  // const axisSelection: d3.Selection<SVGGElement, any, any, any> = selection
+  //   .append('g')
+
+  const { 
+    categorySelection$,
+    axesSelection$,
+    defsSelection$,
+    graphicGSelection$
+  } = multiValueSelectionsObservable({
+    selection,
+    pluginName,
+    clipPathID: 'test',
+    categoryLabels$: observer.isCategorySeprate$.pipe(
+      switchMap(isCategorySeprate => {
+        return iif(
+          () => isCategorySeprate,
+          observer.categoryLabels$,
+          // 如果沒分開的話只取一筆
+          observer.categoryLabels$.pipe(
+            map(d => [d[0]])
+          )
+        )
+      })
+    ),
+    containerPosition$: observer.containerPosition$,
+    graphicTransform$: observer.graphicTransform$
+  })
+
+  observer.layout$.pipe(
+    takeUntil(destroy$),
+  ).subscribe(d => {
+    rootRectSelection
+      .attr('width', d.rootWidth)
+      .attr('height', d.rootHeight)
+  })
+
+  const highlightTarget$ = observer.fullChartParams$.pipe(
+    takeUntil(destroy$),
+    map(d => d.highlightTarget),
+    distinctUntilChanged()
+  )
+
+  // const rootMousemove$: Observable<any> = d3EventObservable(rootSelection, 'mousemove')
+  //   .pipe(
+  //     takeUntil(destroy$),
+  //     debounceTime(10)
+  //   )
+
+  // let r = 0
+  // rootMousemove$.subscribe(d => {
+  //   r++
+  //   console.log('r:', r)
+  // })
+
+  const columnAmount$ = observer.containerPosition$.pipe(
+    map(containerPosition => {
+      const maxColumnIndex = containerPosition.reduce((acc, current) => {
+        return current.columnIndex > acc ? current.columnIndex : acc
+      }, 0)
+      return maxColumnIndex + 1
+    }),
+    distinctUntilChanged()
+  )
+
+  const rowAmount$ = observer.containerPosition$.pipe(
+    map(containerPosition => {
+      const maxRowIndex = containerPosition.reduce((acc, current) => {
+        return current.rowIndex > acc ? current.rowIndex : acc
+      }, 0)
+      return maxRowIndex + 1
+    }),
+    distinctUntilChanged()
+  )
+
+  const textReverseTransform$ = observer.containerPosition$.pipe(
+    takeUntil(destroy$),
+    switchMap(async (d) => d),
+    map(containerPosition => {
+      // const axesRotateXYReverseValue = `rotateX(${data.gridAxesReverseTransform.rotateX}deg) rotateY(${data.gridAxesReverseTransform.rotateY}deg)`
+      // const axesRotateReverseValue = `rotate(${data.gridAxesReverseTransform.rotate}deg)`
+      const containerScaleReverseValue = `scale(${1 / containerPosition[0].scale[0]}, ${1 / containerPosition[0].scale[1]})`
+      // 抵消最外層scale
+      return `${containerScaleReverseValue}`
+    }),
+    distinctUntilChanged()
+  )
+
+  // const ordinalPosition$ = multiValueXYPositionObservable({
+  //   rootSelection,
+  //   fullDataFormatter$: observer.fullDataFormatter$,
+  //   filteredXYMinMaxData$: observer.filteredXYMinMaxData$,
+  //   containerPosition$: observer.containerPosition$,
+  //   layout$: observer.layout$
+  // }).pipe(
+  //   takeUntil(destroy$)
+  // )
+
+  const ordinalPosition$ = ordinalPositionObservable({
+    rootSelection,
+    ordinalScaleDomain$: observer.ordinalScaleDomain$,
+    ordinalScale$: observer.ordinalScale$,
+    ordinalPadding$: observer.ordinalPadding$,
+    containerSize$: observer.containerSize$,
+    containerPosition$: observer.containerPosition$,
+    layout$: observer.layout$,
+  })
+
+  const valueLabelData$ = combineLatest({
+    valueLabels: observer.valueLabels$,
+    fullParams: observer.fullParams$,
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async (d) => d),
+    map(data => {
+      return createValueLabelData(data.valueLabels, data.fullParams.labelTextFormat)
+    }),
+    shareReplay(1)
+  )
+
+  combineLatest({
+    axesSelection: axesSelection$,
+    // rootMousemove: rootMousemove$,
+    layout: observer.layout$,
+    ordinalPosition: ordinalPosition$,
+    computedData: observer.computedData$,
+    fullParams: observer.fullParams$,
+    fullDataFormatter: observer.fullDataFormatter$,
+    fullChartParams: observer.fullChartParams$,
+    highlightTarget: highlightTarget$,
+    textReverseTransform: textReverseTransform$,
+    // CategoryDataMap: observer.CategoryDataMap$,
+    textSizePx: observer.textSizePx$,
+    columnAmount: columnAmount$,
+    rowAmount: rowAmount$,
+    valueLabelData: valueLabelData$,
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d),
+  ).subscribe(data => {
+    // 依event的座標取得group資料
+    const { x, xValue } = data.ordinalPosition
+    // console.log({ x, xValue })
+
+    const lineData = createLineData({
+      axisX: x,
+      // axisY: y,
+      layout: data.layout,
+      fullParams: data.fullParams,
+    })
+    renderLine({
+      selection: data.axesSelection,
+      pluginName: name,
+      lineData,
+      fullParams: data.fullParams,
+      fullChartParams: data.fullChartParams
+    })
+    const labelData = createLabelData({
+      valueLabelData: data.valueLabelData,
+      axisX: x,
+      // axisY: y,
+      xValue,
+      // yValue,
+      fullParams: data.fullParams,
+      textSizePx: data.textSizePx,
+      layout: data.layout,
+      // columnAmount: data.columnAmount,
+      rowAmount: data.rowAmount
+    })
+    const labelSelection = renderLabel({
+      selection: data.axesSelection,
+      labelData,
+      fullParams: data.fullParams,
+      fullDataFormatter: data.fullDataFormatter,
+      fullChartParams: data.fullChartParams,
+      textReverseTransform: data.textReverseTransform,
+      textSizePx: data.textSizePx
+    })
+
+    // label的事件
+    labelSelection
+      .on('mouseover', (event, datum) => {
+        event.stopPropagation()
+        // const { groupIndex, groupLabel } = data.ordinalPositionFn(event)
+
+        isLabelMouseover = true
+
+        subject.event$.next({
+          type: 'multiValue',
+          eventName: 'mouseover',
+          pluginName,
+          highlightTarget: data.highlightTarget,
+          valueDetail: [],
+          datum: null,
+          category: [],
+          categoryIndex: -1,
+          categoryLabel: '',
+          data: data.computedData,
+          event,
+        })
+      })
+      .on('mousemove', (event, datum) => {
+        event.stopPropagation()
+        // const { groupIndex, groupLabel } = data.ordinalPositionFn(event)
+
+        subject.event$.next({
+          type: 'multiValue',
+          eventName: 'mousemove',
+          pluginName,
+          highlightTarget: data.highlightTarget,
+          valueDetail: [],
+          datum: null,
+          category: [],
+          categoryIndex: -1,
+          categoryLabel: '',
+          data: data.computedData,
+          event,
+        })
+      })
+      .on('mouseout', (event, datum) => {
+        event.stopPropagation()
+        // const { groupIndex, groupLabel } = data.ordinalPositionFn(event)
+
+        isLabelMouseover = false
+
+        subject.event$.next({
+          type: 'multiValue',
+          eventName: 'mouseout',
+          pluginName,
+          highlightTarget: data.highlightTarget,
+          valueDetail: [],
+          datum: null,
+          category: [],
+          categoryIndex: -1,
+          categoryLabel: '',
+          data: data.computedData,
+          event,
+        })
+      })
+      .on('click', (event, datum) => {
+        event.stopPropagation()
+        // const { groupIndex, groupLabel } = data.ordinalPositionFn(event)
+
+        subject.event$.next({
+          type: 'multiValue',
+          eventName: 'click',
+          pluginName,
+          highlightTarget: data.highlightTarget,
+          valueDetail: [],
+          datum: null,
+          category: [],
+          categoryIndex: -1,
+          categoryLabel: '',
+          data: data.computedData,
+          event,
+        })
+      })
+
+  })
+
+
+  const rootRectMouseout$ = d3EventObservable(rootRectSelection, 'mouseout').pipe(
+    takeUntil(destroy$),
+  )
+
+  combineLatest({
+    rootRectMouseout: rootRectMouseout$,
+    axesSelection: axesSelection$,
+  }).pipe(
+    takeUntil(destroy$),
+    switchMap(async d => d)
+  ).subscribe(data => {
+    setTimeout(() => {
+      // @Q@ workaround - 不知為何和 label 會有衝突，當滑鼠移動到 label 上時，會觸發 mouseout 事件
+      if (isLabelMouseover == true) {
+        return
+      }
+      
+      removeLine(data.axesSelection)
+      removeLabel(data.axesSelection)
+    })
+  })
+
+  return () => {
+    destroy$.next(undefined)
+    rootRectSelection.remove()
+  }
+})