@orbcharts/core 3.0.0-alpha.48 → 3.0.0-alpha.50

package/dist/src/types/Chart.d.ts

@@ -20,24 +20,22 @@ export interface ChartEntity<T extends ChartType> extends ContextSubject<T> {
     destroy: () => void;
 }
 export interface ChartOptions<T extends ChartType> {
-    preset: Preset<T>;
+    preset: Preset<T, unknown>;
 }
 export interface ChartOptionsPartial<T extends ChartType> {
-    preset?: PresetPartial<T>;
+    preset?: Preset<T, unknown>;
 }
-export interface Preset<T extends ChartType> {
+export interface Preset<T extends ChartType, AllPluginParams> {
+    name: string;
+    description: string;
     chartParams: ChartParams;
     dataFormatter: DataFormatterTypeMap<T>;
-    allPluginParams: {
-        [key: string]: any;
-    };
-    description: string;
+    allPluginParams: AllPluginParams;
 }
-export interface PresetPartial<T extends ChartType> {
+export interface PresetPartial<T extends ChartType, AllPluginParams> {
+    name?: string;
+    description?: string;
     chartParams?: ChartParamsPartial;
     dataFormatter?: DataFormatterPartialTypeMap<T>;
-    allPluginParams?: {
-        [key: string]: any;
-    };
-    description?: string;
+    allPluginParams?: AllPluginParams;
 }

package/package.json

@@ -1,41 +1,41 @@
-{
-  "name": "@orbcharts/core",
-  "version": "3.0.0-alpha.48",
-  "description": "OrbCharts is an open source chart library based on d3.js and rx.js",
-  "author": "Blue Planet Inc.",
-  "license": "Apache-2.0",
-  "keywords": [
-    "d3",
-    "rxjs",
-    "svg",
-    "visualization",
-    "infographic",
-    "graph",
-    "chart"
-  ],
-  "private": false,
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "files": [
-    "*"
-  ],
-  "module": "./dist/orbcharts-core.es.js",
-  "types": "./dist/src/index.d.ts",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "vite build --mode release"
-  },
-  "devDependencies": {
-    "@types/d3": "^7.4.0",
-    "ts-loader": "^9.4.2",
-    "typescript": "^5.0.4",
-    "vite": "^5.3.5",
-    "vite-plugin-dts": "^3.7.3"
-  },
-  "dependencies": {
-    "d3": "^7.8.5",
-    "rxjs": "^7.8.1"
-  }
-}
+{
+  "name": "@orbcharts/core",
+  "version": "3.0.0-alpha.50",
+  "description": "OrbCharts is an open source chart library based on d3.js and rx.js",
+  "author": "Blue Planet Inc.",
+  "license": "Apache-2.0",
+  "keywords": [
+    "d3",
+    "rxjs",
+    "svg",
+    "visualization",
+    "infographic",
+    "graph",
+    "chart"
+  ],
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "files": [
+    "*"
+  ],
+  "module": "./dist/orbcharts-core.es.js",
+  "types": "./dist/src/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "vite build --mode release"
+  },
+  "devDependencies": {
+    "@types/d3": "^7.4.0",
+    "ts-loader": "^9.4.2",
+    "typescript": "^5.0.4",
+    "vite": "^5.3.5",
+    "vite-plugin-dts": "^3.7.3"
+  },
+  "dependencies": {
+    "d3": "^7.8.5",
+    "rxjs": "^7.8.1"
+  }
+}

package/src/AbstractChart.ts

@@ -1,48 +1,48 @@
-import * as d3 from 'd3'
-import {
-  Subject } from 'rxjs'
-import type {
-  ComputedDataFn,
-  ChartEntity,
-  ChartType,
-  ChartParamsPartial,
-  ContextObserverFn,
-  ChartOptionsPartial,
-  DataTypeMap,
-  DataFormatterTypeMap,
-  DataFormatterPartialTypeMap,
-  EventTypeMap,
-  PluginEntity } from './types'
-import { createBaseChart } from './base/createBaseChart'
-
-export abstract class AbstractChart<T extends ChartType> implements ChartEntity<T> {
-  selection: d3.Selection<SVGGElement, unknown, HTMLElement, unknown>
-  destroy: () => void
-  data$: Subject<DataTypeMap<T>> = new Subject()
-  dataFormatter$: Subject<DataFormatterPartialTypeMap<T>> = new Subject()
-  plugins$: Subject<PluginEntity<T, any, any>[]> = new Subject()
-  chartParams$: Subject<ChartParamsPartial> = new Subject()
-  event$: Subject<EventTypeMap<T>> = new Subject()
-
-  constructor (
-    { defaultDataFormatter, computedDataFn, contextObserverFn }: {
-      defaultDataFormatter: DataFormatterTypeMap<T>
-      computedDataFn: ComputedDataFn<T>
-      contextObserverFn: ContextObserverFn<T>
-    },
-    element: HTMLElement | Element,
-    options?: ChartOptionsPartial<T>
-  ) {
-    const baseChart = createBaseChart({ defaultDataFormatter, computedDataFn, contextObserverFn })
-    const chartEntity = baseChart(element, options)
-
-    this.selection = chartEntity.selection
-    this.destroy = chartEntity.destroy
-    this.data$ = chartEntity.data$
-    this.dataFormatter$ = chartEntity.dataFormatter$
-    this.plugins$ = chartEntity.plugins$
-    this.chartParams$ = chartEntity.chartParams$
-    this.event$ = chartEntity.event$
-  }
-  
-}
+import * as d3 from 'd3'
+import {
+  Subject } from 'rxjs'
+import type {
+  ComputedDataFn,
+  ChartEntity,
+  ChartType,
+  ChartParamsPartial,
+  ContextObserverFn,
+  ChartOptionsPartial,
+  DataTypeMap,
+  DataFormatterTypeMap,
+  DataFormatterPartialTypeMap,
+  EventTypeMap,
+  PluginEntity } from './types'
+import { createBaseChart } from './base/createBaseChart'
+
+export abstract class AbstractChart<T extends ChartType> implements ChartEntity<T> {
+  selection: d3.Selection<SVGGElement, unknown, HTMLElement, unknown>
+  destroy: () => void
+  data$: Subject<DataTypeMap<T>> = new Subject()
+  dataFormatter$: Subject<DataFormatterPartialTypeMap<T>> = new Subject()
+  plugins$: Subject<PluginEntity<T, any, any>[]> = new Subject()
+  chartParams$: Subject<ChartParamsPartial> = new Subject()
+  event$: Subject<EventTypeMap<T>> = new Subject()
+
+  constructor (
+    { defaultDataFormatter, computedDataFn, contextObserverFn }: {
+      defaultDataFormatter: DataFormatterTypeMap<T>
+      computedDataFn: ComputedDataFn<T>
+      contextObserverFn: ContextObserverFn<T>
+    },
+    element: HTMLElement | Element,
+    options?: ChartOptionsPartial<T>
+  ) {
+    const baseChart = createBaseChart({ defaultDataFormatter, computedDataFn, contextObserverFn })
+    const chartEntity = baseChart(element, options)
+
+    this.selection = chartEntity.selection
+    this.destroy = chartEntity.destroy
+    this.data$ = chartEntity.data$
+    this.dataFormatter$ = chartEntity.dataFormatter$
+    this.plugins$ = chartEntity.plugins$
+    this.chartParams$ = chartEntity.chartParams$
+    this.event$ = chartEntity.event$
+  }
+  
+}

package/src/GridChart.ts

@@ -1,21 +1,21 @@
-import type {
-  ChartEntity,
-  ChartOptionsPartial } from './types'
-import { DATA_FORMATTER_GRID_DEFAULT } from './defaults'
-import { computeGridData } from './grid/computeGridData'
-import { createGridContextObserver } from './grid/createGridContextObserver'
-import { AbstractChart } from './AbstractChart'
-
-export class GridChart extends AbstractChart<'grid'> implements ChartEntity<'grid'> {
-  constructor (element: HTMLElement | Element, options?: ChartOptionsPartial<'grid'>) {
-    super(
-      {
-        defaultDataFormatter: DATA_FORMATTER_GRID_DEFAULT,
-        computedDataFn: computeGridData,
-        contextObserverFn: createGridContextObserver
-      },
-      element,
-      options
-    )
-  }
+import type {
+  ChartEntity,
+  ChartOptionsPartial } from './types'
+import { DATA_FORMATTER_GRID_DEFAULT } from './defaults'
+import { computeGridData } from './grid/computeGridData'
+import { createGridContextObserver } from './grid/createGridContextObserver'
+import { AbstractChart } from './AbstractChart'
+
+export class GridChart extends AbstractChart<'grid'> implements ChartEntity<'grid'> {
+  constructor (element: HTMLElement | Element, options?: ChartOptionsPartial<'grid'>) {
+    super(
+      {
+        defaultDataFormatter: DATA_FORMATTER_GRID_DEFAULT,
+        computedDataFn: computeGridData,
+        contextObserverFn: createGridContextObserver
+      },
+      element,
+      options
+    )
+  }
 }

package/src/MultiGridChart.ts

@@ -1,21 +1,21 @@
-import type {
-  ChartEntity,
-  ChartOptionsPartial } from './types'
-import { DATA_FORMATTER_MULTI_GRID_DEFAULT } from './defaults'
-import { computeMultiGridData } from './multiGrid/computeMultiGridData'
-import { createMultiGridContextObserver } from './multiGrid/createMultiGridContextObserver'
-import { AbstractChart } from './AbstractChart'
-
-export class MultiGridChart extends AbstractChart<'multiGrid'> implements ChartEntity<'multiGrid'> {
-  constructor (element: HTMLElement | Element, options?: ChartOptionsPartial<'multiGrid'>) {
-    super(
-      {
-        defaultDataFormatter: DATA_FORMATTER_MULTI_GRID_DEFAULT,
-        computedDataFn: computeMultiGridData,
-        contextObserverFn: createMultiGridContextObserver
-      },
-      element,
-      options
-    )
-  }
+import type {
+  ChartEntity,
+  ChartOptionsPartial } from './types'
+import { DATA_FORMATTER_MULTI_GRID_DEFAULT } from './defaults'
+import { computeMultiGridData } from './multiGrid/computeMultiGridData'
+import { createMultiGridContextObserver } from './multiGrid/createMultiGridContextObserver'
+import { AbstractChart } from './AbstractChart'
+
+export class MultiGridChart extends AbstractChart<'multiGrid'> implements ChartEntity<'multiGrid'> {
+  constructor (element: HTMLElement | Element, options?: ChartOptionsPartial<'multiGrid'>) {
+    super(
+      {
+        defaultDataFormatter: DATA_FORMATTER_MULTI_GRID_DEFAULT,
+        computedDataFn: computeMultiGridData,
+        contextObserverFn: createMultiGridContextObserver
+      },
+      element,
+      options
+    )
+  }
 }

package/src/MultiValueChart.ts

@@ -1,21 +1,21 @@
-import type {
-  ChartEntity,
-  ChartOptionsPartial } from './types'
-import { DATA_FORMATTER_MULTI_VALUE_DEFAULT } from './defaults'
-import { computeMultiValueData } from './multiValue/computeMultiValueData'
-import { createMultiValueContextObserver } from './multiValue/createMultiValueContextObserver'
-import { AbstractChart } from './AbstractChart'
-
-export class MultiValueChart extends AbstractChart<'multiValue'> implements ChartEntity<'multiValue'> {
-  constructor (element: HTMLElement | Element, options?: ChartOptionsPartial<'multiValue'>) {
-    super(
-      {
-        defaultDataFormatter: DATA_FORMATTER_MULTI_VALUE_DEFAULT,
-        computedDataFn: computeMultiValueData,
-        contextObserverFn: createMultiValueContextObserver
-      },
-      element,
-      options
-    )
-  }
+import type {
+  ChartEntity,
+  ChartOptionsPartial } from './types'
+import { DATA_FORMATTER_MULTI_VALUE_DEFAULT } from './defaults'
+import { computeMultiValueData } from './multiValue/computeMultiValueData'
+import { createMultiValueContextObserver } from './multiValue/createMultiValueContextObserver'
+import { AbstractChart } from './AbstractChart'
+
+export class MultiValueChart extends AbstractChart<'multiValue'> implements ChartEntity<'multiValue'> {
+  constructor (element: HTMLElement | Element, options?: ChartOptionsPartial<'multiValue'>) {
+    super(
+      {
+        defaultDataFormatter: DATA_FORMATTER_MULTI_VALUE_DEFAULT,
+        computedDataFn: computeMultiValueData,
+        contextObserverFn: createMultiValueContextObserver
+      },
+      element,
+      options
+    )
+  }
 }

package/src/RelationshipChart.ts

@@ -1,21 +1,21 @@
-import type {
-  ChartEntity,
-  ChartOptionsPartial } from './types'
-import { DATA_FORMATTER_RELATIONAL_DEFAULT} from './defaults'
-import { computeRelationshipData } from './relationship/computeRelationshipData'
-import { createRelationshipContextObserver } from './relationship/createRelationshipContextObserver'
-import { AbstractChart } from './AbstractChart'
-
-export class RelationshipChart extends AbstractChart<'relationship'> implements ChartEntity<'relationship'> {
-  constructor (element: HTMLElement | Element, options?: ChartOptionsPartial<'relationship'>) {
-    super(
-      {
-        defaultDataFormatter: DATA_FORMATTER_RELATIONAL_DEFAULT,
-        computedDataFn: computeRelationshipData,
-        contextObserverFn: createRelationshipContextObserver
-      },
-      element,
-      options
-    )
-  }
+import type {
+  ChartEntity,
+  ChartOptionsPartial } from './types'
+import { DATA_FORMATTER_RELATIONAL_DEFAULT} from './defaults'
+import { computeRelationshipData } from './relationship/computeRelationshipData'
+import { createRelationshipContextObserver } from './relationship/createRelationshipContextObserver'
+import { AbstractChart } from './AbstractChart'
+
+export class RelationshipChart extends AbstractChart<'relationship'> implements ChartEntity<'relationship'> {
+  constructor (element: HTMLElement | Element, options?: ChartOptionsPartial<'relationship'>) {
+    super(
+      {
+        defaultDataFormatter: DATA_FORMATTER_RELATIONAL_DEFAULT,
+        computedDataFn: computeRelationshipData,
+        contextObserverFn: createRelationshipContextObserver
+      },
+      element,
+      options
+    )
+  }
 }

package/src/SeriesChart.ts

@@ -1,21 +1,21 @@
-import type {
-  ChartEntity,
-  ChartOptionsPartial } from './types'
-import { DATA_FORMATTER_SERIES_DEFAULT } from './defaults'
-import { computeSeriesData } from './series/computeSeriesData'
-import { createSeriesContextObserver } from './series/createSeriesContextObserver'
-import { AbstractChart } from './AbstractChart'
-
-export class SeriesChart extends AbstractChart<'series'> implements ChartEntity<'series'> {
-  constructor (element: HTMLElement | Element, options?: ChartOptionsPartial<'series'>) {
-    super(
-      {
-        defaultDataFormatter: DATA_FORMATTER_SERIES_DEFAULT,
-        computedDataFn: computeSeriesData,
-        contextObserverFn: createSeriesContextObserver
-      },
-      element,
-      options
-    )
-  }
+import type {
+  ChartEntity,
+  ChartOptionsPartial } from './types'
+import { DATA_FORMATTER_SERIES_DEFAULT } from './defaults'
+import { computeSeriesData } from './series/computeSeriesData'
+import { createSeriesContextObserver } from './series/createSeriesContextObserver'
+import { AbstractChart } from './AbstractChart'
+
+export class SeriesChart extends AbstractChart<'series'> implements ChartEntity<'series'> {
+  constructor (element: HTMLElement | Element, options?: ChartOptionsPartial<'series'>) {
+    super(
+      {
+        defaultDataFormatter: DATA_FORMATTER_SERIES_DEFAULT,
+        computedDataFn: computeSeriesData,
+        contextObserverFn: createSeriesContextObserver
+      },
+      element,
+      options
+    )
+  }
 }

package/src/TreeChart.ts

@@ -1,21 +1,21 @@
-import type {
-  ChartEntity,
-  ChartOptionsPartial } from './types'
-import { DATA_FORMATTER_TREE_DEFAULT } from './defaults'
-import { computeTreeData } from './tree/computeTreeData'
-import { createTreeContextObserver } from './tree/createTreeContextObserver'
-import { AbstractChart } from './AbstractChart'
-
-export class TreeChart extends AbstractChart<'tree'> implements ChartEntity<'tree'> {
-  constructor (element: HTMLElement | Element, options?: ChartOptionsPartial<'tree'>) {
-    super(
-      {
-        defaultDataFormatter: DATA_FORMATTER_TREE_DEFAULT,
-        computedDataFn: computeTreeData,
-        contextObserverFn: createTreeContextObserver
-      },
-      element,
-      options
-    )
-  }
+import type {
+  ChartEntity,
+  ChartOptionsPartial } from './types'
+import { DATA_FORMATTER_TREE_DEFAULT } from './defaults'
+import { computeTreeData } from './tree/computeTreeData'
+import { createTreeContextObserver } from './tree/createTreeContextObserver'
+import { AbstractChart } from './AbstractChart'
+
+export class TreeChart extends AbstractChart<'tree'> implements ChartEntity<'tree'> {
+  constructor (element: HTMLElement | Element, options?: ChartOptionsPartial<'tree'>) {
+    super(
+      {
+        defaultDataFormatter: DATA_FORMATTER_TREE_DEFAULT,
+        computedDataFn: computeTreeData,
+        contextObserverFn: createTreeContextObserver
+      },
+      element,
+      options
+    )
+  }
 }