Class EmbeddedTableChartBuilder

EmbeddedTableChartBuilder

Es un compilador para gráficos de tabla. Para obtener más detalles, consulta la documentación de Gviz.

Métodos

MétodoTipo de datos que se muestraDescripción breve
addRange(range)EmbeddedChartBuilderAgrega un rango al gráfico que modifica este compilador.
asAreaChart()EmbeddedAreaChartBuilderEstablece el tipo de gráfico como AreaChart y muestra un EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderEstablece el tipo de gráfico en BarChart y muestra un EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderEstablece el tipo de gráfico en ColumnChart y muestra un EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderEstablece el tipo de gráfico en ComboChart y muestra un EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderEstablece el tipo de gráfico en HistogramChart y muestra un EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderEstablece el tipo de gráfico en LineChart y muestra un EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderEstablece el tipo de gráfico como PieChart y muestra un EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderEstablece el tipo de gráfico en ScatterChart y muestra un EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderEstablece el tipo de gráfico como TableChart y muestra un EmbeddedTableChartBuilder.
build()EmbeddedChartCrea el gráfico para reflejar todos los cambios realizados en él.
clearRanges()EmbeddedChartBuilderQuita todos los rangos del gráfico que modifica este compilador.
enablePaging(enablePaging)EmbeddedTableChartBuilderEstablece si se habilita la paginación a través de los datos.
enablePaging(pageSize)EmbeddedTableChartBuilderHabilita la paginación y establece la cantidad de filas en cada página.
enablePaging(pageSize, startPage)EmbeddedTableChartBuilderHabilita la paginación, establece el número de filas en cada página y la primera página de la tabla que se mostrará (página los números están basados en cero).
enableRtlTable(rtlEnabled)EmbeddedTableChartBuilderSe agrega compatibilidad básica para idiomas que se escriben de derecha a izquierda (como el árabe o el hebreo) al revertir el el orden de columnas de la tabla, para que la columna cero sea la columna que se encuentra más a la derecha y la última columna la columna más a la izquierda.
enableSorting(enableSorting)EmbeddedTableChartBuilderEstablece si se deben ordenar las columnas cuando el usuario hace clic en un encabezado.
getChartType()ChartTypeMuestra el tipo de gráfico actual.
getContainer()ContainerInfoMuestra el gráfico ContainerInfo, que encapsula el lugar en el que aparece el gráfico en la de la hoja de cálculo.
getRanges()Range[]Muestra una copia de la lista de rangos que actualmente proporcionan datos para este gráfico.
removeRange(range)EmbeddedChartBuilderQuita el rango especificado del gráfico que modifica este compilador.
setChartType(type)EmbeddedChartBuilderCambia el tipo de gráfico.
setFirstRowNumber(number)EmbeddedTableChartBuilderEstablece el número de fila para la primera fila de la tabla de datos.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderEstablece la estrategia que se usará para las filas y columnas ocultas.
setInitialSortingAscending(column)EmbeddedTableChartBuilderEstablece el índice de la columna según la cual la tabla debe ordenarse inicialmente (ascendente).
setInitialSortingDescending(column)EmbeddedTableChartBuilderEstablece el índice de la columna según la cual la tabla debe ordenarse inicialmente (orden descendente).
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderEstablece la estrategia de combinación que se debe utilizar cuando existe más de un rango.
setNumHeaders(headers)EmbeddedChartBuilderEstablece el número de filas o columnas del rango que deben tratarse como encabezados.
setOption(option, value)EmbeddedChartBuilderEstablece las opciones avanzadas para este gráfico.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderEstablece la posición y cambia el lugar en el que aparece el gráfico en la hoja.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderEstablece si se transponen las filas y columnas del gráfico.
showRowNumberColumn(showRowNumber)EmbeddedTableChartBuilderEstablece si se muestra el número de fila como la primera columna de la tabla.
useAlternatingRowStyle(alternate)EmbeddedTableChartBuilderEstablece si el estilo de color alternativo se debe asignar a las 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 aplicó agregado 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

NombreTipoDescripción
rangeRangeEl rango que se agregará.

Volver

EmbeddedChartBuilder: Este compilador se usa para encadenamiento.


asAreaChart()

Establece el tipo de gráfico como AreaChart y muestra un EmbeddedAreaChartBuilder.

Volver

EmbeddedAreaChartBuilder: Es un compilador para un gráfico de áreas.


asBarChart()

Establece el tipo de gráfico en BarChart y muestra un EmbeddedBarChartBuilder.

Volver

EmbeddedBarChartBuilder: Es un compilador para un gráfico de barras.


asColumnChart()

Establece el tipo de gráfico en ColumnChart y muestra un EmbeddedColumnChartBuilder.

Volver

EmbeddedColumnChartBuilder: Es un compilador para un gráfico de columnas.


asComboChart()

Establece el tipo de gráfico en ComboChart y muestra un EmbeddedComboChartBuilder.

Volver

EmbeddedComboChartBuilder: Es un compilador para un gráfico combinado.


asHistogramChart()

Establece el tipo de gráfico en HistogramChart y muestra un EmbeddedHistogramChartBuilder.

Volver

EmbeddedHistogramChartBuilder: Es un compilador para un gráfico de histograma.


asLineChart()

Establece el tipo de gráfico en LineChart y muestra un EmbeddedLineChartBuilder.

Volver

EmbeddedLineChartBuilder: Es un compilador para un gráfico de líneas.


asPieChart()

Establece el tipo de gráfico como PieChart y muestra un EmbeddedPieChartBuilder.

Volver

EmbeddedPieChartBuilder: Es un compilador para un gráfico circular.


asScatterChart()

Establece el tipo de gráfico en ScatterChart y muestra un EmbeddedScatterChartBuilder.

Volver

EmbeddedScatterChartBuilder: Es un compilador para un diagrama de dispersión.


asTableChart()

Establece el tipo de gráfico como TableChart y muestra un EmbeddedTableChartBuilder.

Volver

EmbeddedTableChartBuilder: Es un compilador para un gráfico de tablas.


build()

Crea el gráfico para reflejar todos los cambios realizados en él.

Este método no dibuja automáticamente el gráfico en la parte superior de la hoja de cálculo. Un gráfico nuevo debe insertarse a través de sheet.insertChart(chart) y se debe actualizar un gráfico existente 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 aún 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 se usa para encadenamiento.


enablePaging(enablePaging)

Establece si se habilita 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 de página predeterminado es 10.

Parámetros

NombreTipoDescripción
enablePagingBooleantrue si se debe habilitar la paginación; de lo contrario, false.

Volver

EmbeddedTableChartBuilder: Este compilador es útil para el encadenamiento.


enablePaging(pageSize)

Habilita la paginación y establece la cantidad 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

NombreTipoDescripción
pageSizeIntegerLa cantidad de filas en cada página de la tabla.

Volver

EmbeddedTableChartBuilder: Este compilador es útil para el encadenamiento.


enablePaging(pageSize, startPage)

Habilita la paginación, establece el número de filas en cada página y la primera página de la tabla que se mostrará (página los números están basados en cero).

El tamaño predeterminado de la página es 10 y la página de inicio predeterminada 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

NombreTipoDescripción
pageSizeIntegerLa cantidad de filas en cada página de la tabla.
startPageIntegerEs la primera página de la tabla que se mostrará (los números de página se basan en cero).

Volver

EmbeddedTableChartBuilder: Este compilador es útil para el encadenamiento.


enableRtlTable(rtlEnabled)

Se agrega compatibilidad básica para idiomas que se escriben de derecha a izquierda (como el árabe o el hebreo) al revertir el el orden de columnas de la tabla, para que la columna cero sea la columna que se encuentra más a la derecha y la última columna la columna más a la izquierda.

Esto no afecta al índice de columna en los datos subyacentes, solo al orden de visualización. La visualización de tablas no admite la visualización completa de idioma bidireccional (BiDi) 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 alto y ancho más pequeñas que la el tamaño de tabla requerido. El comportamiento predeterminado es la compatibilidad con RTL inhabilitada.

Parámetros

NombreTipoDescripción
rtlEnabledBooleantrue si la compatibilidad con la derecha a la izquierda debe estar habilitada, false de lo contrario.

Volver

EmbeddedTableChartBuilder: Este compilador es útil para el encadenamiento.


enableSorting(enableSorting)

Establece si se deben ordenar las columnas cuando el usuario hace clic en un encabezado.

Si el ordenamiento está habilitado, cuando los usuarios hacen clic en el encabezado de la columna, las filas se colocan ordenado. El comportamiento predeterminado es el ordenamiento habilitado.

Parámetros

NombreTipoDescripción
enableSortingBooleantrue para habilitar el ordenamiento haciendo clic en los encabezados de las columnas; de lo contrario, false.

Volver

EmbeddedTableChartBuilder: Este compilador es útil para el encadenamiento.


getChartType()

Muestra el tipo de gráfico actual.

Volver

ChartType: Es el tipo de gráfico.


getContainer()

Muestra el gráfico ContainerInfo, que encapsula el lugar en el que aparece el gráfico en la de la hoja de cálculo.

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: Es 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 array de rangos que funcionan como la fuente de datos de la compilación del gráfico.


removeRange(range)

Quita el rango especificado del gráfico que modifica este compilador. No arroja un error si el rango no está en este gráfico.

El rango que se quite debe coincidir con un rango agregado a través de addRange(range). de lo contrario, no se realizará ningún cambio en el gráfico. No se puede usar este método para quitar valores de forma parcial de un rango.

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

NombreTipoDescripción
rangeRangeEl rango que se quitará.

Volver

EmbeddedChartBuilder: Este compilador se usa para encadenamiento.


setChartType(type)

Cambia el tipo de gráfico. Por el momento, 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

NombreTipoDescripción
typeChartTypeEl tipo al que se cambiará este gráfico.

Volver

EmbeddedChartBuilder: Este compilador se usa para encadenamiento.


setFirstRowNumber(number)

Establece el número de fila para la primera fila de la tabla de datos.

El número 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

NombreTipoDescripción
numberIntegerEl número de la primera fila de la tabla de datos.

Volver

EmbeddedTableChartBuilder: Este compilador es útil para el encadenamiento.


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

NombreTipoDescripción
strategyChartHiddenDimensionStrategyLa estrategia que se usará para las filas y columnas ocultas.

Volver

EmbeddedChartBuilder: Este compilador se usa para encadenamiento.


setInitialSortingAscending(column)

Establece el índice de la columna según la cual la tabla debe ordenarse inicialmente (ascendente).

La columna os está ordenada de forma ascendente y está marcada con una flecha pequeña que lo indica.

// Creates a table chart builder and sorts it by the second column (ascending).
var builder = Charts.newTableChart();
builder.setInitialSortingAscending(2);

Parámetros

NombreTipoDescripción
columnIntegerNúmero de la columna según la cual la tabla debe ordenarse inicialmente.

Volver

EmbeddedTableChartBuilder: Este compilador es útil para el encadenamiento.


setInitialSortingDescending(column)

Establece el índice de la columna según la cual la tabla debe ordenarse inicialmente (orden descendente).

El SO de la columna está ordenado de forma descendente y está marcada con una flecha pequeña que lo indica.

// Creates a table chart builder and sorts it by the second column (descending).
var builder = Charts.newTableChart();
builder.setInitialSortingDescending(2);

Parámetros

NombreTipoDescripción
columnIntegerNúmero de la columna según la cual la tabla debe ordenarse inicialmente.

Volver

EmbeddedTableChartBuilder: Este compilador es útil para el encadenamiento.


setMergeStrategy(mergeStrategy)

Establece la estrategia de combinación que se debe utilizar cuando existe 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

NombreTipoDescripción
mergeStrategyChartMergeStrategyEstrategia de combinación a usar.

Volver

EmbeddedChartBuilder: Este compilador se usa para encadenamiento.


setNumHeaders(headers)

Establece el número 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

NombreTipoDescripción
headersIntegerLa cantidad de filas o columnas que se deben tratar como encabezados. Los valores negativos generan encabezados se detecten automáticamente.

Volver

EmbeddedChartBuilder: Este compilador se usa para encadenamiento.


setOption(option, value)

Establece las opciones avanzadas para este gráfico. Para ver una lista de las opciones disponibles, consulta Gráfico opciones de configuración.

Este método no valida que la opción que especifiques sea válida para este tipo de gráfico ni si sea del formato o la estructura correctos.

En este ejemplo, se muestra cómo cambiar el título y configurar una leyenda.

builder.setOption('title', 'Earnings projections');
builder.setOption('legend', {position: 'top', textStyle: {color: 'blue', fontSize: 16}});

Parámetros

NombreTipoDescripción
optionStringEl nombre de la opción.
valueObjectEl valor de la opción.

Volver

EmbeddedChartBuilder: Este compilador, para encadenamiento,


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Establece la posición y cambia el lugar en el que aparece el gráfico en la hoja. anchorRowPos y anchorColPos tienen el índice 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

NombreTipoDescripción
anchorRowPosIntegerEl lado superior del gráfico está anclado en esta fila.
anchorColPosIntegerEl lado izquierdo del gráfico está anclado en esta columna.
offsetXIntegerLa esquina superior derecha del gráfico está desplazada por esta cantidad de píxeles.
offsetYIntegerLa esquina inferior izquierda del gráfico está desplazada esta cantidad de píxeles.

Volver

EmbeddedChartBuilder: Este compilador se usa para encadenamiento.


setTransposeRowsAndColumns(transpose)

Establece si se transponen las filas y columnas del gráfico. Si se configuran como true, las filas y se cambien las columnas. 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

NombreTipoDescripción
transposeBooleanSi es true, las filas y columnas usadas para construir el gráfico se transpuesto.

Volver

EmbeddedChartBuilder: Este compilador se usa para encadenamiento.


showRowNumberColumn(showRowNumber)

Establece si se muestra el número de fila como la primera columna de la tabla.

El comportamiento predeterminado no muestra los números de las filas.

Parámetros

NombreTipoDescripción
showRowNumberBooleantrue si la primera columna de la tabla debe mostrar el número de fila. De lo contrario, false.

Volver

EmbeddedTableChartBuilder: Este compilador es útil para el encadenamiento.


useAlternatingRowStyle(alternate)

Establece si el estilo de color alternativo se debe asignar a las filas impares y pares de un gráfico de tabla.

El comportamiento predeterminado es que las filas tengan un estilo de color alternativo.

Parámetros

NombreTipoDescripción
alternateBooleantrue si los estilos de color deben ser alternados; de lo contrario, false.

Volver

EmbeddedTableChartBuilder: Este compilador es útil para el encadenamiento.