Se usó la API de Cloud Translation para traducir esta página.

Class EmbeddedChartBuilder

Es el compilador que se usa para editar un elemento EmbeddedChart. Los cambios realizados en el gráfico no se guardarán hasta Se llama a Sheet.updateChart(chart) en el gráfico recompilado.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B8");
var chart = sheet.getCharts()[0];
chart = chart.modify()
    .addRange(range)
    .setOption('title', 'Updated!')
    .setOption('animation.duration', 500)
    .setPosition(2,2,0,0)
    .build();
sheet.updateChart(chart);

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 como 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 como 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 como TableChart y muestra un `EmbeddedTableChartBuilder`.
`build()`	`EmbeddedChart`	Crea el gráfico para reflejar todos los cambios realizados en él.
`clearRanges()`	`EmbeddedChartBuilder`	Quita todos los rangos del gráfico que modifica este compilador.
`getChartType()`	`ChartType`	Muestra el tipo de gráfico actual.
`getContainer()`	`ContainerInfo`	Muestra 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)`	`EmbeddedChartBuilder`	Quita el rango especificado del gráfico que modifica este compilador.
`setChartType(type)`	`EmbeddedChartBuilder`	Cambia el tipo de gráfico.
`setHiddenDimensionStrategy(strategy)`	`EmbeddedChartBuilder`	Establece la estrategia que se usará para las filas y columnas ocultas.
`setMergeStrategy(mergeStrategy)`	`EmbeddedChartBuilder`	Establece la estrategia de combinación que se debe utilizar cuando existe más de un rango.
`setNumHeaders(headers)`	`EmbeddedChartBuilder`	Establece el número de filas o columnas del rango que deben tratarse como encabezados.
`setOption(option, value)`	`EmbeddedChartBuilder`	Establece las opciones avanzadas para este gráfico.
`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`	`EmbeddedChartBuilder`	Establece la posición y cambia el lugar en el que aparece el gráfico en la hoja.
`setTransposeRowsAndColumns(transpose)`	`EmbeddedChartBuilder`	Establece si se transponen las filas y columnas del gráfico.

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

Nombre	Tipo	Descripción
`range`	`Range`	El 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.

`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

Nombre	Tipo	Descripción
`range`	`Range`	El 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

Nombre	Tipo	Descripción
`type`	`ChartType`	El tipo al que se cambiará este gráfico.

Volver

EmbeddedChartBuilder: Este compilador se usa para 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

Nombre	Tipo	Descripción
`strategy`	`ChartHiddenDimensionStrategy`	La estrategia que se usará para las filas y columnas ocultas.

Volver

EmbeddedChartBuilder: Este compilador se usa para 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

Nombre	Tipo	Descripción
`mergeStrategy`	`ChartMergeStrategy`	Estrategia 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

Nombre	Tipo	Descripción
`headers`	`Integer`	La 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

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

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 está desplazada por esta cantidad de píxeles.
`offsetY`	`Integer`	La 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

Nombre	Tipo	Descripción
`transpose`	`Boolean`	Si es `true`, las filas y columnas usadas para construir el gráfico se transpuesto.

Volver

EmbeddedChartBuilder: Este compilador se usa para encadenamiento.