Class EmbeddedChartBuilder

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
ВстроенныйChartBuilder

Builder, используемый для редактирования EmbeddedChart . Изменения, внесенные в диаграмму, не сохраняются до тех пор, пока на перестроенной диаграмме не будет Sheet.updateChart(chart) .

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1: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);

Методы

Метод Тип возврата Краткое описание
addRange(range) EmbeddedChartBuilder Добавляет диапазон к диаграмме, которую модифицирует этот построитель.
asAreaChart() EmbeddedAreaChartBuilder Задает тип диаграммы как AreaChart и возвращает EmbeddedAreaChartBuilder .
asBarChart() EmbeddedBarChartBuilder Задает тип диаграммы BarChart и возвращает EmbeddedBarChartBuilder .
asColumnChart() EmbeddedColumnChartBuilder Задает тип диаграммы ColumnChart и возвращает EmbeddedColumnChartBuilder .
asComboChart() EmbeddedComboChartBuilder Задает тип диаграммы ComboChart и возвращает EmbeddedComboChartBuilder .
asHistogramChart() EmbeddedHistogramChartBuilder Задает тип диаграммы как HistogramChart и возвращает EmbeddedHistogramChartBuilder .
asLineChart() EmbeddedLineChartBuilder Задает тип диаграммы LineChart и возвращает EmbeddedLineChartBuilder .
asPieChart() EmbeddedPieChartBuilder Задает тип диаграммы PieChart и возвращает EmbeddedPieChartBuilder .
asScatterChart() EmbeddedScatterChartBuilder Задает тип диаграммы ScatterChart и возвращает EmbeddedScatterChartBuilder .
asTableChart() EmbeddedTableChartBuilder Задает тип диаграммы TableChart и возвращает EmbeddedTableChartBuilder .
build() EmbeddedChart Создает диаграмму, чтобы отразить все внесенные в нее изменения.
clearRanges() EmbeddedChartBuilder Удаляет все диапазоны из диаграммы, которую модифицирует этот построитель.
getChartType() ChartType Возвращает текущий тип диаграммы.
getContainer() ContainerInfo Возвратите ContainerInfo диаграммы, которая инкапсулирует, где диаграмма появляется на листе.
getRanges() Range[] Возвращает копию списка диапазонов, в настоящее время предоставляющих данные для этой диаграммы.
removeRange(range) EmbeddedChartBuilder Удаляет указанный диапазон из диаграммы, которую модифицирует этот построитель.
setChartType(type) EmbeddedChartBuilder Изменяет тип диаграммы.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Задает стратегию для скрытых строк и столбцов.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Задает стратегию слияния, которую следует использовать, когда существует более одного диапазона.
setNumHeaders(headers) EmbeddedChartBuilder Задает количество строк или столбцов диапазона, которые следует рассматривать как заголовки.
setOption(option, value) EmbeddedChartBuilder Задает дополнительные параметры для этой диаграммы.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Задает положение, изменяя положение диаграммы на листе.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Устанавливает, будут ли строки и столбцы диаграммы транспонированы.

Подробная документация

addRange(range)

Добавляет диапазон к диаграмме, которую модифицирует этот построитель. Не добавляет диапазон, если он уже был добавлен на диаграмму.

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

sheet.insertChart(chart);

Параметры

Имя Тип Описание
range Range Диапазон для добавления.

Возвращаться

EmbeddedChartBuilder — этот построитель для цепочки


asAreaChart()

Задает тип диаграммы как AreaChart и возвращает EmbeddedAreaChartBuilder .

Возвращаться

EmbeddedAreaChartBuilder — построитель диаграмм с областями


asBarChart()

Задает тип диаграммы BarChart и возвращает EmbeddedBarChartBuilder .

Возвращаться

EmbeddedBarChartBuilder — построитель гистограммы


asColumnChart()

Задает тип диаграммы ColumnChart и возвращает EmbeddedColumnChartBuilder .

Возвращаться

EmbeddedColumnChartBuilder — построитель столбчатой ​​диаграммы


asComboChart()

Задает тип диаграммы ComboChart и возвращает EmbeddedComboChartBuilder .

Возвращаться

EmbeddedComboChartBuilder — конструктор комбо-диаграмм


asHistogramChart()

Задает тип диаграммы как HistogramChart и возвращает EmbeddedHistogramChartBuilder .

Возвращаться

EmbeddedHistogramChartBuilder — построитель гистограммы


asLineChart()

Задает тип диаграммы LineChart и возвращает EmbeddedLineChartBuilder .

Возвращаться

EmbeddedLineChartBuilder — построитель линейного графика


asPieChart()

Задает тип диаграммы PieChart и возвращает EmbeddedPieChartBuilder .

Возвращаться

EmbeddedPieChartBuilder — построитель круговой диаграммы


asScatterChart()

Задает тип диаграммы ScatterChart и возвращает EmbeddedScatterChartBuilder .

Возвращаться

EmbeddedScatterChartBuilder — построитель точечной диаграммы


asTableChart()

Задает тип диаграммы TableChart и возвращает EmbeddedTableChartBuilder .

Возвращаться

EmbeddedTableChartBuilder — построитель табличной диаграммы


build()

Создает диаграмму, чтобы отразить все внесенные в нее изменения.

Этот метод не рисует диаграмму автоматически поверх электронной таблицы. Новую диаграмму необходимо вставить с помощью sheet.insertChart(chart) , а существующую диаграмму следует обновить с помощью sheet.updateChart(chart) .

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

sheet.insertChart(chart);

Возвращаться

EmbeddedChart — созданная диаграмма, которую еще нужно добавить в таблицу


clearRanges()

Удаляет все диапазоны из диаграммы, которую модифицирует этот построитель.

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

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

Возвращаться

EmbeddedChartBuilder — этот построитель для цепочки


getChartType()

Возвращает текущий тип диаграммы.

Возвращаться

ChartType — тип диаграммы


getContainer()

Возвратите ContainerInfo диаграммы, которая инкапсулирует, где диаграмма появляется на листе.

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

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

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

Возвращаться

ContainerInfo — объект, содержащий позицию контейнера графика.


getRanges()

Возвращает копию списка диапазонов, в настоящее время предоставляющих данные для этой диаграммы. Используйте addRange(range) и removeRange(range) , чтобы изменить этот список.

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

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

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

Возвращаться

Range[] — массив диапазонов, которые служат источником данных для построения диаграммы.


removeRange(range)

Удаляет указанный диапазон из диаграммы, которую модифицирует этот построитель. Не выдает ошибку, если диапазон отсутствует на этой диаграмме.

Удаленный диапазон должен совпадать с диапазоном, добавленным через addRange(range) ; в противном случае никакие изменения не вносятся в диаграмму. Этот метод нельзя использовать для частичного удаления значений из диапазона.

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

var firstRange = sheet.getRange("A1:B5");
var secondRange = sheet.getRange("A6:B8");

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

var chart = chartBuilder.build();

sheet.insertChart(chart);

Параметры

Имя Тип Описание
range Range Диапазон для удаления.

Возвращаться

EmbeddedChartBuilder — этот построитель для цепочки


setChartType(type)

Изменяет тип диаграммы. В настоящее время поддерживаются не все типы встроенных диаграмм. См. ChartType .

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

sheet.insertChart(chart);

Параметры

Имя Тип Описание
type ChartType Тип, на который следует изменить эту диаграмму.

Возвращаться

EmbeddedChartBuilder — этот построитель для цепочки


setHiddenDimensionStrategy(strategy)

Задает стратегию для скрытых строк и столбцов. По умолчанию 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();

sheet.insertChart(chart);

Параметры

Имя Тип Описание
strategy ChartHiddenDimensionStrategy Стратегия, используемая для скрытых строк и столбцов.

Возвращаться

EmbeddedChartBuilder — этот построитель для цепочки


setMergeStrategy(mergeStrategy)

Задает стратегию слияния, которую следует использовать, когда существует более одного диапазона. Если MERGE_ROWS , строки объединяются; если MERGE_COLUMNS , столбцы объединяются. По умолчанию MERGE_COLUMNS .

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

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

Параметры

Имя Тип Описание
mergeStrategy ChartMergeStrategy Используемая стратегия слияния.

Возвращаться

EmbeddedChartBuilder — этот построитель для цепочки


setNumHeaders(headers)

Задает количество строк или столбцов диапазона, которые следует рассматривать как заголовки.

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

sheet.insertChart(chart);

Параметры

Имя Тип Описание
headers Integer Количество строк или столбцов, которые следует рассматривать как заголовки. Отрицательные значения вызывают автоматическое обнаружение заголовков.

Возвращаться

EmbeddedChartBuilder — этот построитель для цепочки


setOption(option, value)

Задает дополнительные параметры для этой диаграммы. Чтобы просмотреть список доступных параметров, см. раздел Параметры конфигурации диаграммы .

Этот метод не проверяет, действителен ли указанный вами параметр для этого типа диаграммы, а также правильно ли формат/структура значения.

В этом примере показано, как изменить заголовок и установить легенду.

builder.setOption('title', 'Earnings projections');
builder.setOption('legend', {position: 'top', textStyle: {color: 'blue', fontSize: 16}});

Параметры

Имя Тип Описание
option String Название опции.
value Object Стоимость опции.

Возвращаться

EmbeddedChartBuilder — этот построитель для цепочки.


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Задает положение, изменяя положение диаграммы на листе. anchorRowPos и anchorColPos имеют индекс 1.

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

sheet.insertChart(chart);

Параметры

Имя Тип Описание
anchorRowPos Integer Верхняя сторона диаграммы привязана к этой строке.
anchorColPos Integer Левая сторона диаграммы привязана к этому столбцу.
offsetX Integer Верхний правый угол диаграммы смещается на это количество пикселей.
offsetY Integer Нижний левый угол диаграммы смещен на указанное количество пикселей.

Возвращаться

EmbeddedChartBuilder — этот построитель для цепочки


setTransposeRowsAndColumns(transpose)

Устанавливает, будут ли строки и столбцы диаграммы транспонированы. Если установлено значение true , строки и столбцы меняются местами. По умолчанию false .

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

sheet.insertChart(chart);

Параметры

Имя Тип Описание
transpose Boolean Если true , строки и столбцы, используемые для построения диаграммы, транспонируются.

Возвращаться

EmbeddedChartBuilder — этот построитель для цепочки