@orbcharts/core 4.0.0-alpha.0 → 4.0.0-beta.0

package/src/types/Chart.ts

@@ -1,62 +1,62 @@
-import type {
-  DeepPartial,
-  ChartContext,
-  Encoding,
-  PluginEntity,
-  RawData,
-  Theme
-} from './index'
-
-export interface SizeConfig {
-  width: number | 'auto'
-  height: number | 'auto'
-  resizeDebounce: number
-}
-
-// export interface ChartDefaults {
-//   theme: Theme
-//   encoding: Encoding
-// }
-
-export interface ChartOptions {
-  size: SizeConfig
-  // defaults: ChartDefaults
-  theme: Theme
-  data: RawData
-  encoding: Encoding
-  plugins: PluginEntity<any, any, any>[]
-}
-
-export interface PartialChartOptions {
-  size?: Partial<SizeConfig>
-  theme?: DeepPartial<Theme>
-  data?: RawData
-  encoding?: DeepPartial<Encoding>
-  plugins?: PluginEntity<any, any, any>[]
-}
-
-export interface CreateChart {
-  (element: HTMLElement | Element, options?: PartialChartOptions): ChartEntity
-}
-
-export interface ChartEntity {
-  // Commands
-  resize(sizeConfig: SizeConfig): void
-  setData(data: RawData): void // replace
-  // setEncoding(partial: Partial<Encoding>): void // deep-merge with default
-  updateEncoding(patch: DeepPartial<Encoding>): void // deep-merge with previous
-  forceReplaceEncoding(full: Encoding): void // replace
-  getEncoding(): Readonly<Encoding>
-  setPlugins(plugins: PluginEntity<any, any, any>[]): void // replace all
-  addPlugin(plugin: PluginEntity<any, any, any>): void
-  removePlugin(id: string): void
-  // setTheme(theme: Theme): void // replace all
-  updateTheme(patch: DeepPartial<Theme>): void // deep-merge with previous
-  forceReplaceTheme(full: Theme): void // replace all
-  getTheme(): Readonly<Theme>
-  destroy(): void;
-
-  // context
-  context: ChartContext<{}>
-}
-
+import type {
+  DeepPartial,
+  ChartContext,
+  Encoding,
+  PluginEntity,
+  RawData,
+  Theme
+} from './index'
+
+export interface SizeConfig {
+  width: number | 'auto'
+  height: number | 'auto'
+  resizeDebounce: number
+}
+
+// export interface ChartDefaults {
+//   theme: Theme
+//   encoding: Encoding
+// }
+
+export interface ChartOptions {
+  size: SizeConfig
+  // defaults: ChartDefaults
+  theme: Theme
+  data: RawData
+  encoding: Encoding
+  plugins: PluginEntity<any, any, any>[]
+}
+
+export interface PartialChartOptions {
+  size?: Partial<SizeConfig>
+  theme?: DeepPartial<Theme>
+  data?: RawData
+  encoding?: DeepPartial<Encoding>
+  plugins?: PluginEntity<any, any, any>[]
+}
+
+export interface CreateChart {
+  (element: HTMLElement | Element, options?: PartialChartOptions): ChartEntity
+}
+
+export interface ChartEntity {
+  // Commands
+  resize(sizeConfig: SizeConfig): void
+  setData(data: RawData): void // replace
+  // setEncoding(partial: Partial<Encoding>): void // deep-merge with default
+  updateEncoding(patch: DeepPartial<Encoding>): void // deep-merge with previous
+  forceReplaceEncoding(full: Encoding): void // replace
+  getEncoding(): Readonly<Encoding>
+  setPlugins(plugins: PluginEntity<any, any, any>[]): void // replace all
+  addPlugin(plugin: PluginEntity<any, any, any>): void
+  removePlugin(id: string): void
+  // setTheme(theme: Theme): void // replace all
+  updateTheme(patch: DeepPartial<Theme>): void // deep-merge with previous
+  forceReplaceTheme(full: Theme): void // replace all
+  getTheme(): Readonly<Theme>
+  destroy(): void;
+
+  // context
+  context: ChartContext<{}>
+}
+

package/src/types/ChartContext.ts

@@ -1,42 +1,42 @@
-import type { Observable, Subject } from 'rxjs'
-import type {
-  RawData,
-  Encoding,
-  ModelData,
-  PluginInfo,
-  Theme,
-  EventData,
-  LayerInfo,
-} from './index'
-
-export interface Size {
-  width: number
-  height: number
-}
-
-// 定義可擴展的 context 類型 - 只包含新增的欄位
-export interface ExtendableContext {
-  // 只能添加新的欄位，不能修改現有的 ChartContext
-  [key: string]: Observable<any> | Subject<any> | Function | any
-}
-
-export type ChartContext<ExtendContext extends ExtendableContext> = {
-  // svgSelection: d3.Selection<SVGGElement, unknown, HTMLElement, any>
-  // canvasSelection: d3.Selection<HTMLCanvasElement, unknown, HTMLElement, any>
-  root: HTMLElement | Element
-  svg: SVGElement | null
-  canvas: HTMLCanvasElement | null
-  // rawData$: Observable<RawData>
-  encoding$: Observable<Encoding>
-  seriesData$: Observable<ModelData<'series'>[]>
-  gridData$: Observable<ModelData<'grid'>[]>
-  multivariateData$: Observable<ModelData<'multivariate'>[]>
-  graphData$: Observable<ModelData<'graph'>[]>
-  treeData$: Observable<ModelData<'tree'>[]>
-  plugins$: Observable<readonly PluginInfo[]>
-  theme$: Observable<Theme>
-  event$: Observable<EventData>
-  eventTrigger$: Subject<EventData>
-  size$: Observable<Size>
-  _updateLayerElements: <ElementType extends "svg" | "canvas">(elementType: ElementType, fromPluginName: string, fetchLayerInfo: LayerInfo[]) => Record<string, ElementType extends "svg" ? SVGGElement : HTMLCanvasElement>
+import type { Observable, Subject } from 'rxjs'
+import type {
+  RawData,
+  Encoding,
+  ModelData,
+  PluginInfo,
+  Theme,
+  EventData,
+  LayerInfo,
+} from './index'
+
+export interface Size {
+  width: number
+  height: number
+}
+
+// 定義可擴展的 context 類型 - 只包含新增的欄位
+export interface ExtendableContext {
+  // 只能添加新的欄位，不能修改現有的 ChartContext
+  [key: string]: Observable<any> | Subject<any> | Function | any
+}
+
+export type ChartContext<ExtendContext extends ExtendableContext> = {
+  // svgSelection: d3.Selection<SVGGElement, unknown, HTMLElement, any>
+  // canvasSelection: d3.Selection<HTMLCanvasElement, unknown, HTMLElement, any>
+  root: HTMLElement | Element
+  svg: SVGElement | null
+  canvas: HTMLCanvasElement | null
+  // rawData$: Observable<RawData>
+  encoding$: Observable<Encoding>
+  seriesData$: Observable<ModelData<'series'>[]>
+  gridData$: Observable<ModelData<'grid'>[]>
+  multivariateData$: Observable<ModelData<'multivariate'>[]>
+  graphData$: Observable<ModelData<'graph'>[]>
+  treeData$: Observable<ModelData<'tree'>[]>
+  plugins$: Observable<readonly PluginInfo[]>
+  theme$: Observable<Theme>
+  event$: Observable<EventData>
+  eventTrigger$: Subject<EventData>
+  size$: Observable<Size>
+  _updateLayerElements: <ElementType extends "svg" | "canvas">(elementType: ElementType, fromPluginName: string, fetchLayerInfo: LayerInfo[]) => Record<string, ElementType extends "svg" ? SVGGElement : HTMLCanvasElement>
 } & ExtendContext

package/src/types/Common.ts

@@ -1,5 +1,5 @@
-
-
-export type DeepPartial<T> = Partial<{
-  [P in keyof T]: DeepPartial<T[P]>
+
+
+export type DeepPartial<T> = Partial<{
+  [P in keyof T]: DeepPartial<T[P]>
 }>

package/src/types/Encoding.ts

@@ -1,43 +1,43 @@
-
-
-
-export interface EncodingDataset {
-  from: string
-  sort: 'original' | 'alphabetical' | string[]
-}
-
-export interface EncodingSeries {
-  from: string
-  sort: 'original' | 'alphabetical' | string[]
-}
-
-export interface EncodingCategory {
-  from: string
-  sort: 'original' | 'alphabetical' | string[]
-}
-
-export interface EncodingValue {
-  from: string
-  sort: 'original' | 'asc' | 'desc'
-  aggregate: 'sum' | 'mean' | 'median' | 'min' | 'max' | 'count' | 'none'
-}
-
-export interface EncodingMultivariateItem {
-  from: string
-  name: string
-}
-
-export type EncodingMultivariate = EncodingMultivariateItem[]
-
-export interface EncodingColor {
-  from: 'index' | 'series' | 'category' | 'dataset'
-}
-
-export interface Encoding {
-  dataset: EncodingDataset
-  series: EncodingSeries
-  category: EncodingCategory
-  value: EncodingValue
-  multivariate: EncodingMultivariate
-  color: EncodingColor
+
+
+
+export interface EncodingDataset {
+  from: string
+  sort: 'original' | 'alphabetical' | string[]
+}
+
+export interface EncodingSeries {
+  from: string
+  sort: 'original' | 'alphabetical' | string[]
+}
+
+export interface EncodingCategory {
+  from: string
+  sort: 'original' | 'alphabetical' | string[]
+}
+
+export interface EncodingValue {
+  from: string
+  sort: 'original' | 'asc' | 'desc'
+  aggregate: 'sum' | 'mean' | 'median' | 'min' | 'max' | 'count' | 'none'
+}
+
+export interface EncodingMultivariateItem {
+  from: string
+  name: string
+}
+
+export type EncodingMultivariate = EncodingMultivariateItem[]
+
+export interface EncodingColor {
+  from: 'index' | 'series' | 'category' | 'dataset'
+}
+
+export interface Encoding {
+  dataset: EncodingDataset
+  series: EncodingSeries
+  category: EncodingCategory
+  value: EncodingValue
+  multivariate: EncodingMultivariate
+  color: EncodingColor
 }

package/src/types/Event.ts

@@ -1,26 +1,26 @@
-import type {
-  ModelType,
-  RenderDatumBase
-} from '../../../core/src/types/index'
-
-export type EventType = 'click'
-  | 'mouseover'
-  | 'mousemove'
-  | 'mouseout'
-  | 'dragstart'
-  | 'drag'
-  | 'dragend'
-  // | 'resize'
-  | 'zoom'
-  | 'transitionMove'
-  | 'transitionEnd'
-
-export interface EventData<T extends ModelType = ModelType, ExtendTypes extends Record<string, any> = {}> {
-  eventName: EventType
-  pluginName: string
-  layerName: string
-  target: RenderDatumBase<T, ExtendTypes> | null
-  data?: any
-  tween?: number
-  event?: Event
+import type {
+  ModelType,
+  RenderDatumBase
+} from '../../../core/src/types/index'
+
+export type EventType = 'click'
+  | 'mouseover'
+  | 'mousemove'
+  | 'mouseout'
+  | 'dragstart'
+  | 'drag'
+  | 'dragend'
+  // | 'resize'
+  | 'zoom'
+  | 'transitionMove'
+  | 'transitionEnd'
+
+export interface EventData<T extends ModelType = ModelType, ExtendTypes extends Record<string, any> = {}> {
+  eventName: EventType
+  pluginName: string
+  layerName: string
+  target: RenderDatumBase<T, ExtendTypes> | null
+  data?: any
+  tween?: number
+  event?: Event
 }

package/src/types/Layers.ts

@@ -1,93 +1,93 @@
-import type { Observable } from 'rxjs'
-import type { DeepPartial, ChartContext, ExtendableContext, ValidatorResult } from './index'
-
-// export type LayerParamsBase<LayerName extends string> = {
-//   [K in LayerName]: unknown
-// }
-
-
-// export type LayerParams<LayerName extends string, Params = any> = Record<LayerName, Params>
-
-// export interface LayerContext<ExtendContext extends ExtendableContext = {}> {
-//   svgSelection: d3.Selection<SVGGElement, unknown, HTMLElement, any>
-//   canvasSelection: d3.Selection<HTMLCanvasElement, unknown, HTMLElement, any>
-//   name: string
-//   context: ChartContext<ExtendContext>
-// }
-
-// export type LayerContext<ExtendContext, LayerParams extends Record<string, any> = Record<string, any>> = ChartContext<ExtendContext> & {
-//   layerParams$: Observable<LayerParams>
-// }
-
-export interface LayerInfo {
-  pluginId: string
-  pluginName: string
-  layerName: string
-  layerIndex: number
-}
-
-export interface SVGLayerEnableProps<ExtendContext extends ExtendableContext, PluginParams, LayerParams> {
-  context: ChartContext<ExtendContext>
-  svgG: SVGGElement
-  // canvas: HTMLCanvasElement
-  pluginParams$: Observable<PluginParams>
-  initLayerParams: DeepPartial<LayerParams>
-}
-
-export interface CanvasLayerEnableProps<ExtendContext extends ExtendableContext, PluginParams, LayerParams> {
-  context: ChartContext<ExtendContext>
-  // svgG: SVGGElement
-  canvas: HTMLCanvasElement
-  pluginParams$: Observable<PluginParams>
-  initLayerParams: DeepPartial<LayerParams>
-}
-
-export type LayerEnableProps<ElementType extends 'svg' | 'canvas', ExtendContext extends ExtendableContext, PluginParams, LayerParams> =
-  ElementType extends 'svg' ? SVGLayerEnableProps<ExtendContext, PluginParams, LayerParams> :
-  ElementType extends 'canvas' ? CanvasLayerEnableProps<ExtendContext, PluginParams, LayerParams> :
-  never
-
-export interface SVGLayerSetupProps<ExtendContext extends ExtendableContext, PluginParams, LayerParams> {
-  context: ChartContext<ExtendContext>
-  svgG: SVGGElement
-  // canvas: HTMLCanvasElement
-  pluginParams$: Observable<PluginParams>
-  layerParams$: Observable<LayerParams>
-}
-
-export interface CanvasLayerSetupProps<ExtendContext extends ExtendableContext, PluginParams, LayerParams> {
-  context: ChartContext<ExtendContext>
-  // svgG: SVGGElement
-  canvas: HTMLCanvasElement
-  pluginParams$: Observable<PluginParams>
-  layerParams$: Observable<LayerParams>
-}
-
-export type LayerSetupProps<ElementType extends 'svg' | 'canvas', ExtendContext extends ExtendableContext, PluginParams, LayerParams> =
-  ElementType extends 'svg' ? SVGLayerSetupProps<ExtendContext, PluginParams, LayerParams> :
-  ElementType extends 'canvas' ? CanvasLayerSetupProps<ExtendContext, PluginParams, LayerParams> :
-  never
-
-export interface DefineLayerConfig<ElementType extends 'svg' | 'canvas', ExtendContext extends ExtendableContext, PluginParams extends Record<string, any>, LayerParams extends Record<string, any>> {
-  name: string
-  defaultParams: LayerParams
-  layerIndex: number
-  initShow: boolean
-  validator?: (params: DeepPartial<LayerParams>) => ValidatorResult
-  setup: (setupProps: LayerSetupProps<ElementType, ExtendContext, PluginParams, LayerParams>) => () => void
-}
-
-export interface LayerEntity<ExtendContext extends ExtendableContext, PluginParams, LayerParams> {
-  readonly _name: string
-  readonly _defaultParams: LayerParams
-  readonly _layerIndex: number
-  readonly _initShow: boolean
-  // _enable(el: { svg: SVGSVGElement; canvas: HTMLCanvasElement }, context: ChartContext<ExtendContext>): void
-  _enable(enableProps: LayerEnableProps<'svg' | 'canvas', ExtendContext, PluginParams, LayerParams>): void
-  _disable(): void
-  // _setParams(params: DeepPartial<LayerParams>): void
-  _updateParams(params: DeepPartial<LayerParams>): void
-  _forceReplaceParams(params: LayerParams): void
-  _getParams: () => LayerParams
-  _destroy(): void
+import type { Observable } from 'rxjs'
+import type { DeepPartial, ChartContext, ExtendableContext, ValidatorResult } from './index'
+
+// export type LayerParamsBase<LayerName extends string> = {
+//   [K in LayerName]: unknown
+// }
+
+
+// export type LayerParams<LayerName extends string, Params = any> = Record<LayerName, Params>
+
+// export interface LayerContext<ExtendContext extends ExtendableContext = {}> {
+//   svgSelection: d3.Selection<SVGGElement, unknown, HTMLElement, any>
+//   canvasSelection: d3.Selection<HTMLCanvasElement, unknown, HTMLElement, any>
+//   name: string
+//   context: ChartContext<ExtendContext>
+// }
+
+// export type LayerContext<ExtendContext, LayerParams extends Record<string, any> = Record<string, any>> = ChartContext<ExtendContext> & {
+//   layerParams$: Observable<LayerParams>
+// }
+
+export interface LayerInfo {
+  pluginId: string
+  pluginName: string
+  layerName: string
+  layerIndex: number
+}
+
+export interface SVGLayerEnableProps<ExtendContext extends ExtendableContext, PluginParams, LayerParams> {
+  context: ChartContext<ExtendContext>
+  svgG: SVGGElement
+  // canvas: HTMLCanvasElement
+  pluginParams$: Observable<PluginParams>
+  initLayerParams: DeepPartial<LayerParams>
+}
+
+export interface CanvasLayerEnableProps<ExtendContext extends ExtendableContext, PluginParams, LayerParams> {
+  context: ChartContext<ExtendContext>
+  // svgG: SVGGElement
+  canvas: HTMLCanvasElement
+  pluginParams$: Observable<PluginParams>
+  initLayerParams: DeepPartial<LayerParams>
+}
+
+export type LayerEnableProps<ElementType extends 'svg' | 'canvas', ExtendContext extends ExtendableContext, PluginParams, LayerParams> =
+  ElementType extends 'svg' ? SVGLayerEnableProps<ExtendContext, PluginParams, LayerParams> :
+  ElementType extends 'canvas' ? CanvasLayerEnableProps<ExtendContext, PluginParams, LayerParams> :
+  never
+
+export interface SVGLayerSetupProps<ExtendContext extends ExtendableContext, PluginParams, LayerParams> {
+  context: ChartContext<ExtendContext>
+  svgG: SVGGElement
+  // canvas: HTMLCanvasElement
+  pluginParams$: Observable<PluginParams>
+  layerParams$: Observable<LayerParams>
+}
+
+export interface CanvasLayerSetupProps<ExtendContext extends ExtendableContext, PluginParams, LayerParams> {
+  context: ChartContext<ExtendContext>
+  // svgG: SVGGElement
+  canvas: HTMLCanvasElement
+  pluginParams$: Observable<PluginParams>
+  layerParams$: Observable<LayerParams>
+}
+
+export type LayerSetupProps<ElementType extends 'svg' | 'canvas', ExtendContext extends ExtendableContext, PluginParams, LayerParams> =
+  ElementType extends 'svg' ? SVGLayerSetupProps<ExtendContext, PluginParams, LayerParams> :
+  ElementType extends 'canvas' ? CanvasLayerSetupProps<ExtendContext, PluginParams, LayerParams> :
+  never
+
+export interface DefineLayerConfig<ElementType extends 'svg' | 'canvas', ExtendContext extends ExtendableContext, PluginParams extends Record<string, any>, LayerParams extends Record<string, any>> {
+  name: string
+  defaultParams: LayerParams
+  layerIndex: number
+  initShow: boolean
+  validator?: (params: DeepPartial<LayerParams>) => ValidatorResult
+  setup: (setupProps: LayerSetupProps<ElementType, ExtendContext, PluginParams, LayerParams>) => () => void
+}
+
+export interface LayerEntity<ExtendContext extends ExtendableContext, PluginParams, LayerParams> {
+  readonly _name: string
+  readonly _defaultParams: LayerParams
+  readonly _layerIndex: number
+  readonly _initShow: boolean
+  // _enable(el: { svg: SVGSVGElement; canvas: HTMLCanvasElement }, context: ChartContext<ExtendContext>): void
+  _enable(enableProps: LayerEnableProps<'svg' | 'canvas', ExtendContext, PluginParams, LayerParams>): void
+  _disable(): void
+  // _setParams(params: DeepPartial<LayerParams>): void
+  _updateParams(params: DeepPartial<LayerParams>): void
+  _forceReplaceParams(params: LayerParams): void
+  _getParams: () => LayerParams
+  _destroy(): void
 }