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 в противном случае.
get As(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
get Blob() Blob Верните данные внутри этого объекта в виде большого двоичного объекта.
get Chart Id() Integer Возвращает стабильный идентификатор диаграммы, уникальный во всей электронной таблице, содержащей диаграмму, или 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 — диаграмма источника данных.


get As(contentType)

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

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

Параметры

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

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

Blob — данные в виде большого двоичного объекта.


get Blob()

Верните данные внутри этого объекта в виде большого двоичного объекта.

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

Blob — данные в виде большого двоичного объекта.


get Chart Id()

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

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

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


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

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

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

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

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


modify()

Возвращает Embedded Chart Builder , который можно использовать для изменения этой диаграммы. Вызовитеsheet.updateChart 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 — конструктор для создания встроенных диаграмм.