Es un compilador para diagramas de dispersión. Para obtener más detalles, consulta la documentación de Gviz.
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
add | Embedded | Agrega un rango al gráfico que modifica este compilador. |
as | Embedded | Establece el tipo de gráfico en AreaChart y muestra un Embedded . |
as | Embedded | Establece el tipo de gráfico en BarChart y muestra un Embedded . |
as | Embedded | Establece el tipo de gráfico en ColumnChart y muestra un Embedded . |
as | Embedded | Establece el tipo de gráfico en ComboChart y muestra un Embedded . |
as | Embedded | Establece el tipo de gráfico en HistogramChart y muestra un Embedded . |
as | Embedded | Establece el tipo de gráfico en LineChart y muestra un Embedded . |
as | Embedded | Establece el tipo de gráfico en PieChart y muestra un Embedded . |
as | Embedded | Establece el tipo de gráfico en ScatterChart y muestra un Embedded . |
as | Embedded | Establece el tipo de gráfico en TableChart y muestra un Embedded . |
build() | Embedded | Compila el gráfico para que refleje todos los cambios que se le hayan realizado. |
clear | Embedded | Quita todos los rangos del gráfico que modifica este compilador. |
get | Chart | Muestra el tipo de gráfico actual. |
get | Container | Devuelve el Container del gráfico, que encapsula dónde aparece el gráfico en la hoja. |
get | Range[] | Muestra una copia de la lista de rangos que actualmente proporcionan datos para este gráfico. |
remove | Embedded | Quita el rango especificado del gráfico que modifica este compilador. |
set | Embedded | Establece el color de fondo del gráfico. |
set | Embedded | Cambia el tipo de gráfico. |
set | Embedded | Establece los colores de las líneas del gráfico. |
set | Embedded | Establece la estrategia que se usará para las filas y columnas ocultas. |
set | Embedded | Establece la posición de la leyenda con respecto al gráfico. |
set | Embedded | Establece el estilo de texto de la leyenda del gráfico. |
set | Embedded | Establece la estrategia de combinación que se usará cuando exista más de un rango. |
set | Embedded | Establece la cantidad de filas o columnas del rango que se deben tratar como encabezados. |
set | Embedded | Establece opciones avanzadas para este gráfico. |
set | Embedded | Establece el estilo de los puntos de la línea. |
set | Embedded | Establece la posición y cambia la ubicación en la que aparece el gráfico en la hoja. |
set | Embedded | Establece el título del gráfico. |
set | Embedded | Establece el estilo de texto del título del gráfico. |
set | Embedded | Establece si las filas y columnas del gráfico se transponen. |
set | Embedded | Convierte el eje horizontal en una escala logarítmica (requiere que todos los valores sean positivos). |
set | Embedded | Establece el rango para el eje horizontal del gráfico. |
set | Embedded | Establece el estilo de texto del eje horizontal. |
set | Embedded | Agrega un título al eje horizontal. |
set | Embedded | Establece el estilo de texto del título del eje horizontal. |
set | Embedded | Convierte el eje vertical en una escala logarítmica (requiere que todos los valores sean positivos). |
set | Embedded | Establece el rango para el eje vertical del gráfico. |
set | Embedded | Establece el estilo de texto del eje vertical. |
set | Embedded | Agrega un título al eje vertical. |
set | Embedded | Establece el estilo de texto del título del eje vertical. |
Documentación detallada
add Range(range)
Agrega un rango al gráfico que modifica este compilador. No agrega el rango si ya se agregó al gráfico.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B8')) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
range | Range | Es el rango que se agregará. |
Volver
Embedded
: Este compilador, para encadenar
as Area Chart()
Establece el tipo de gráfico en AreaChart y muestra un Embedded
.
Volver
Embedded
: Es un compilador para un gráfico de áreas.
as Bar Chart()
Establece el tipo de gráfico en BarChart y muestra un Embedded
.
Volver
Embedded
: Es un compilador para un gráfico de barras.
as Column Chart()
Establece el tipo de gráfico en ColumnChart y muestra un Embedded
.
Volver
Embedded
: Es un compilador para un gráfico de columnas.
as Combo Chart()
Establece el tipo de gráfico en ComboChart y muestra un Embedded
.
Volver
Embedded
: Es un compilador para un gráfico combinado.
as Histogram Chart()
Establece el tipo de gráfico en HistogramChart y muestra un Embedded
.
Volver
Embedded
: Es un compilador para un gráfico de histograma.
as Line Chart()
Establece el tipo de gráfico en LineChart y muestra un Embedded
.
Volver
Embedded
: Es un compilador para un gráfico de líneas.
as Pie Chart()
Establece el tipo de gráfico en PieChart y muestra un Embedded
.
Volver
Embedded
: Es un compilador para un gráfico circular.
as Scatter Chart()
Establece el tipo de gráfico en ScatterChart y muestra un Embedded
.
Volver
Embedded
: Es un compilador para un diagrama de dispersión.
as Table Chart()
Establece el tipo de gráfico en TableChart y muestra un Embedded
.
Volver
Embedded
: Es un compilador para un gráfico de tabla.
build()
Compila el gráfico para que refleje todos los cambios que se le hayan realizado.
Este método no dibuja automáticamente el gráfico en la parte superior de la hoja de cálculo. Se debe insertar un gráfico nuevo a través de sheet.insertChart(chart)
, y se debe actualizar un gráfico existente a través de sheet.updateChart(chart)
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Volver
Embedded
: Es el gráfico creado, que aún se debe agregar a la hoja de cálculo.
clear Ranges()
Quita todos los rangos del gráfico que modifica este compilador.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This code updates the chart to use only the new ranges while preserving the // existing formatting of the chart. const chart = sheet.getCharts()[0]; const newChart = chart.modify() .clearRanges() .addRange(sheet.getRange('A1:A5')) .addRange(sheet.getRange('B1:B5')) .build(); sheet.updateChart(newChart);
Volver
Embedded
: Este compilador, para encadenar
get Chart Type()
get Container()
Devuelve el Container
del gráfico, que encapsula dónde aparece el gráfico en la hoja.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B8')) .setPosition(5, 5, 0, 0); // This method returns the exact same data as Chart#getContainerInfo() const containerInfo = chartBuilder.getContainer(); // Logs the values used in setPosition() Logger.log( 'Anchor Column: %s\r\nAnchor Row %s\r\nOffset X %s\r\nOffset Y %s', containerInfo.getAnchorColumn(), containerInfo.getAnchorRow(), containerInfo.getOffsetX(), containerInfo.getOffsetY(), );
Volver
Container
: Es un objeto que contiene la posición del contenedor de gráficos.
get Ranges()
Muestra una copia de la lista de rangos que actualmente proporcionan datos para este gráfico. Usa add
y remove
para modificar esta lista.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B8')) .setPosition(5, 5, 0, 0); const ranges = chartBuilder.getRanges(); // There's only one range as a data source for this chart, // so this logs "A1:B8" for (const i in ranges) { const range = ranges[i]; Logger.log(range.getA1Notation()); }
Volver
Range[]
: Es un array de rangos que funcionan como la fuente de datos del gráfico que se compilará.
remove Range(range)
Quita el rango especificado del gráfico que modifica este compilador. No genera un error si el rango no está en este gráfico.
El rango que se quita debe coincidir con un rango agregado a través de add
. De lo contrario, no se realizará ningún cambio en el gráfico. No se puede usar este método para quitar valores de un rango de forma parcial.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const firstRange = sheet.getRange('A1:B5'); const secondRange = sheet.getRange('A6:B8'); const chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(firstRange) // This range will render in a different color .addRange(secondRange) .setPosition(5, 5, 0, 0); // Note that you can use either of these two formats, but the range // MUST match up with a range that was added via addRange(), or it // will not be removed, and will not throw an exception chartBuilder.removeRange(firstRange); chartBuilder.removeRange(sheet.getRange('A6:B8')); const chart = chartBuilder.build(); sheet.insertChart(chart);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
range | Range | El rango que se quitará. |
Volver
Embedded
: Este compilador, para encadenar
set Background Color(cssValue)
Establece el color de fondo del gráfico.
// Creates a line chart builder and sets the background color to gray const builder = Charts.newLineChart(); builder.setBackgroundColor('gray');
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
css | String | Es el valor CSS del color (como "blue" o "#00f" ). |
Volver
Embedded
: Este compilador es útil para encadenar.
set Chart Type(type)
Cambia el tipo de gráfico. Actualmente, no se admiten todos los tipos de gráficos incorporados. Consulta los Chart
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
type | Chart | Es el tipo al que se cambiará este gráfico. |
Volver
Embedded
: Este compilador, para encadenar
set Colors(cssValues)
Establece los colores de las líneas del gráfico.
// Creates a line chart builder and sets the first two lines to be drawn in // green and red, respectively. const builder = Charts.newLineChart(); builder.setColors(['green', 'red']);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
css | String[] | Un array de valores de CSS de color, como ["red", "#acf"] . El enésimo elemento del array representa el color de la enésima línea del gráfico. |
Volver
Embedded
: Este compilador es útil para encadenar.
set Hidden Dimension Strategy(strategy)
Establece la estrategia que se usará para las filas y columnas ocultas. La configuración predeterminada es IGNORE_ROWS
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setHiddenDimensionStrategy( Charts.ChartHiddenDimensionStrategy.IGNORE_COLUMNS, ) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
strategy | Chart | Es la estrategia que se usará para las filas y columnas ocultas. |
Volver
Embedded
: Este compilador, para encadenar
set Legend Position(position)
Establece la posición de la leyenda con respecto al gráfico. De forma predeterminada, no hay leyenda.
// Creates a line chart builder and sets the legend position to right. const builder = Charts.newLineChart(); builder.setLegendPosition(Charts.Position.RIGHT);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
position | Position | Es la posición de la leyenda. |
Volver
Embedded
: Este compilador es útil para encadenar.
set Legend Text Style(textStyle)
Establece el estilo de texto de la leyenda del gráfico.
// Creates a line chart builder and sets it up for a blue, 26-point legend. const textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26); const style = textStyleBuilder.build(); const builder = Charts.newLineChart(); builder.setLegendTextStyle(style);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | Text | Es el estilo de texto que se usará para la leyenda del gráfico. |
Volver
Embedded
: Este compilador es útil para encadenar.
set Merge Strategy(mergeStrategy)
Establece la estrategia de combinación que se usará cuando exista más de un rango. Si es MERGE_ROWS
, se combinan las filas; si es MERGE_COLUMNS
, se combinan las columnas. La configuración predeterminada es MERGE_COLUMNS
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B10'); const range2 = sheet.getRange('C:C10'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .addRange(range2) .setMergeStrategy(Charts.ChartMergeStrategy.MERGE_ROWS) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
merge | Chart | La estrategia de combinación que se usará. |
Volver
Embedded
: Este compilador, para encadenar
set Num Headers(headers)
Establece la cantidad de filas o columnas del rango que se deben tratar como encabezados.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setNumHeaders(1) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
headers | Integer | Es la cantidad de filas o columnas que se deben tratar como encabezados. Los valores negativos hacen que los encabezados se detecten automáticamente. |
Volver
Embedded
: Este compilador, para encadenar
set Option(option, value)
Establece opciones avanzadas para este gráfico. Para ver una lista de las opciones disponibles, consulta Opciones de configuración de gráficos.
Este método no valida si la opción que especificas es válida para este tipo de gráfico ni si el valor tiene el formato o la estructura correctos.
En este ejemplo, se muestra cómo cambiar el título y establecer una leyenda.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); const sheet = spreadsheet.getSheets()[0]; const chart = sheet.newChart() .setOption('title', 'Earnings projections') .setOption('legend', { position: 'top', textStyle: { color: 'blue', fontSize: 16 }, }).build();
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
option | String | El nombre de la opción. |
value | Object | El valor de la opción. |
Volver
Embedded
: Este compilador, para encadenar.
set Point Style(style)
Establece el estilo de los puntos de la línea. De forma predeterminada, los puntos no tienen estilos particulares y solo se ve la línea.
// Creates a line chart builder and sets large point style. const builder = Charts.newLineChart(); builder.setPointStyle(Charts.PointStyle.LARGE);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
style | Point | Es el estilo que se usará para los puntos de la línea. |
Volver
Embedded
: Este compilador es útil para encadenar.
Consulta también
set Position(anchorRowPos, anchorColPos, offsetX, offsetY)
Establece la posición y cambia la ubicación en la que aparece el gráfico en la hoja. anchor
y anchor
tienen un índice de 1.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
anchor | Integer | El lado superior del gráfico está anclado en esta fila. |
anchor | Integer | El lado izquierdo del gráfico está anclado en esta columna. |
offsetX | Integer | La esquina superior derecha del gráfico se desplaza esta cantidad de píxeles. |
offsetY | Integer | La esquina inferior izquierda del gráfico se desplaza esta cantidad de píxeles. |
Volver
Embedded
: Este compilador, para encadenar
set Title(chartTitle)
Establece el título del gráfico. El título se muestra centrado sobre el gráfico.
// Creates a line chart builder and title to 'My Line Chart'. const builder = Charts.newLineChart(); builder.setTitle('My Line Chart');
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
chart | String | el título del gráfico. |
Volver
Embedded
: Este compilador es útil para encadenar.
set TitleTextStyle(textStyle)
Establece el estilo de texto del título del gráfico.
// Creates a line chart builder and sets it up for a blue, 26-point title. const textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26); const style = textStyleBuilder.build(); const builder = Charts.newLineChart(); builder.setTitleTextStyle(style);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | Text | Es el estilo de texto que se usará para el título del gráfico. Para crear un objeto Text , llama a Charts.newTextStyle() . |
Volver
Embedded
: Este compilador es útil para encadenar.
set Transpose Rows And Columns(transpose)
Establece si las filas y columnas del gráfico se transponen. Si se establece en true
, se intercambian las filas y las columnas. La configuración predeterminada es false
.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setTransposeRowsAndColumns(true) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
transpose | Boolean | Si es true , las filas y columnas que se usan para construir el gráfico se transponen. |
Volver
Embedded
: Este compilador, para encadenar
set XAxis Log Scale()
Convierte el eje horizontal en una escala logarítmica (requiere que todos los valores sean positivos).
Volver
Embedded
: Este compilador es útil para encadenar.
set XAxis Range(start, end)
Establece el rango para el eje horizontal del gráfico.
Si algún dato está fuera del rango, este se expande para incluirlo.
// Creates a scatter chart builder and sets the X-axis range to be 0 to 100. const builder = Charts.newTableChart(); builder.setXAxisRange(0, 100);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
start | Number | Es el valor de la línea de cuadrícula más baja del eje horizontal. |
end | Number | Es el valor de la línea de cuadrícula más alta del eje horizontal. |
Volver
Embedded
: Este compilador es útil para encadenar.
set XAxis Text Style(textStyle)
Establece el estilo de texto del eje horizontal.
// Creates a line chart builder and sets the X-axis text style to blue, 18-point // font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setXAxisTextStyle(textStyle);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | Text | Es el estilo de texto que se usará para el título del eje horizontal. Para crear un objeto Text , llama a Charts.newTextStyle() . |
Volver
Embedded
: Este compilador es útil para encadenar.
set XAxis Title(title)
Agrega un título al eje horizontal. El título está centrado y aparece debajo de las etiquetas de valor del eje.
// Creates a line chart builder and sets the X-axis title. const builder = Charts.newLineChart(); builder.setTitle('X-axis Title');
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
title | String | Es el título del eje X. |
Volver
Embedded
: Este compilador es útil para encadenar.
set XAxis TitleTextStyle(textStyle)
Establece el estilo de texto del título del eje horizontal.
// Creates a line chart builder and sets the X-axis title text style to blue, // 18-point font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setXAxisTitleTextStyle(textStyle);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | Text | Es el estilo de texto que se usará para el título del eje horizontal. Para crear un objeto Text , llama a Charts.newTextStyle() . |
Volver
Embedded
: Este compilador es útil para encadenar.
set YAxis Log Scale()
Convierte el eje vertical en una escala logarítmica (requiere que todos los valores sean positivos).
Volver
Embedded
: Este compilador es útil para encadenar.
set YAxis Range(start, end)
Establece el rango para el eje vertical del gráfico. Si algún dato se encuentra fuera del rango, este se expande para incluirlos.
// Creates a scatter chart builder and sets the Y-axis range to be 0 to 100. const builder = Charts.newTableChart(); builder.setYAxisRange(0, 100);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
start | Number | Es el valor de la línea de cuadrícula más baja del eje vertical. |
end | Number | Es el valor de la línea de cuadrícula más alta del eje vertical. |
Volver
Embedded
: Este compilador es útil para encadenar.
set YAxis Text Style(textStyle)
Establece el estilo de texto del eje vertical.
// Creates a line chart builder and sets the Y-axis text style to blue, 18-point // font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setYAxisTextStyle(textStyle);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | Text | Es el estilo de texto que se usará para el título del eje horizontal. Para crear un objeto Text , llama a Charts.newTextStyle() . |
Volver
Embedded
: Este compilador es útil para encadenar.
set YAxis Title(title)
Agrega un título al eje vertical. El título está centrado y aparece a la izquierda de las etiquetas de valor.
// Creates a line chart builder and sets the Y-axis title. const builder = Charts.newLineChart(); builder.setYAxisTitle('Y-axis Title');
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
title | String | Es el título del eje Y. |
Volver
Embedded
: Este compilador es útil para encadenar.
set YAxis TitleTextStyle(textStyle)
Establece el estilo de texto del título del eje vertical.
// Creates a line chart builder and sets the Y-axis title text style to blue, // 18-point font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setYAxisTitleTextStyle(textStyle);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
text | Text | Es el estilo de texto que se usará para el título del eje horizontal. Para crear un objeto Text , llama a Charts.newTextStyle() . |
Volver
Embedded
: Este compilador es útil para encadenar.