@types/chartjs-plugin-doughnutlabel-rebourne

Installation

npm install --save @types/chartjs-plugin-doughnutlabel-rebourne

Summary

This package contains type definitions for chartjs-plugin-doughnutlabel-rebourne (https://github.com/alexkuc/chartjs-plugin-doughnutlabel-rebourne).

Details

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

index.d.ts

import { Chart, ChartType, Plugin } from "chart.js";

declare module "chart.js" {
    interface PluginOptionsByType<TType extends ChartType> {
        doughnutlabel?: DoughnutLabel.Options;
    }
}

// Using declaration merging https://www.typescriptlang.org/docs/handbook/declaration-merging.html
// Allows importing the plugin as: import * as DoughnutLabel from 'chartjs-plugin-doughnutlabel-rebourne';
// and using the interfaces as: DoughnutLabel.Label
declare namespace DoughnutLabel {
    interface Options {
        labels?: Label[];
        /** Which plugin core api to use to draw labels */
        api?: Exclude<keyof Plugin, "id">;
        /** How much padding to add when scaling very large text (value in percentage of 100) */
        paddingPercentage?: number | `${number}`;
        /** Show labels or not (plugin scope) */
        display?: boolean;
        /** Color of the labels (plugin scope) */
        color?: CanvasRenderingContext2D["fillStyle"];
        /** The font options used to draw the label text (plugin scope) */
        font?: Font;
    }

    interface Label {
        /** The text to display */
        text: string | number | ((chart: Chart) => string | number);
        /** The font options used to draw the label text (single label scope) */
        font?: Font;
        /** Color of the labels (single label scope) */
        color?: CanvasRenderingContext2D["fillStyle"];
        /** Show the label or not (single label scope) */
        display?: boolean;
    }

    interface Font {
        /** Defaults to `Chart.defaults.global.defaultFontFamily` */
        family?: string;
        /** Defaults to 1.2 */
        lineHeight?: number | `${number}`;
        /** Defaults to `Chart.defaults.global.defaultFontSize` */
        size?: number | `${number}`;
        /** Defaults to `Chart.defaults.global.defaultFontStyle` */
        style?: "normal" | "italic" | "oblique" | "initial" | "inherit";
        /** Defaults to `'normal'` */
        weight?: string;
    }
}

declare const DoughnutLabel: Plugin<"doughnut">;

export = DoughnutLabel;

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: chart.js

Credits

These definitions were written by Piotr Ładoński.