Class EmbeddedTableChartBuilder

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

Volver

EmbeddedChartBuilder: Este compilador, para encadenar.

Establece el tipo de gráfico en AreaChart y devuelve un EmbeddedAreaChartBuilder.

Volver

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

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

Volver

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

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

Volver

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

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

Volver

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

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

Volver

EmbeddedHistogramChartBuilder: Es un compilador para un histograma.

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

Volver

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

Establece el tipo de gráfico en PieChart y devuelve un EmbeddedPieChartBuilder.

Volver

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

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

Volver

EmbeddedScatterChartBuilder: Es un compilador para un gráfico de dispersión.

Establece el tipo de gráfico en TableChart y devuelve un EmbeddedTableChartBuilder.

Volver

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

Compila el gráfico para reflejar todos los cambios que se le realizaron.

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 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

EmbeddedChart: Es el gráfico creado, que aún debe agregarse a la hoja de cálculo.

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

EmbeddedChartBuilder: Este compilador, para encadenar.

Establece si se debe habilitar la paginación 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

Volver

EmbeddedTableChartBuilder: Este compilador, útil para el encadenamiento.

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.
const builder = Charts.newTableChart();
builder.enablePaging(5);

Parámetros

Volver

EmbeddedTableChartBuilder: Este compilador, útil para el encadenamiento.

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 comienzan en cero).

El tamaño de página predeterminado 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.
const builder = Charts.newTableChart();
builder.enablePaging(5, 2);

Parámetros

Volver

EmbeddedTableChartBuilder: Este compilador, útil para el encadenamiento.

Agrega compatibilidad básica para idiomas de derecha a izquierda (como el árabe o el hebreo) invirtiendo el orden de las columnas de la tabla, de modo que la columna cero sea la columna más a la derecha y la última columna sea la columna más a la izquierda.

Esto no afecta el índice de la columna en los datos subyacentes, solo el orden de visualización. La visualización de la tabla no admite la visualización completa de idiomas bidireccionales (BiDi) incluso con esta opción. Esta opción se ignora si habilitas la paginación (con la opción page) o si la tabla tiene barras de desplazamiento porque especificaste opciones de altura y ancho más pequeñas que el tamaño de tabla requerido. El comportamiento predeterminado es la compatibilidad con RTL inhabilitada.

Parámetros

Volver

EmbeddedTableChartBuilder: Este compilador, útil para el encadenamiento.

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

Si la clasificación está habilitada, cuando los usuarios hacen clic en el encabezado de la columna, las filas se clasifican automáticamente. El comportamiento predeterminado es la clasificación habilitada.

Parámetros

Volver

EmbeddedTableChartBuilder: Este compilador, útil para el encadenamiento.

Devuelve el tipo de gráfico actual.

Volver

ChartType: Es el tipo de gráfico.

Devuelve el objeto ContainerInfo 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

ContainerInfo: Es un objeto que contiene la posición del contenedor del gráfico.

Devuelve 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.

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 sirven como fuente de datos del gráfico que se compilará.

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 quitado 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. Este método no se puede usar para quitar parcialmente valores de un rango.

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 renders 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
// is not removed, and does not throw an exception
chartBuilder.removeRange(firstRange);
chartBuilder.removeRange(sheet.getRange('A6:B8'));

const chart = chartBuilder.build();

sheet.insertChart(chart);

Parámetros

Volver

EmbeddedChartBuilder: Este compilador, para encadenar.

Cambia el tipo de gráfico. Por el momento, no se admiten todos los tipos de gráficos incorporados. Consulta los ChartType.

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

Volver

EmbeddedChartBuilder: Este compilador, para encadenar.

Establece el número de fila 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.
const builder = Charts.newTableChart();
builder.setFirstRowNumber(2);

Parámetros

Volver

EmbeddedTableChartBuilder: Este compilador, útil para el encadenamiento.

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

Volver

EmbeddedChartBuilder: Este compilador, para encadenar.

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

La columna está ordenada en orden ascendente y está marcada con una pequeña flecha que lo indica.

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

Parámetros

Volver

EmbeddedTableChartBuilder: Este compilador, útil para el encadenamiento.

Establece el índice de la columna según la cual se debe ordenar inicialmente la tabla (de forma descendente).

La columna está ordenada en orden descendente y está marcada con una pequeña flecha que lo indica.

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

Parámetros

Volver

EmbeddedTableChartBuilder: Este compilador, útil para el encadenamiento.

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

Volver

EmbeddedChartBuilder: Este compilador, para encadenar.

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

Volver

EmbeddedChartBuilder: Este compilador, para encadenar.

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

Volver

EmbeddedChartBuilder: Este compilador, para encadenar.

Establece la posición y cambia el lugar en el que aparece el gráfico en la hoja. anchorRowPos y anchorColPos se indexan a partir 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

Volver

EmbeddedChartBuilder: Este compilador, para encadenar.

Establece si se transponen las filas y columnas del gráfico. 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

Volver

EmbeddedChartBuilder: Este compilador, para encadenar.

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

El comportamiento predeterminado es no mostrar los números de fila.

Parámetros

Volver

EmbeddedTableChartBuilder: Este compilador, útil para el encadenamiento.

Establece si se asigna un estilo de color alternado a las filas pares e impares de un gráfico de tabla.

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

Parámetros

Volver

EmbeddedTableChartBuilder: Este compilador, útil para el encadenamiento.