Class EmbeddedChart

Встроенная диаграмма

Представляет собой диаграмму, встроенную в электронную таблицу.

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

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A2:B8');
let 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);

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

function newChart(range) {
  const sheet = SpreadsheetApp.getActiveSheet();
  const chartBuilder = sheet.newChart();
  chartBuilder.addRange(range)
      .setChartType(Charts.ChartType.LINE)
      .setOption('title', 'My Line Chart!');
  sheet.insertChart(chartBuilder.build());
}

Методы

Метод Тип возвращаемого значения Краткое описание
as Data Source Chart() Data Source Chart |null Если диаграмма является диаграммой источника данных, выполняется приведение типа к экземпляру диаграммы источника данных, в противном случае — null .
get As(contentType) Blob Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob), преобразованных в указанный тип содержимого.
get Blob() Blob Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob).
get Chart Id() Integer|null Возвращает стабильный идентификатор для диаграммы, уникальный во всей электронной таблице, содержащей диаграмму, или null если диаграмма отсутствует в электронной таблице.
get Container Info() Container Info Возвращает информацию о местоположении диаграммы на листе.
get Hidden Dimension Strategy() Chart Hidden Dimension Strategy Возвращает стратегию, используемую для обработки скрытых строк и столбцов.
get Merge Strategy() Chart Merge Strategy Возвращает стратегию слияния, используемую в случае наличия более чем одного диапазона.
get Num Headers() Integer Возвращает количество строк или столбцов в заданном диапазоне, которые рассматриваются как заголовки.
get Options() Chart Options Возвращает параметры для этой диаграммы, такие как высота, цвета и оси.
get Ranges() Range[] Возвращает диапазоны, которые используются в качестве источника данных для этой диаграммы.
get Transpose Rows And Columns() Boolean Если true , строки и столбцы, используемые для заполнения диаграммы, меняются местами.
modify() Embedded Chart Builder Возвращает Embedded Chart Builder , который можно использовать для изменения данной диаграммы.

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

as Data Source Chart()

Если диаграмма является диаграммой источника данных, выполняется приведение типа к экземпляру диаграммы источника данных, в противном случае — null .

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

Data Source Chart |null — Диаграмма источников данных.

get As(contentType)

Возвращает данные из этого объекта в виде двоичных данных (blob), преобразованных в указанный тип содержимого. Этот метод добавляет соответствующее расширение к имени файла — например, "myfile.pdf". Однако он предполагает, что часть имени файла, следующая за последней точкой (если таковая имеется), является существующим расширением, которое следует заменить. Следовательно, "ShoppingList.12.25.2014" становится "ShoppingList.12.25.pdf".

Чтобы просмотреть ежедневные квоты на конверсии, см. раздел «Квоты для сервисов Google» . На вновь созданные домены Google Workspace могут временно распространяться более строгие квоты.

Параметры

Имя Тип Описание
content Type String MIME-тип для преобразования. Для большинства файлов .blob единственным допустимым вариантом является 'application/pdf' . Для изображений в форматах BMP, GIF, JPEG или PNG также допустимы любые из 'image/bmp' , 'image/gif' , 'image/jpeg' или 'image/png' . Для документа Google Docs также допустим 'text/markdown' .

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

Blob — Данные в виде двоичных данных (blob).

get Blob()

Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob).

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

Blob — Данные в виде двоичных данных (blob).

get Chart Id()

Возвращает стабильный идентификатор для диаграммы, уникальный во всей электронной таблице, содержащей диаграмму, или null если диаграмма отсутствует в электронной таблице.

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

Integer|null — стабильный идентификатор диаграммы.

get Container Info()

Возвращает информацию о местоположении диаграммы на листе.

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

const containerInfo = chart.getContainerInfo();

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

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

Container Info — объект, содержащий положение контейнера диаграммы.

get Hidden Dimension Strategy()

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

// Logs the strategy to use for hidden rows and columns which is
// Charts.ChartHiddenDimensionStrategy.IGNORE_COLUMNS in this case.
Logger.log(chart.getHiddenDimensionStrategy());

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

Chart Hidden Dimension Strategy — стратегия, используемая для скрытия строк и столбцов.

get Merge Strategy()

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

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

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

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

Chart Merge Strategy : MERGE_ROWS — если объединяются строки из нескольких диапазонов; MERGE_COLUMNS если объединяются столбцы из нескольких диапазонов.

get Num Headers()

Возвращает количество строк или столбцов в заданном диапазоне, которые рассматриваются как заголовки.

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

// Logs the number of rows or columns to use as headers, which is 1 in this
// case.
Logger.log(chart.getHeaders());

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

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

get Options()

Возвращает параметры для этой диаграммы, такие как высота, цвета и оси.

Возвращаемые параметры являются неизменяемыми.

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

Chart Options — Параметры этой диаграммы, такие как высота, цвета и оси.

get Ranges()

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

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

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

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

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

get Transpose Rows And Columns()

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

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

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

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

Boolean — True если строки и столбцы, использованные для построения диаграммы, поменяны местами.

modify()

Возвращает Embedded Chart Builder , который можно использовать для изменения данной диаграммы. Вызовите метод sheet.updateChart(chart) , чтобы сохранить изменения.

const sheet = SpreadsheetApp.getActiveSheet();
let chart = sheet.getCharts()[0];
chart = chart.modify()
            .setOption('width', 800)
            .setOption('height', 640)
            .setPosition(5, 5, 0, 0)
            .build();
sheet.updateChart(chart);

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

Embedded Chart Builder — инструмент для создания встроенных диаграмм.