Merge pull request #108 from burlandm/master

Add flot definitions
2026-05-27 14:30:49 +08:00 · 2012-12-05 02:33:05 -08:00
parent e22f30c0a7 2c11ca9d46
commit 6051bf74bf
1 changed files with 215 additions and 0 deletions
--- a/flot/jquery.flot.d.ts
+++ b/flot/jquery.flot.d.ts
@@ -0,0 +1,215 @@
+/// <reference path="jquery.d.ts" />
+
+module jquery.flot {
+    interface plotOptions {
+        colors?: any[];
+        series?: seriesOptions;
+        legend?: legendOptions;
+        xaxis?: axisOptions;
+        yaxis?: axisOptions;
+        xaxes?: axisOptions[];
+        yaxes?: axisOptions[];
+        grid?: gridOptions;
+        interfaction?: interaction;
+        hooks?: hooks;
+    }
+
+    interface hooks {
+        processOptions: { (plot: plot, options: plotOptions): void; } [];
+        processRawData: { (plot: plot, series: dataSeries, data: any[], datapoints: datapoints): void; }[];
+        processDatapoints: { (plot: plot, series: dataSeries, datapoints: datapoints): void; }[];
+        processOffset: { (plot: plot, offset: canvasPoint): void; }[];
+        drawBackground: { (plot: plot, context: CanvasRenderingContext2D): void; }[];
+        drawSeries: { (plot: plot, context: CanvasRenderingContext2D, series: dataSeries): void; }[];
+        draw: { (plot: plot, context: CanvasRenderingContext2D): void; }[];
+        bindEvents: { (plot: plot, eventHolder: JQuery): void; }[];
+        drawOverlay: { (plot: plot, context: CanvasRenderingContext2D): void; }[];
+        shutdown: { (plot: plot, eventHolder: JQuery): void; }[];
+    }
+
+    interface interaction {
+        redrawOverlayInterval?: number;
+    }
+
+    interface gridOptions {
+        show?: bool;
+        aboveData?: bool;
+        color?: any;                // color
+        backgroundColor?: any;      //color/gradient or null
+        margin?: any;                // number or margin object
+        labelMargin?: number;
+        axisMargin?: number;
+        markings?: any;             //array of markings or (fn: axes -> array of markings)
+        borderWidth: number;
+        borderColor?: any;          // color or null
+        minBorderMargin?: number;       // or null
+        clickable?: bool;
+        hoverable?: bool;
+        autoHighlight?: bool;
+        mouseActiveRadius?: number;
+        tickColor?: any;
+        markingsColor?: any;
+        markingsLineWidth?: number;
+    }
+
+    interface legendOptions {
+        show?: bool;
+        labelFormatter?: (label: string, series: any) => string; //  null or (fn: string, series object -> string)
+        labelBoxBorderColor?: any;   //color
+        noColumns?: number;
+        position?: string;           //"ne" or "nw" or "se" or "sw"
+        margin?: any;                //number of pixels or [x margin, y margin]
+        backgroundColor?: any;       //null or color
+        backgroundOpacity?: number;  // between 0 and 1
+        container?: JQuery;         // null or jQuery object/DOM element/jQuery expression
+        sorted?: any;                //null/false, true, "ascending", "descending" or a comparator
+    }
+
+    interface seriesOptions {
+        color?: number;
+        label?: string;
+        lines?: linesOptions;
+        bars?: barsOptions;
+        points?: pointsOptions;
+        xaxis?: number;
+        yaxis?: number;
+        clickable?: bool;
+        hoverable?: bool;
+        shadowSize?: number;
+        highlightColor?: any;
+    }
+
+    interface dataSeries extends seriesOptions {
+        data: any[];
+    }
+
+    interface axisOptions {
+        show?: bool;            // null or true/false
+        position?: string;      // "bottom" or "top" or "left" or "right"
+
+        color?: any;            // null or color spec
+        tickColor?: any;        // null or color spec
+        font?: any;             // null or font spec object
+
+        min?: number;
+        max?: number;
+        autoscaleMargin?: number;
+
+        transform?: (v: number) => number;              // null or fn: number -> number
+        inverseTransform?: (v: number) => number;       // null or fn: number -> number
+
+        ticks?: any;                                    // null or number or ticks array or (fn: axis -> ticks array)
+        tickSize?: any;                                 // number or array
+        minTickSize?: any;                              // number or array
+        tickFormatter?: (t: number) => string;                            // (fn: number, object -> string) or string
+        tickDecimals?: number;
+
+        labelWidth?: number;
+        labelHeight?: number;
+        reserveSpace?: bool;
+
+        tickLength?: number;
+
+        alignTicksWithAxis?: number;
+    }
+
+    interface seriesTypeBase {
+        show?: bool;
+        lineWidth?: number;
+        fill?: any;              //boolean or number
+        fillColor?: any;         //null or color/gradient
+    }
+
+    interface linesOptions extends seriesTypeBase {
+        steps?: bool;
+    }
+
+    interface barsOptions extends seriesTypeBase {
+        barWidth?: number;
+        align?: string;
+        horizontal?: bool;
+    }
+
+    interface pointsOptions extends seriesTypeBase {
+        radius?: number;
+        symbol?: any;
+    }
+
+    interface gradient {
+        colors: any[];
+    }
+
+    interface item {
+        datapoint: number[];        // the point, e.g. [0, 2]
+        dataIndex: number;          // the index of the point in the data array
+        series: dataSeries;             //the series object
+        seriesIndex: number;        //the index of the series
+        pageX: number;
+        pageY: number;              //the global screen coordinates of the point
+    }
+
+    interface datapoints {
+        points: number[];
+        pointsize: number;
+        format: datapointFormat[];
+    }
+
+    interface datapointFormat {
+        x?: bool;
+        y?: bool;
+        number: bool;
+        required: bool;
+        defaultValue?: number;
+    }
+
+    interface point {
+        x: number;
+        y: number;
+    }
+
+    interface canvasPoint {
+        top: number;
+        left: number;
+        bottom?: number;
+        right?: number;
+    }
+
+    interface axes {
+        xaxis: axis;
+        yaxis: axis;
+        x2axis?: axis;
+        y2axis?: axis;
+    }
+
+    interface axis extends axisOptions {
+        p2c(point):canvasPoint;
+        c2p(canvasPoint):point;
+    }
+
+    interface plot {
+        highlight(series: dataSeries, datapoint: item);
+        unhightlight();
+        unhighlight(series: dataSeries, datapoint: item);
+        setData(data: any);
+        setupGrid();
+        draw();
+        triggerRedrawOverlay();
+        width();
+        height();
+        offset();
+        pointOffset(point: point);
+        resize();
+        shutdown();
+        getData(): dataSeries[];
+        getAxes(): axes;
+        getPlaceholder(): JQuery;
+        getCanvas(): HTMLCanvasElement;
+        getPlotOffset(): canvasPoint;
+        getOptions(): plotOptions;
+    }
+}
+
+interface JQueryStatic {
+    plot(placeholder: JQuery, data: jquery.flot.dataSeries[], options?: jquery.flot.plotOptions): jquery.flot.plot;
+    plot(placeholder: JQuery, data: any[], options?: jquery.flot.plotOptions): jquery.flot.plot;
+}