@types/chartjs-plugin-crosshair

Installation

npm install --save @types/chartjs-plugin-crosshair

Summary

This package contains type definitions for chartjs-plugin-crosshair (https://chartjs-plugin-crosshair.netlify.com).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/chartjs-plugin-crosshair.

index.d.ts

import * as Chart from "chart.js";

declare module "chart.js" {
    interface ChartPluginsOptions {
        crosshair?: CrosshairOptions | undefined;
    }

    interface InteractionModeRegistry {
        "interpolate": "interpolate";
    }

    interface ChartDataSets {
        interpolate?: boolean | undefined;
    }
}

// This is a workaround needed because:
// classes exported with `export = ` can't be augmented by normal module augmentation (like we use above)
// see https://github.com/Microsoft/TypeScript/issues/14080
declare global {
    interface Chart {
        panZoom: (increment: number) => void;
    }
}

export interface CrosshairOptions {
    line?: LineOptions | undefined;
    sync?: SyncOptions | undefined;
    zoom?: ZoomOptions | undefined;
    snap?: SnapOptions | undefined;
    callbacks?: CallbackOptions | undefined;
}

/** https://chartjs-plugin-crosshair.netlify.app/options.html#crosshair-line-options */
export interface LineOptions {
    color?: string | undefined;
    width?: number | undefined;
    dashPattern?: number[] | undefined;
}

/** https://chartjs-plugin-crosshair.netlify.app/options.html#chart-interaction-syncing */
export interface SyncOptions {
    enabled?: boolean | undefined;
    group?: number | undefined;
    suppressTooltips?: boolean | undefined;
}

/** https://chartjs-plugin-crosshair.netlify.app/options.html#zooming */
export interface ZoomOptions {
    enabled?: boolean | undefined;
    zoomboxBackgroundColor?: string | undefined;
    zoomboxBorderColor?: string | undefined;
    zoomButtonText?: string | undefined;
    zoomButtonClass?: string | undefined;
}

/** https://chartjs-plugin-crosshair.netlify.app/options.html#snapping */
export interface SnapOptions {
    enabled?: boolean | undefined;
}

/** https://chartjs-plugin-crosshair.netlify.app/options.html#callbacks */
export interface CallbackOptions {
    beforeZoom?: ((start: number, end: number) => boolean) | undefined;
    afterZoom?: ((start: number, end: number) => void) | undefined;
}

Additional Details

• Last updated: Tue, 17 Oct 2023 22:10:14 GMT
• Dependencies: @types/chart.js

Credits

These definitions were written by Dan Manastireanu.