Class EmbeddedChart

EmbeddedChart

Representa um gráfico que foi incorporado a uma planilha.

Este exemplo mostra como modificar um gráfico:

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

Este exemplo mostra como criar um novo gráfico:

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 retornoBreve descrição
asDataSourceChart()DataSourceChartConverte para uma instância de gráfico da fonte de dados se o gráfico for de fonte de dados. Caso contrário, o resultado será null.
getAs(contentType)BlobRetorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorne os dados dentro desse objeto como um blob.
getChartId()IntegerRetorna um identificador estável para o gráfico que é exclusivo em toda a planilha que contém o gráfico ou null se o gráfico não estiver em uma planilha.
getContainerInfo()ContainerInfoRetorna informações sobre onde o gráfico está posicionado em uma página.
getHiddenDimensionStrategy()ChartHiddenDimensionStrategyRetorna a estratégia a ser usada para lidar com linhas e colunas ocultas.
getMergeStrategy()ChartMergeStrategyRetorna a estratégia de mesclagem usada quando há mais de um intervalo.
getNumHeaders()IntegerRetorna o número de linhas ou colunas do intervalo que são tratadas como cabeçalhos.
getOptions()ChartOptionsRetorna as opções desse gráfico, como altura, cores e eixos.
getRanges()Range[]Retorna os intervalos que este gráfico usa como fonte de dados.
getTransposeRowsAndColumns()BooleanSe for true, as linhas e colunas usadas para preencher o gráfico serão alteradas.
modify()EmbeddedChartBuilderRetorna um EmbeddedChartBuilder que pode ser usado para modificar esse gráfico.

Documentação detalhada

asDataSourceChart()

Converte para uma instância de gráfico da fonte de dados se o gráfico for de fonte de dados. Caso contrário, o resultado será null.

Retorno

DataSourceChart: o gráfico da fonte de dados.


getAs(contentType)

Retorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado. Esse método adiciona a extensão apropriada ao nome do arquivo, por exemplo, "meuarquivo.pdf". No entanto, ela pressupõe que a parte do nome do arquivo que segue o último ponto (se houver) é uma extensão que precisa ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ShoppingList.12.25.pdf".

Para ver as cotas diárias de conversões, consulte Cotas para Serviços do Google. Os domínios do Google Workspace recém-criados podem estar temporariamente sujeitos a cotas mais rigorosas.

Parâmetros

NomeTipoDescrição
contentTypeStringO tipo MIME para conversão. Para a maioria dos blobs, 'application/pdf' é a única opção válida. Para imagens no formato BMP, GIF, JPEG ou PNG, qualquer elemento 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' também é válido.

Retorno

Blob: os dados como um blob.


getBlob()

Retorne os dados dentro desse objeto como um blob.

Retorno

Blob: os dados como um blob.


getChartId()

Retorna um identificador estável para o gráfico que é exclusivo em toda a planilha que contém o gráfico ou null se o gráfico não estiver em uma planilha.

Retorno

Integer: um identificador de gráfico estável.


getContainerInfo()

Retorna informações sobre onde o gráfico está posicionado em uma página.

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

Retorno

ContainerInfo: um objeto que contém a posição do contêiner do gráfico.


getHiddenDimensionStrategy()

Retorna a estratégia a ser usada para lidar com linhas e colunas ocultas. O valor padrão é 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());

Retorno

ChartHiddenDimensionStrategy: a estratégia a ser usada para linhas e colunas ocultas.


getMergeStrategy()

Retorna a estratégia de mesclagem usada quando há mais de um intervalo. Se MERGE_ROWS, a linha será mesclada. Se MERGE_COLUMNS, as colunas serão mescladas. Por padrão, é configurado como 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());

Retorno

ChartMergeStrategy: MERGE_ROWS se as linhas forem mescladas em vários intervalos; MERGE_COLUMNS se as colunas forem mescladas em vários intervalos.


getNumHeaders()

Retorna o número de linhas ou colunas do intervalo que são tratadas como cabeçalhos.

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

Retorno

Integer: o número de linhas ou colunas tratadas como cabeçalhos. Valores negativos indicam que os cabeçalhos são detectados automaticamente.


getOptions()

Retorna as opções desse gráfico, como altura, cores e eixos.

As opções retornadas são imutáveis.

Retorno

ChartOptions: as opções do gráfico, como altura, cores e eixos.


getRanges()

Retorna os intervalos que este gráfico usa como fonte de dados.

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

Retorno

Range[]: uma matriz de intervalos que servem como a fonte de dados do gráfico.


getTransposeRowsAndColumns()

Se for true, as linhas e colunas usadas para preencher o gráfico serão alteradas. O padrão é 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());

Retorno

Boolean: true se as linhas e colunas usadas para construir o gráfico forem transpostas.


modify()

Retorna um EmbeddedChartBuilder que pode ser usado para modificar esse gráfico. Invoque sheet.updateChart(chart) para salvar as mudanças.

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

Retorno

EmbeddedChartBuilder: um criador para gerar gráficos incorporados.