chartjs-chart-treemap 4.0.0 → 4.1.0

package/dist/types.d.ts

@@ -1,45 +1,80 @@
-import type { Chart, ChartComponent, Color, CoreChartOptions, DatasetController, Element, FontSpec, Scriptable, ScriptableContext, VisualElement } from 'chart.js';
+import type { BorderRadius, Chart, ChartComponent, Color, CoreChartOptions, DatasetController, Element, FontSpec, Scriptable, ScriptableContext, VisualElement } from 'chart.js';
 export type AnyObject = Record<string, unknown>;
 export type LabelPosition = 'top' | 'middle' | 'bottom';
 export type LabelAlign = 'left' | 'center' | 'right';
 export type LabelOverflow = 'cut' | 'hidden' | 'fit';
-type TreemapScriptableContext = ScriptableContext<'treemap'> & {
+export type TreemapDisplayMode = 'containerBoxes' | 'headerBoxes';
+export type TreemapBorderWidth = number | Partial<Record<'bottom' | 'left' | 'right' | 'top', number>>;
+export type TreemapBorderRadius = Required<BorderRadius>;
+export type TreemapFontSpec = Partial<FontSpec>;
+export type TreemapScriptableContext = ScriptableContext<'treemap'> & {
     raw: TreemapDataPoint;
 };
-type TreemapControllerDatasetCaptionsOptions = {
+export type TreemapFormatter<T> = T | ((context: TreemapScriptableContext) => T);
+export type TreemapControllerDatasetCaptionsOptions = {
     align?: Scriptable<LabelAlign, TreemapScriptableContext>;
     color?: Scriptable<Color, TreemapScriptableContext>;
     display?: boolean;
-    formatter?: Scriptable<string, TreemapScriptableContext>;
-    font?: FontSpec;
+    formatter?: TreemapFormatter<string>;
+    font?: TreemapFontSpec;
     hoverColor?: Scriptable<Color, TreemapScriptableContext>;
-    hoverFont?: FontSpec;
+    hoverFont?: TreemapFontSpec;
     padding?: number;
 };
-type TreemapControllerDatasetLabelsOptions = {
+export type TreemapControllerDatasetLabelsOptions = {
     align?: Scriptable<LabelAlign, TreemapScriptableContext>;
     color?: Scriptable<Color | Color[], TreemapScriptableContext>;
     display?: boolean;
-    formatter?: Scriptable<string | Array<string>, TreemapScriptableContext>;
-    font?: Scriptable<FontSpec | FontSpec[], TreemapScriptableContext>;
+    formatter?: TreemapFormatter<string | string[]>;
+    font?: Scriptable<TreemapFontSpec | TreemapFontSpec[], TreemapScriptableContext>;
     hoverColor?: Scriptable<Color | Color[], TreemapScriptableContext>;
-    hoverFont?: Scriptable<FontSpec | FontSpec[], TreemapScriptableContext>;
+    hoverFont?: Scriptable<TreemapFontSpec | TreemapFontSpec[], TreemapScriptableContext>;
     overflow?: Scriptable<LabelOverflow, TreemapScriptableContext>;
     padding?: number;
     position?: Scriptable<LabelPosition, TreemapScriptableContext>;
 };
-type TreemapControllerDatasetDividersOptions = {
+export type TreemapControllerDatasetDividersOptions = {
     display?: boolean;
-    lineCapStyle?: string;
-    lineColor?: string;
+    lineCapStyle?: CanvasLineCap;
+    lineColor?: Color;
     lineDash?: number[];
     lineDashOffset?: number;
     lineWidth?: number;
 };
+export type TreemapCaptionsOptions = {
+    align?: LabelAlign;
+    color: Color;
+    display?: boolean;
+    font: TreemapFontSpec;
+    formatter?: TreemapFormatter<string>;
+    hoverColor?: Color;
+    hoverFont?: TreemapFontSpec;
+    padding: number;
+};
+export type TreemapLabelsOptions = {
+    align: LabelAlign;
+    color: Color | Color[];
+    display?: boolean;
+    font: TreemapFontSpec | TreemapFontSpec[];
+    formatter?: TreemapFormatter<string | string[]>;
+    hoverColor?: Color | Color[];
+    hoverFont?: TreemapFontSpec | TreemapFontSpec[];
+    overflow: LabelOverflow;
+    padding: number;
+    position: LabelPosition;
+};
+export type TreemapDividersOptions = {
+    display?: boolean;
+    lineCapStyle: CanvasLineCap;
+    lineColor: Color;
+    lineDash: number[];
+    lineDashOffset: number;
+    lineWidth: number;
+};
 export interface TreemapControllerDatasetOptions<DType> {
     spacing?: number;
     rtl?: boolean;
-    displayType?: 'containerBoxes' | 'headerBoxes';
+    displayType?: TreemapDisplayMode;
     backgroundColor?: Scriptable<Color, TreemapScriptableContext>;
     borderColor?: Scriptable<Color, TreemapScriptableContext>;
     borderWidth?: number;
@@ -86,12 +121,14 @@ declare module 'chart.js' {
 export interface TreemapOptions {
     backgroundColor: Color;
     borderColor: Color;
-    borderWidth: number | {
-        top?: number;
-        right?: number;
-        bottom?: number;
-        left?: number;
-    };
+    borderRadius: number | Partial<BorderRadius>;
+    borderWidth: TreemapBorderWidth;
+    captions: TreemapCaptionsOptions;
+    displayMode: TreemapDisplayMode;
+    dividers: TreemapDividersOptions;
+    labels: TreemapLabelsOptions;
+    rtl: boolean;
+    spacing: number;
 }
 export interface TreemapConfig {
     x: number;
@@ -110,4 +147,3 @@ export type TreemapElementComponent = ChartComponent & {
     prototype: TreemapElement;
     new (cfg: TreemapConfig): TreemapElement;
 };
-export {};

package/dist/utils.d.ts

@@ -1,7 +1,7 @@
 export declare const getGroupKey: (lvl: unknown) => string;
 export declare function normalizeTreeToArray(keys: string[], treeLeafKey: string, obj: Record<string, any>): Record<string, any>[];
 export declare function flatten(input: any[]): any[];
-export declare function group(values: Record<string, any>[], grp: string, keys: string[], treeLeafKey: string, mainGrp?: string, mainValue?: any, groups?: string[]): Record<string, any>[];
+export declare function group(values: Record<string, any>[], grp: string, keys: string[], treeLeafKey: string, mainGrp?: string, mainValue?: any, groups?: string[], allGroups?: string[], groupIndex?: number): Record<string, any>[];
 export declare function index(values: any[], key: string): string;
 export declare function sort(values: any[], key?: string): void;
 export declare function sum(values: any[], key?: string): number;

package/package.json

@@ -106,5 +106,5 @@
   "type": "module",
   "types": "dist/index.esm.d.ts",
   "unpkg": "dist/chartjs-chart-treemap.min.js",
-  "version": "4.0.0"
+  "version": "4.1.0"
 }