Class EmbeddedChart

EmbeddedChart

Representa un gráfico que se incrustó en una hoja de cálculo.

En este ejemplo, se muestra cómo modificar un gráfico existente:

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A2: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);

En este ejemplo, se muestra cómo crear un gráfico nuevo:

function newChart(range, sheet) {
  var sheet = SpreadsheetApp.getActiveSheet();
  var chartBuilder = sheet.newChart();
  chartBuilder.addRange(range)
      .setChartType(Charts.ChartType.LINE)
      .setOption('title', 'My Line Chart!');
  sheet.insertChart(chartBuilder.build());
}

Métodos

MétodoTipo de datos que se muestraDescripción breve
asDataSourceChart()DataSourceChartConvierte una instancia de gráfico de fuente de datos si este es un gráfico de fuente de datos o null de lo contrario.
getAs(contentType)BlobMuestra los datos dentro de este objeto como un BLOB convertido al tipo de contenido especificado.
getBlob()BlobMuestra los datos dentro de este objeto como un BLOB.
getChartId()IntegerMuestra un identificador estable para el gráfico que es único en la hoja de cálculo que contiene el gráfico o null si el gráfico no está en una hoja de cálculo.
getContainerInfo()ContainerInfoMuestra información sobre la posición del gráfico en una hoja.
getHiddenDimensionStrategy()ChartHiddenDimensionStrategyMuestra la estrategia que se usará para manejar filas y columnas ocultas.
getMergeStrategy()ChartMergeStrategyMuestra la estrategia de combinación que se usa cuando existe más de un rango.
getNumHeaders()IntegerMuestra el número de filas o columnas en el rango que se tratan como encabezados.
getOptions()ChartOptionsMuestra las opciones de este gráfico, como la altura, los colores y los ejes.
getRanges()Range[]Muestra los rangos que utiliza este gráfico como fuente de datos.
getTransposeRowsAndColumns()BooleanSi es true, se cambiarán las filas y columnas que se usan para propagar el gráfico.
modify()EmbeddedChartBuilderMuestra un EmbeddedChartBuilder que se puede usar para modificar este gráfico.

Documentación detallada

asDataSourceChart()

Convierte una instancia de gráfico de fuente de datos si este es un gráfico de fuente de datos o null de lo contrario.

Devolvedor

DataSourceChart: Es el gráfico de fuente de datos.


getAs(contentType)

Muestra los datos dentro de este objeto como un BLOB convertido al tipo de contenido especificado. Este método agrega la extensión adecuada al nombre de archivo, por ejemplo, “myfile.pdf”. Sin embargo, se supone que la parte del nombre de archivo que sigue al último punto (si existe) es una extensión existente que se debe reemplazar. En consecuencia, “ShoppingList.12.25.2014” se convierte en “ShoppingList.12.25.pdf”.

Para ver las cuotas diarias de las conversiones, consulta Cuotas de los servicios de Google. Los dominios de Google Workspace creados recientemente pueden estar sujetos a cuotas más estrictas de forma temporal.

Parámetros

NombreTipoDescripción
contentTypeStringEl tipo de MIME al que se realizará la conversión. Para la mayoría de los BLOB, 'application/pdf' es la única opción válida. En el caso de las imágenes en formato BMP, GIF, JPEG o PNG, también es válido cualquiera de los valores 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'.

Devolvedor

Blob: Son los datos como un BLOB.


getBlob()

Muestra los datos dentro de este objeto como un BLOB.

Devolvedor

Blob: Son los datos como un BLOB.


getChartId()

Muestra un identificador estable para el gráfico que es único en la hoja de cálculo que contiene el gráfico o null si el gráfico no está en una hoja de cálculo.

Devolvedor

Integer: Es un identificador de gráfico estable.


getContainerInfo()

Muestra información sobre la posición del gráfico en una hoja.

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();

var containerInfo = chart.getContainerInfo();

// 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());

Devolvedor

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


getHiddenDimensionStrategy()

Muestra la estrategia que se usará para manejar 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()

// Logs the strategy to use for hidden rows and columns which is
// Charts.ChartHiddenDimensionStrategy.IGNORE_COLUMNS in this case.
Logger.log(chart.getHiddenDimensionStrategy());

Devolvedor

ChartHiddenDimensionStrategy: Es la estrategia que se usará para filas y columnas ocultas.


getMergeStrategy()

Muestra la estrategia de combinación que se usa cuando existe más de un rango. Si es MERGE_ROWS, la fila se combinará; si es MERGE_COLUMNS, las columnas se combinarán. 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("C1:C10");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .addRange(range2)
    .setMergeStrategy(Charts.ChartMergeStrategy.MERGE_ROWS)
    .setPosition(5, 5, 0, 0)
    .build()

// Logs whether rows of multiple ranges are merged, which is MERGE_ROWS in this case.
Logger.log(chart.getMergeStrategy());

Devolvedor

ChartMergeStrategy: Es MERGE_ROWS si las filas se combinan en varios rangos; MERGE_COLUMNS si las columnas se combinan en varios rangos.


getNumHeaders()

Muestra el número de filas o columnas en el rango que se tratan 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()

// Logs the number of rows or columns to use as headers, which is 1 in this case.
Logger.log(chart.getHeaders());

Devolvedor

Integer: La cantidad de filas o columnas que se tratan como encabezados. Los valores negativos indican que los encabezados se detectan automáticamente.


getOptions()

Muestra las opciones de este gráfico, como la altura, los colores y los ejes.

Las opciones que se muestran son inmutables.

Devolvedor

ChartOptions: Son las opciones de este gráfico, como la altura, los colores y los ejes.


getRanges()

Muestra los rangos que utiliza este gráfico como fuente de datos.

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();

var ranges = chart.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());
}

Devolvedor

Range[]: Es un array de rangos que funciona como fuente de datos de este gráfico.


getTransposeRowsAndColumns()

Si es true, se cambiarán las filas y columnas que se usan para propagar el gráfico. 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()
    .addRange(range)
    .setChartType(Charts.ChartType.BAR)
    .setTransposeRowsAndColumns(true)
    .setPosition(5, 5, 0, 0)
    .build()

// Logs whether rows and columns should be transposed, which is true in this case.
Logger.log(chart.getTransposeRowsAndColumns());

Devolvedor

Boolean: Es true si se transponen las filas y columnas que se usaron para construir el gráfico.


modify()

Muestra un EmbeddedChartBuilder que se puede usar para modificar este gráfico. Invoca a sheet.updateChart(chart) para guardar los cambios.

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.getCharts()[0];
chart = chart.modify()
    .setOption('width', 800)
    .setOption('height', 640)
    .setPosition(5, 5, 0, 0)
    .build();
sheet.updateChart(chart);

Devolvedor

EmbeddedChartBuilder: Es un compilador para crear gráficos incorporados.