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 em uma instância de gráfico de fonte de dados se o gráfico for de fonte de dados ou null caso contrário.
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido no 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, contendo 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 existe mais de um intervalo.
getNumHeaders()IntegerRetorna o número de linhas ou colunas do intervalo que são tratados como cabeçalhos.
getOptions()ChartOptionsRetorna as opções do 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 o gráfico.

Documentação detalhada

asDataSourceChart()

Converte em uma instância de gráfico de fonte de dados se o gráfico for de fonte de dados ou null caso contrário.

Retornar

DataSourceChart: o gráfico da fonte de dados.

getAs(contentType)

Retorna os dados dentro desse objeto como um blob convertido no tipo de conteúdo especificado. Isso adiciona a extensão adequada ao nome do arquivo, por exemplo, "myfile.pdf". No entanto, pressupõe que a parte do nome do arquivo que segue o ponto final (se houver) é uma que deve ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ListaShopping.12.25.pdf".

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

Parâmetros

NomeTipoDescrição
contentTypeStringO tipo MIME em que a conversão será feita. Para a maioria dos blobs, 'application/pdf' é a única opção válida. Para imagens no formato BMP, GIF, JPEG ou PNG, qualquer um dos valores 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' também precisa ser válidos. Para um documento do Documentos Google, 'text/markdown' também é válido.

Retornar

Blob: os dados como um blob.

getBlob()

Retorne os dados dentro desse objeto como um blob.

Retornar

Blob: os dados como um blob.

getChartId()

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

Retornar

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

Retornar

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

Retornar

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

getMergeStrategy()

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

Retornar

ChartMergeStrategy — MERGE_ROWS se as linhas forem mescladas em vários intervalos MERGE_COLUMNS se as colunas estiverem mescladas em vários intervalos

getNumHeaders()

Retorna o número de linhas ou colunas do intervalo que são tratados 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());

Retornar

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

getOptions()

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

As opções retornadas não podem ser mudadas.

Retornar

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

Retornar

Range[]: uma matriz de intervalos que servem como a fonte de dados deste 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());

Retornar

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

modify()

Retorna um EmbeddedChartBuilder que pode ser usado para modificar o 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);

Retornar

EmbeddedChartBuilder: um builder para criação de gráficos incorporados.