Class EmbeddedChart

Gráfico incorporado

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

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

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A2:B8');
let 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) {
  const sheet = SpreadsheetApp.getActiveSheet();
  const 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()DataSourceChartTransmite a una instancia de gráfico de fuente de datos si el gráfico 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()BlobDevuelve 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 lo contiene o null si el gráfico no está en una hoja de cálculo.
getContainerInfo()ContainerInfoDevuelve información sobre la posición del gráfico dentro de una hoja.
getHiddenDimensionStrategy()ChartHiddenDimensionStrategyMuestra la estrategia que se usará para controlar las filas y columnas ocultas.
getMergeStrategy()ChartMergeStrategyMuestra la estrategia de combinación que se usa cuando existe más de un rango.
getNumHeaders()IntegerMuestra la cantidad de filas o columnas del rango que se tratan como encabezados.
getOptions()ChartOptionsMuestra las opciones de este gráfico, como la altura, los colores y los ejes.
getRanges()Range[]Devuelve los rangos que este gráfico usa como fuente de datos.
getTransposeRowsAndColumns()BooleanSi es true, se cambian las filas y las 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()

Transmite a una instancia de gráfico de fuente de datos si el gráfico es un gráfico de fuente de datos o null de lo contrario.

Volver

DataSourceChart: Es el gráfico de la 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 del archivo, por ejemplo, "miarchivo.pdf". Sin embargo, se da por sentado que la parte del nombre de archivo que sigue al último punto (si corresponde) es una extensión existente que se debe reemplazar. Por lo tanto, "ShoppingList.12.25.2014" se convierte en "ShoppingList.12.25.pdf".

Para ver las cuotas diarias de conversiones, consulta Cuotas de los servicios de Google. Es posible que los dominios de Google Workspace recién creados estén sujetos temporalmente a cuotas más estrictas.

Parámetros

NombreTipoDescripción
contentTypeStringEs el tipo de MIME al que se debe realizar la conversión. Para la mayoría de los blobs, 'application/pdf' es la única opción válida. Para las imágenes en formato BMP, GIF, JPEG o PNG, también son válidos 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'. Para un documento de Documentos de Google, 'text/markdown' también es válido.

Volver

Blob: Los datos como un BLOB.

getBlob()

Devuelve los datos dentro de este objeto como un blob.

Volver

Blob: Los datos como un BLOB.

getChartId()

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

Volver

Integer: Es un identificador de gráfico estable.

getContainerInfo()

Devuelve información sobre la posición del gráfico dentro de una hoja. 

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

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

Volver

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

getHiddenDimensionStrategy()

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

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

Volver

ChartHiddenDimensionStrategy: Es la estrategia que se usará para las 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, 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('C1:C10');
const 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());

Volver

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

getNumHeaders()

Muestra la cantidad de filas o columnas del rango que se tratan 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();

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

Volver

Integer: Es 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.

Volver

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

getRanges()

Devuelve los rangos que este gráfico usa como fuente de datos. 

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

const ranges = chart.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 funcionan como fuente de datos de este gráfico.

getTransposeRowsAndColumns()

Si es true, se cambian las filas y las columnas que se usan para propagar el gráfico. 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()
                  .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());

Volver

Boolean: true si las filas y columnas que se usan para construir el gráfico están transpuestas.

modify()

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

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

Volver

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