Esta página foi traduzida pela API Cloud Translation.

Class EmbeddedTableChartBuilder

Builder para gráficos de tabela. Para mais detalhes, consulte a documentação do Gviz.

Métodos

Método	Tipo de retorno	Breve descrição
`addRange(range)`	`EmbeddedChartBuilder`	Adiciona um intervalo ao gráfico modificado por este builder.
`asAreaChart()`	`EmbeddedAreaChartBuilder`	Define o tipo de gráfico como "AreaChart" e retorna um `EmbeddedAreaChartBuilder`.
`asBarChart()`	`EmbeddedBarChartBuilder`	Define o tipo de gráfico como "BarChart" e retorna um `EmbeddedBarChartBuilder`.
`asColumnChart()`	`EmbeddedColumnChartBuilder`	Define o tipo de gráfico como "ColumnChart" e retorna um `EmbeddedColumnChartBuilder`.
`asComboChart()`	`EmbeddedComboChartBuilder`	Define o tipo de gráfico como "ComboChart" e retorna um `EmbeddedComboChartBuilder`.
`asHistogramChart()`	`EmbeddedHistogramChartBuilder`	Define o tipo de gráfico como HistogramChart e retorna um `EmbeddedHistogramChartBuilder`.
`asLineChart()`	`EmbeddedLineChartBuilder`	Define o tipo de gráfico como "LineChart" e retorna um `EmbeddedLineChartBuilder`.
`asPieChart()`	`EmbeddedPieChartBuilder`	Define o tipo de gráfico como PieChart e retorna um `EmbeddedPieChartBuilder`.
`asScatterChart()`	`EmbeddedScatterChartBuilder`	Define o tipo de gráfico como ScatterChart e retorna um `EmbeddedScatterChartBuilder`.
`asTableChart()`	`EmbeddedTableChartBuilder`	Define o tipo de gráfico como "TableChart" e retorna um `EmbeddedTableChartBuilder`.
`build()`	`EmbeddedChart`	Cria o gráfico para refletir todas as mudanças feitas nele.
`clearRanges()`	`EmbeddedChartBuilder`	Remove todos os intervalos do gráfico modificado por esse builder.
`enablePaging(enablePaging)`	`EmbeddedTableChartBuilder`	Define se a paginação dos dados será ativada.
`enablePaging(pageSize)`	`EmbeddedTableChartBuilder`	Ativa a paginação e define o número de linhas em cada página.
`enablePaging(pageSize, startPage)`	`EmbeddedTableChartBuilder`	Ativa a paginação, define o número de linhas em cada página e a primeira página da tabela a ser mostrada (os números de página são baseados em zero).
`enableRtlTable(rtlEnabled)`	`EmbeddedTableChartBuilder`	Adiciona suporte básico para idiomas da direita para a esquerda (como árabe ou hebraico) revertendo a ordem das colunas da tabela, de modo que a coluna zero seja a mais à direita e a última coluna seja a mais à esquerda.
`enableSorting(enableSorting)`	`EmbeddedTableChartBuilder`	Define se as colunas serão classificadas quando o usuário clicar em um cabeçalho de coluna.
`getChartType()`	`ChartType`	Retorna o tipo de gráfico atual.
`getContainer()`	`ContainerInfo`	Retorna a `ContainerInfo` do gráfico, que encapsula onde o gráfico aparece na planilha.
`getRanges()`	`Range[]`	Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico.
`removeRange(range)`	`EmbeddedChartBuilder`	Remove o intervalo especificado do gráfico modificado por esse builder.
`setChartType(type)`	`EmbeddedChartBuilder`	Muda o tipo de gráfico.
`setFirstRowNumber(number)`	`EmbeddedTableChartBuilder`	Define o número da primeira linha na tabela de dados.
`setHiddenDimensionStrategy(strategy)`	`EmbeddedChartBuilder`	Define a estratégia a ser usada para linhas e colunas ocultas.
`setInitialSortingAscending(column)`	`EmbeddedTableChartBuilder`	Define o índice da coluna de acordo com a qual a tabela deve ser classificada inicialmente (em ordem crescente).
`setInitialSortingDescending(column)`	`EmbeddedTableChartBuilder`	Define o índice da coluna de acordo com a qual a tabela deve ser inicialmente classificada (descendente).
`setMergeStrategy(mergeStrategy)`	`EmbeddedChartBuilder`	Define a estratégia de mesclagem a ser usada quando mais de um intervalo existir.
`setNumHeaders(headers)`	`EmbeddedChartBuilder`	Define o número de linhas ou colunas do intervalo que devem ser tratadas como cabeçalhos.
`setOption(option, value)`	`EmbeddedChartBuilder`	Define opções avançadas para este gráfico.
`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`	`EmbeddedChartBuilder`	Define a posição, mudando onde o gráfico aparece na planilha.
`setTransposeRowsAndColumns(transpose)`	`EmbeddedChartBuilder`	Define se as linhas e colunas do gráfico são transpostas.
`showRowNumberColumn(showRowNumber)`	`EmbeddedTableChartBuilder`	Define se o número da linha será mostrado como a primeira coluna da tabela.
`useAlternatingRowStyle(alternate)`	`EmbeddedTableChartBuilder`	Define se o estilo de cor alternada é atribuído a linhas ímpares e pares de um gráfico de tabela.

Documentação detalhada

`addRange(range)`

Adiciona um intervalo ao gráfico modificado por este builder. Não adiciona o intervalo se ele já tiver sido adicionado ao gráfico.

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

sheet.insertChart(chart);

Parâmetros

Nome	Tipo	Descrição
`range`	`Range`	O intervalo a ser adicionado.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`asAreaChart()`

Define o tipo de gráfico como "AreaChart" e retorna um EmbeddedAreaChartBuilder.

Retornar

EmbeddedAreaChartBuilder: um builder para um gráfico de área

`asBarChart()`

Define o tipo de gráfico como "BarChart" e retorna um EmbeddedBarChartBuilder.

Retornar

EmbeddedBarChartBuilder: um criador de gráfico de barras

`asColumnChart()`

Define o tipo de gráfico como "ColumnChart" e retorna um EmbeddedColumnChartBuilder.

Retornar

EmbeddedColumnChartBuilder: um criador de gráficos de colunas

`asComboChart()`

Define o tipo de gráfico como "ComboChart" e retorna um EmbeddedComboChartBuilder.

Retornar

EmbeddedComboChartBuilder: um criador de gráficos de combinação

`asHistogramChart()`

Define o tipo de gráfico como HistogramChart e retorna um EmbeddedHistogramChartBuilder.

Retornar

EmbeddedHistogramChartBuilder: um criador de gráficos de histograma

`asLineChart()`

Define o tipo de gráfico como "LineChart" e retorna um EmbeddedLineChartBuilder.

Retornar

EmbeddedLineChartBuilder: um criador de gráficos de linhas

`asPieChart()`

Define o tipo de gráfico como PieChart e retorna um EmbeddedPieChartBuilder.

Retornar

EmbeddedPieChartBuilder: um criador de gráficos de pizza

`asScatterChart()`

Define o tipo de gráfico como ScatterChart e retorna um EmbeddedScatterChartBuilder.

Retornar

EmbeddedScatterChartBuilder: um builder para um gráfico de dispersão

`asTableChart()`

Define o tipo de gráfico como "TableChart" e retorna um EmbeddedTableChartBuilder.

Retornar

EmbeddedTableChartBuilder: um builder para um gráfico de tabela

`build()`

Cria o gráfico para refletir todas as mudanças feitas nele.

Esse método não desenha automaticamente o gráfico na parte de cima da planilha. Um novo gráfico precisa ser inserido usando sheet.insertChart(chart), e um gráfico existente precisa ser atualizado usando sheet.updateChart(chart).

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)
                  .setPosition(5, 5, 0, 0)
                  .build();

sheet.insertChart(chart);

Retornar

EmbeddedChart: o gráfico criado, que ainda precisa ser adicionado à planilha.

`clearRanges()`

Remove todos os intervalos do gráfico modificado por esse builder.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This code updates the chart to use only the new ranges while preserving the
// existing formatting of the chart.
const chart = sheet.getCharts()[0];
const newChart = chart.modify()
                     .clearRanges()
                     .addRange(sheet.getRange('A1:A5'))
                     .addRange(sheet.getRange('B1:B5'))
                     .build();
sheet.updateChart(newChart);

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`enablePaging(enablePaging)`

Define se a paginação dos dados será ativada.

O comportamento padrão é a paginação desativada. Se a paginação estiver ativada, o tamanho padrão da página será 10.

Parâmetros

Nome	Tipo	Descrição
`enablePaging`	`Boolean`	`true` se a paginação precisa ser ativada. Caso contrário, `false`.

Retornar

EmbeddedTableChartBuilder: esse builder é útil para encadeamento.

`enablePaging(pageSize)`

Ativa a paginação e define o número de linhas em cada página.

O tamanho de página padrão é 10.

// Creates a table chart builder and enables paging with page size of 5.
const builder = Charts.newTableChart();
builder.enablePaging(5);

Parâmetros

Nome	Tipo	Descrição
`pageSize`	`Integer`	O número de linhas em cada página da tabela.

Retornar

EmbeddedTableChartBuilder: esse builder é útil para encadeamento.

`enablePaging(pageSize, startPage)`

Ativa a paginação, define o número de linhas em cada página e a primeira página da tabela a ser mostrada (os números de página são baseados em zero).

O tamanho de página padrão é 10, e a página inicial padrão é 0.

// Creates a table chart builder and enables paging with page size of 5 and
// displays page 2 first.
const builder = Charts.newTableChart();
builder.enablePaging(5, 2);

Parâmetros

Nome	Tipo	Descrição
`pageSize`	`Integer`	O número de linhas em cada página da tabela.
`startPage`	`Integer`	A primeira página da tabela a ser exibida. Os números de página são baseados em zero.

Retornar

EmbeddedTableChartBuilder: esse builder é útil para encadeamento.

`enableRtlTable(rtlEnabled)`

Adiciona suporte básico para idiomas da direita para a esquerda (como árabe ou hebraico) revertendo a ordem das colunas da tabela, de modo que a coluna zero seja a mais à direita e a última coluna seja a mais à esquerda.

Isso não afeta o índice de colunas nos dados subjacentes, apenas a ordem de exibição. A visualização de idioma bidirecional (BiDi) completa não é compatível com a visualização de tabela, mesmo com essa opção. Essa opção será ignorada se você ativar a paginação (usando a opção de página) ou se a tabela tiver barras de rolagem porque você especificou opções de altura e largura menores que o tamanho da tabela. O comportamento padrão é o suporte a RTL desativado.

Parâmetros

Nome	Tipo	Descrição
`rtlEnabled`	`Boolean`	`true` se o suporte da direita para a esquerda precisa ser ativado, `false` caso contrário.

Retornar

EmbeddedTableChartBuilder: esse builder é útil para encadeamento.

`enableSorting(enableSorting)`

Define se as colunas serão classificadas quando o usuário clicar em um cabeçalho de coluna.

Se a ordenação estiver ativada, quando os usuários clicarem no cabeçalho da coluna, as linhas serão classificadas automaticamente. O comportamento padrão é a classificação ativada.

Parâmetros

Nome	Tipo	Descrição
`enableSorting`	`Boolean`	`true` para ativar a classificação clicando nos cabeçalhos das colunas, `false` caso contrário.

Retornar

EmbeddedTableChartBuilder: esse builder é útil para encadeamento.

`getChartType()`

Retorna o tipo de gráfico atual.

Retornar

ChartType: o tipo de gráfico.

`getContainer()`

Retorna a ContainerInfo do gráfico, que encapsula onde o gráfico aparece na planilha.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const 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()
const containerInfo = chartBuilder.getContainer();

// Logs the values 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.

`getRanges()`

Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico. Use addRange(range) e removeRange(range) para modificar essa lista.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const chartBuilder = sheet.newChart()
                         .setChartType(Charts.ChartType.BAR)
                         .addRange(sheet.getRange('A1:B8'))
                         .setPosition(5, 5, 0, 0);

const ranges = chartBuilder.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());
}

Retornar

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

`removeRange(range)`

Remove o intervalo especificado do gráfico modificado por esse builder. Não gera um erro se o intervalo não estiver no gráfico.

O intervalo removido precisa corresponder a um intervalo adicionado por addRange(range). Caso contrário, nenhuma mudança será feita no gráfico. Esse método não pode ser usado para remover parcialmente valores de um intervalo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const firstRange = sheet.getRange('A1:B5');
const secondRange = sheet.getRange('A6:B8');

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

const chart = chartBuilder.build();

sheet.insertChart(chart);

Parâmetros

Nome	Tipo	Descrição
`range`	`Range`	O intervalo a ser removido.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`setChartType(type)`

Muda o tipo de gráfico. No momento, nem todos os tipos de gráficos incorporados são compatíveis. Consulte ChartType.

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)
                  .setPosition(5, 5, 0, 0)
                  .build();

sheet.insertChart(chart);

Parâmetros

Nome	Tipo	Descrição
`type`	`ChartType`	O tipo para mudar esse gráfico.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`setFirstRowNumber(number)`

Define o número da primeira linha na tabela de dados.

O número de linha padrão da primeira linha é 1.

// Creates a table chart builder and sets the first row to be 2.
const builder = Charts.newTableChart();
builder.setFirstRowNumber(2);

Parâmetros

Nome	Tipo	Descrição
`number`	`Integer`	O número da primeira linha na tabela de dados.

Retornar

EmbeddedTableChartBuilder: esse builder é útil para encadeamento.

`setHiddenDimensionStrategy(strategy)`

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

sheet.insertChart(chart);

Parâmetros

Nome	Tipo	Descrição
`strategy`	`ChartHiddenDimensionStrategy`	A estratégia a ser usada para linhas e colunas ocultas.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`setInitialSortingAscending(column)`

Define o índice da coluna de acordo com a qual a tabela deve ser classificada inicialmente (em ordem crescente).

A coluna é classificada em ordem crescente e marcada com uma pequena seta que indica isso.

// Creates a table chart builder and sorts it by the second column (ascending).
const builder = Charts.newTableChart();
builder.setInitialSortingAscending(2);

Parâmetros

Nome	Tipo	Descrição
`column`	`Integer`	O número da coluna de acordo com a qual a tabela deve ser inicialmente classificada.

Retornar

EmbeddedTableChartBuilder: esse builder é útil para encadeamento.

`setInitialSortingDescending(column)`

Define o índice da coluna de acordo com a qual a tabela deve ser inicialmente classificada (descendente).

A coluna é classificada em ordem decrescente e marcada com uma pequena seta que indica isso.

// Creates a table chart builder and sorts it by the second column (descending).
const builder = Charts.newTableChart();
builder.setInitialSortingDescending(2);

Parâmetros

Nome	Tipo	Descrição
`column`	`Integer`	O número da coluna de acordo com a qual a tabela deve ser inicialmente classificada.

Retornar

EmbeddedTableChartBuilder: esse builder é útil para encadeamento.

`setMergeStrategy(mergeStrategy)`

Define a estratégia de mesclagem a ser usada quando mais de um intervalo existir. Se MERGE_ROWS, as linhas são mescladas. Se MERGE_COLUMNS, as colunas são mescladas. O valor padrão é MERGE_COLUMNS.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const range = sheet.getRange('A1:B10');
const range2 = sheet.getRange('C:C10');
const 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

Nome	Tipo	Descrição
`mergeStrategy`	`ChartMergeStrategy`	A estratégia de mesclagem a ser usada.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`setNumHeaders(headers)`

Define o número de linhas ou colunas do intervalo que devem ser tratadas como cabeçalhos.

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

sheet.insertChart(chart);

Parâmetros

Nome	Tipo	Descrição
`headers`	`Integer`	O número de linhas ou colunas a serem tratadas como cabeçalhos. Valores negativos fazem com que os cabeçalhos sejam detectados automaticamente.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`setOption(option, value)`

Define opções avançadas para este gráfico. Para conferir uma lista das opções disponíveis, consulte Opções de configuração de gráficos.

Esse método não valida se a opção especificada é válida para esse tipo de gráfico nem se o valor está no formato/estrutura correto.

Este exemplo mostra como mudar o título e definir uma legenda.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const sheet = spreadsheet.getSheets()[0];
const chart = sheet.newChart()
 .setOption('title', 'Earnings projections')
 .setOption('legend', {
   position: 'top',
   textStyle: { color: 'blue', fontSize: 16 },
 }).build();

Parâmetros

Nome	Tipo	Descrição
`option`	`String`	O nome da opção.
`value`	`Object`	O valor da opção.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento.

`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`

Define a posição, mudando onde o gráfico aparece na planilha. anchorRowPos e anchorColPos são indexados por 1.

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)
                  .setPosition(5, 5, 0, 0)
                  .build();

sheet.insertChart(chart);

Parâmetros

Nome	Tipo	Descrição
`anchorRowPos`	`Integer`	O lado superior do gráfico é ancorado nessa linha.
`anchorColPos`	`Integer`	O lado esquerdo do gráfico está fixado nessa coluna.
`offsetX`	`Integer`	O canto superior direito do gráfico é deslocado por esse número de pixels.
`offsetY`	`Integer`	O canto inferior esquerdo do gráfico é deslocado por esse número de pixels.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`setTransposeRowsAndColumns(transpose)`

Define se as linhas e colunas do gráfico são transpostas. Se definido como true, as linhas e colunas são trocadas. O padrão é false.

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)
                  .setTransposeRowsAndColumns(true)
                  .setPosition(5, 5, 0, 0)
                  .build();

sheet.insertChart(chart);

Parâmetros

Nome	Tipo	Descrição
`transpose`	`Boolean`	Se `true`, as linhas e colunas usadas para construir o gráfico são transpostas.

Retornar

EmbeddedChartBuilder: este builder, para encadeamento

`showRowNumberColumn(showRowNumber)`

Define se o número da linha será mostrado como a primeira coluna da tabela.

O comportamento padrão não mostra os números de linha.

Parâmetros

Nome	Tipo	Descrição
`showRowNumber`	`Boolean`	`true` se a primeira coluna da tabela precisa mostrar o número da linha, `false` caso contrário.

Retornar

EmbeddedTableChartBuilder: esse builder é útil para encadeamento.

`useAlternatingRowStyle(alternate)`

Define se o estilo de cor alternada é atribuído a linhas ímpares e pares de um gráfico de tabela.

O comportamento padrão é as linhas com estilo de cor alternada.

Parâmetros

Nome	Tipo	Descrição
`alternate`	`Boolean`	`true` se os estilos de cores precisarem ser alternados, `false` caso contrário.

Retornar

EmbeddedTableChartBuilder: esse builder é útil para encadeamento.