Data tables hold the data for all chart types. * * @returns A DataTableBuilder, which can hold data for charts. */ function newDataTable(): DataTableBuilder /** * Creates a new data view definition. * *
Use setters to define the different properties of the data view. * * @returns A DataViewDefinitionBuilder, which can be used to build a data view definition. */ function newDataViewDefinition(): Charts.DataViewDefinitionBuilder /** * Starts building a line chart, as described in the Google Chart * Tools documentation. * * @returns A LineChartBuilder, which can be used to build a line chart. */ function newLineChart(): Charts.LineChartBuilder /** * Starts building a pie chart, as described in the Google Chart * Tools documentation. * * @returns A PieChartBuilder, which can be used to build a pie chart. */ function newPieChart(): Charts.PieChartBuilder /** * Starts building a scatter chart, as described in the Google Chart * Tools documentation. * * @returns A ScatterChartBuilder, which can be used to build a scatter chart. */ function newScatterChart(): Charts.ScatterChartBuilder /** * Starts building a table chart, as described in the Google Chart * Tools documentation. * * @returns A TableChartBuilder, which can be used to build a table chart. */ function newTableChart(): Charts.TableChartBuilder /** * Creates a new text style builder. * *
To change the default values, use the setter functions. * * @returns A TextStyleBuilder, which can be used to build a text style configuration object. */ function newTextStyle(): Charts.TextStyleBuilder class AreaChartBuilder { private constructor(); /** * Builds the chart. * * @returns A Chart object, which can be embedded into documents, UI elements, or used as a static * image. */ build(): Charts.Chart /** * Reverses the drawing of series in the domain axis. For vertical-range charts (such as line, * area or column charts), this means the horizontal axis is drawn from right to left. For * horizontal-range charts (such as bar charts), this means the vertical axis is drawn from top to * bottom. For pie charts, this means the slices are drawn counterclockwise. * *
* // Creates a pie chart builder and sets drawing of the slices in a counter-clockwise manner.
* var builder = Charts.newPieChart();
* builder.reverseCategories();
*
* // Creates a line chart builder and sets the background color to gray
* var builder = Charts.newLineChart();
* builder.setBackgroundColor("gray");
* "blue" or "#00f").
*
* @returns This builder, useful for chaining.
*/
setBackgroundColor(
cssValue: string
): Charts.AreaChartBuilder
/**
* Sets the colors for the lines in the chart.
*
*
* // Creates a line chart builder and sets the first two lines to be drawn in green and red,
* // respectively.
* var builder = Charts.newLineChart();
* builder.setColors(["green", "red"]);
* ["red", "#acf"]. The nth element
* in the array represents the color of the nth line in the chart.
*
* @returns This builder, useful for chaining.
*/
setColors(
cssValues: string[]
): Charts.AreaChartBuilder
/**
* Sets the data source URL that is used to pull data in from an external source, such as Google
* Sheets. If a data source URL and a DataTable are provided, the data source URL is ignored.
*
* For more information about querying data sources, check out the Google Charts documentation.
*
* @param url - The data source URL, including any query parameters.
*
* @returns This builder, useful for chaining.
*/
setDataSourceUrl(
url: string
): Charts.AreaChartBuilder
/**
* Sets the data table to use for the chart using a DataTableBuilder. This is a convenience method
* for setting the data table without needing to call build().
*
* @param tableBuilder - A data table builder. A new data table is created instantly as part of this
* call, so any further updates to the builder won't be reflected in the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
tableBuilder: DataTableBuilder
): Charts.AreaChartBuilder
/**
* Sets the data table which contains the lines for the chart, as well as the X-axis labels. The
* first column should be a string, and contain the horizontal axis labels. Any number of columns
* can follow, all must be numeric. Each column is displayed as a separate line.
*
* @param table - The data table to use for the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
table: DataTableSource
): Charts.AreaChartBuilder
/**
* Sets the data view definition to use for the chart.
*
* @param dataViewDefinition - A data view definition object that defines the view that should be
* derived from the given data source for the chart drawing.
*
* @returns This builder, useful for chaining.
*/
setDataViewDefinition(
dataViewDefinition: Charts.DataViewDefinition
): Charts.AreaChartBuilder
/**
* Sets the dimensions for the chart.
*
* @param width - The width of the chart, in pixels.
* @param height - The height of the chart, in pixels.
*
* @returns This builder, useful for chaining.
*/
setDimensions(
width: number,
height: number
): Charts.AreaChartBuilder
/**
* Sets the position of the legend with respect to the chart. By default, there is no legend.
*
*
* // Creates a line chart builder and sets the legend position to right.
* var builder = Charts.newLineChart();
* builder.setLegendPosition(Charts.Position.RIGHT);
*
* // Creates a line chart builder and sets it up for a blue, 26-point legend.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
* var builder = Charts.newLineChart();
* builder.setLegendTextStyle(style);
*
* // Build an area chart with a 1-second animation duration.
* var builder = Charts.newAreaChart();
* builder.setOption('animation.duration', 1000);
* var chart = builder.build();
*
* // Creates a line chart builder and sets large point style.
* var builder = Charts.newLineChart();
* builder.setPointStyle(Charts.PointStyle.LARGE);
* If any data points fall outside the range, the range is expanded to include those data * points. * * @param start - The value for the lowest grid line of the range axis. * @param end - The value for the highest grid line of the range axis. * * @returns This builder, useful for chaining. */ setRange( start: Number, end: Number ): Charts.AreaChartBuilder /** * Uses stacked lines, meaning that line and bar values are stacked (accumulated). By default, * there is no stacking. * * @returns This builder, useful for chaining. */ setStacked(): Charts.AreaChartBuilder /** * Sets the title of the chart. The title is displayed centered above the chart. * *
* // Creates a line chart builder and title to 'My Line Chart'.
* var builder = Charts.newLineChart();
* builder.setTitle('My Line Chart')
*
* // Creates a line chart builder and sets it up for a blue, 26-point title.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
* var builder = Charts.newLineChart();
* builder.setTitleTextStyle(style);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.AreaChartBuilder
/**
* Sets the horizontal axis text style.
*
*
* // Creates a line chart builder and sets the X-axis text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setXAxisTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setXAxisTextStyle(
textStyle: Charts.TextStyle
): Charts.AreaChartBuilder
/**
* Adds a title to the horizontal axis. The title is centered and appears below the axis value
* labels.
*
*
* // Creates a line chart builder and sets the X-axis title.
* var builder = Charts.newLineChart();
* builder.setTitle('X-axis Title')
*
* // Creates a line chart builder and sets the X-axis title text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setXAxisTitleTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setXAxisTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.AreaChartBuilder
/**
* Sets the vertical axis text style.
*
*
* // Creates a line chart builder and sets the Y-axis text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setYAxisTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setYAxisTextStyle(
textStyle: Charts.TextStyle
): Charts.AreaChartBuilder
/**
* Adds a title to the vertical axis. The title is centered and appears to the left of the value
* labels.
*
*
* // Creates a line chart builder and sets the Y-axis title.
* var builder = Charts.newLineChart();
* builder.setYAxisTitle('Y-axis Title')
*
* // Creates a line chart builder and sets the Y-axis title text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setYAxisTitleTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setYAxisTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.AreaChartBuilder
/**
* Makes the range axis into a logarithmic scale (requires all values to be positive). The range
* axis are the vertical axis for vertical charts (such as line, area, or column) and the
* horizontal axis for horizontal charts (such as bar).
*
* @returns This builder, useful for chaining.
*/
useLogScale(): Charts.AreaChartBuilder
}
class BarChartBuilder {
private constructor();
/**
* Builds the chart.
*
* @returns A Chart object, which can be embedded into documents, UI elements, or used as a static
* image.
*/
build(): Charts.Chart
/**
* Reverses the drawing of series in the domain axis. For vertical-range charts (such as line,
* area or column charts), this means the horizontal axis is drawn from right to left. For
* horizontal-range charts (such as bar charts), this means the vertical axis is drawn from top to
* bottom. For pie charts, this means the slices are drawn counterclockwise.
*
*
* // Creates a pie chart builder and sets drawing of the slices in a counter-clockwise manner.
* var builder = Charts.newPieChart();
* builder.reverseCategories();
*
* // Creates a line chart builder and sets the background color to gray
* var builder = Charts.newLineChart();
* builder.setBackgroundColor("gray");
* "blue" or "#00f").
*
* @returns This builder, useful for chaining.
*/
setBackgroundColor(
cssValue: string
): Charts.BarChartBuilder
/**
* Sets the colors for the lines in the chart.
*
*
* // Creates a line chart builder and sets the first two lines to be drawn in green and red,
* // respectively.
* var builder = Charts.newLineChart();
* builder.setColors(["green", "red"]);
* ["red", "#acf"]. The nth element
* in the array represents the color of the nth line in the chart.
*
* @returns This builder, useful for chaining.
*/
setColors(
cssValues: string[]
): Charts.BarChartBuilder
/**
* Sets the data source URL that is used to pull data in from an external source, such as Google
* Sheets. If a data source URL and a DataTable are provided, the data source URL is ignored.
*
* For more information about querying data sources, check out the Google Charts documentation.
*
* @param url - The data source URL, including any query parameters.
*
* @returns This builder, useful for chaining.
*/
setDataSourceUrl(
url: string
): Charts.BarChartBuilder
/**
* Sets the data table to use for the chart using a DataTableBuilder. This is a convenience method
* for setting the data table without needing to call build().
*
* @param tableBuilder - A data table builder. A new data table is created instantly as part of this
* call, so any further updates to the builder won't be reflected in the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
tableBuilder: DataTableBuilder
): Charts.BarChartBuilder
/**
* Sets the data table which contains the lines for the chart, as well as the X-axis labels. The
* first column should be a string, and contain the horizontal axis labels. Any number of columns
* can follow, all must be numeric. Each column is displayed as a separate line.
*
* @param table - The data table to use for the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
table: DataTableSource
): Charts.BarChartBuilder
/**
* Sets the data view definition to use for the chart.
*
* @param dataViewDefinition - A data view definition object that defines the view that should be
* derived from the given data source for the chart drawing.
*
* @returns This builder, useful for chaining.
*/
setDataViewDefinition(
dataViewDefinition: Charts.DataViewDefinition
): Charts.BarChartBuilder
/**
* Sets the dimensions for the chart.
*
* @param width - The width of the chart, in pixels.
* @param height - The height of the chart, in pixels.
*
* @returns This builder, useful for chaining.
*/
setDimensions(
width: number,
height: number
): Charts.BarChartBuilder
/**
* Sets the position of the legend with respect to the chart. By default, there is no legend.
*
*
* // Creates a line chart builder and sets the legend position to right.
* var builder = Charts.newLineChart();
* builder.setLegendPosition(Charts.Position.RIGHT);
*
* // Creates a line chart builder and sets it up for a blue, 26-point legend.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
* var builder = Charts.newLineChart();
* builder.setLegendTextStyle(style);
*
* // Build a bar chart with a 1-second animation duration.
* var builder = Charts.newBarChart();
* builder.setOption('animation.duration', 1000);
* var chart = builder.build();
* If any data points fall outside the range, the range is expanded to include those data * points. * * @param start - The value for the lowest grid line of the range axis. * @param end - The value for the highest grid line of the range axis. * * @returns This builder, useful for chaining. */ setRange( start: Number, end: Number ): Charts.BarChartBuilder /** * Uses stacked lines, meaning that line and bar values are stacked (accumulated). By default, * there is no stacking. * * @returns This builder, useful for chaining. */ setStacked(): Charts.BarChartBuilder /** * Sets the title of the chart. The title is displayed centered above the chart. * *
* // Creates a line chart builder and title to 'My Line Chart'.
* var builder = Charts.newLineChart();
* builder.setTitle('My Line Chart')
*
* // Creates a line chart builder and sets it up for a blue, 26-point title.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
* var builder = Charts.newLineChart();
* builder.setTitleTextStyle(style);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.BarChartBuilder
/**
* Sets the horizontal axis text style.
*
*
* // Creates a line chart builder and sets the X-axis text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setXAxisTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setXAxisTextStyle(
textStyle: Charts.TextStyle
): Charts.BarChartBuilder
/**
* Adds a title to the horizontal axis. The title is centered and appears below the axis value
* labels.
*
*
* // Creates a line chart builder and sets the X-axis title.
* var builder = Charts.newLineChart();
* builder.setTitle('X-axis Title')
*
* // Creates a line chart builder and sets the X-axis title text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setXAxisTitleTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setXAxisTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.BarChartBuilder
/**
* Sets the vertical axis text style.
*
*
* // Creates a line chart builder and sets the Y-axis text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setYAxisTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setYAxisTextStyle(
textStyle: Charts.TextStyle
): Charts.BarChartBuilder
/**
* Adds a title to the vertical axis. The title is centered and appears to the left of the value
* labels.
*
*
* // Creates a line chart builder and sets the Y-axis title.
* var builder = Charts.newLineChart();
* builder.setYAxisTitle('Y-axis Title')
*
* // Creates a line chart builder and sets the Y-axis title text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setYAxisTitleTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setYAxisTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.BarChartBuilder
/**
* Makes the range axis into a logarithmic scale (requires all values to be positive). The range
* axis are the vertical axis for vertical charts (such as line, area, or column) and the
* horizontal axis for horizontal charts (such as bar).
*
* @returns This builder, useful for chaining.
*/
useLogScale(): Charts.BarChartBuilder
}
class Chart {
private constructor();
/**
* Return the data inside this object as a blob converted to the specified content type. This
* method adds the appropriate extension to the filename—for example, "myfile.pdf". However, it
* assumes that the part of the filename that follows the last period (if any) is an existing
* extension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes
* "ShoppingList.12.25.pdf".
*
* To view the daily quotas for conversions, see Quotas for Google
* Services. Newly created G Suite domains might be temporarily subject to stricter quotas.
*
* @param contentType - The MIME type to convert to. For most blobs, 'application/pdf' is
* the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of 'image/bmp', 'image/gif', 'image/jpeg', or 'image/png' are also
* valid.
*
* @returns The data as a blob.
*/
getAs(
contentType: string
): Blob
/**
* Return the data inside this object as a blob.
*
* @returns The data as a blob.
*/
getBlob(): Blob
/**
* Returns the options for this chart, such as height, colors, and axes.
*
*
The returned options are immutable.
*
* @returns The options for this chart, such as height, colors, and axes.
*/
getOptions(): Charts.ChartOptions
}
enum ChartHiddenDimensionStrategy {
/**
* Default; charts skips any hidden columns and hidden rows.
*/
IGNORE_BOTH = "IGNORE_BOTH",
/**
* Charts skips hidden columns only.
*/
IGNORE_COLUMNS = "IGNORE_COLUMNS",
/**
* Charts skips hidden rows only.
*/
IGNORE_ROWS = "IGNORE_ROWS",
/**
* Charts does not skip hidden columns or hidden rows.
*/
SHOW_BOTH = "SHOW_BOTH",
}
enum ChartMergeStrategy {
/**
* Default. Charts merges the columns of multiple ranges.
*/
MERGE_COLUMNS = "MERGE_COLUMNS",
/**
* Charts merges the rows of multiple ranges.
*/
MERGE_ROWS = "MERGE_ROWS",
}
class ChartOptions {
private constructor();
/**
* Returns a configured option for this chart.
*
* @param option - The string representing the desired option.
*
* @returns The value currently set for the specified option or null if the option was not
* set.
*/
get(
option: string
): object
/**
* Returns a configured option for this chart. If the chart option is not set, returns the default
* value of this option if available, or returns null if the default value is not
* available.
*
* @param option - The string representing the desired option.
*
* @returns The value currently set for the specified option. If the option was not set and the
* default value is available, returns the default value.
*/
getOrDefault(
option: string
): object
}
enum ChartType {
/**
* Area chart
*/
AREA = "AREA",
/**
* Bar chart
*/
BAR = "BAR",
/**
* Bubble chart.
*/
BUBBLE = "BUBBLE",
/**
* Candlestick chart.
*/
CANDLESTICK = "CANDLESTICK",
/**
* Column chart
*/
COLUMN = "COLUMN",
/**
* Combo chart
*/
COMBO = "COMBO",
/**
* Gauge chart.
*/
GAUGE = "GAUGE",
/**
* Geo chart.
*/
GEO = "GEO",
/**
* Histogram
*/
HISTOGRAM = "HISTOGRAM",
/**
* Line chart
*/
LINE = "LINE",
/**
* Org chart.
*/
ORG = "ORG",
/**
* Pie chart
*/
PIE = "PIE",
/**
* Radar chart.
*/
RADAR = "RADAR",
/**
* Scatter chart
*/
SCATTER = "SCATTER",
/**
* Sparkline chart.
*/
SPARKLINE = "SPARKLINE",
/**
* Stepped area chart.
*/
STEPPED_AREA = "STEPPED_AREA",
/**
* Table chart
*/
TABLE = "TABLE",
/**
* Timeline chart.
*/
TIMELINE = "TIMELINE",
/**
* Treemap chart.
*/
TREEMAP = "TREEMAP",
/**
* Waterfall chart.
*/
WATERFALL = "WATERFALL",
}
class ColumnChartBuilder {
private constructor();
/**
* Builds the chart.
*
* @returns A Chart object, which can be embedded into documents, UI elements, or used as a static
* image.
*/
build(): Charts.Chart
/**
* Reverses the drawing of series in the domain axis. For vertical-range charts (such as line,
* area or column charts), this means the horizontal axis is drawn from right to left. For
* horizontal-range charts (such as bar charts), this means the vertical axis is drawn from top to
* bottom. For pie charts, this means the slices are drawn counterclockwise.
*
*
* // Creates a pie chart builder and sets drawing of the slices in a counter-clockwise manner.
* var builder = Charts.newPieChart();
* builder.reverseCategories();
*
* // Creates a line chart builder and sets the background color to gray
* var builder = Charts.newLineChart();
* builder.setBackgroundColor("gray");
* "blue" or "#00f").
*
* @returns This builder, useful for chaining.
*/
setBackgroundColor(
cssValue: string
): Charts.ColumnChartBuilder
/**
* Sets the colors for the lines in the chart.
*
*
* // Creates a line chart builder and sets the first two lines to be drawn in green and red,
* // respectively.
* var builder = Charts.newLineChart();
* builder.setColors(["green", "red"]);
* ["red", "#acf"]. The nth element
* in the array represents the color of the nth line in the chart.
*
* @returns This builder, useful for chaining.
*/
setColors(
cssValues: string[]
): Charts.ColumnChartBuilder
/**
* Sets the data source URL that is used to pull data in from an external source, such as Google
* Sheets. If a data source URL and a DataTable are provided, the data source URL is ignored.
*
* For more information about querying data sources, check out the Google Charts documentation.
*
* @param url - The data source URL, including any query parameters.
*
* @returns This builder, useful for chaining.
*/
setDataSourceUrl(
url: string
): Charts.ColumnChartBuilder
/**
* Sets the data table to use for the chart using a DataTableBuilder. This is a convenience method
* for setting the data table without needing to call build().
*
* @param tableBuilder - A data table builder. A new data table is created instantly as part of this
* call, so any further updates to the builder won't be reflected in the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
tableBuilder: DataTableBuilder
): Charts.ColumnChartBuilder
/**
* Sets the data table which contains the lines for the chart, as well as the X-axis labels. The
* first column should be a string, and contain the horizontal axis labels. Any number of columns
* can follow, all must be numeric. Each column is displayed as a separate line.
*
* @param table - The data table to use for the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
table: DataTableSource
): Charts.ColumnChartBuilder
/**
* Sets the data view definition to use for the chart.
*
* @param dataViewDefinition - A data view definition object that defines the view that should be
* derived from the given data source for the chart drawing.
*
* @returns This builder, useful for chaining.
*/
setDataViewDefinition(
dataViewDefinition: Charts.DataViewDefinition
): Charts.ColumnChartBuilder
/**
* Sets the dimensions for the chart.
*
* @param width - The width of the chart, in pixels.
* @param height - The height of the chart, in pixels.
*
* @returns This builder, useful for chaining.
*/
setDimensions(
width: number,
height: number
): Charts.ColumnChartBuilder
/**
* Sets the position of the legend with respect to the chart. By default, there is no legend.
*
*
* // Creates a line chart builder and sets the legend position to right.
* var builder = Charts.newLineChart();
* builder.setLegendPosition(Charts.Position.RIGHT);
*
* // Creates a line chart builder and sets it up for a blue, 26-point legend.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
* var builder = Charts.newLineChart();
* builder.setLegendTextStyle(style);
*
* // Build a column chart with a 1-second animation duration.
* var builder = Charts.newColumnChart();
* builder.setOption('animation.duration', 1000);
* var chart = builder.build();
* If any data points fall outside the range, the range is expanded to include those data * points. * * @param start - The value for the lowest grid line of the range axis. * @param end - The value for the highest grid line of the range axis. * * @returns This builder, useful for chaining. */ setRange( start: Number, end: Number ): Charts.ColumnChartBuilder /** * Uses stacked lines, meaning that line and bar values are stacked (accumulated). By default, * there is no stacking. * * @returns This builder, useful for chaining. */ setStacked(): Charts.ColumnChartBuilder /** * Sets the title of the chart. The title is displayed centered above the chart. * *
* // Creates a line chart builder and title to 'My Line Chart'.
* var builder = Charts.newLineChart();
* builder.setTitle('My Line Chart')
*
* // Creates a line chart builder and sets it up for a blue, 26-point title.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
* var builder = Charts.newLineChart();
* builder.setTitleTextStyle(style);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.ColumnChartBuilder
/**
* Sets the horizontal axis text style.
*
*
* // Creates a line chart builder and sets the X-axis text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setXAxisTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setXAxisTextStyle(
textStyle: Charts.TextStyle
): Charts.ColumnChartBuilder
/**
* Adds a title to the horizontal axis. The title is centered and appears below the axis value
* labels.
*
*
* // Creates a line chart builder and sets the X-axis title.
* var builder = Charts.newLineChart();
* builder.setTitle('X-axis Title')
*
* // Creates a line chart builder and sets the X-axis title text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setXAxisTitleTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setXAxisTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.ColumnChartBuilder
/**
* Sets the vertical axis text style.
*
*
* // Creates a line chart builder and sets the Y-axis text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setYAxisTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setYAxisTextStyle(
textStyle: Charts.TextStyle
): Charts.ColumnChartBuilder
/**
* Adds a title to the vertical axis. The title is centered and appears to the left of the value
* labels.
*
*
* // Creates a line chart builder and sets the Y-axis title.
* var builder = Charts.newLineChart();
* builder.setYAxisTitle('Y-axis Title')
*
* // Creates a line chart builder and sets the Y-axis title text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setYAxisTitleTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setYAxisTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.ColumnChartBuilder
/**
* Makes the range axis into a logarithmic scale (requires all values to be positive). The range
* axis are the vertical axis for vertical charts (such as line, area, or column) and the
* horizontal axis for horizontal charts (such as bar).
*
* @returns This builder, useful for chaining.
*/
useLogScale(): Charts.ColumnChartBuilder
}
enum CurveStyle {
/**
* Straight lines without curve.
*/
NORMAL = "NORMAL",
/**
* The angles of the line are smoothed.
*/
SMOOTH = "SMOOTH",
}
class DataViewDefinition {
private constructor();
}
class DataViewDefinitionBuilder {
private constructor();
/**
* Builds and returns the data view definition object that was built using this builder.
*
* @returns A data view definition object that was built using this builder.
*/
build(): Charts.DataViewDefinition
/**
* Sets the indexes of the columns to include in the data view as well as specifying role-column
* information. This subset of column indexes refer to the columns of the data source that the
* data view is derived from.
*
* A column role describes the purpose of the data in that column: for example, a column might * hold data describing tooltip text, data point annotations, or uncertainty indicators. For more * details, see DataTable Roles in the Google Charts * documentation. * *
Assuming a spreadsheet with the following data in A1:C3: * *
* "abc", 20, "blue"
* "def", 30, "red"
* "ghi", 40, "orange"
*
* var COLUMN_SPEC = [
* 0, // categories
* 1, // counts
* {sourceColumn: 2, role: 'style'}
* ];
*
* function roleColumnChart() {
* var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
* var sheet = spreadsheet.getActiveSheet();
* var viewSpec = Charts.newDataViewDefinition()
* .setColumns(COLUMN_SPEC)
* .build();
* var chartBuilder = sheet.newChart()
* .setChartType(Charts.ChartType.BAR)
* .setDataViewDefinition(viewSpec)
* .setOption('useFirstColumnAsDomain', true)
* .setPosition(5, 1, 0, 0)
* .setOption('hAxis', { title: 'Counts' })
* .setOption('vAxis', { title: 'Categories' })
* .addRange(sheet.getRange('A1:C3'));
* sheet.insertChart(chartBuilder.build());
* };
*
* // Creates a pie chart builder and sets drawing of the slices in a counter-clockwise manner.
* var builder = Charts.newPieChart();
* builder.reverseCategories();
*
* // Creates a line chart builder and sets the background color to gray
* var builder = Charts.newLineChart();
* builder.setBackgroundColor("gray");
* "blue" or "#00f").
*
* @returns This builder, useful for chaining.
*/
setBackgroundColor(
cssValue: string
): Charts.LineChartBuilder
/**
* Sets the colors for the lines in the chart.
*
*
* // Creates a line chart builder and sets the first two lines to be drawn in green and red,
* // respectively.
* var builder = Charts.newLineChart();
* builder.setColors(["green", "red"]);
* ["red", "#acf"]. The nth element
* in the array represents the color of the nth line in the chart.
*
* @returns This builder, useful for chaining.
*/
setColors(
cssValues: string[]
): Charts.LineChartBuilder
/**
* Sets the style to use for curves in the chart. See CurveStyle for allowed curve
* styles.
*
*
* // Creates a line chart builder and curves the lines in the chart.
* var builder = Charts.newLineChart();
* builder.setCurveStyle(Charts.CurveStyle.SMOOTH)
* For more information about querying data sources, check out the Google Charts documentation.
*
* @param url - The data source URL, including any query parameters.
*
* @returns This builder, useful for chaining.
*/
setDataSourceUrl(
url: string
): Charts.LineChartBuilder
/**
* Sets the data table to use for the chart using a DataTableBuilder. This is a convenience method
* for setting the data table without needing to call build().
*
* @param tableBuilder - A data table builder. A new data table is created instantly as part of this
* call, so any further updates to the builder won't be reflected in the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
tableBuilder: DataTableBuilder
): Charts.LineChartBuilder
/**
* Sets the data table which contains the lines for the chart, as well as the X-axis labels. The
* first column should be a string, and contain the horizontal axis labels. Any number of columns
* can follow, all must be numeric. Each column is displayed as a separate line.
*
* @param table - The data table to use for the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
table: DataTableSource
): Charts.LineChartBuilder
/**
* Sets the data view definition to use for the chart.
*
* @param dataViewDefinition - A data view definition object that defines the view that should be
* derived from the given data source for the chart drawing.
*
* @returns This builder, useful for chaining.
*/
setDataViewDefinition(
dataViewDefinition: Charts.DataViewDefinition
): Charts.LineChartBuilder
/**
* Sets the dimensions for the chart.
*
* @param width - The width of the chart, in pixels.
* @param height - The height of the chart, in pixels.
*
* @returns This builder, useful for chaining.
*/
setDimensions(
width: number,
height: number
): Charts.LineChartBuilder
/**
* Sets the position of the legend with respect to the chart. By default, there is no legend.
*
*
* // Creates a line chart builder and sets the legend position to right.
* var builder = Charts.newLineChart();
* builder.setLegendPosition(Charts.Position.RIGHT);
*
* // Creates a line chart builder and sets it up for a blue, 26-point legend.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
* var builder = Charts.newLineChart();
* builder.setLegendTextStyle(style);
*
* // Build a line chart with a 1-second animation duration.
* var builder = Charts.newLineChart();
* builder.setOption('animation.duration', 1000);
* var chart = builder.build();
*
* // Creates a line chart builder and sets large point style.
* var builder = Charts.newLineChart();
* builder.setPointStyle(Charts.PointStyle.LARGE);
* If any data points fall outside the range, the range is expanded to include those data * points. * * @param start - The value for the lowest grid line of the range axis. * @param end - The value for the highest grid line of the range axis. * * @returns This builder, useful for chaining. */ setRange( start: Number, end: Number ): Charts.LineChartBuilder /** * Sets the title of the chart. The title is displayed centered above the chart. * *
* // Creates a line chart builder and title to 'My Line Chart'.
* var builder = Charts.newLineChart();
* builder.setTitle('My Line Chart')
*
* // Creates a line chart builder and sets it up for a blue, 26-point title.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
* var builder = Charts.newLineChart();
* builder.setTitleTextStyle(style);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.LineChartBuilder
/**
* Sets the horizontal axis text style.
*
*
* // Creates a line chart builder and sets the X-axis text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setXAxisTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setXAxisTextStyle(
textStyle: Charts.TextStyle
): Charts.LineChartBuilder
/**
* Adds a title to the horizontal axis. The title is centered and appears below the axis value
* labels.
*
*
* // Creates a line chart builder and sets the X-axis title.
* var builder = Charts.newLineChart();
* builder.setTitle('X-axis Title')
*
* // Creates a line chart builder and sets the X-axis title text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setXAxisTitleTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setXAxisTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.LineChartBuilder
/**
* Sets the vertical axis text style.
*
*
* // Creates a line chart builder and sets the Y-axis text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setYAxisTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setYAxisTextStyle(
textStyle: Charts.TextStyle
): Charts.LineChartBuilder
/**
* Adds a title to the vertical axis. The title is centered and appears to the left of the value
* labels.
*
*
* // Creates a line chart builder and sets the Y-axis title.
* var builder = Charts.newLineChart();
* builder.setYAxisTitle('Y-axis Title')
*
* // Creates a line chart builder and sets the Y-axis title text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setYAxisTitleTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setYAxisTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.LineChartBuilder
/**
* Makes the range axis into a logarithmic scale (requires all values to be positive). The range
* axis are the vertical axis for vertical charts (such as line, area, or column) and the
* horizontal axis for horizontal charts (such as bar).
*
* @returns This builder, useful for chaining.
*/
useLogScale(): Charts.LineChartBuilder
}
class MatchType {
private constructor();
/**
* Match any substring
*/
static ANY: Charts.MatchType;
/**
* Match exact values only
*/
static EXACT: Charts.MatchType;
/**
* Match prefixes starting from the beginning of the value
*/
static PREFIX: Charts.MatchType;
/**
* Returns the name of the match type to be used in the options JSON.
*
* @returns The name of the type.
*/
getName(): string
}
class NumberRangeFilterBuilder {
private constructor();
/**
* Sets the maximum allowed value for the range lower extent. If undefined, the value is inferred
* from the contents of the DataTable managed by the control.
*
*
* // Builds a number range filter and sets the maximum value to 100.
* var numberRangeFilter = Charts.newNumberRangeFilter()
* .setFilterColumnLabel("Col2")
* .setMaxValue(100)
* .build();
*
* // Builds a number range filter and sets the minimum value to 10.
* var numberRangeFilter = Charts.newNumberRangeFilter()
* .setFilterColumnLabel("Col2")
* .setMinValue(10)
* .build();
*
* // Builds a number range filter and sets it to have a horizontal orientation.
* var numberRangeFilter = Charts.newNumberRangeFilter()
* .setFilterColumnLabel("Col2")
* .setOrientation(Charts.Orientation.HORIZONTAL)
* .build();
*
* // Builds a number range filter and enables showing of the number range values.
* var numberRangeFilter = Charts.newNumberRangeFilter()
* .setFilterColumnLabel("Col2")
* .setShowRangeValues(true)
* .build();
* true, enables showing of labels next to the slider.
*
* @returns This builder, useful for chaining.
*/
setShowRangeValues(
showRangeValues: Boolean
): Charts.NumberRangeFilterBuilder
/**
* Sets the number of ticks (fixed positions in a range bar) a number range filter slider thumbs
* can fall in.
*
*
* // Builds a number range filter and sets the number of ticks for the range to 10.
* var numberRangeFilter = Charts.newNumberRangeFilter()
* .setFilterColumnLabel("Col2")
* .setTicks(10)
* .build();
*
* // Creates a pie chart builder and sets drawing of the slices in a counter-clockwise manner.
* var builder = Charts.newPieChart();
* builder.reverseCategories();
*
* // Creates a line chart builder and sets the background color to gray
* var builder = Charts.newLineChart();
* builder.setBackgroundColor("gray");
* "blue" or "#00f").
*
* @returns This builder, useful for chaining.
*/
setBackgroundColor(
cssValue: string
): Charts.PieChartBuilder
/**
* Sets the colors for the lines in the chart.
*
*
* // Creates a line chart builder and sets the first two lines to be drawn in green and red,
* // respectively.
* var builder = Charts.newLineChart();
* builder.setColors(["green", "red"]);
* ["red", "#acf"]. The nth element
* in the array represents the color of the nth line in the chart.
*
* @returns This builder, useful for chaining.
*/
setColors(
cssValues: string[]
): Charts.PieChartBuilder
/**
* Sets the data source URL that is used to pull data in from an external source, such as Google
* Sheets. If a data source URL and a DataTable are provided, the data source URL is ignored.
*
* For more information about querying data sources, check out the Google Charts documentation.
*
* @param url - The data source URL, including any query parameters.
*
* @returns This builder, useful for chaining.
*/
setDataSourceUrl(
url: string
): Charts.PieChartBuilder
/**
* Sets the data table to use for the chart using a DataTableBuilder. This is a convenience method
* for setting the data table without needing to call build().
*
* @param tableBuilder - A data table builder. A new data table is created instantly as part of this
* call, so any further updates to the builder won't be reflected in the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
tableBuilder: DataTableBuilder
): Charts.PieChartBuilder
/**
* Sets the data table which contains the lines for the chart, as well as the X-axis labels. The
* first column should be a string, and contain the horizontal axis labels. Any number of columns
* can follow, all must be numeric. Each column is displayed as a separate line.
*
* @param table - The data table to use for the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
table: DataTableSource
): Charts.PieChartBuilder
/**
* Sets the data view definition to use for the chart.
*
* @param dataViewDefinition - A data view definition object that defines the view that should be
* derived from the given data source for the chart drawing.
*
* @returns This builder, useful for chaining.
*/
setDataViewDefinition(
dataViewDefinition: Charts.DataViewDefinition
): Charts.PieChartBuilder
/**
* Sets the dimensions for the chart.
*
* @param width - The width of the chart, in pixels.
* @param height - The height of the chart, in pixels.
*
* @returns This builder, useful for chaining.
*/
setDimensions(
width: number,
height: number
): Charts.PieChartBuilder
/**
* Sets the position of the legend with respect to the chart. By default, there is no legend.
*
*
* // Creates a line chart builder and sets the legend position to right.
* var builder = Charts.newLineChart();
* builder.setLegendPosition(Charts.Position.RIGHT);
*
* // Creates a line chart builder and sets it up for a blue, 26-point legend.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
* var builder = Charts.newLineChart();
* builder.setLegendTextStyle(style);
*
* // Build a pie chart with a pretty legend.
* var builder = Charts.newPieChart();
* builder.setOption('legend', {textStyle: {color: 'blue', fontSize: 16}});
* var chart = builder.build();
*
* // Creates a line chart builder and title to 'My Line Chart'.
* var builder = Charts.newLineChart();
* builder.setTitle('My Line Chart')
*
* // Creates a line chart builder and sets it up for a blue, 26-point title.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
* var builder = Charts.newLineChart();
* builder.setTitleTextStyle(style);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.PieChartBuilder
}
enum PointStyle {
/**
* Use largest sized line points.
*/
HUGE = "HUGE",
/**
* Use large sized line points.
*/
LARGE = "LARGE",
/**
* Use medium sized line points.
*/
MEDIUM = "MEDIUM",
/**
* Do not display line points.
*/
NONE = "NONE",
/**
* Use tiny line points.
*/
TINY = "TINY",
}
enum Position {
/**
* Below the chart.
*/
BOTTOM = "BOTTOM",
/**
* No legend is displayed.
*/
NONE = "NONE",
/**
* To the right of the chart.
*/
RIGHT = "RIGHT",
/**
* Above the chart.
*/
TOP = "TOP",
}
class ScatterChartBuilder {
private constructor();
/**
* Builds the chart.
*
* @returns A Chart object, which can be embedded into documents, UI elements, or used as a static
* image.
*/
build(): Charts.Chart
/**
* Sets the background color for the chart.
*
*
* // Creates a line chart builder and sets the background color to gray
* var builder = Charts.newLineChart();
* builder.setBackgroundColor("gray");
* "blue" or "#00f").
*
* @returns This builder, useful for chaining.
*/
setBackgroundColor(
cssValue: string
): Charts.ScatterChartBuilder
/**
* Sets the colors for the lines in the chart.
*
*
* // Creates a line chart builder and sets the first two lines to be drawn in green and red,
* // respectively.
* var builder = Charts.newLineChart();
* builder.setColors(["green", "red"]);
* ["red", "#acf"]. The nth element
* in the array represents the color of the nth line in the chart.
*
* @returns This builder, useful for chaining.
*/
setColors(
cssValues: string[]
): Charts.ScatterChartBuilder
/**
* Sets the data source URL that is used to pull data in from an external source, such as Google
* Sheets. If a data source URL and a DataTable are provided, the data source URL is ignored.
*
* For more information about querying data sources, check out the Google Charts documentation.
*
* @param url - The data source URL, including any query parameters.
*
* @returns This builder, useful for chaining.
*/
setDataSourceUrl(
url: string
): Charts.ScatterChartBuilder
/**
* Sets the data table to use for the chart using a DataTableBuilder. This is a convenience method
* for setting the data table without needing to call build().
*
* @param tableBuilder - A data table builder. A new data table is created instantly as part of this
* call, so any further updates to the builder won't be reflected in the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
tableBuilder: DataTableBuilder
): Charts.ScatterChartBuilder
/**
* Sets the data table which contains the lines for the chart, as well as the X-axis labels. The
* first column should be a string, and contain the horizontal axis labels. Any number of columns
* can follow, all must be numeric. Each column is displayed as a separate line.
*
* @param table - The data table to use for the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
table: DataTableSource
): Charts.ScatterChartBuilder
/**
* Sets the data view definition to use for the chart.
*
* @param dataViewDefinition - A data view definition object that defines the view that should be
* derived from the given data source for the chart drawing.
*
* @returns This builder, useful for chaining.
*/
setDataViewDefinition(
dataViewDefinition: Charts.DataViewDefinition
): Charts.ScatterChartBuilder
/**
* Sets the dimensions for the chart.
*
* @param width - The width of the chart, in pixels.
* @param height - The height of the chart, in pixels.
*
* @returns This builder, useful for chaining.
*/
setDimensions(
width: number,
height: number
): Charts.ScatterChartBuilder
/**
* Sets the position of the legend with respect to the chart. By default, there is no legend.
*
*
* // Creates a line chart builder and sets the legend position to right.
* var builder = Charts.newLineChart();
* builder.setLegendPosition(Charts.Position.RIGHT);
*
* // Creates a line chart builder and sets it up for a blue, 26-point legend.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
* var builder = Charts.newLineChart();
* builder.setLegendTextStyle(style);
*
* // Build a scatter chart with a 1-second animation duration.
* var builder = Charts.newScatterChart();
* builder.setOption('animation.duration', 1000);
* var chart = builder.build();
*
* // Creates a line chart builder and sets large point style.
* var builder = Charts.newLineChart();
* builder.setPointStyle(Charts.PointStyle.LARGE);
*
* // Creates a line chart builder and title to 'My Line Chart'.
* var builder = Charts.newLineChart();
* builder.setTitle('My Line Chart')
*
* // Creates a line chart builder and sets it up for a blue, 26-point title.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
* var builder = Charts.newLineChart();
* builder.setTitleTextStyle(style);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.ScatterChartBuilder
/**
* Makes the horizontal axis into a logarithmic scale (requires all values to be positive).
*
* @returns This builder, useful for chaining.
*/
setXAxisLogScale(): Charts.ScatterChartBuilder
/**
* Sets the range for the horizontal axis of the chart.
*
* If any data points fall outside the range, the range is expanded to include those data * points. * *
* // Creates a scatter chart builder and sets the X-axis range to be 0 to 100.
* var builder = Charts.newTableChart();
* builder.setXAxisRange(0, 100);
*
* // Creates a line chart builder and sets the X-axis text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setXAxisTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setXAxisTextStyle(
textStyle: Charts.TextStyle
): Charts.ScatterChartBuilder
/**
* Adds a title to the horizontal axis. The title is centered and appears below the axis value
* labels.
*
*
* // Creates a line chart builder and sets the X-axis title.
* var builder = Charts.newLineChart();
* builder.setTitle('X-axis Title')
*
* // Creates a line chart builder and sets the X-axis title text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setXAxisTitleTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setXAxisTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.ScatterChartBuilder
/**
* Makes the vertical axis into a logarithmic scale (requires all values to be positive).
*
* @returns This builder, useful for chaining.
*/
setYAxisLogScale(): Charts.ScatterChartBuilder
/**
* Sets the range for the vertical axis of the chart. If any data points fall outside the range,
* the range is expanded to include those data points.
*
*
* // Creates a scatter chart builder and sets the Y-axis range to be 0 to 100.
* var builder = Charts.newTableChart();
* builder.setYAxisRange(0, 100);
*
* // Creates a line chart builder and sets the Y-axis text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setYAxisTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setYAxisTextStyle(
textStyle: Charts.TextStyle
): Charts.ScatterChartBuilder
/**
* Adds a title to the vertical axis. The title is centered and appears to the left of the value
* labels.
*
*
* // Creates a line chart builder and sets the Y-axis title.
* var builder = Charts.newLineChart();
* builder.setYAxisTitle('Y-axis Title')
*
* // Creates a line chart builder and sets the Y-axis title text style to blue, 18-point font.
* var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build();
* var builder = Charts.newLineChart();
* builder.setYAxisTitleTextStyle(textStyle);
* TextStyleBuilder object by calling Charts.newTextStyle().
*
* @returns This builder, useful for chaining.
*/
setYAxisTitleTextStyle(
textStyle: Charts.TextStyle
): Charts.ScatterChartBuilder
}
class StringFilterBuilder {
private constructor();
/**
* Sets whether matching should be case sensitive or not.
*
*
* // Builds a case insensitive string filter to filter column "Col1".
* var stringFilter = Charts.newStringFilter()
* .setFilterColumnLabel("Col1")
* .setCaseSensitive(false)
* .build();
* true, enables string matching case sensitivity.
*
* @returns This builder, useful for chaining.
*/
setCaseSensitive(
caseSensitive: Boolean
): Charts.StringFilterBuilder
/**
* Sets whether the control should match exact values only (MatchType.EXACT), prefixes
* starting from the beginning of the value (MatchType.PREFIX), or any substring
* (MatchType.ANY).
*
*
* // Builds a string filter to filter column "Col1" matching the prefix.
* var stringFilter = Charts.newStringFilter()
* .setFilterColumnLabel("Col1")
* .setMatchType(Charts.MatchType.PREFIX)
* .build();
*
* // Builds a string filter to filter column "Col1" that checks the match any time a key is
* // pressed.
* var stringFilter = Charts.newStringFilter()
* .setFilterColumnLabel("Col1")
* .setRealtimeTrigger(true)
* .build();
* true, sets events to be triggered at real time (when a key is
* pressed).
*
* @returns This builder, useful for chaining.
*/
setRealtimeTrigger(
realtimeTrigger: Boolean
): Charts.StringFilterBuilder
}
class TableChartBuilder {
private constructor();
/**
* Builds the chart.
*
* @returns A Chart object, which can be embedded into documents, UI elements, or used as a static
* image.
*/
build(): Charts.Chart
/**
* Sets whether to enable paging through the data.
*
* The default behavior is paging disabled. If paging is enabled the default page size is 10.
*
* @param enablePaging - true if paging should be enabled, false otherwise.
*
* @returns This builder, useful for chaining.
*/
enablePaging(
enablePaging: Boolean
): Charts.TableChartBuilder
/**
* Enables paging and sets the number of rows in each page.
*
*
The default page size is 10. * *
* // Creates a table chart builder and enables paging with page size of 5.
* var builder = Charts.newTableChart();
* builder.enablePaging(5);
* The default page size is 10, and the default start page is 0. * *
* // Creates a table chart builder and enables paging with page size of 5 and displays page 2
* // first.
* var builder = Charts.newTableChart();
* builder.enablePaging(5, 2);
* This does not affect the column index in the underlying data, only the order of display.
* Full bi-directional (BiDi) language display is not supported by the table visualization even
* with this option. This option is ignored if you enable paging (using the page option), or if
* the table has scroll bars because you have specified height and width options smaller than the
* required table size. The default behavior is RTL support disabled.
*
* @param rtlEnabled - true if right-to-left support should be enabled, false
* otherwise.
*
* @returns This builder, useful for chaining.
*/
enableRtlTable(
rtlEnabled: Boolean
): Charts.TableChartBuilder
/**
* Sets whether to sort columns when the user clicks a column heading.
*
*
If sorting is enabled, when users click on the column header the rows are automatically
* sorted. The default behavior is sorting enabled.
*
* @param enableSorting - true to enable sorting by clicking on column headers, false otherwise.
*
* @returns This builder, useful for chaining.
*/
enableSorting(
enableSorting: Boolean
): Charts.TableChartBuilder
/**
* Sets the data source URL that is used to pull data in from an external source, such as Google
* Sheets. If a data source URL and a DataTable are provided, the data source URL is ignored.
*
*
For more information about querying data sources, check out the Google Charts documentation.
*
* @param url - The data source URL, including any query parameters.
*
* @returns This builder, useful for chaining.
*/
setDataSourceUrl(
url: string
): Charts.TableChartBuilder
/**
* Sets the data table to use for the chart using a DataTableBuilder. This is a convenience method
* for setting the data table without needing to call build().
*
* @param tableBuilder - A data table builder. A new data table is created instantly as part of this
* call, so any further updates to the builder won't be reflected in the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
tableBuilder: DataTableBuilder
): Charts.TableChartBuilder
/**
* Sets the data table which contains the lines for the chart, as well as the X-axis labels. The
* first column should be a string, and contain the horizontal axis labels. Any number of columns
* can follow, all must be numeric. Each column is displayed as a separate line.
*
* @param table - The data table to use for the chart.
*
* @returns This builder, useful for chaining.
*/
setDataTable(
table: DataTableSource
): Charts.TableChartBuilder
/**
* Sets the data view definition to use for the chart.
*
* @param dataViewDefinition - A data view definition object that defines the view that should be
* derived from the given data source for the chart drawing.
*
* @returns This builder, useful for chaining.
*/
setDataViewDefinition(
dataViewDefinition: Charts.DataViewDefinition
): Charts.TableChartBuilder
/**
* Sets the dimensions for the chart.
*
* @param width - The width of the chart, in pixels.
* @param height - The height of the chart, in pixels.
*
* @returns This builder, useful for chaining.
*/
setDimensions(
width: number,
height: number
): Charts.TableChartBuilder
/**
* Sets the row number for the first row in the data table.
*
*
The default row number of the first row is 1. * *
* // Creates a table chart builder and sets the first row to be 2.
* var builder = Charts.newTableChart();
* builder.setFirstRowNumber(2);
* The column os sorted in ascending order and is marked with a small arrow indicating that. * *
* // Creates a table chart builder and sorts it by the second column (ascending).
* var builder = Charts.newTableChart();
* builder.setInitialSortingAscending(2);
* The column os sorted in descending order and is marked with a a small arrow indicating that. * *
* // Creates a table chart builder and sorts it by the second column (descending).
* var builder = Charts.newTableChart();
* builder.setInitialSortingDescending(2);
*
* // Build a table chart which renders HTML.
* var builder = Charts.newTableChart();
* builder.setOption('allowHtml', {@code true});
* var chart = builder.build();
* The default behavior is not showing row numbers.
*
* @param showRowNumber - true if the first column of the table should show the row number,
* false otherwise.
*
* @returns This builder, useful for chaining.
*/
showRowNumberColumn(
showRowNumber: Boolean
): Charts.TableChartBuilder
/**
* Sets whether alternating color style is assigned to odd and even rows of a table chart.
*
*
The default behavior is the rows having alternating color style.
*
* @param alternate - true if color styles should be alternating, false otherwise.
*
* @returns This builder, useful for chaining.
*/
useAlternatingRowStyle(
alternate: Boolean
): Charts.TableChartBuilder
}
class TextStyle {
private constructor();
/**
* Gets the color of the text style.
*
*
* // Creates a new text style that uses blue text and logs the color.
* var textStyle = Charts.newTextStyle().setColor('blue').build();
* Logger.log(textStyle.getColor());
* "blue" or "#00f").
*/
getColor(): string
/**
* Gets the font name of the text style.
*
*
* // Creates a new text style that uses Ariel font and logs the font name.
* var textStyle = Charts.newTextStyle().setFontName('Ariel').build();
* Logger.log(textStyle.getFontName());
*
* // Creates a new text style that uses 18 pixel font size and logs the font size.
* var textStyle = Charts.newTextStyle().setFontSize(18).build();
* Logger.log(textStyle.getFontSize());
*
* // Creates a new text style that uses 26-point blue font.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26);
* var style = textStyleBuilder.build();
*
* // Creates a new text style that uses blue font.
* var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF');
* var style = textStyleBuilder.build();
* "blue" or "#00f").
*
* @returns This builder, useful for chaining.
*/
setColor(
cssValue: string
): Charts.TextStyleBuilder
/**
* Sets the font name of the text style
*
*
* // Creates a new text style that uses Ariel font.
* var textStyleBuilder = Charts.newTextStyle().setFontName('Ariel');
* var style = textStyleBuilder.build();
*
* // Creates a new text style that uses 26-point font.
* var textStyleBuilder = Charts.newTextStyle().setFontSize(26);
* var style = textStyleBuilder.build();
*