@types/chartjs-plugin-crosshair
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.1 • Public • Published

    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

    // Type definitions for chartjs-plugin-crosshair 1.1
    // Project: https://chartjs-plugin-crosshair.netlify.com
    // Definitions by: Dan Manastireanu <https://github.com/danmana>
    // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
    // TypeScript Version: 3.2
    
    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: Thu, 08 Jul 2021 09:07:13 GMT
    • Dependencies: @types/chart.js
    • Global values: none

    Credits

    These definitions were written by Dan Manastireanu.

    Keywords

    none

    Install

    npm i @types/chartjs-plugin-crosshair

    DownloadsWeekly Downloads

    5,197

    Version

    1.1.1

    License

    MIT

    Unpacked Size

    7.38 kB

    Total Files

    4

    Last publish

    Collaborators

    • types