highcharts-ng.d.ts

// Type definitions for highcharts-ng 0.0.8
// Project: https://github.com/pablojim/highcharts-ng
// Definitions by: Scott Hatcher <https://github.com/scatcher>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference path="../highcharts/highcharts.d.ts" />

interface HighChartsNGConfig {
    options: HighchartsOptions;
    //The below properties are watched separately for changes.

    //Series object (optional) - a list of series using normal highcharts series options.
    series?: HighchartsIndividualSeriesOptions[];
    //Title configuration (optional)
    title?: {
        text?: string;
    };
    //Boolean to control showng loading status on chart (optional)
    //Could be a string if you want to show specific loading text.
    loading?: boolean | string;
    //Configuration for the xAxis (optional). Currently only one x axis can be dynamically controlled.
    //properties currentMin and currentMax provied 2-way binding to the chart's maximimum and minimum
    xAxis?: {
        currentMin?: number;
        currentMax?: number;
        title?: { text?: string }
    };
    //Whether to use HighStocks instead of HighCharts (optional). Defaults to false.
    useHighStocks?: boolean;
    //size (optional) if left out the chart will default to size of the div or something sensible.
    size?: {
        width?: number;
        height?: number;
    };
    //function (optional) - setup some logic for the chart
    func?: (chart: HighchartsChartObject) => void;
}

//Instantiated Chart
interface HighChartsNGChart extends HighChartsNGConfig {
    //This is a simple way to access all the Highcharts API that is not currently managed by this directive.
    getHighcharts(): HighchartsChartObject;
}