Compilador para gráficos de tabla. Para obtener más detalles, consulta la documentación de Gviz.
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Agrega un rango al gráfico que modifica este compilador. |
asAreaChart() | EmbeddedAreaChartBuilder | Establece el tipo de gráfico en AreaChart y muestra un EmbeddedAreaChartBuilder . |
asBarChart() | EmbeddedBarChartBuilder | Establece el tipo de gráfico en BarChart y muestra un EmbeddedBarChartBuilder . |
asColumnChart() | EmbeddedColumnChartBuilder | Establece el tipo de gráfico en ColumnChart y muestra un EmbeddedColumnChartBuilder . |
asComboChart() | EmbeddedComboChartBuilder | Establece el tipo de gráfico en comboChart y muestra un EmbeddedComboChartBuilder . |
asHistogramChart() | EmbeddedHistogramChartBuilder | Establece el tipo de gráfico en HistogramChart y muestra un EmbeddedHistogramChartBuilder . |
asLineChart() | EmbeddedLineChartBuilder | Establece el tipo de gráfico en LineChart y muestra un EmbeddedLineChartBuilder . |
asPieChart() | EmbeddedPieChartBuilder | Establece el tipo de gráfico en PieChart y muestra un EmbeddedPieChartBuilder . |
asScatterChart() | EmbeddedScatterChartBuilder | Establece el tipo de gráfico en ScatterChart y muestra un EmbeddedScatterChartBuilder . |
asTableChart() | EmbeddedTableChartBuilder | Establece el tipo de gráfico en TableChart y muestra un EmbeddedTableChartBuilder . |
build() | EmbeddedChart | Compila el gráfico para reflejar todos los cambios realizados en él. |
clearRanges() | EmbeddedChartBuilder | Quita todos los rangos del gráfico que modifica este compilador. |
enablePaging(enablePaging) | EmbeddedTableChartBuilder | Establece si se debe habilitar la paginación a través de los datos. |
enablePaging(pageSize) | EmbeddedTableChartBuilder | Habilita la paginación y establece el número de filas en cada página. |
enablePaging(pageSize, startPage) | EmbeddedTableChartBuilder | Habilita la paginación, establece la cantidad de filas en cada página y la primera página de la tabla que se mostrará (los números de página se basan en cero). |
enableRtlTable(rtlEnabled) | EmbeddedTableChartBuilder | Agrega compatibilidad básica para idiomas con escritura de derecha a izquierda (como árabe o hebreo) mediante la reversión del orden de las columnas de la tabla, de modo que la columna cero es la columna más a la derecha y la última columna es la más a la izquierda. |
enableSorting(enableSorting) | EmbeddedTableChartBuilder | Establece si se deben ordenar las columnas cuando el usuario hace clic en el encabezado de una columna. |
getChartType() | ChartType | Muestra el tipo de gráfico actual. |
getContainer() | ContainerInfo | Muestra el gráfico ContainerInfo , que encapsula dónde aparece el gráfico en la hoja. |
getRanges() | Range[] | Muestra una copia de la lista de rangos que actualmente proporcionan datos para este gráfico. |
removeRange(range) | EmbeddedChartBuilder | Quita el rango especificado del gráfico que modifica este compilador. |
setChartType(type) | EmbeddedChartBuilder | Cambia el tipo de gráfico. |
setFirstRowNumber(number) | EmbeddedTableChartBuilder | Establece el número de la primera fila de la tabla de datos. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Establece la estrategia que se usará para las filas y columnas ocultas. |
setInitialSortingAscending(column) | EmbeddedTableChartBuilder | Establece el índice de la columna según el que la tabla debería ordenarse de forma inicial (ascendente). |
setInitialSortingDescending(column) | EmbeddedTableChartBuilder | Establece el índice de la columna según el que la tabla debería ordenarse de forma inicial (descendente). |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Establece la estrategia de combinación que se usará cuando exista más de un rango. |
setNumHeaders(headers) | EmbeddedChartBuilder | Establece la cantidad de filas o columnas del rango que deben tratarse como encabezados. |
setOption(option, value) | EmbeddedChartBuilder | Establece opciones avanzadas para este gráfico. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Establece la posición y cambia el lugar en que aparece el gráfico en la hoja. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Establece si las columnas y las filas del gráfico están transpuestas. |
showRowNumberColumn(showRowNumber) | EmbeddedTableChartBuilder | Establece si se debe mostrar el número de fila como la primera columna de la tabla. |
useAlternatingRowStyle(alternate) | EmbeddedTableChartBuilder | Establece si el estilo de color alternativo se asigna a filas impares y pares de un gráfico de tabla. |
Documentación detallada
addRange(range)
Agrega un rango al gráfico que modifica este compilador. No agrega el rango si ya se agregó al gráfico.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var 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 | El rango que se agregará. |
Volver
EmbeddedChartBuilder
: Este compilador, para encadenar
asAreaChart()
Establece el tipo de gráfico en AreaChart y muestra un EmbeddedAreaChartBuilder
.
Volver
EmbeddedAreaChartBuilder
: un compilador para un gráfico de áreas
asBarChart()
Establece el tipo de gráfico en BarChart y muestra un EmbeddedBarChartBuilder
.
Volver
EmbeddedBarChartBuilder
: un compilador para un gráfico de barras
asColumnChart()
Establece el tipo de gráfico en ColumnChart y muestra un EmbeddedColumnChartBuilder
.
Volver
EmbeddedColumnChartBuilder
: un compilador para un gráfico de columnas
asComboChart()
Establece el tipo de gráfico en comboChart y muestra un EmbeddedComboChartBuilder
.
Volver
EmbeddedComboChartBuilder
: un compilador para un gráfico combinado
asHistogramChart()
Establece el tipo de gráfico en HistogramChart y muestra un EmbeddedHistogramChartBuilder
.
Volver
EmbeddedHistogramChartBuilder
: un compilador para un gráfico de histograma
asLineChart()
Establece el tipo de gráfico en LineChart y muestra un EmbeddedLineChartBuilder
.
Volver
EmbeddedLineChartBuilder
: un compilador para un gráfico de líneas
asPieChart()
Establece el tipo de gráfico en PieChart y muestra un EmbeddedPieChartBuilder
.
Volver
EmbeddedPieChartBuilder
: un compilador para un gráfico circular
asScatterChart()
Establece el tipo de gráfico en ScatterChart y muestra un EmbeddedScatterChartBuilder
.
Volver
EmbeddedScatterChartBuilder
: un compilador para un diagrama de dispersión
asTableChart()
Establece el tipo de gráfico en TableChart y muestra un EmbeddedTableChartBuilder
.
Volver
EmbeddedTableChartBuilder
: un compilador para un gráfico de tabla
build()
Compila el gráfico para reflejar todos los cambios realizados en él.
Este método no dibuja automáticamente el gráfico sobre la hoja de cálculo. Se debe insertar un gráfico nuevo a través de sheet.insertChart(chart)
y un gráfico existente debe actualizarse a través de sheet.updateChart(chart)
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B5"); var chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Volver
EmbeddedChart
: Es el gráfico creado, que debe agregarse a la hoja de cálculo.
clearRanges()
Quita todos los rangos del gráfico que modifica este compilador.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This code updates the chart to use only the new ranges while preserving the existing // formatting of the chart. var chart = sheet.getCharts()[0]; var newChart = chart .modify() .clearRanges() .addRange(sheet.getRange("A1:A5")) .addRange(sheet.getRange("B1:B5")) .build(); sheet.updateChart(newChart);
Volver
EmbeddedChartBuilder
: Este compilador, para encadenar
enablePaging(enablePaging)
Establece si se debe habilitar la paginación a través de los datos.
El comportamiento predeterminado es la paginación inhabilitada. Si la paginación está habilitada, el tamaño predeterminado de la página es 10.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
enablePaging | Boolean | true si se debe habilitar la paginación, de lo contrario, false . |
Volver
EmbeddedTableChartBuilder
: Este compilador, útil para encadenar.
enablePaging(pageSize)
Habilita la paginación y establece el número de filas en cada página.
El tamaño de página predeterminado es 10.
// Creates a table chart builder and enables paging with page size of 5. var builder = Charts.newTableChart(); builder.enablePaging(5);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
pageSize | Integer | La cantidad de filas en cada página de la tabla. |
Volver
EmbeddedTableChartBuilder
: Este compilador, útil para encadenar.
enablePaging(pageSize, startPage)
Habilita la paginación, establece la cantidad de filas en cada página y la primera página de la tabla que se mostrará (los números de página se basan en cero).
El tamaño predeterminado de la página es 10 y el tamaño predeterminado es 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);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
pageSize | Integer | La cantidad de filas en cada página de la tabla. |
startPage | Integer | La primera página de la tabla que se mostrará (los números de página se basan en cero). |
Volver
EmbeddedTableChartBuilder
: Este compilador, útil para encadenar.
enableRtlTable(rtlEnabled)
Agrega compatibilidad básica para idiomas con escritura de derecha a izquierda (como árabe o hebreo) mediante la reversión del orden de las columnas de la tabla, de modo que la columna cero es la columna más a la derecha y la última columna es la más a la izquierda.
Esto no afecta el índice de columna en los datos subyacentes, solo el orden en el que se muestra. La visualización de tablas bidireccionales no es compatible con la visualización bidireccional total de la tabla, incluso con esta opción. Esta opción se ignora si habilitas la paginación (con la opción de página) o si la tabla tiene barras de desplazamiento porque especificaste opciones de altura y ancho menores que el tamaño de tabla requerido. El comportamiento predeterminado es la compatibilidad con RTL inhabilitada.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
rtlEnabled | Boolean | true si se debe habilitar la compatibilidad de derecha a izquierda; de lo contrario, false . |
Volver
EmbeddedTableChartBuilder
: Este compilador, útil para encadenar.
enableSorting(enableSorting)
Establece si se deben ordenar las columnas cuando el usuario hace clic en el encabezado de una columna.
Si el ordenamiento está habilitado, cuando los usuarios hacen clic en el encabezado de la columna, las filas se ordenan automáticamente. El comportamiento predeterminado es el ordenamiento habilitado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
enableSorting | Boolean | true para habilitar el ordenamiento haciendo clic en los encabezados de las columnas; de lo contrario, false . |
Volver
EmbeddedTableChartBuilder
: Este compilador, útil para encadenar.
getChartType()
getContainer()
Muestra el gráfico ContainerInfo
, que encapsula dónde aparece el gráfico en la hoja.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var 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() var containerInfo = chartBuilder.getContainer(); // Logs the values we 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
ContainerInfo
: un objeto que contiene la posición del contenedor del gráfico
getRanges()
Muestra una copia de la lista de rangos que actualmente proporcionan datos para este gráfico. Usa addRange(range)
y removeRange(range)
para modificar esta lista.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange("A1:B8")) .setPosition(5, 5, 0, 0); var ranges = chartBuilder.getRanges(); // There's only one range as a data source for this chart, // so this logs "A1:B8" for (var i in ranges) { var range = ranges[i]; Logger.log(range.getA1Notation()); }
Volver
Range[]
: Es un arreglo de rangos que sirven como gráfico para compilar la fuente de datos.
removeRange(range)
Quita el rango especificado del gráfico que modifica este compilador. No muestra un error si el rango no está en este gráfico.
El rango que se quite debe coincidir con un rango agregado mediante addRange(range)
; de lo contrario, no se realizará ningún cambio en el gráfico. Este método no se puede usar para quitar valores de un rango de forma parcial.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var firstRange = sheet.getRange("A1:B5"); var secondRange = sheet.getRange("A6:B8"); var 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")); var chart = chartBuilder.build(); sheet.insertChart(chart);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
range | Range | El rango que se quitará. |
Volver
EmbeddedChartBuilder
: Este compilador, para encadenar
setChartType(type)
Cambia el tipo de gráfico. Actualmente, no se admiten todos los tipos de gráficos incorporados. Consulta los ChartType
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B5"); var 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 | ChartType | El tipo en el que se cambiará este gráfico. |
Volver
EmbeddedChartBuilder
: Este compilador, para encadenar
setFirstRowNumber(number)
Establece el número de la primera fila de la tabla de datos.
El número de fila predeterminado de la primera fila es 1.
// Creates a table chart builder and sets the first row to be 2. var builder = Charts.newTableChart(); builder.setFirstRowNumber(2);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
number | Integer | Número de fila de la primera fila de la tabla de datos. |
Volver
EmbeddedTableChartBuilder
: Este compilador, útil para encadenar.
setHiddenDimensionStrategy(strategy)
Establece la estrategia que se usará para las filas y columnas ocultas. La configuración predeterminada es IGNORE_ROWS
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B5"); var 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 | ChartHiddenDimensionStrategy | La estrategia que se usará para las filas y columnas ocultas. |
Volver
EmbeddedChartBuilder
: Este compilador, para encadenar
setInitialSortingAscending(column)
Establece el índice de la columna según el que la tabla debería ordenarse de forma inicial (ascendente).
La columna "SO" está ordenada de forma ascendente y está marcada con una flecha pequeña que indica eso.
// Creates a table chart builder and sorts it by the second column (ascending). var builder = Charts.newTableChart(); builder.setInitialSortingAscending(2);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
column | Integer | Número de la columna según la cual se debe ordenar inicialmente la tabla. |
Volver
EmbeddedTableChartBuilder
: Este compilador, útil para encadenar.
setInitialSortingDescending(column)
Establece el índice de la columna según el que la tabla debería ordenarse de forma inicial (descendente).
La columna "SO" está ordenada de forma descendente y está marcada con una flecha pequeña que indica eso.
// Creates a table chart builder and sorts it by the second column (descending). var builder = Charts.newTableChart(); builder.setInitialSortingDescending(2);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
column | Integer | Número de la columna según la cual se debe ordenar inicialmente la tabla. |
Volver
EmbeddedTableChartBuilder
: Este compilador, útil para encadenar.
setMergeStrategy(mergeStrategy)
Establece la estrategia de combinación que se usará cuando exista más de un rango. Si es MERGE_ROWS
, las filas se combinan; si es MERGE_COLUMNS
, las columnas se combinan. La configuración predeterminada es MERGE_COLUMNS
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B10"); var range2 = sheet.getRange("C:C10"); var 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 |
---|---|---|
mergeStrategy | ChartMergeStrategy | La estrategia de combinación que se usará. |
Volver
EmbeddedChartBuilder
: Este compilador, para encadenar
setNumHeaders(headers)
Establece la cantidad de filas o columnas del rango que deben tratarse como encabezados.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B5"); var 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 | La cantidad de filas o columnas que se tratarán como encabezados. Los valores negativos provocan que los encabezados se detecten automáticamente. |
Volver
EmbeddedChartBuilder
: Este compilador, para encadenar
setOption(option, value)
Establece opciones avanzadas para este gráfico. Para ver una lista de las opciones disponibles, consulta Opciones de configuración del gráfico.
Este método no valida que la opción que especificas sea 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.
builder.setOption('title', 'Earnings projections'); builder.setOption('legend', {position: 'top', textStyle: {color: 'blue', fontSize: 16}});
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
option | String | El nombre de la opción. |
value | Object | El valor de la opción. |
Volver
EmbeddedChartBuilder
: Este compilador, para encadenar.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
Establece la posición y cambia el lugar en que aparece el gráfico en la hoja. anchorRowPos
y anchorColPos
tienen la indexación 1.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B5"); var chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
anchorRowPos | Integer | El lado superior del gráfico está anclado en esta fila. |
anchorColPos | Integer | El lado izquierdo del gráfico está anclado en esta columna. |
offsetX | Integer | La esquina superior derecha del gráfico se compensa con esta cantidad de píxeles. |
offsetY | Integer | La esquina inferior izquierda del gráfico se compensa con esta cantidad de píxeles. |
Volver
EmbeddedChartBuilder
: Este compilador, para encadenar
setTransposeRowsAndColumns(transpose)
Establece si las columnas y las filas del gráfico están transpuestas. Si se configura como true
, las filas y columnas se cambian. La configuración predeterminada es false
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B5"); var 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
EmbeddedChartBuilder
: Este compilador, para encadenar
showRowNumberColumn(showRowNumber)
Establece si se debe mostrar el número de fila como la primera columna de la tabla.
El comportamiento predeterminado no muestra números de fila.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
showRowNumber | Boolean | true si la primera columna de la tabla debe mostrar el número de fila, de lo contrario, false . |
Volver
EmbeddedTableChartBuilder
: Este compilador, útil para encadenar.
useAlternatingRowStyle(alternate)
Establece si el estilo de color alternativo se asigna a filas impares y pares de un gráfico de tabla.
El comportamiento predeterminado es el de las filas que tienen un estilo de color alternativo.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
alternate | Boolean | true si los estilos de color deberían ser alternativos; de lo contrario, false . |
Volver
EmbeddedTableChartBuilder
: Este compilador, útil para encadenar.