@orbcharts/core 3.0.0-alpha.61 → 3.0.0-alpha.62

package/src/utils/commonUtils.ts

@@ -1,50 +1,54 @@
-// import * as d3 from 'd3'
-
-// 是否為原始物件
-export function isPlainObject(variable: any) {
-  return Object.prototype.toString.call(variable) === "[object Object]";
-}
-
-// 是否為function
-export function isFunction(fn: any) {
-  return !!fn && !fn.nodename && fn.constructor != String && fn.constructor != RegExp && fn.constructor != Array && /function/i.test(fn + "");
-}
-
-// 將可選的參數和預設值合併
-export function mergeOptionsWithDefault<Options extends { [key: string]: any; }> (options: {[key: string]: any}, defaultOptions: Options): Options {
-  if (isPlainObject(options) === false || isPlainObject(defaultOptions) === false) {
-    return Object.assign({}, defaultOptions)
-  }
-  const mergeObjColumns = (_options: {[key: string]: any}, _defaultOptions: {[key: string]: any}) => {
-    const obj: Options = (Object.assign({}, _defaultOptions) as any)
-    for (let key of Object.keys(_options)) {
-      if ((key in _defaultOptions) == false) {
-        continue
-      }
-      let objValue: any = undefined
-      // 下一層的plain object
-      if (isPlainObject(_options[key]) && isPlainObject(_defaultOptions[key])) {
-        objValue = mergeObjColumns(_options[key], _defaultOptions[key])
-        obj[key as keyof Options] = objValue
-      }
-      // 不是plain object直接賦值
-      else {
-        obj[key as keyof Options] = _options[key]
-      }
-    }
-    return obj
-  }
-  
-  return mergeObjColumns(options, defaultOptions)
-}
-
-// 加上千分位 ,
-export function formatCommaNumber (num = 0): string {
-  try {
-    let parts = num.toString().split('.');
-    parts[0] = parts[0].replace(/\B(?=(\d{3})+(?!\d))/g, ',');
-    return parts.join('.');
-  } catch (e: any) {
-    console.error(e)
-  }
-}
+
+// 是否為原始物件
+export function isPlainObject(variable: any) {
+  return Object.prototype.toString.call(variable) === "[object Object]";
+}
+
+// 是否為function
+export function isFunction(fn: any) {
+  return !!fn && !fn.nodename && fn.constructor != String && fn.constructor != RegExp && fn.constructor != Array && /function/i.test(fn + "");
+}
+
+// 是否為dom
+export function isDom(obj: any) {
+  return !!(obj && obj.nodeType);
+}
+
+// 將可選的參數和預設值合併
+export function mergeOptionsWithDefault<Options extends { [key: string]: any; }> (options: {[key: string]: any}, defaultOptions: Options): Options {
+  if (isPlainObject(options) === false || isPlainObject(defaultOptions) === false) {
+    return Object.assign({}, defaultOptions)
+  }
+  const mergeObjColumns = (_options: {[key: string]: any}, _defaultOptions: {[key: string]: any}) => {
+    const obj: Options = (Object.assign({}, _defaultOptions) as any)
+    for (let key of Object.keys(_options)) {
+      if ((key in _defaultOptions) == false) {
+        continue
+      }
+      let objValue: any = undefined
+      // 下一層的plain object
+      if (isPlainObject(_options[key]) && isPlainObject(_defaultOptions[key])) {
+        objValue = mergeObjColumns(_options[key], _defaultOptions[key])
+        obj[key as keyof Options] = objValue
+      }
+      // 不是plain object直接賦值
+      else {
+        obj[key as keyof Options] = _options[key]
+      }
+    }
+    return obj
+  }
+  
+  return mergeObjColumns(options, defaultOptions)
+}
+
+// 加上千分位 ,
+export function formatCommaNumber (num = 0): string {
+  try {
+    let parts = num.toString().split('.');
+    parts[0] = parts[0].replace(/\B(?=(\d{3})+(?!\d))/g, ',');
+    return parts.join('.');
+  } catch (e: any) {
+    console.error(e)
+  }
+}

package/src/utils/d3Utils.ts

@@ -1,108 +1,108 @@
-import * as d3 from 'd3'
-import { DATA_FORMATTER_VALUE_AXIS_DEFAULT } from '../defaults'
-
-// scaleLinear - 連續資料對應到比例尺座標上
-export const createAxisLinearScale = ({
-  maxValue = 1,
-  minValue = 0,
-  axisWidth,
-  scaleDomain = DATA_FORMATTER_VALUE_AXIS_DEFAULT.scaleDomain,
-  scaleRange = DATA_FORMATTER_VALUE_AXIS_DEFAULT.scaleRange,
-}: {
-  maxValue: number
-  minValue: number
-  axisWidth: number
-  scaleDomain: [number | 'min' | 'auto', number | 'max' | 'auto']
-  scaleRange: [number, number] // 0-1
-}) => {
-  // -- 無值補上預設值 --
-  const domainMin: number | 'min' | 'auto' = scaleDomain[0] ?? DATA_FORMATTER_VALUE_AXIS_DEFAULT.scaleDomain[0]
-  const domainMax: number | 'max' | 'auto' = scaleDomain[1] ?? DATA_FORMATTER_VALUE_AXIS_DEFAULT.scaleDomain[1]
-  const rangeMin: number = scaleRange[0] ?? DATA_FORMATTER_VALUE_AXIS_DEFAULT.scaleRange[0]
-  const rangeMax: number = scaleRange[1] ?? DATA_FORMATTER_VALUE_AXIS_DEFAULT.scaleRange[1]
-
-  // -- 'auto' | 'max' | 'min' 替換成實際值 --
-  let domainMinValue: number = (() => {
-    if (domainMin === 'auto') {
-      return minValue < 0 ? minValue : 0
-    } else if (domainMin === 'min') {
-      return minValue
-    } else {
-      return domainMin
-    }
-  })()
-  
-  let domainMaxValue: number = (() => {
-    if (domainMax === 'auto') {
-      return maxValue >= 0 ? maxValue : 0
-    } else if (domainMax === 'max') {
-      return maxValue
-    } else {
-      return domainMax
-    }
-  })()
-  // let rangeMinValue = axisWidth * rangeMin
-  // let rangeMaxValue = axisWidth * rangeMax
-
-  // -- 計算padding --
-  // if (padding > 0) {
-  //   const stepAmount = maxValue - minValue + (padding * 2)
-  //   const eachStepWidth = axisWidth / stepAmount
-  //   const paddingWidth = eachStepWidth * padding
-  //   rangeMinValue += paddingWidth
-  //   rangeMaxValue -= paddingWidth
-  // }
-
-  // -- 依場景大小換算 --
-  const axisDomainMinValue = maxValue - (maxValue - domainMinValue) / (1 - rangeMin)
-  const axisDomainMaxValue = domainMaxValue / rangeMax
-  
-  // return d3.scaleLinear()
-  //   .domain([domainMinValue, domainMaxValue])
-  //   .range([rangeMinValue, rangeMaxValue])
-  return d3.scaleLinear()
-    .domain([axisDomainMinValue, axisDomainMaxValue])
-    .range([0, axisWidth])
-}
-
-// scalePoint - 非連續資料對應到比例尺座標上
-export const createAxisPointScale = ({ axisLabels, axisWidth, padding = 0.5 }: {
-  axisLabels: string[]
-  axisWidth: number
-  padding?: number
-  // reverse?: boolean  
-}) => {
-  let range: [d3.NumberValue, d3.NumberValue] = [0, axisWidth]
-
-  return d3.scalePoint()
-      .domain(axisLabels)
-      .range(range)
-      .padding(padding)
-}
-
-// scaleQuantize - 比例尺座標對應非連續資料索引
-export const createAxisQuantizeScale = ({ axisLabels, axisWidth, padding = 0, reverse = false }:{
-  axisLabels: string[] | Date[],
-  axisWidth: number
-  padding?: number
-  reverse?: boolean
-}) => {
-
-  let range: number[] = axisLabels.map((d: string | Date, i: number) => i)
-  if (reverse) {
-    range.reverse()
-  }
-  // if (reverse) {
-  //   range = axisLabels.map((d: string | Date, i: number) => axisLabels.length - 1 - i)
-  // } else {
-  //   range = axisLabels.map((d: string | Date, i: number) => i)
-  // }
-  const step = range.length - 1 + (padding * 2) // 圖軸刻度分段數量
-  const stepWidth = axisWidth / step
-  const rangePadding = stepWidth * padding - (stepWidth * 0.5) // 實際要計算的範圍是圖軸左右那邊增加0.5
-
-  // console.log('rangePadding', rangePadding)
-  return d3.scaleQuantize<number>()
-    .domain([rangePadding, axisWidth - rangePadding])
-    .range(range)
-}
+import * as d3 from 'd3'
+import { DATA_FORMATTER_VALUE_AXIS_DEFAULT } from '../defaults'
+
+// scaleLinear - 連續資料對應到比例尺座標上
+export const createAxisLinearScale = ({
+  maxValue = 1,
+  minValue = 0,
+  axisWidth,
+  scaleDomain = DATA_FORMATTER_VALUE_AXIS_DEFAULT.scaleDomain,
+  scaleRange = DATA_FORMATTER_VALUE_AXIS_DEFAULT.scaleRange,
+}: {
+  maxValue: number
+  minValue: number
+  axisWidth: number
+  scaleDomain: [number | 'min' | 'auto', number | 'max' | 'auto']
+  scaleRange: [number, number] // 0-1
+}) => {
+  // -- 無值補上預設值 --
+  const domainMin: number | 'min' | 'auto' = scaleDomain[0] ?? DATA_FORMATTER_VALUE_AXIS_DEFAULT.scaleDomain[0]
+  const domainMax: number | 'max' | 'auto' = scaleDomain[1] ?? DATA_FORMATTER_VALUE_AXIS_DEFAULT.scaleDomain[1]
+  const rangeMin: number = scaleRange[0] ?? DATA_FORMATTER_VALUE_AXIS_DEFAULT.scaleRange[0]
+  const rangeMax: number = scaleRange[1] ?? DATA_FORMATTER_VALUE_AXIS_DEFAULT.scaleRange[1]
+
+  // -- 'auto' | 'max' | 'min' 替換成實際值 --
+  let domainMinValue: number = (() => {
+    if (domainMin === 'auto') {
+      return minValue < 0 ? minValue : 0
+    } else if (domainMin === 'min') {
+      return minValue
+    } else {
+      return domainMin
+    }
+  })()
+  
+  let domainMaxValue: number = (() => {
+    if (domainMax === 'auto') {
+      return maxValue >= 0 ? maxValue : 0
+    } else if (domainMax === 'max') {
+      return maxValue
+    } else {
+      return domainMax
+    }
+  })()
+  // let rangeMinValue = axisWidth * rangeMin
+  // let rangeMaxValue = axisWidth * rangeMax
+
+  // -- 計算padding --
+  // if (padding > 0) {
+  //   const stepAmount = maxValue - minValue + (padding * 2)
+  //   const eachStepWidth = axisWidth / stepAmount
+  //   const paddingWidth = eachStepWidth * padding
+  //   rangeMinValue += paddingWidth
+  //   rangeMaxValue -= paddingWidth
+  // }
+
+  // -- 依場景大小換算 --
+  const axisDomainMinValue = maxValue - (maxValue - domainMinValue) / (1 - rangeMin)
+  const axisDomainMaxValue = domainMaxValue / rangeMax
+  
+  // return d3.scaleLinear()
+  //   .domain([domainMinValue, domainMaxValue])
+  //   .range([rangeMinValue, rangeMaxValue])
+  return d3.scaleLinear()
+    .domain([axisDomainMinValue, axisDomainMaxValue])
+    .range([0, axisWidth])
+}
+
+// scalePoint - 非連續資料對應到比例尺座標上
+export const createAxisPointScale = ({ axisLabels, axisWidth, padding = 0.5 }: {
+  axisLabels: string[]
+  axisWidth: number
+  padding?: number
+  // reverse?: boolean  
+}) => {
+  let range: [d3.NumberValue, d3.NumberValue] = [0, axisWidth]
+
+  return d3.scalePoint()
+      .domain(axisLabels)
+      .range(range)
+      .padding(padding)
+}
+
+// scaleQuantize - 比例尺座標對應非連續資料索引
+export const createAxisQuantizeScale = ({ axisLabels, axisWidth, padding = 0, reverse = false }:{
+  axisLabels: string[] | Date[],
+  axisWidth: number
+  padding?: number
+  reverse?: boolean
+}) => {
+
+  let range: number[] = axisLabels.map((d: string | Date, i: number) => i)
+  if (reverse) {
+    range.reverse()
+  }
+  // if (reverse) {
+  //   range = axisLabels.map((d: string | Date, i: number) => axisLabels.length - 1 - i)
+  // } else {
+  //   range = axisLabels.map((d: string | Date, i: number) => i)
+  // }
+  const step = range.length - 1 + (padding * 2) // 圖軸刻度分段數量
+  const stepWidth = axisWidth / step
+  const rangePadding = stepWidth * padding - (stepWidth * 0.5) // 實際要計算的範圍是圖軸左右那邊增加0.5
+
+  // console.log('rangePadding', rangePadding)
+  return d3.scaleQuantize<number>()
+    .domain([rangePadding, axisWidth - rangePadding])
+    .range(range)
+}

package/src/utils/errorMessage.ts

@@ -0,0 +1,43 @@
+
+// export function createMessagePrefix (status: 'warning' | 'error'): string {
+//   return `[OrbCharts ${status}]:`
+// }
+
+export function createOrbChartsErrorMessage (e: {
+  message: string // e.message
+  stack: string // e.stack
+}): string {
+  return `[OrbCharts warn]: ${e.message}`
+}
+
+
+// // 未預期的錯誤
+// export function createUnexpectedErrorMessage ({ from, systemMessage }: {
+//   from: string // 
+//   systemMessage: string // catch 給的的原生錯誤訊息
+// }): string {
+//   return `${createMessagePrefix('error')} unexpected error from '${from}':
+// ${systemMessage}`
+// }
+
+// validator 的 error 訊息
+export function createValidatorErrorMessage ({ columnName, expectToBe, from }: {
+  columnName: string // e.g. 'seriesLabels'
+  expectToBe: string // e.g. 'string[]'
+  from: string // e.g. Chart.chartParams$, Pie.params$
+}): string {
+  return `Invalid value: '${columnName}' must be '${expectToBe}'
+
+----> find in '${from}'`
+}
+
+// validator 的 warning 訊息
+export function createValidatorWarningMessage ({ columnName, expectToBe, from }: {
+  columnName: string // e.g. 'seriesLabels'
+  expectToBe: string // e.g. 'string[]'
+  from: string // e.g. Chart.chartParams$, Pie.params$
+}): string {
+  return `Value is not correct: '${columnName}' suppose to be '${expectToBe}', it may cause unexpected errors.'
+  
+----> find in '${from}'`
+}