kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-04-23 04:49:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fixes to google.visualization type definitions

Browse Source 
Updates type definition for ChartArea and ChartLegend based on the
latest documentation.

Changes the draw overloads to use a union type.

Updates documentation links to the new domain.
This commit is contained in:
Gleb Mazovetskiy
2017-09-08 16:34:15 +01:00
parent ceebd7b2ed
commit bfe50f3146
2 changed files with 73 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
types/google.visualization/google.visualization-tests.ts
View File

@@ -96,7 +96,7 @@ function test_barChart() {
role: "annotation" },
2]);
var options = {
var options: google.visualization.BarChartOptions = {
title: "Density of Precious Metals, in g/cm^3",
width: 600,
height: 400,
@@ -139,7 +139,7 @@ function test_histogram() {
['Ultrasaurus (ultra lizard)', 30.5],
['Velociraptor (swift robber)', 1.8]]);
var options = {
var options: google.visualization.HistogramOptions = {
title: 'Lengths of dinosaurs, in meters',
legend: { position: 'none' }
};

153
types/google.visualization/index.d.ts vendored
View File

@@ -1,6 +1,6 @@
// Type definitions for Google Visualisation Apis
// Project: https://developers.google.com/chart/
// Definitions by: Dan Ludwig <https://github.com/danludwig>, Gregory Moore <https://github.com/gmoore-sjcorg>, Dan Manastireanu <https://github.com/danmana>, Michael Cheng <https://github.com/mlcheng>, Ivan Bisultanov <https://github.com/IvanBisultanov>
// Definitions by: Dan Ludwig <https://github.com/danludwig>, Gregory Moore <https://github.com/gmoore-sjcorg>, Dan Manastireanu <https://github.com/danmana>, Michael Cheng <https://github.com/mlcheng>, Ivan Bisultanov <https://github.com/IvanBisultanov>, Gleb Mazovetskiy <https://github.com/glebm>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare namespace google {
@@ -15,7 +15,7 @@ declare namespace google {
function setOnLoadCallback(handler: Function): void;
}
//https://developers.google.com/chart/interactive/docs/reference
// https://developers.google.com/chart/interactive/docs/reference
namespace visualization {
export interface ChartSpecs {
@@ -291,7 +291,7 @@ declare namespace google {
//#endregion
//#region GeoChart
//https://google-developers.appspot.com/chart/interactive/docs/gallery/geochart
// https://developers.google.com/chart/interactive/docs/gallery/geochart
export class GeoChart extends ChartBase {
draw(data: DataTable, options: GeoChartOptions): void;
}
@@ -306,7 +306,7 @@ declare namespace google {
enableRegionInteractivity?: boolean;
height?: number;
keepAspectRatio?: boolean;
legend?: ChartLegend;
legend?: ChartLegend | 'none';
region?: string;
magnifyingGlass?: GeoChartMagnifyingGlass;
markerOpacity?: number;
@@ -410,23 +410,26 @@ declare namespace google {
}
export interface ChartArea {
top?: any;
left?: any;
right?: any;
bottom?: any;
width?: any;
height?: any;
backgroundColor: string | { stroke: string; strokeWidth?: number };
top?: number | string;
left?: number | string;
right?: number | string;
bottom?: number | string;
width?: number | string;
height?: number | string;
}
export type ChartLegendPosition = 'bottom' | 'left' | 'in' | 'none' | 'right' | 'top';
export type ChartLegendAlignment = 'start' | 'center' | 'end';
export interface ChartLegend {
alignment?: string;
alignment?: ChartLegendAlignment;
maxLines?: number;
position?: string;
position?: ChartLegendPosition;
textStyle?: ChartTextStyle;
numberFormat?: string;
}
// https://google-developers.appspot.com/chart/interactive/docs/animation
// https://developers.google.com/chart/interactive/docs/animation
export interface TransitionAnimation {
duration?: number;
easing?: string; // linear, in, out, inAndOut
@@ -434,7 +437,7 @@ declare namespace google {
}
export interface ChartAxis {
baseline?: number; // This option is only supported for a continuous axis. https://google-developers.appspot.com/chart/interactive/docs/customizing_axes#Terminology
baseline?: number; // This option is only supported for a continuous axis. https://developers.google.com/chart/interactive/docs/customizing_axes#Terminology
baselineColor?: string; // google's documentation on this is wrong, specifies it as a number. The color of the baseline for the horizontal axis. Can be any HTML color string, for example: 'red' or '#00cc00'
direction?: number; // The direction in which the values along the horizontal axis grow. Specify -1 to reverse the order of the values.
format?: string; // icu pattern set http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details
@@ -536,7 +539,7 @@ declare namespace google {
//#endregion
//#region ScatterChart
// https://google-developers.appspot.com/chart/interactive/docs/gallery/scatterchart
// https://developers.google.com/chart/interactive/docs/gallery/scatterchart
export class ScatterChart extends CoreChartBase {
draw(data: DataTable | DataView, options?: ScatterChartOptions): void;
}
@@ -559,7 +562,7 @@ declare namespace google {
forceIFrame?: boolean;
hAxis?: ChartAxis;
height?: number;
legend?: ChartLegend | "none";
legend?: ChartLegend | 'none';
lineWidth?: number;
pointSize?: number;
selectionMode?: string;
@@ -576,13 +579,12 @@ declare namespace google {
//#endregion
//#region ColumnChart
// https://google-developers.appspot.com/chart/interactive/docs/gallery/columnchart
// https://developers.google.com/chart/interactive/docs/gallery/columnchart
export class ColumnChart extends CoreChartBase {
draw(data: DataTable, options: ColumnChartOptions): void;
draw(data: DataView, options: ColumnChartOptions): void;
draw(data: DataTable | DataView, options: ColumnChartOptions): void;
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/columnchart#Configuration_Options
// https://developers.google.com/chart/interactive/docs/gallery/columnchart#Configuration_Options
export interface ColumnChartOptions {
aggregationTarget?: string;
animation?: TransitionAnimation;
@@ -599,7 +601,7 @@ declare namespace google {
hAxis?: ChartAxis;
height?: number;
isStacked?: boolean;
legend?: ChartLegend;
legend?: ChartLegend | 'none';
reverseCategories?: boolean;
selectionMode?: string // single / multiple
series?: any;
@@ -616,13 +618,12 @@ declare namespace google {
//#endregion
//#region LineChart
// https://google-developers.appspot.com/chart/interactive/docs/gallery/linechart
// https://developers.google.com/chart/interactive/docs/gallery/linechart
export class LineChart extends CoreChartBase {
draw(data: DataTable, options: LineChartOptions): void;
draw(data: DataView, options: LineChartOptions): void;
draw(data: DataTable | DataView, options: LineChartOptions): void;
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/linechart#Configuration_Options
// https://developers.google.com/chart/interactive/docs/gallery/linechart#Configuration_Options
export interface LineChartOptions {
aggregationTarget?: string;
animation?: TransitionAnimation;
@@ -642,7 +643,7 @@ declare namespace google {
hAxis?: ChartAxis;
height?: number;
interpolateNulls?: boolean;
legend?: ChartLegend;
legend?: ChartLegend | 'none';
lineWidth?: number;
orientation?: string;
pointSize?: number;
@@ -662,7 +663,7 @@ declare namespace google {
//#endregion
//#region BarChart
// https://google-developers.appspot.com/chart/interactive/docs/gallery/barchart#Configuration_Options
// https://developers.google.com/chart/interactive/docs/gallery/barchart#Configuration_Options
export interface BarChartOptions {
aggregationTarget?: string;
animation?: TransitionAnimation;
@@ -681,7 +682,7 @@ declare namespace google {
hAxis?: ChartAxis;
height?: number;
isStacked?: boolean;
legend?: ChartLegend;
legend?: ChartLegend | 'none';
reverseCategories?: boolean;
series?: any;
theme?: string;
@@ -694,22 +695,20 @@ declare namespace google {
width?: number;
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/barchart
// https://developers.google.com/chart/interactive/docs/gallery/barchart
export class BarChart extends CoreChartBase {
draw(data: DataTable, options: BarChartOptions): void;
draw(data: DataView, options: BarChartOptions): void;
draw(data: DataTable | DataView, options: BarChartOptions): void;
}
//#endregion
//#region Histogram
// https://google-developers.appspot.com/chart/interactive/docs/gallery/histogram
// https://developers.google.com/chart/interactive/docs/gallery/histogram
export class Histogram extends CoreChartBase {
draw(data: DataTable, options: HistogramOptions): void;
draw(data: DataView, options: HistogramOptions): void;
draw(data: DataTable | DataView, options: HistogramOptions): void;
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/histogram#Configuration_Options
// https://developers.google.com/chart/interactive/docs/gallery/histogram#Configuration_Options
export interface HistogramOptions {
animation?: TransitionAnimation;
axisTitlesPosition?: string; // in, out, none
@@ -727,7 +726,7 @@ declare namespace google {
height?: number;
interpolateNulls?: boolean;
isStacked?: boolean;
legend?: ChartLegend;
legend?: ChartLegend | 'none';
orientation?: string;
reverseCategories?: boolean;
series?: any;
@@ -750,13 +749,12 @@ declare namespace google {
//#endregion
//#region AreaChart
// https://google-developers.appspot.com/chart/interactive/docs/gallery/areachart
// https://developers.google.com/chart/interactive/docs/gallery/areachart
export class AreaChart extends CoreChartBase {
draw(data: DataTable, options: AreaChartOptions): void;
draw(data: DataView, options: AreaChartOptions): void;
draw(data: DataTable | DataView, options: AreaChartOptions): void;
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/areachart#Configuration_Options
// https://developers.google.com/chart/interactive/docs/gallery/areachart#Configuration_Options
export interface AreaChartOptions {
aggregationTarget?: string;
animation?: TransitionAnimation;
@@ -777,7 +775,7 @@ declare namespace google {
height?: number;
interpolateNulls?: boolean;
isStacked?: boolean;
legend?: ChartLegend;
legend?: ChartLegend | 'none';
lineWidth?: number;
orientation?: string;
pointSize?: number;
@@ -800,8 +798,7 @@ declare namespace google {
// https://developers.google.com/chart/interactive/docs/gallery/annotationchart
export class AnnotationChart extends CoreChartBase
{
draw(data: DataTable, options: AnnotationChartOptions): void;
draw(data: DataView, options: AnnotationChartOptions): void;
draw(data: DataTable | DataView, options: AnnotationChartOptions): void;
setVisibleChartRange(start: Date, end: Date): void;
getVisibleChartRange(): {start: Date; end: Date };
hideDataColumns(columnIndexes: number | number[]): void;
@@ -825,7 +822,7 @@ declare namespace google {
displayRangeSelector?: boolean;
displayZoomButtons?: boolean;
fill?: number;
legendPosition?: string;
legendPosition?: 'sameRow' | 'newRow';
max?: number;
min?: number;
numberFormats?: any;
@@ -840,13 +837,12 @@ declare namespace google {
//#endregion
//#region SteppedAreaChart
// https://google-developers.appspot.com/chart/interactive/docs/gallery/areachart
// https://developers.google.com/chart/interactive/docs/gallery/areachart
export class SteppedAreaChart extends CoreChartBase {
draw(data: DataTable, options: SteppedAreaChartOptions): void;
draw(data: DataView, options: SteppedAreaChartOptions): void;
draw(data: DataTable | DataView, options: SteppedAreaChartOptions): void;
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/areachart#Configuration_Options
// https://developers.google.com/chart/interactive/docs/gallery/areachart#Configuration_Options
export interface SteppedAreaChartOptions {
aggregationTarget?: string;
animation?: TransitionAnimation;
@@ -864,7 +860,7 @@ declare namespace google {
height?: number;
interpolateNulls?: boolean;
isStacked?: boolean;
legend?: ChartLegend;
legend?: ChartLegend | 'none';
reverseCategories?: boolean;
selectionMode?: string // single / multiple
series?: any;
@@ -881,13 +877,12 @@ declare namespace google {
//#endregion
//#region PieChart
// https://google-developers.appspot.com/chart/interactive/docs/gallery/piechart
// https://developers.google.com/chart/interactive/docs/gallery/piechart
export class PieChart extends CoreChartBase {
draw(data: DataTable, options: PieChartOptions): void;
draw(data: DataView, options: PieChartOptions): void;
draw(data: DataTable | DataView, options: PieChartOptions): void;
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/piechart#Configuration_Options
// https://developers.google.com/chart/interactive/docs/gallery/piechart#Configuration_Options
export interface PieChartOptions {
backgroundColor?: any;
chartArea?: ChartArea;
@@ -897,7 +892,7 @@ declare namespace google {
fontName?: string;
height?: number;
is3D?: boolean;
legend?: ChartLegend;
legend?: ChartLegend | 'none';
pieHole?: number;
pieSliceBorderColor?: string;
pieSliceText?: string;
@@ -917,10 +912,9 @@ declare namespace google {
//#endregion
//#region BubbleChart
// https://google-developers.appspot.com/chart/interactive/docs/gallery/scatterchart
// https://developers.google.com/chart/interactive/docs/gallery/scatterchart
export class BubbleChart extends CoreChartBase {
draw(data: DataTable, options?: BubbleChartOptions): void;
draw(data: DataView, options?: BubbleChartOptions): void;
draw(data: DataTable | DataView, options?: BubbleChartOptions): void;
}
export interface BubbleChartOptions {
@@ -938,7 +932,7 @@ declare namespace google {
forceIFrame?: boolean;
hAxis?: ChartAxis;
height?: number;
legend?: ChartLegend;
legend?: ChartLegend | 'none';
selectionMode?: string;
series?: any;
sizeAxis?: ChartSizeAxis;
@@ -968,15 +962,14 @@ declare namespace google {
//#endregion
//#region TreeMap
// https://google-developers.appspot.com/chart/interactive/docs/gallery/treemap
// https://developers.google.com/chart/interactive/docs/gallery/treemap
export class TreeMap extends ChartBase {
draw(data: DataTable, options?: TreeMapOptions): void;
draw(data: DataView, options?: TreeMapOptions): void;
draw(data: DataTable | DataView, options?: TreeMapOptions): void;
goUpAndDraw(): void;
getMaxPossibleDepth(): number;
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/treemap#Configuration_Options
// https://developers.google.com/chart/interactive/docs/gallery/treemap#Configuration_Options
export interface TreeMapOptions {
fontColor?: string;
fontFamily?: string;
@@ -1007,13 +1000,12 @@ declare namespace google {
//#endregion
//#region Table
// https://google-developers.appspot.com/chart/interactive/docs/gallery/table
// https://developers.google.com/chart/interactive/docs/gallery/table
export class Table extends ChartBase {
draw(data: DataTable, options?: TableOptions): void;
draw(data: DataView, options?: TableOptions): void;
draw(data: DataTable | DataView, options?: TableOptions): void;
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/table#Configuration_Options
// https://developers.google.com/chart/interactive/docs/gallery/table#Configuration_Options
export interface TableOptions {
allowHtml?: boolean;
alternatingRowStyle?: boolean;
@@ -1046,15 +1038,14 @@ declare namespace google {
//#endregion
//#region Timeline
// https://google-developers.appspot.com/chart/interactive/docs/gallery/timeline
// https://developers.google.com/chart/interactive/docs/gallery/timeline
export class Timeline {
constructor(element: Element);
draw(data: DataTable, options?: TimelineOptions): void;
draw(data: DataView, options?: TimelineOptions): void;
draw(data: DataTable | DataView, options?: TimelineOptions): void;
clearChart(): void;
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/timeline#Configuration_Options
// https://developers.google.com/chart/interactive/docs/gallery/timeline#Configuration_Options
export interface TimelineOptions {
avoidOverlappingGridLines?: boolean;
backgroundColor?: any;
@@ -1082,12 +1073,12 @@ declare namespace google {
//#endregion
//#region CandlestickChart
// https://google-developers.appspot.com/chart/interactive/docs/gallery/candlestickchart
// https://developers.google.com/chart/interactive/docs/gallery/candlestickchart
export class CandlestickChart extends CoreChartBase {
draw(data: DataTable | DataView, options: CandlestickChartOptions): void;
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/candlestickchart#Configuration_Options
// https://developers.google.com/chart/interactive/docs/gallery/candlestickchart#Configuration_Options
export interface CandlestickChartOptions {
aggregationTarget?: string;
animation?: TransitionAnimation;
@@ -1103,7 +1094,7 @@ declare namespace google {
fontName?: string;
hAxis?: ChartAxis;
height?: number;
legend?: ChartLegend | "none";
legend?: ChartLegend | 'none';
orientation?: string;
reverseCategories?: boolean;
selectionMode?: string // single / multiple
@@ -1121,13 +1112,12 @@ declare namespace google {
//#endregion
//#region ComboChart
// https://google-developers.appspot.com/chart/interactive/docs/gallery/combochart
// https://developers.google.com/chart/interactive/docs/gallery/combochart
export class ComboChart extends CoreChartBase {
draw(data: DataTable, options: ComboChartOptions): void;
draw(data: DataView, options: ComboChartOptions): void;
draw(data: DataTable | DataView, options: ComboChartOptions): void;
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/combochart#configuration-options
// https://developers.google.com/chart/interactive/docs/gallery/combochart#configuration-options
export interface ComboChartOptions {
aggregationTarget?: string;
animation?: TransitionAnimation;
@@ -1151,7 +1141,7 @@ declare namespace google {
height?: number;
interpolateNulls?: boolean;
isStacked?: boolean;
legend?: ChartLegend;
legend?: ChartLegend | 'none';
lineDashStyle?: number[];
lineWidth?: number;
orientation?: string;
@@ -1383,16 +1373,15 @@ declare namespace google {
//#endregion
//#region OrgChart
// https://google-developers.appspot.com/chart/interactive/docs/gallery/orgchart
// https://developers.google.com/chart/interactive/docs/gallery/orgchart
export class OrgChart extends CoreChartBase {
draw(data: DataTable, options: OrgChartOptions): void;
draw(data: DataView, options: OrgChartOptions): void;
draw(data: DataTable | DataView, options: OrgChartOptions): void;
collapse(row: number, collapsed: boolean): void;
getChildrenIndexes(row: number): number[];
getCollapsedNodes(): number[];
}
// https://google-developers.appspot.com/chart/interactive/docs/gallery/orgchart#Configuration_Options
// https://developers.google.com/chart/interactive/docs/gallery/orgchart#Configuration_Options
export interface OrgChartOptions {
allowCollapse?: boolean;
allowHtml?: boolean;