@thewhitehaven04/chartjs-plugin-zoom 2.2.31 → 2.2.33

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thewhitehaven04/chartjs-plugin-zoom",
-  "version": "2.2.31",
+  "version": "2.2.33",
   "description": "A fork of the ChartJS Zoom plugin that enables zoom and pan functionality in Chart.js charts",
   "homepage": "https://www.chartjs.org/chartjs-plugin-zoom/",
   "repository": {
@@ -11,19 +11,20 @@
   "type": "module",
   "jsdelivr": "dist/chartjs-plugin-zoom.min.js",
   "unpkg": "dist/chartjs-plugin-zoom.min.js",
-  "main": "dist/chartjs-plugin-zoom.js",
-  "module": "dist/chartjs-plugin-zoom.esm.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/chartjs-plugin-zoom.js",
+  "module": "./dist/chartjs-plugin-zoom.esm.js",
+  "types": "types/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/**/*.d.ts",
       "import": "./dist/chartjs-plugin-zoom-esm.js",
       "require": "./dist/chartjs-plugin-zoom.js"
     }
   },
   "files": [
     "dist/*.js",
-    "dist/*.d.ts"
+    "dist/*.d.ts",
+    "types"
   ],
   "scripts": {
     "autobuild": "rollup -c -w",

package/types/index.d.ts

@@ -0,0 +1,31 @@
+import plugin from './plugin';
+import type { ZoomPluginOptions } from './options';
+import type { ScaleRange } from './state';
+import type { DistributiveArray, PanAmount, ZoomAmount } from './types.js';
+import type { ChartType, ChartTypeRegistry, Point, Scale, UpdateMode } from 'chart.js';
+declare module 'chart.js' {
+    interface PluginOptionsByType<TType extends ChartType> {
+        zoom: ZoomPluginOptions;
+    }
+    enum UpdateModeEnum {
+        zoom = "zoom"
+    }
+    interface Chart<TType extends ChartType = keyof ChartTypeRegistry, TData = DistributiveArray<ChartTypeRegistry[TType]['defaultDataPoint']>, TLabel = unknown> {
+        pan(pan: PanAmount, scales?: Scale[], mode?: UpdateMode): void;
+        zoom(zoom: ZoomAmount, mode?: UpdateMode): void;
+        zoomRect(p0: Point, p1: Point, mode?: UpdateMode): void;
+        zoomScale(id: string, range: ScaleRange, mode?: UpdateMode): void;
+        resetZoom(mode?: UpdateMode): void;
+        getZoomLevel(): number;
+        getInitialScaleBounds(): Record<string, {
+            min?: number;
+            max?: number;
+        }>;
+        getZoomedScaleBounds(): Record<string, Partial<ScaleRange>>;
+        isZoomedOrPanned(): boolean;
+        isZoomingOrPanning(): boolean;
+    }
+}
+export default plugin;
+export { pan, zoom, zoomRect, zoomScale, resetZoom } from './core';
+//# sourceMappingURL=index.d.ts.map

package/types/options.d.ts

@@ -0,0 +1,196 @@
+/// <reference types="hammerjs" />
+import type { Chart, Color, Point } from 'chart.js';
+export type Mode = 'x' | 'y' | 'xy';
+export type ModeFn = (context: {
+    chart: Chart;
+}) => Mode;
+export type ModeOption = Mode | ModeFn;
+export type ModifierKey = 'ctrl' | 'alt' | 'shift' | 'meta';
+export type DrawTime = 'afterDraw' | 'afterDatasetsDraw' | 'beforeDraw' | 'beforeDatasetsDraw';
+export type ZoomTrigger = 'api' | 'drag' | 'wheel' | 'pinch';
+export type PanTrigger = 'api' | 'drag' | 'wheel' | 'other';
+type RejectableStartEvent<T = Event | HammerInput> = (context: {
+    chart: Chart;
+    event: T;
+    point: Point;
+}) => boolean | undefined;
+type RejectEvent<T = Event | HammerInput> = (context: {
+    chart: Chart;
+    event: T;
+}) => void;
+type GenericEvent = (context: {
+    chart: Chart;
+}) => void;
+export interface WheelOptions {
+    /**
+     * Enable the zoom via mouse wheel
+     */
+    enabled?: boolean;
+    /**
+     * Speed of zoom via mouse wheel
+     * (percentage of zoom on a wheel event)
+     */
+    speed?: number;
+    /**
+     * Modifier key required for zooming with mouse
+     */
+    modifierKey?: ModifierKey | null;
+}
+export interface DragOptions {
+    /**
+     * Enable the zoom via drag
+     */
+    enabled?: boolean;
+    /**
+     * Minimal zoom distance required before actually applying zoom
+     */
+    threshold?: number;
+    /**
+     * Border color of the drag area
+     */
+    borderColor?: Color;
+    /**
+     * Border width of the drag area
+     */
+    borderWidth?: number;
+    /**
+     * Background color of the drag area
+     */
+    backgroundColor?: Color;
+    /**
+     * Modifier key required for drag-to-zoom
+     */
+    modifierKey?: ModifierKey | null;
+    /**
+     * Draw time required for drag-to-zoom
+     */
+    drawTime?: DrawTime;
+    /**
+     * Maintain aspect ratio of the drag rectangle
+     */
+    maintainAspectRatio?: boolean;
+}
+export interface PinchOptions {
+    /**
+     * Enable the zoom via pinch
+     */
+    enabled?: boolean;
+}
+/**
+ * Container for zoom options
+ */
+export interface ZoomOptions {
+    /**
+     * Zooming directions. Remove the appropriate direction to disable
+     * E.g. 'y' would only allow zooming in the y direction
+     * A function that is called as the user is zooming and returns the
+     * available directions can also be used:
+     *    mode: function({ chart }) {
+     *      return 'xy';
+     *    },
+     */
+    mode?: ModeOption;
+    /**
+     * Options of the mouse wheel mode
+     */
+    wheel?: WheelOptions;
+    /**
+     * Options of the drag-to-zoom mode
+     */
+    drag?: DragOptions;
+    /**
+     * Options of the pinch mode
+     */
+    pinch?: PinchOptions;
+    scaleMode?: ModeOption;
+    /** @deprecated Use scaleMode instead */
+    overScaleMode?: ModeOption;
+    /**
+     * Function called while the user is zooming
+     */
+    onZoom?: (context: {
+        chart: Chart;
+        trigger: ZoomTrigger;
+        amount?: {
+            x: number;
+            y: number;
+        } & {
+            focalPoint: Point;
+        };
+    }) => void;
+    /**
+     * Function called once zooming is completed
+     */
+    onZoomComplete?: GenericEvent;
+    /**
+     * Function called when wheel input occurs without modifier key
+     */
+    onZoomRejected?: RejectEvent<Event>;
+    onZoomStart?: RejectableStartEvent<Event>;
+}
+/**
+ * Container for pan options
+ */
+export interface PanOptions {
+    /**
+     * Boolean to enable panning
+     */
+    enabled?: boolean;
+    /**
+     * Panning directions. Remove the appropriate direction to disable
+     * E.g. 'y' would only allow panning in the y direction
+     * A function that is called as the user is panning and returns the
+     * available directions can also be used:
+     *   mode: function({ chart }) {
+     *     return 'xy';
+     *   },
+     */
+    mode?: ModeOption;
+    /**
+     * Modifier key required for panning with mouse
+     */
+    modifierKey?: ModifierKey | null;
+    scaleMode?: ModeOption;
+    /** @deprecated Use scaleMode instead */
+    overScaleMode?: ModeOption;
+    /**
+     * Minimal pan distance required before actually applying pan
+     */
+    threshold?: number;
+    /**
+     * Function called while the user is panning
+     */
+    onPan?: (context: {
+        chart: Chart;
+        trigger: PanTrigger;
+        delta: {
+            x: number;
+            y: number;
+        };
+    }) => void;
+    /**
+     * Function called once panning is completed
+     */
+    onPanComplete?: GenericEvent;
+    /**
+     * Function called when pan fails because modifier key was not detected.
+     * event is the Hammer event that failed - see https://hammerjs.github.io/api#event-object
+     */
+    onPanRejected?: RejectEvent<HammerInput>;
+    onPanStart?: RejectableStartEvent<HammerInput>;
+}
+export interface ScaleLimits {
+    min?: number | 'original';
+    max?: number | 'original';
+    minRange?: number;
+}
+export interface LimitOptions {
+    [axisId: string]: ScaleLimits;
+}
+export interface ZoomPluginOptions {
+    pan?: PanOptions;
+    limits?: LimitOptions;
+    zoom?: ZoomOptions;
+}
+export {};
+//# sourceMappingURL=options.d.ts.map