@orbcharts/plugins-basic 3.0.2 → 3.0.4

package/src/base/types.ts

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

package/src/const.ts

@@ -1,30 +1,30 @@
-
-// 圖層索引 - 底層（無圖型）
-export const LAYER_INDEX_OF_ROOT = 0
-
-// 圖層索引 - 背景  *預留
-export const LAYER_INDEX_OF_BG = 1
-
-// 圖層索引 - 圖軸
-export const LAYER_INDEX_OF_AXIS = 2
-
-// 圖層索引 - 輔助線、圖軸的輔助資訊
-export const LAYER_INDEX_OF_AUX = 3
-
-// 圖層索引 - 底層圖型
-export const LAYER_INDEX_OF_GRAPHIC_GROUND = 4
-
-// 圖層索引 - 一般圖型
-export const LAYER_INDEX_OF_GRAPHIC = 5
-
-// 圖層索引 - 覆蓋圖型
-export const LAYER_INDEX_OF_GRAPHIC_COVER = 6
-
-// 圖層索引 - 圖型上的標籤文字
-export const LAYER_INDEX_OF_LABEL = 7
-
-// 圖層索引 - 圖例、圖表上的文字
-export const LAYER_INDEX_OF_INFO = 8
-
-// 圖層索引 - Tooltip、事件觸發的覆蓋圖型
-export const LAYER_INDEX_OF_TOOLTIP = 9
+
+// 圖層索引 - 底層（無圖型）
+export const LAYER_INDEX_OF_ROOT = 0
+
+// 圖層索引 - 背景  *預留
+export const LAYER_INDEX_OF_BG = 1
+
+// 圖層索引 - 圖軸
+export const LAYER_INDEX_OF_AXIS = 2
+
+// 圖層索引 - 輔助線、圖軸的輔助資訊
+export const LAYER_INDEX_OF_AUX = 3
+
+// 圖層索引 - 底層圖型
+export const LAYER_INDEX_OF_GRAPHIC_GROUND = 4
+
+// 圖層索引 - 一般圖型
+export const LAYER_INDEX_OF_GRAPHIC = 5
+
+// 圖層索引 - 覆蓋圖型
+export const LAYER_INDEX_OF_GRAPHIC_COVER = 6
+
+// 圖層索引 - 圖型上的標籤文字
+export const LAYER_INDEX_OF_LABEL = 7
+
+// 圖層索引 - 圖例、圖表上的文字
+export const LAYER_INDEX_OF_INFO = 8
+
+// 圖層索引 - Tooltip、事件觸發的覆蓋圖型
+export const LAYER_INDEX_OF_TOOLTIP = 9

package/src/grid/defaults.ts

@@ -1,214 +1,214 @@
-import type {
-  LinesParams,
-  LineAreasParams,
-  GroupAuxParams,
-  DotsParams,
-  BarsParams,
-  StackedBarsParams,
-  BarsTriangleParams,
-  GroupAxisParams,
-  ValueAxisParams,
-  StackedValueAxisParams,
-  GridTooltipParams,
-  GroupZoomParams,
-  GridLegendParams
-} from '../../lib/plugins-basic-types'
-// import { measureTextWidth } from '../utils/commonUtils'
-
-export const DEFAULT_LINES_PARAMS: LinesParams = {
-  lineCurve: 'curveLinear',
-  lineWidth: 2
-}
-
-export const DEFAULT_LINE_AREAS_PARAMS: LineAreasParams = {
-  lineCurve: 'curveLinear',
-  linearGradientOpacity: [1, 0]
-}
-
-export const DEFAULT_DOTS_PARAMS: DotsParams = {
-  radius: 4,
-  fillColorType: 'background',
-  strokeColorType: 'label',
-  strokeWidth: 2,
-  // strokeWidthWhileHighlight: 3,
-  onlyShowHighlighted: false
-}
-
-export const DEFAULT_GROUP_AUX_PARAMS: GroupAuxParams = {
-  showLine: true,
-  showLabel: true,
-  lineDashArray: '3, 3',
-  lineColorType: 'primary',
-  labelColorType: 'primary',
-  labelTextColorType: 'background',
-  labelTextFormat: text => text,
-  labelPadding: 20,
-  labelRotate: 0
-}
-DEFAULT_GROUP_AUX_PARAMS.labelTextFormat.toString = () => `text => text`
-
-export const DEFAULT_BARS_PARAMS: BarsParams = {
-  // barType: 'rect',
-  barWidth: 0,
-  barPadding: 1,
-  barGroupPadding: 40,
-  barRadius: false,
-}
-
-export const DEFAULT_BARS_DIVERGING_PARAMS: BarsParams = {
-  ...DEFAULT_BARS_PARAMS
-}
-
-export const DEFAULT_STACKED_BARS_PARAMS: StackedBarsParams = {
-  barWidth: 0,
-  barGroupPadding: 10,
-  barRadius: false,
-}
-
-export const DEFAULT_BARS_TRIANGLE_PARAMS: BarsTriangleParams = {
-  barWidth: 0,
-  barPadding: 1,
-  barGroupPadding: 20,
-  linearGradientOpacity: [1, 0]
-}
-
-export const DEFAULT_GROUP_AXIS_PARAMS: GroupAxisParams = {
-  // labelAnchor: 'start',
-  labelOffset: [0, 0],
-  labelColorType: 'primary',
-  axisLineVisible: true,
-  axisLineColorType: 'primary',
-  ticks: 'all',
-  tickFormat: text => text,
-  tickLineVisible: true,
-  tickPadding: 20,
-  tickFullLine: false,
-  tickFullLineDasharray: 'none',
-  tickColorType: 'secondary',
-  tickTextRotate: 0,
-  tickTextColorType: 'primary',
-}
-DEFAULT_GROUP_AXIS_PARAMS.tickFormat.toString = () => `text => text`
-
-export const DEFAULT_VALUE_AXIS_PARAMS: ValueAxisParams = {
-  // labelAnchor: 'end',
-  labelOffset: [0, 0],
-  labelColorType: 'primary',
-  axisLineVisible: false,
-  axisLineColorType: 'primary',
-  ticks: null,
-  // tickFormat: ',.0f',
-  // tickFormat: v => v,
-  tickFormat: num => {
-    if (num === null || Number.isNaN(num) == true) {
-      return num || 0
-    }
-    const parts = num.toString().split('.')
-    parts[0] = parts[0].replace(/\B(?=(\d{3})+(?!\d))/g, ',')
-    return parts.join('.')
-  },
-  tickLineVisible: true,
-  tickPadding: 20,
-  tickFullLine: true,
-  tickFullLineDasharray: 'none',
-  tickColorType: 'secondary',
-  tickTextRotate: 0,
-  tickTextColorType: 'primary'
-}
-DEFAULT_VALUE_AXIS_PARAMS.tickFormat.toString = () => `num => {
-  if (num === null || Number.isNaN(num) == true) {
-    return num || 0
-  }
-  const parts = num.toString().split('.')
-  parts[0] = parts[0].replace(/\B(?=(\d{3})+(?!\d))/g, ',')
-  return parts.join('.')
-}`
-
-export const DEFAULT_STACKED_VALUE_AXIS_PARAMS: StackedValueAxisParams = {
-  ...DEFAULT_VALUE_AXIS_PARAMS
-}
-
-export const DEFAULT_GROUP_ZOOM_PARAMS: GroupZoomParams = {
-
-}
-
-export const DEFAULT_GRID_LEGEND_PARAMS: GridLegendParams = {
-  placement: 'bottom',
-  padding: 28,
-  // offset: [0, 0],
-  backgroundFill: 'none',
-  backgroundStroke: 'none',
-  gap: 10,
-  listRectWidth: 14,
-  listRectHeight: 14,
-  listRectRadius: 0,
-  // highlightEvent: false
-  textColorType: 'primary'
-}
-
-export const DEFAULT_GRID_TOOLTIP_PARAMS: GridTooltipParams = {
-  backgroundColorType: 'background',
-  strokeColorType: 'primary',
-  backgroundOpacity: 0.8,
-  textColorType: 'primary',
-  offset: [20, 5],
-  padding: 10,
-  renderFn: (eventData, { styles, utils }) => {
-    const bulletWidth = styles.textSizePx * 0.7
-    const offset = (styles.textSizePx / 2) - (bulletWidth / 2)
-
-    const titleSvg = `<g><text dominant-baseline="hanging" font-size="${styles.textSizePx}" fill="${styles.textColor}">${eventData.groupLabel}</text></g>`
-    const groupLabelTextWidth = utils.measureTextWidth(eventData.groupLabel, styles.textSizePx)
-    const listTextWidth = eventData.group.reduce((acc, group) => {
-      const text = `${group.seriesLabel}${utils.toCurrency(group.value)}`
-      const _maxTextWidth = utils.measureTextWidth(text, styles.textSizePx)
-      return _maxTextWidth > acc ? _maxTextWidth : acc
-    }, 0)
-    const maxTextWidth = Math.max(groupLabelTextWidth, listTextWidth)
-    const lineEndX = maxTextWidth + styles.textSizePx * 3
-    const contentSvg = eventData.group
-      .map((group, i) => {
-        const y = i * styles.textSizePx * 1.5
-        const isHighlight = group.id === (eventData.datum && eventData.datum.id)
-        return `<g transform="translate(0, ${styles.textSizePx * 2})">
-  <rect width="${bulletWidth}" height="${bulletWidth}" x="${offset}" y="${y + offset}" rx="${bulletWidth / 2}" fill="${group.color}"></rect>
-  <text x="${styles.textSizePx * 1.5}" y="${y}" font-size="${styles.textSizePx}" dominant-baseline="hanging" fill="${styles.textColor}">
-    <tspan font-weight="${isHighlight ? 'bold' : ''}">${group.seriesLabel}</tspan>
-    <tspan font-weight="bold" text-anchor="end" x="${lineEndX}">${utils.toCurrency(group.value)}</tspan>
-  </text>
-</g>`
-      })
-      .join('')
-    return `${titleSvg}
-${contentSvg}`
-  }
-}
-DEFAULT_GRID_TOOLTIP_PARAMS.renderFn.toString = () => `(eventData, { styles, utils }) => {
-    const bulletWidth = styles.textSizePx * 0.7
-    const offset = (styles.textSizePx / 2) - (bulletWidth / 2)
-
-    const titleSvg = \`<g><text dominant-baseline="hanging" font-size="\${styles.textSizePx}" fill="\${styles.textColor}">\${eventData.groupLabel}</text></g>\`
-    const groupLabelTextWidth = utils.measureTextWidth(eventData.groupLabel, styles.textSizePx)
-    const listTextWidth = eventData.group.reduce((acc, group) => {
-      const text = \`\${group.seriesLabel}\${utils.toCurrency(group.value)}\`
-      const _maxTextWidth = utils.measureTextWidth(text, styles.textSizePx)
-      return _maxTextWidth > acc ? _maxTextWidth : acc
-    }, 0)
-    const maxTextWidth = Math.max(groupLabelTextWidth, listTextWidth)
-    const lineEndX = maxTextWidth + styles.textSizePx * 3
-    const contentSvg = eventData.group
-      .map((group, i) => {
-        const y = i * styles.textSizePx * 1.5
-        const isHighlight = group.id === (eventData.datum && eventData.datum.id)
-        return \`<g transform="translate(0, \${styles.textSizePx * 2})">
-  <rect width="\${bulletWidth}" height="\${bulletWidth}" x="\${offset}" y="\${y + offset}" rx="\${bulletWidth / 2}" fill="\${group.color}"></rect>
-  <text x="\${styles.textSizePx * 1.5}" y="\${y}" font-size="\${styles.textSizePx}" dominant-baseline="hanging" fill="\${styles.textColor}">
-    <tspan font-weight="\${isHighlight ? 'bold' : ''}">\${group.seriesLabel}</tspan>
-    <tspan font-weight="bold" text-anchor="end" x="\${lineEndX}">\${utils.toCurrency(group.value)}</tspan>
-  </text>
-</g>\`
-      })
-      .join('')
-    return \`\${titleSvg}
-\${contentSvg}\`
+import type {
+  LinesParams,
+  LineAreasParams,
+  GroupAuxParams,
+  DotsParams,
+  BarsParams,
+  StackedBarsParams,
+  BarsTriangleParams,
+  GroupAxisParams,
+  ValueAxisParams,
+  StackedValueAxisParams,
+  GridTooltipParams,
+  GroupZoomParams,
+  GridLegendParams
+} from '../../lib/plugins-basic-types'
+// import { measureTextWidth } from '../utils/commonUtils'
+
+export const DEFAULT_LINES_PARAMS: LinesParams = {
+  lineCurve: 'curveLinear',
+  lineWidth: 2
+}
+
+export const DEFAULT_LINE_AREAS_PARAMS: LineAreasParams = {
+  lineCurve: 'curveLinear',
+  linearGradientOpacity: [1, 0]
+}
+
+export const DEFAULT_DOTS_PARAMS: DotsParams = {
+  radius: 4,
+  fillColorType: 'background',
+  strokeColorType: 'label',
+  strokeWidth: 2,
+  // strokeWidthWhileHighlight: 3,
+  onlyShowHighlighted: false
+}
+
+export const DEFAULT_GROUP_AUX_PARAMS: GroupAuxParams = {
+  showLine: true,
+  showLabel: true,
+  lineDashArray: '3, 3',
+  lineColorType: 'primary',
+  labelColorType: 'primary',
+  labelTextColorType: 'background',
+  labelTextFormat: text => text,
+  labelPadding: 20,
+  labelRotate: 0
+}
+DEFAULT_GROUP_AUX_PARAMS.labelTextFormat.toString = () => `text => text`
+
+export const DEFAULT_BARS_PARAMS: BarsParams = {
+  // barType: 'rect',
+  barWidth: 0,
+  barPadding: 1,
+  barGroupPadding: 40,
+  barRadius: false,
+}
+
+export const DEFAULT_BARS_DIVERGING_PARAMS: BarsParams = {
+  ...DEFAULT_BARS_PARAMS
+}
+
+export const DEFAULT_STACKED_BARS_PARAMS: StackedBarsParams = {
+  barWidth: 0,
+  barGroupPadding: 10,
+  barRadius: false,
+}
+
+export const DEFAULT_BARS_TRIANGLE_PARAMS: BarsTriangleParams = {
+  barWidth: 0,
+  barPadding: 1,
+  barGroupPadding: 20,
+  linearGradientOpacity: [1, 0]
+}
+
+export const DEFAULT_GROUP_AXIS_PARAMS: GroupAxisParams = {
+  // labelAnchor: 'start',
+  labelOffset: [0, 0],
+  labelColorType: 'primary',
+  axisLineVisible: true,
+  axisLineColorType: 'primary',
+  ticks: 'all',
+  tickFormat: text => text,
+  tickLineVisible: true,
+  tickPadding: 20,
+  tickFullLine: false,
+  tickFullLineDasharray: 'none',
+  tickColorType: 'secondary',
+  tickTextRotate: 0,
+  tickTextColorType: 'primary',
+}
+DEFAULT_GROUP_AXIS_PARAMS.tickFormat.toString = () => `text => text`
+
+export const DEFAULT_VALUE_AXIS_PARAMS: ValueAxisParams = {
+  // labelAnchor: 'end',
+  labelOffset: [0, 0],
+  labelColorType: 'primary',
+  axisLineVisible: false,
+  axisLineColorType: 'primary',
+  ticks: null,
+  // tickFormat: ',.0f',
+  // tickFormat: v => v,
+  tickFormat: num => {
+    if (num === null || Number.isNaN(num) == true) {
+      return num || 0
+    }
+    const parts = num.toString().split('.')
+    parts[0] = parts[0].replace(/\B(?=(\d{3})+(?!\d))/g, ',')
+    return parts.join('.')
+  },
+  tickLineVisible: true,
+  tickPadding: 20,
+  tickFullLine: true,
+  tickFullLineDasharray: 'none',
+  tickColorType: 'secondary',
+  tickTextRotate: 0,
+  tickTextColorType: 'primary'
+}
+DEFAULT_VALUE_AXIS_PARAMS.tickFormat.toString = () => `num => {
+  if (num === null || Number.isNaN(num) == true) {
+    return num || 0
+  }
+  const parts = num.toString().split('.')
+  parts[0] = parts[0].replace(/\B(?=(\d{3})+(?!\d))/g, ',')
+  return parts.join('.')
+}`
+
+export const DEFAULT_STACKED_VALUE_AXIS_PARAMS: StackedValueAxisParams = {
+  ...DEFAULT_VALUE_AXIS_PARAMS
+}
+
+export const DEFAULT_GROUP_ZOOM_PARAMS: GroupZoomParams = {
+
+}
+
+export const DEFAULT_GRID_LEGEND_PARAMS: GridLegendParams = {
+  placement: 'bottom',
+  padding: 28,
+  // offset: [0, 0],
+  backgroundFill: 'none',
+  backgroundStroke: 'none',
+  gap: 10,
+  listRectWidth: 14,
+  listRectHeight: 14,
+  listRectRadius: 0,
+  // highlightEvent: false
+  textColorType: 'primary'
+}
+
+export const DEFAULT_GRID_TOOLTIP_PARAMS: GridTooltipParams = {
+  backgroundColorType: 'background',
+  strokeColorType: 'primary',
+  backgroundOpacity: 0.8,
+  textColorType: 'primary',
+  offset: [20, 5],
+  padding: 10,
+  renderFn: (eventData, { styles, utils }) => {
+    const bulletWidth = styles.textSizePx * 0.7
+    const offset = (styles.textSizePx / 2) - (bulletWidth / 2)
+
+    const titleSvg = `<g><text dominant-baseline="hanging" font-size="${styles.textSizePx}" fill="${styles.textColor}">${eventData.groupLabel}</text></g>`
+    const groupLabelTextWidth = utils.measureTextWidth(eventData.groupLabel, styles.textSizePx)
+    const listTextWidth = eventData.group.reduce((acc, group) => {
+      const text = `${group.seriesLabel}${utils.toCurrency(group.value)}`
+      const _maxTextWidth = utils.measureTextWidth(text, styles.textSizePx)
+      return _maxTextWidth > acc ? _maxTextWidth : acc
+    }, 0)
+    const maxTextWidth = Math.max(groupLabelTextWidth, listTextWidth)
+    const lineEndX = maxTextWidth + styles.textSizePx * 3
+    const contentSvg = eventData.group
+      .map((group, i) => {
+        const y = i * styles.textSizePx * 1.5
+        const isHighlight = group.id === (eventData.datum && eventData.datum.id)
+        return `<g transform="translate(0, ${styles.textSizePx * 2})">
+  <rect width="${bulletWidth}" height="${bulletWidth}" x="${offset}" y="${y + offset}" rx="${bulletWidth / 2}" fill="${group.color}"></rect>
+  <text x="${styles.textSizePx * 1.5}" y="${y}" font-size="${styles.textSizePx}" dominant-baseline="hanging" fill="${styles.textColor}">
+    <tspan font-weight="${isHighlight ? 'bold' : ''}">${group.seriesLabel}</tspan>
+    <tspan font-weight="bold" text-anchor="end" x="${lineEndX}">${utils.toCurrency(group.value)}</tspan>
+  </text>
+</g>`
+      })
+      .join('')
+    return `${titleSvg}
+${contentSvg}`
+  }
+}
+DEFAULT_GRID_TOOLTIP_PARAMS.renderFn.toString = () => `(eventData, { styles, utils }) => {
+    const bulletWidth = styles.textSizePx * 0.7
+    const offset = (styles.textSizePx / 2) - (bulletWidth / 2)
+
+    const titleSvg = \`<g><text dominant-baseline="hanging" font-size="\${styles.textSizePx}" fill="\${styles.textColor}">\${eventData.groupLabel}</text></g>\`
+    const groupLabelTextWidth = utils.measureTextWidth(eventData.groupLabel, styles.textSizePx)
+    const listTextWidth = eventData.group.reduce((acc, group) => {
+      const text = \`\${group.seriesLabel}\${utils.toCurrency(group.value)}\`
+      const _maxTextWidth = utils.measureTextWidth(text, styles.textSizePx)
+      return _maxTextWidth > acc ? _maxTextWidth : acc
+    }, 0)
+    const maxTextWidth = Math.max(groupLabelTextWidth, listTextWidth)
+    const lineEndX = maxTextWidth + styles.textSizePx * 3
+    const contentSvg = eventData.group
+      .map((group, i) => {
+        const y = i * styles.textSizePx * 1.5
+        const isHighlight = group.id === (eventData.datum && eventData.datum.id)
+        return \`<g transform="translate(0, \${styles.textSizePx * 2})">
+  <rect width="\${bulletWidth}" height="\${bulletWidth}" x="\${offset}" y="\${y + offset}" rx="\${bulletWidth / 2}" fill="\${group.color}"></rect>
+  <text x="\${styles.textSizePx * 1.5}" y="\${y}" font-size="\${styles.textSizePx}" dominant-baseline="hanging" fill="\${styles.textColor}">
+    <tspan font-weight="\${isHighlight ? 'bold' : ''}">\${group.seriesLabel}</tspan>
+    <tspan font-weight="bold" text-anchor="end" x="\${lineEndX}">\${utils.toCurrency(group.value)}</tspan>
+  </text>
+</g>\`
+      })
+      .join('')
+    return \`\${titleSvg}
+\${contentSvg}\`
 }`