Builder para gráficos de histograma. Para mais detalhes, consulte a documentação do Gviz.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
add | Embedded | Adiciona um intervalo ao gráfico modificado por este builder. |
as | Embedded | Define o tipo de gráfico como "AreaChart" e retorna um Embedded . |
as | Embedded | Define o tipo de gráfico como "BarChart" e retorna um Embedded . |
as | Embedded | Define o tipo de gráfico como "ColumnChart" e retorna um Embedded . |
as | Embedded | Define o tipo de gráfico como "ComboChart" e retorna um Embedded . |
as | Embedded | Define o tipo de gráfico como HistogramChart e retorna um Embedded . |
as | Embedded | Define o tipo de gráfico como "LineChart" e retorna um Embedded . |
as | Embedded | Define o tipo de gráfico como PieChart e retorna um Embedded . |
as | Embedded | Define o tipo de gráfico como ScatterChart e retorna um Embedded . |
as | Embedded | Define o tipo de gráfico como "TableChart" e retorna um Embedded . |
build() | Embedded | Cria o gráfico para refletir todas as mudanças feitas nele. |
clear | Embedded | Remove todos os intervalos do gráfico modificado por esse builder. |
get | Chart | Retorna o tipo de gráfico atual. |
get | Container | Retorna a Container do gráfico, que encapsula onde o gráfico aparece na
planilha. |
get | Range[] | Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico. |
remove | Embedded | Remove o intervalo especificado do gráfico modificado por esse builder. |
reverse | Embedded | Inverte o desenho das séries no eixo do domínio. |
set | Embedded | Define a cor de fundo do gráfico. |
set | Embedded | Muda o tipo de gráfico. |
set | Embedded | Define as cores das linhas no gráfico. |
set | Embedded | Define a estratégia a ser usada para linhas e colunas ocultas. |
set | Embedded | Define a posição da legenda em relação ao gráfico. |
set | Embedded | Define o estilo de texto da legenda do gráfico. |
set | Embedded | Define a estratégia de mesclagem a ser usada quando mais de um intervalo existir. |
set | Embedded | Define o número de linhas ou colunas do intervalo que devem ser tratadas como cabeçalhos. |
set | Embedded | Define opções avançadas para este gráfico. |
set | Embedded | Define a posição, mudando onde o gráfico aparece na planilha. |
set | Embedded | Define o intervalo do gráfico. |
set | Embedded | Usa linhas empilhadas, ou seja, os valores de linhas e barras são empilhados (acumulados). |
set | Embedded | Define o título do gráfico. |
set | Embedded | Define o estilo de texto do título do gráfico. |
set | Embedded | Define se as linhas e colunas do gráfico são transpostas. |
set | Embedded | Define o estilo de texto do eixo horizontal. |
set | Embedded | Adiciona um título ao eixo horizontal. |
set | Embedded | Define o estilo do texto do título do eixo horizontal. |
set | Embedded | Define o estilo de texto do eixo vertical. |
set | Embedded | Adiciona um título ao eixo vertical. |
set | Embedded | Define o estilo do texto do título do eixo vertical. |
use | Embedded | Transforma o eixo de intervalo em uma escala logarítmica (exige que todos os valores sejam positivos). |
Documentação detalhada
add Range(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
Embedded
: este builder, para encadeamento
as Area Chart()
Define o tipo de gráfico como "AreaChart" e retorna um Embedded
.
Retornar
Embedded
: um builder para um gráfico de área
as Bar Chart()
Define o tipo de gráfico como "BarChart" e retorna um Embedded
.
Retornar
Embedded
: um criador de gráfico de barras
as Column Chart()
Define o tipo de gráfico como "ColumnChart" e retorna um Embedded
.
Retornar
Embedded
: um criador de gráficos de colunas
as Combo Chart()
Define o tipo de gráfico como "ComboChart" e retorna um Embedded
.
Retornar
Embedded
: um criador de gráficos de combinação
as Histogram Chart()
Define o tipo de gráfico como HistogramChart e retorna um Embedded
.
Retornar
Embedded
: um criador de gráficos de histograma
as Line Chart()
Define o tipo de gráfico como "LineChart" e retorna um Embedded
.
Retornar
Embedded
: um criador de gráficos de linhas
as Pie Chart()
Define o tipo de gráfico como PieChart e retorna um Embedded
.
Retornar
Embedded
: um criador de gráficos de pizza
as Scatter Chart()
Define o tipo de gráfico como ScatterChart e retorna um Embedded
.
Retornar
Embedded
: um builder para um gráfico de dispersão
as Table Chart()
Define o tipo de gráfico como "TableChart" e retorna um Embedded
.
Retornar
Embedded
: 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
Embedded
: o gráfico criado, que ainda precisa ser adicionado à planilha.
clear Ranges()
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
Embedded
: este builder, para encadeamento
get Chart Type()
get Container()
Retorna a Container
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
Container
: um objeto que contém a posição do contêiner do gráfico.
get Ranges()
Retorna uma cópia da lista de intervalos que estão fornecendo dados para o gráfico. Use add
e remove
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.
remove Range(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 add
.
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
Embedded
: este builder, para encadeamento
reverse Categories()
Inverte o desenho das séries no eixo do domínio. Para gráficos de intervalo vertical (como gráficos de linhas, de área ou de colunas), isso significa que o eixo horizontal é desenhado da direita para a esquerda. Para gráficos de intervalo horizontal (como gráficos de barras), isso significa que o eixo vertical é desenhado de cima para baixo. Para gráficos de pizza, isso significa que as fatias são desenhadas no sentido anti-horário.
// Creates a pie chart builder and sets drawing of the slices in a // counter-clockwise manner. const builder = Charts.newPieChart(); builder.reverseCategories();
Retornar
Embedded
: esse builder é útil para encadeamento.
set Background Color(cssValue)
Define a cor de fundo do gráfico.
// Creates a line chart builder and sets the background color to gray const builder = Charts.newLineChart(); builder.setBackgroundColor('gray');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
css | String | O valor CSS da cor (como "blue" ou "#00f" ). |
Retornar
Embedded
: esse builder é útil para encadeamento.
set Chart Type(type)
Muda o tipo de gráfico. No momento, nem todos os tipos de gráficos incorporados são compatíveis. Consulte 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);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
type | Chart | O tipo para mudar esse gráfico. |
Retornar
Embedded
: este builder, para encadeamento
set Colors(cssValues)
Define as cores das linhas no gráfico.
// Creates a line chart builder and sets the first two lines to be drawn in // green and red, respectively. const builder = Charts.newLineChart(); builder.setColors(['green', 'red']);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
css | String[] | Uma matriz de valores CSS de cor, como ["red", "#acf"] . O elemento n
na matriz representa a cor da linha n no gráfico. |
Retornar
Embedded
: esse builder é útil para encadeamento.
set Hidden Dimension Strategy(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 | Chart | A estratégia a ser usada para linhas e colunas ocultas. |
Retornar
Embedded
: este builder, para encadeamento
set Legend Position(position)
Define a posição da legenda em relação ao gráfico. Por padrão, não há legenda.
// Creates a line chart builder and sets the legend position to right. const builder = Charts.newLineChart(); builder.setLegendPosition(Charts.Position.RIGHT);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
position | Position | A posição da legenda. |
Retornar
Embedded
: esse builder é útil para encadeamento.
set Legend Text Style(textStyle)
Define o estilo de texto da legenda do gráfico.
// Creates a line chart builder and sets it up for a blue, 26-point legend. const textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26); const style = textStyleBuilder.build(); const builder = Charts.newLineChart(); builder.setLegendTextStyle(style);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | Text | O estilo de texto a ser usado na legenda do gráfico. |
Retornar
Embedded
: esse builder é útil para encadeamento.
set Merge Strategy(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 |
---|---|---|
merge | Chart | A estratégia de mesclagem a ser usada. |
Retornar
Embedded
: este builder, para encadeamento
set Num Headers(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
Embedded
: este builder, para encadeamento
set Option(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
Embedded
: este builder, para encadeamento.
set Position(anchorRowPos, anchorColPos, offsetX, offsetY)
Define a posição, mudando onde o gráfico aparece na planilha. anchor
e
anchor
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 |
---|---|---|
anchor | Integer | O lado superior do gráfico é ancorado nessa linha. |
anchor | 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
Embedded
: este builder, para encadeamento
set Range(start, end)
Define o intervalo do gráfico.
Se algum ponto de dados estiver fora do intervalo, ele será expandido para incluir esses pontos.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
start | Number | O valor da linha de grade mais baixa do eixo de intervalo. |
end | Number | O valor da linha de grade mais alta do eixo de intervalo. |
Retornar
Embedded
: esse builder é útil para encadeamento.
set Stacked()
Usa linhas empilhadas, ou seja, os valores de linhas e barras são empilhados (acumulados). Por padrão, não há empilhamento.
Retornar
Embedded
: esse builder é útil para encadeamento.
set Title(chartTitle)
Define o título do gráfico. O título é exibido centralizado acima do gráfico.
// Creates a line chart builder and title to 'My Line Chart'. const builder = Charts.newLineChart(); builder.setTitle('My Line Chart');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
chart | String | o título do gráfico. |
Retornar
Embedded
: esse builder é útil para encadeamento.
set Title Text Style(textStyle)
Define o estilo de texto do título do gráfico.
// Creates a line chart builder and sets it up for a blue, 26-point title. const textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26); const style = textStyleBuilder.build(); const builder = Charts.newLineChart(); builder.setTitleTextStyle(style);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | Text | O estilo de texto a ser usado para o título do gráfico. É possível criar um objeto Text chamando Charts.newTextStyle() . |
Retornar
Embedded
: esse builder é útil para encadeamento.
set Transpose Rows And Columns(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
Embedded
: este builder, para encadeamento
set XAxis Text Style(textStyle)
Define o estilo de texto do eixo horizontal.
// Creates a line chart builder and sets the X-axis text style to blue, 18-point // font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setXAxisTextStyle(textStyle);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | Text | O estilo de texto a ser usado para o título do eixo horizontal. É possível criar um objeto Text chamando Charts.newTextStyle() . |
Retornar
Embedded
: esse builder é útil para encadeamento.
set XAxis Title(title)
Adiciona um título ao eixo horizontal. O título é centralizado e aparece abaixo dos rótulos de valor do eixo.
// Creates a line chart builder and sets the X-axis title. const builder = Charts.newLineChart(); builder.setTitle('X-axis Title');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | O título do eixo X. |
Retornar
Embedded
: esse builder é útil para encadeamento.
set XAxis Title Text Style(textStyle)
Define o estilo do texto do título do eixo horizontal.
// Creates a line chart builder and sets the X-axis title text style to blue, // 18-point font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setXAxisTitleTextStyle(textStyle);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | Text | O estilo de texto a ser usado para o título do eixo horizontal. É possível criar um objeto Text chamando Charts.newTextStyle() . |
Retornar
Embedded
: esse builder é útil para encadeamento.
set YAxis Text Style(textStyle)
Define o estilo de texto do eixo vertical.
// Creates a line chart builder and sets the Y-axis text style to blue, 18-point // font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setYAxisTextStyle(textStyle);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | Text | O estilo de texto a ser usado para o título do eixo horizontal. É possível criar um objeto Text chamando Charts.newTextStyle() . |
Retornar
Embedded
: esse builder é útil para encadeamento.
set YAxis Title(title)
Adiciona um título ao eixo vertical. O título é centralizado e aparece à esquerda dos rótulos de valor.
// Creates a line chart builder and sets the Y-axis title. const builder = Charts.newLineChart(); builder.setYAxisTitle('Y-axis Title');
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | O título do eixo Y. |
Retornar
Embedded
: esse builder é útil para encadeamento.
set YAxis Title Text Style(textStyle)
Define o estilo do texto do título do eixo vertical.
// Creates a line chart builder and sets the Y-axis title text style to blue, // 18-point font. const textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); const builder = Charts.newLineChart(); builder.setYAxisTitleTextStyle(textStyle);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
text | Text | O estilo de texto a ser usado para o título do eixo horizontal. É possível criar um objeto Text chamando Charts.newTextStyle() . |
Retornar
Embedded
: esse builder é útil para encadeamento.
use Log Scale()
Transforma o eixo de intervalo em uma escala logarítmica (exige que todos os valores sejam positivos). O eixo de intervalo é o eixo vertical para gráficos verticais (como linha, área ou coluna) e o eixo horizontal para gráficos horizontais (como barra).
Retornar
Embedded
: esse builder é útil para encadeamento.