Поделиться через


ExcelScript.ChartSeries interface

Представляет ряд в диаграмме.

Замечания

Примеры

/**
 * This sample produces a line chart with two series.
 * The chart assumes data in A1:E5 that looks like this:
 * Product Qtr1 Qtr2 Qtr3 Qtr4
 * Frames 5000 7000 6544 4377
 * Saddles 400 323 276 651
 */
function main(workbook: ExcelScript.Workbook) {
  // Establish the ranges to use.
  const sheet = workbook.getActiveWorksheet();
  const headerRange = sheet.getRange("A1:E1");
  const firstSeriesRange = sheet.getRange("A2:E2");
  const secondSeriesRange = sheet.getRange("A3:E3");

  // Create the chart.
  const lineChart = sheet.addChart(ExcelScript.ChartType.line, headerRange);

  // Add the first chart series.
  const firstSeries = lineChart.addChartSeries();
  firstSeries.setXAxisValues(headerRange);
  firstSeries.setValues(firstSeriesRange);

  // Add the second chart series.
  const secondSeries = lineChart.addChartSeries();
  secondSeries.setXAxisValues(headerRange);
  secondSeries.setValues(secondSeriesRange);
}

Методика

addChartTrendline(type)

Добавляет новую линию тренда в коллекцию линий тренда.

delete()

Удаляет ряд диаграммы.

getAxisGroup()

Указывает группу для указанного ряда.

getBinOptions()

Объединяет параметры интервалов для гистограмм и диаграмм Парето.

getBoxwhiskerOptions()

Объединяет параметры для диаграмм "ящик с усами"

getBubbleScale()

Может быть целым числом от 0 (нуля) до 300, представляющим процентное значение от размера по умолчанию. Это свойство применяется только к пузырьковым диаграммам.

getChartTrendline(index)

Возвращает объект линии тренда по индексу, который является порядком вставки в массиве элементов.

getChartType()

Представляет тип диаграммы для ряда. Дополнительные сведения см. в этой ExcelScript.ChartType статье.

getDataLabels()

Представляет коллекцию всех меток данных в ряде.

getDimensionDataSourceString(dimension)

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

getDimensionDataSourceType(dimension)

Возвращает тип источника данных ряда диаграммы.

getDimensionValues(dimension)

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

getDoughnutHoleSize()

Представляет размер отверстия ряда кольцевой диаграммы. Действителен только для диаграмм с кольцевой и кольцевой диаграммами. Выдает ошибку InvalidArgument на недопустимых диаграммах.

getExplosion()

Задает значение взрыва для круговой диаграммы или среза кольцевой диаграммы. Возвращает нуль (0) при отсутствии развертывания (верхушка сектора — в центре круговой диаграммы).

getFiltered()

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

getFirstSliceAngle()

Задает угол первого среза круговой диаграммы или кольцевой диаграммы в градусах (по часовой стрелке по вертикали). Применяется только к круговым, объемным круговым и кольцевым диаграммам. Может находиться в диапазоне от 0 до 360.

getFormat()

Представляет форматирование ряда диаграммы, включая формат заливки и линий.

getGapWidth()

Представляет ширину разрывов рядов диаграммы. Допустимо только для линейчатых и столбцовых диаграмм, а также для определенных классов линейных и круговых диаграмм. Создает исключение недопустимого аргумента на недопустимых диаграммах.

getGradientMaximumColor()

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

getGradientMaximumType()

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

getGradientMaximumValue()

Задает максимальное значение ряда диаграммы карты регионов.

getGradientMidpointColor()

Задает цвет для среднего значения ряда диаграмм карты регионов.

getGradientMidpointType()

Задает тип для среднего значения ряда диаграммы карты регионов.

getGradientMidpointValue()

Задает значение в середине ряда диаграммы карты регионов.

getGradientMinimumColor()

Задает цвет для минимального значения ряда диаграммы карты регионов.

getGradientMinimumType()

Указывает тип минимального значения ряда диаграмм карты региона.

getGradientMinimumValue()

Задает минимальное значение ряда диаграммы карты регионов.

getGradientStyle()

Задает стиль градиента ряда диаграммы карты регионов.

getHasDataLabels()

Указывает, имеет ли ряд метки данных.

getInvertColor()

Задает цвет заливки для отрицательных точек данных в ряде.

getInvertIfNegative()

Значение true, если Excel инвертирует шаблон в элементе, если он соответствует отрицательному числу.

getMapOptions()

Объединяет параметры для диаграммы с картой региона.

getMarkerBackgroundColor()

Задает цвет фона маркера ряда диаграммы.

getMarkerForegroundColor()

Задает цвет маркера переднего плана ряда диаграммы.

getMarkerSize()

Задает размер маркера ряда диаграммы. Поддерживаемый диапазон размеров — от 2 до 72. Этот метод возвращает ошибку InvalidArgument, если задан размер за пределами поддерживаемого диапазона.

getMarkerStyle()

Задает стиль маркера ряда диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartMarkerStyle статье.

getName()

Указывает имя ряда на диаграмме. Длина имени не должна превышать 255 символов.

getOverlap()

Указывает на расположение строк и столбцов. Может находиться в диапазоне от -100 до 100. Применяется только к двумерным диаграммам и гистограммам.

getParentLabelStrategy()

Задает область стратегии родительской метки ряда для диаграммы дерева.

getPlotOrder()

Задает порядок построения ряда диаграммы в группе диаграмм.

getPoints()

Возвращает коллекцию всех точек ряда.

getSecondPlotSize()

Задает размер вторичного раздела круговой диаграммы или линейчатой круговой диаграммы в процентах от размера основного кругового круга. Может находиться в диапазоне от 5 до 200.

getShowConnectorLines()

Указывает, отображаются ли линии соединителя в каскадных диаграммах.

getShowLeaderLines()

Указывает, отображаются ли линии-лидеры для каждой метки данных в ряде.

getShowShadow()

Указывает, имеет ли ряд тень.

getSmooth()

Указывает, является ли ряд гладким. Применимо только к линейным диаграммам и точечным диаграммам.

getSplitType()

Указывает способ разделения двух разделов круговой диаграммы или линейчатой диаграммы.

getSplitValue()

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

getTrendlines()

Коллекция линий тренда в серии.

getVaryByCategories()

Значение true, если Excel присваивает каждому маркеру данных другой цвет или узор. Диаграмма должна содержать только один ряд.

getXErrorBars()

Представляет объект планки погрешностей для ряда диаграммы.

getYErrorBars()

Представляет объект планки погрешностей для ряда диаграммы.

setAxisGroup(axisGroup)

Указывает группу для указанного ряда.

setBubbleScale(bubbleScale)

Может быть целым числом от 0 (нуля) до 300, представляющим процентное значение от размера по умолчанию. Это свойство применяется только к пузырьковым диаграммам.

setBubbleSizes(sourceData)

Задает размеры пузырьков для ряда диаграмм. Применяется только для пузырьковых диаграмм.

setChartType(chartType)

Представляет тип диаграммы для ряда. Дополнительные сведения см. в этой ExcelScript.ChartType статье.

setDoughnutHoleSize(doughnutHoleSize)

Представляет размер отверстия ряда кольцевой диаграммы. Действителен только для диаграмм с кольцевой и кольцевой диаграммами. Выдает ошибку InvalidArgument на недопустимых диаграммах.

setExplosion(explosion)

Задает значение взрыва для круговой диаграммы или среза кольцевой диаграммы. Возвращает нуль (0) при отсутствии развертывания (верхушка сектора — в центре круговой диаграммы).

setFiltered(filtered)

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

setFirstSliceAngle(firstSliceAngle)

Задает угол первого среза круговой диаграммы или кольцевой диаграммы в градусах (по часовой стрелке по вертикали). Применяется только к круговым, объемным круговым и кольцевым диаграммам. Может находиться в диапазоне от 0 до 360.

setGapWidth(gapWidth)

Представляет ширину разрывов рядов диаграммы. Допустимо только для линейчатых и столбцовых диаграмм, а также для определенных классов линейных и круговых диаграмм. Создает исключение недопустимого аргумента на недопустимых диаграммах.

setGradientMaximumColor(gradientMaximumColor)

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

setGradientMaximumType(gradientMaximumType)

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

setGradientMaximumValue(gradientMaximumValue)

Задает максимальное значение ряда диаграммы карты регионов.

setGradientMidpointColor(gradientMidpointColor)

Задает цвет для среднего значения ряда диаграмм карты регионов.

setGradientMidpointType(gradientMidpointType)

Задает тип для среднего значения ряда диаграммы карты регионов.

setGradientMidpointValue(gradientMidpointValue)

Задает значение в середине ряда диаграммы карты регионов.

setGradientMinimumColor(gradientMinimumColor)

Задает цвет для минимального значения ряда диаграммы карты регионов.

setGradientMinimumType(gradientMinimumType)

Указывает тип минимального значения ряда диаграмм карты региона.

setGradientMinimumValue(gradientMinimumValue)

Задает минимальное значение ряда диаграммы карты регионов.

setGradientStyle(gradientStyle)

Задает стиль градиента ряда диаграммы карты регионов.

setHasDataLabels(hasDataLabels)

Указывает, имеет ли ряд метки данных.

setInvertColor(invertColor)

Задает цвет заливки для отрицательных точек данных в ряде.

setInvertIfNegative(invertIfNegative)

Значение true, если Excel инвертирует шаблон в элементе, если он соответствует отрицательному числу.

setMarkerBackgroundColor(markerBackgroundColor)

Задает цвет фона маркера ряда диаграммы.

setMarkerForegroundColor(markerForegroundColor)

Задает цвет маркера переднего плана ряда диаграммы.

setMarkerSize(markerSize)

Задает размер маркера ряда диаграммы. Поддерживаемый диапазон размеров — от 2 до 72. Этот метод возвращает ошибку InvalidArgument, если задан размер за пределами поддерживаемого диапазона.

setMarkerStyle(markerStyle)

Задает стиль маркера ряда диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartMarkerStyle статье.

setName(name)

Указывает имя ряда на диаграмме. Длина имени не должна превышать 255 символов.

setOverlap(overlap)

Указывает на расположение строк и столбцов. Может находиться в диапазоне от -100 до 100. Применяется только к двумерным диаграммам и гистограммам.

setParentLabelStrategy(parentLabelStrategy)

Задает область стратегии родительской метки ряда для диаграммы дерева.

setPlotOrder(plotOrder)

Задает порядок построения ряда диаграммы в группе диаграмм.

setSecondPlotSize(secondPlotSize)

Задает размер вторичного раздела круговой диаграммы или линейчатой круговой диаграммы в процентах от размера основного кругового круга. Может находиться в диапазоне от 5 до 200.

setShowConnectorLines(showConnectorLines)

Указывает, отображаются ли линии соединителя в каскадных диаграммах.

setShowLeaderLines(showLeaderLines)

Указывает, отображаются ли линии-лидеры для каждой метки данных в ряде.

setShowShadow(showShadow)

Указывает, имеет ли ряд тень.

setSmooth(smooth)

Указывает, является ли ряд гладким. Применимо только к линейным диаграммам и точечным диаграммам.

setSplitType(splitType)

Указывает способ разделения двух разделов круговой диаграммы или линейчатой диаграммы.

setSplitValue(splitValue)

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

setValues(sourceData)

Задает значения для ряда диаграммы. Для точечной диаграммы она относится к значениям оси Y.

setVaryByCategories(varyByCategories)

Значение true, если Excel присваивает каждому маркеру данных другой цвет или узор. Диаграмма должна содержать только один ряд.

setXAxisValues(sourceData)

Задает значения оси X для ряда диаграммы.

Подробнее о методе

addChartTrendline(type)

Добавляет новую линию тренда в коллекцию линий тренда.

addChartTrendline(type?: ChartTrendlineType): ChartTrendline;

Параметры

type
ExcelScript.ChartTrendlineType

Указывает тип линии тренда. Значение по умолчанию — Linear. Дополнительные сведения см. в этой ExcelScript.ChartTrendline статье.

Возвращает

delete()

Удаляет ряд диаграммы.

delete(): void;

Возвращает

void

Примеры

/**
 * This sample creates a bubble chart and manually adds each series.
 */
function main(workbook: ExcelScript.Workbook) {
  const sheet = workbook.getActiveWorksheet();
  
  // Add sample data.
  const data = [
    ["Product", "Price ($)", "Quality Score", "Market Share"],
    ["Keyboards", 85, 88, 25],
    ["Mice", 120, 80, 20]
  ];
  const dataRange = sheet.getRange("A1:D3");
  dataRange.setValues(data);
  
  // Create bubble chart - start with headers to create empty chart.
  const chart = sheet.addChart(
    ExcelScript.ChartType.bubble,
    sheet.getRange("B1:D1")
  );
  chart.setPosition("A5");
  chart.getTitle().setText("Product Analysis");
  
  // Remove any default series that were created.
  while (chart.getSeries().length > 0) {
    chart.getSeries()[0].delete();
  }
  
  // Add each product as its own series.
  for (let i = 2; i <= 3; i++) {
    const productName = sheet.getRange(`A${i}`).getValue() as string;
    const newSeries = chart.addChartSeries(productName);
    newSeries.setXAxisValues(sheet.getRange(`B${i}:B${i}`));
    newSeries.setValues(sheet.getRange(`C${i}:C${i}`));
    newSeries.setBubbleSizes(sheet.getRange(`D${i}:D${i}`));
  }
}

getAxisGroup()

Указывает группу для указанного ряда.

getAxisGroup(): ChartAxisGroup;

Возвращает

getBinOptions()

Объединяет параметры интервалов для гистограмм и диаграмм Парето.

getBinOptions(): ChartBinOptions;

Возвращает

getBoxwhiskerOptions()

Объединяет параметры для диаграмм "ящик с усами"

getBoxwhiskerOptions(): ChartBoxwhiskerOptions;

Возвращает

getBubbleScale()

Может быть целым числом от 0 (нуля) до 300, представляющим процентное значение от размера по умолчанию. Это свойство применяется только к пузырьковым диаграммам.

getBubbleScale(): number;

Возвращает

number

getChartTrendline(index)

Возвращает объект линии тренда по индексу, который является порядком вставки в массиве элементов.

getChartTrendline(index: number): ChartTrendline;

Параметры

index

number

Представляет порядок вставки в массиве элементов.

Возвращает

getChartType()

Представляет тип диаграммы для ряда. Дополнительные сведения см. в этой ExcelScript.ChartType статье.

getChartType(): ChartType;

Возвращает

getDataLabels()

Представляет коллекцию всех меток данных в ряде.

getDataLabels(): ChartDataLabels;

Возвращает

Примеры

/**
 * This sample accesses and configures data labels for a series.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Configure data labels via series.
  const series = chart.getSeries()[0];
  const dataLabels = series.getDataLabels();
  dataLabels.setShowPercentage(true);
  dataLabels.setShowValue(false);
}

getDimensionDataSourceString(dimension)

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

getDimensionDataSourceString(dimension: ChartSeriesDimension): string;

Параметры

dimension
ExcelScript.ChartSeriesDimension

Измерение оси, из которой происходит данные.

Возвращает

string

getDimensionDataSourceType(dimension)

Возвращает тип источника данных ряда диаграммы.

getDimensionDataSourceType(
            dimension: ChartSeriesDimension
        ): ChartDataSourceType;

Параметры

dimension
ExcelScript.ChartSeriesDimension

Измерение оси, из которой происходит данные.

Возвращает

getDimensionValues(dimension)

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

getDimensionValues(dimension: ChartSeriesDimension): string[];

Параметры

dimension
ExcelScript.ChartSeriesDimension

Измерение оси, из которой происходит данные.

Возвращает

string[]

getDoughnutHoleSize()

Представляет размер отверстия ряда кольцевой диаграммы. Действителен только для диаграмм с кольцевой и кольцевой диаграммами. Выдает ошибку InvalidArgument на недопустимых диаграммах.

getDoughnutHoleSize(): number;

Возвращает

number

getExplosion()

Задает значение взрыва для круговой диаграммы или среза кольцевой диаграммы. Возвращает нуль (0) при отсутствии развертывания (верхушка сектора — в центре круговой диаграммы).

getExplosion(): number;

Возвращает

number

getFiltered()

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

getFiltered(): boolean;

Возвращает

boolean

getFirstSliceAngle()

Задает угол первого среза круговой диаграммы или кольцевой диаграммы в градусах (по часовой стрелке по вертикали). Применяется только к круговым, объемным круговым и кольцевым диаграммам. Может находиться в диапазоне от 0 до 360.

getFirstSliceAngle(): number;

Возвращает

number

getFormat()

Представляет форматирование ряда диаграммы, включая формат заливки и линий.

getFormat(): ChartSeriesFormat;

Возвращает

Примеры

/**
 * This sample gets the series format to customize appearance.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Customize the series color.
  const series = chart.getSeries()[0];
  const format = series.getFormat();
  format.getFill().setSolidColor("#B0C4DE");
}

getGapWidth()

Представляет ширину разрывов рядов диаграммы. Допустимо только для линейчатых и столбцовых диаграмм, а также для определенных классов линейных и круговых диаграмм. Создает исключение недопустимого аргумента на недопустимых диаграммах.

getGapWidth(): number;

Возвращает

number

getGradientMaximumColor()

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

getGradientMaximumColor(): string;

Возвращает

string

getGradientMaximumType()

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

getGradientMaximumType(): ChartGradientStyleType;

Возвращает

getGradientMaximumValue()

Задает максимальное значение ряда диаграммы карты регионов.

getGradientMaximumValue(): number;

Возвращает

number

getGradientMidpointColor()

Задает цвет для среднего значения ряда диаграмм карты регионов.

getGradientMidpointColor(): string;

Возвращает

string

getGradientMidpointType()

Задает тип для среднего значения ряда диаграммы карты регионов.

getGradientMidpointType(): ChartGradientStyleType;

Возвращает

getGradientMidpointValue()

Задает значение в середине ряда диаграммы карты регионов.

getGradientMidpointValue(): number;

Возвращает

number

getGradientMinimumColor()

Задает цвет для минимального значения ряда диаграммы карты регионов.

getGradientMinimumColor(): string;

Возвращает

string

getGradientMinimumType()

Указывает тип минимального значения ряда диаграмм карты региона.

getGradientMinimumType(): ChartGradientStyleType;

Возвращает

getGradientMinimumValue()

Задает минимальное значение ряда диаграммы карты регионов.

getGradientMinimumValue(): number;

Возвращает

number

getGradientStyle()

Задает стиль градиента ряда диаграммы карты регионов.

getGradientStyle(): ChartGradientStyle;

Возвращает

getHasDataLabels()

Указывает, имеет ли ряд метки данных.

getHasDataLabels(): boolean;

Возвращает

boolean

getInvertColor()

Задает цвет заливки для отрицательных точек данных в ряде.

getInvertColor(): string;

Возвращает

string

getInvertIfNegative()

Значение true, если Excel инвертирует шаблон в элементе, если он соответствует отрицательному числу.

getInvertIfNegative(): boolean;

Возвращает

boolean

getMapOptions()

Объединяет параметры для диаграммы с картой региона.

getMapOptions(): ChartMapOptions;

Возвращает

getMarkerBackgroundColor()

Задает цвет фона маркера ряда диаграммы.

getMarkerBackgroundColor(): string;

Возвращает

string

getMarkerForegroundColor()

Задает цвет маркера переднего плана ряда диаграммы.

getMarkerForegroundColor(): string;

Возвращает

string

getMarkerSize()

Задает размер маркера ряда диаграммы. Поддерживаемый диапазон размеров — от 2 до 72. Этот метод возвращает ошибку InvalidArgument, если задан размер за пределами поддерживаемого диапазона.

getMarkerSize(): number;

Возвращает

number

getMarkerStyle()

Задает стиль маркера ряда диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartMarkerStyle статье.

getMarkerStyle(): ChartMarkerStyle;

Возвращает

getName()

Указывает имя ряда на диаграмме. Длина имени не должна превышать 255 символов.

getName(): string;

Возвращает

string

Примеры

/**
 * This sample logs the names of each of the chart series in a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let chart = selectedSheet.getChart("ColumnClusteredChart");

  // Log the name of each chart series in the chart.
  let seriesList = chart.getSeries();
  seriesList.forEach((series) => {
    console.log(series.getName());
  });
}

getOverlap()

Указывает на расположение строк и столбцов. Может находиться в диапазоне от -100 до 100. Применяется только к двумерным диаграммам и гистограммам.

getOverlap(): number;

Возвращает

number

getParentLabelStrategy()

Задает область стратегии родительской метки ряда для диаграммы дерева.

getParentLabelStrategy(): ChartParentLabelStrategy;

Возвращает

getPlotOrder()

Задает порядок построения ряда диаграммы в группе диаграмм.

getPlotOrder(): number;

Возвращает

number

getPoints()

Возвращает коллекцию всех точек ряда.

getPoints(): ChartPoint[];

Возвращает

getSecondPlotSize()

Задает размер вторичного раздела круговой диаграммы или линейчатой круговой диаграммы в процентах от размера основного кругового круга. Может находиться в диапазоне от 5 до 200.

getSecondPlotSize(): number;

Возвращает

number

getShowConnectorLines()

Указывает, отображаются ли линии соединителя в каскадных диаграммах.

getShowConnectorLines(): boolean;

Возвращает

boolean

getShowLeaderLines()

Указывает, отображаются ли линии-лидеры для каждой метки данных в ряде.

getShowLeaderLines(): boolean;

Возвращает

boolean

getShowShadow()

Указывает, имеет ли ряд тень.

getShowShadow(): boolean;

Возвращает

boolean

getSmooth()

Указывает, является ли ряд гладким. Применимо только к линейным диаграммам и точечным диаграммам.

getSmooth(): boolean;

Возвращает

boolean

getSplitType()

Указывает способ разделения двух разделов круговой диаграммы или линейчатой диаграммы.

getSplitType(): ChartSplitType;

Возвращает

getSplitValue()

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

getSplitValue(): number;

Возвращает

number

getTrendlines()

Коллекция линий тренда в серии.

getTrendlines(): ChartTrendline[];

Возвращает

getVaryByCategories()

Значение true, если Excel присваивает каждому маркеру данных другой цвет или узор. Диаграмма должна содержать только один ряд.

getVaryByCategories(): boolean;

Возвращает

boolean

getXErrorBars()

Представляет объект планки погрешностей для ряда диаграммы.

getXErrorBars(): ChartErrorBars;

Возвращает

getYErrorBars()

Представляет объект планки погрешностей для ряда диаграммы.

getYErrorBars(): ChartErrorBars;

Возвращает

Примеры

/**
 * This script adds error bars for the standard error of each chart series point.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range for the chart.
  const worksheet = workbook.getWorksheet("Sample");
  const dataRange = worksheet.getRange("A1:B15");

  // Create a line chart.
  const chart = worksheet.addChart(ExcelScript.ChartType.line, dataRange);

  // For each series, add error bars for the standard error on each point
  const allSeries = chart.getSeries();
  allSeries.forEach((series) => {
    series.getYErrorBars().setType(ExcelScript.ChartErrorBarsType.stError);
    series.getYErrorBars().setVisible(true);
  });
}

setAxisGroup(axisGroup)

Указывает группу для указанного ряда.

setAxisGroup(axisGroup: ChartAxisGroup): void;

Параметры

Возвращает

void

setBubbleScale(bubbleScale)

Может быть целым числом от 0 (нуля) до 300, представляющим процентное значение от размера по умолчанию. Это свойство применяется только к пузырьковым диаграммам.

setBubbleScale(bubbleScale: number): void;

Параметры

bubbleScale

number

Возвращает

void

setBubbleSizes(sourceData)

Задает размеры пузырьков для ряда диаграмм. Применяется только для пузырьковых диаграмм.

setBubbleSizes(sourceData: Range): void;

Параметры

sourceData
ExcelScript.Range

Объект Range , соответствующий исходным данным.

Возвращает

void

Примеры

/**
 * This sample sets bubble sizes for a bubble chart series.
 */
function main(workbook: ExcelScript.Workbook) {
  const sheet = workbook.getActiveWorksheet();
  
  // Add sample data.
  const data = [
    ["Product", "Price ($)", "Quality Score", "Market Share"],
    ["Product A", 85, 88, 25]
  ];
  const dataRange = sheet.getRange("A1:D2");
  dataRange.setValues(data);
  
  // Create bubble chart.
  const chart = sheet.addChart(
    ExcelScript.ChartType.bubble,
    sheet.getRange("B1:D1")
  );
  chart.setPosition("A4");
  
  // Remove default series.
  while (chart.getSeries().length > 0) {
    chart.getSeries()[0].delete();
  }
  
  // Add series with bubble sizes.
  const newSeries = chart.addChartSeries("Product A");
  newSeries.setXAxisValues(sheet.getRange("B2:B2"));
  newSeries.setValues(sheet.getRange("C2:C2"));
  newSeries.setBubbleSizes(sheet.getRange("D2:D2"));
}

setChartType(chartType)

Представляет тип диаграммы для ряда. Дополнительные сведения см. в этой ExcelScript.ChartType статье.

setChartType(chartType: ChartType): void;

Параметры

Возвращает

void

setDoughnutHoleSize(doughnutHoleSize)

Представляет размер отверстия ряда кольцевой диаграммы. Действителен только для диаграмм с кольцевой и кольцевой диаграммами. Выдает ошибку InvalidArgument на недопустимых диаграммах.

setDoughnutHoleSize(doughnutHoleSize: number): void;

Параметры

doughnutHoleSize

number

Возвращает

void

setExplosion(explosion)

Задает значение взрыва для круговой диаграммы или среза кольцевой диаграммы. Возвращает нуль (0) при отсутствии развертывания (верхушка сектора — в центре круговой диаграммы).

setExplosion(explosion: number): void;

Параметры

explosion

number

Возвращает

void

setFiltered(filtered)

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

setFiltered(filtered: boolean): void;

Параметры

filtered

boolean

Возвращает

void

setFirstSliceAngle(firstSliceAngle)

Задает угол первого среза круговой диаграммы или кольцевой диаграммы в градусах (по часовой стрелке по вертикали). Применяется только к круговым, объемным круговым и кольцевым диаграммам. Может находиться в диапазоне от 0 до 360.

setFirstSliceAngle(firstSliceAngle: number): void;

Параметры

firstSliceAngle

number

Возвращает

void

setGapWidth(gapWidth)

Представляет ширину разрывов рядов диаграммы. Допустимо только для линейчатых и столбцовых диаграмм, а также для определенных классов линейных и круговых диаграмм. Создает исключение недопустимого аргумента на недопустимых диаграммах.

setGapWidth(gapWidth: number): void;

Параметры

gapWidth

number

Возвращает

void

setGradientMaximumColor(gradientMaximumColor)

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

setGradientMaximumColor(gradientMaximumColor: string): void;

Параметры

gradientMaximumColor

string

Возвращает

void

setGradientMaximumType(gradientMaximumType)

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

setGradientMaximumType(
            gradientMaximumType: ChartGradientStyleType
        ): void;

Параметры

Возвращает

void

setGradientMaximumValue(gradientMaximumValue)

Задает максимальное значение ряда диаграммы карты регионов.

setGradientMaximumValue(gradientMaximumValue: number): void;

Параметры

gradientMaximumValue

number

Возвращает

void

setGradientMidpointColor(gradientMidpointColor)

Задает цвет для среднего значения ряда диаграмм карты регионов.

setGradientMidpointColor(gradientMidpointColor: string): void;

Параметры

gradientMidpointColor

string

Возвращает

void

setGradientMidpointType(gradientMidpointType)

Задает тип для среднего значения ряда диаграммы карты регионов.

setGradientMidpointType(
            gradientMidpointType: ChartGradientStyleType
        ): void;

Параметры

gradientMidpointType
ExcelScript.ChartGradientStyleType

Возвращает

void

setGradientMidpointValue(gradientMidpointValue)

Задает значение в середине ряда диаграммы карты регионов.

setGradientMidpointValue(gradientMidpointValue: number): void;

Параметры

gradientMidpointValue

number

Возвращает

void

setGradientMinimumColor(gradientMinimumColor)

Задает цвет для минимального значения ряда диаграммы карты регионов.

setGradientMinimumColor(gradientMinimumColor: string): void;

Параметры

gradientMinimumColor

string

Возвращает

void

setGradientMinimumType(gradientMinimumType)

Указывает тип минимального значения ряда диаграмм карты региона.

setGradientMinimumType(
            gradientMinimumType: ChartGradientStyleType
        ): void;

Параметры

Возвращает

void

setGradientMinimumValue(gradientMinimumValue)

Задает минимальное значение ряда диаграммы карты регионов.

setGradientMinimumValue(gradientMinimumValue: number): void;

Параметры

gradientMinimumValue

number

Возвращает

void

setGradientStyle(gradientStyle)

Задает стиль градиента ряда диаграммы карты регионов.

setGradientStyle(gradientStyle: ChartGradientStyle): void;

Параметры

Возвращает

void

setHasDataLabels(hasDataLabels)

Указывает, имеет ли ряд метки данных.

setHasDataLabels(hasDataLabels: boolean): void;

Параметры

hasDataLabels

boolean

Возвращает

void

Примеры

/**
 * This sample enables data labels on a chart series.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Enable data labels on the series.
  const series = chart.getSeries()[0];
  series.setHasDataLabels(true);
}

setInvertColor(invertColor)

Задает цвет заливки для отрицательных точек данных в ряде.

setInvertColor(invertColor: string): void;

Параметры

invertColor

string

Возвращает

void

setInvertIfNegative(invertIfNegative)

Значение true, если Excel инвертирует шаблон в элементе, если он соответствует отрицательному числу.

setInvertIfNegative(invertIfNegative: boolean): void;

Параметры

invertIfNegative

boolean

Возвращает

void

setMarkerBackgroundColor(markerBackgroundColor)

Задает цвет фона маркера ряда диаграммы.

setMarkerBackgroundColor(markerBackgroundColor: string): void;

Параметры

markerBackgroundColor

string

Возвращает

void

setMarkerForegroundColor(markerForegroundColor)

Задает цвет маркера переднего плана ряда диаграммы.

setMarkerForegroundColor(markerForegroundColor: string): void;

Параметры

markerForegroundColor

string

Возвращает

void

setMarkerSize(markerSize)

Задает размер маркера ряда диаграммы. Поддерживаемый диапазон размеров — от 2 до 72. Этот метод возвращает ошибку InvalidArgument, если задан размер за пределами поддерживаемого диапазона.

setMarkerSize(markerSize: number): void;

Параметры

markerSize

number

Возвращает

void

Примеры

/**
 * This sample sets the marker size for a line chart series.
 * This assumes the active worksheet has a line chart with markers.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the marker size for all series.
  const series = chart.getSeries();
  series.forEach((s) => {
    s.setMarkerSize(8);
  });
}

setMarkerStyle(markerStyle)

Задает стиль маркера ряда диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartMarkerStyle статье.

setMarkerStyle(markerStyle: ChartMarkerStyle): void;

Параметры

Возвращает

void

Примеры

/**
 * This sample sets the marker style for a line chart series.
 * This assumes the active worksheet has a line chart with markers.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the marker style to circle.
  const series = chart.getSeries()[0];
  series.setMarkerStyle(ExcelScript.ChartMarkerStyle.circle);
}

setName(name)

Указывает имя ряда на диаграмме. Длина имени не должна превышать 255 символов.

setName(name: string): void;

Параметры

name

string

Возвращает

void

Примеры

/**
 * This sample sets the name of chart series.
 * This assumes the active worksheet has a chart with at least 4 series.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set names for all series.
  const seriesCollection = chart.getSeries();
  seriesCollection[0].setName("Solar");
  seriesCollection[1].setName("Wind");
  seriesCollection[2].setName("Hydro");
  seriesCollection[3].setName("Geothermal");
}

setOverlap(overlap)

Указывает на расположение строк и столбцов. Может находиться в диапазоне от -100 до 100. Применяется только к двумерным диаграммам и гистограммам.

setOverlap(overlap: number): void;

Параметры

overlap

number

Возвращает

void

Примеры

/**
 * This sample sets the overlap of the columns in a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let chart = selectedSheet.getChart("ColumnClusteredChart");

  // Set the overlap of every column of each series within a category.
  let seriesList = chart.getSeries();
  seriesList.forEach((series) => {
    // An overlap of 25 means the columns have 25% of their length overlapping with the adjacent columns in the same category.
    series.setOverlap(25);
  });
}

setParentLabelStrategy(parentLabelStrategy)

Задает область стратегии родительской метки ряда для диаграммы дерева.

setParentLabelStrategy(
            parentLabelStrategy: ChartParentLabelStrategy
        ): void;

Параметры

Возвращает

void

setPlotOrder(plotOrder)

Задает порядок построения ряда диаграммы в группе диаграмм.

setPlotOrder(plotOrder: number): void;

Параметры

plotOrder

number

Возвращает

void

setSecondPlotSize(secondPlotSize)

Задает размер вторичного раздела круговой диаграммы или линейчатой круговой диаграммы в процентах от размера основного кругового круга. Может находиться в диапазоне от 5 до 200.

setSecondPlotSize(secondPlotSize: number): void;

Параметры

secondPlotSize

number

Возвращает

void

setShowConnectorLines(showConnectorLines)

Указывает, отображаются ли линии соединителя в каскадных диаграммах.

setShowConnectorLines(showConnectorLines: boolean): void;

Параметры

showConnectorLines

boolean

Возвращает

void

setShowLeaderLines(showLeaderLines)

Указывает, отображаются ли линии-лидеры для каждой метки данных в ряде.

setShowLeaderLines(showLeaderLines: boolean): void;

Параметры

showLeaderLines

boolean

Возвращает

void

setShowShadow(showShadow)

Указывает, имеет ли ряд тень.

setShowShadow(showShadow: boolean): void;

Параметры

showShadow

boolean

Возвращает

void

setSmooth(smooth)

Указывает, является ли ряд гладким. Применимо только к линейным диаграммам и точечным диаграммам.

setSmooth(smooth: boolean): void;

Параметры

smooth

boolean

Возвращает

void

setSplitType(splitType)

Указывает способ разделения двух разделов круговой диаграммы или линейчатой диаграммы.

setSplitType(splitType: ChartSplitType): void;

Параметры

Возвращает

void

setSplitValue(splitValue)

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

setSplitValue(splitValue: number): void;

Параметры

splitValue

number

Возвращает

void

setValues(sourceData)

Задает значения для ряда диаграммы. Для точечной диаграммы она относится к значениям оси Y.

setValues(sourceData: Range): void;

Параметры

sourceData
ExcelScript.Range

Объект Range , соответствующий исходным данным.

Возвращает

void

setVaryByCategories(varyByCategories)

Значение true, если Excel присваивает каждому маркеру данных другой цвет или узор. Диаграмма должна содержать только один ряд.

setVaryByCategories(varyByCategories: boolean): void;

Параметры

varyByCategories

boolean

Возвращает

void

setXAxisValues(sourceData)

Задает значения оси X для ряда диаграммы.

setXAxisValues(sourceData: Range): void;

Параметры

sourceData
ExcelScript.Range

Объект Range , соответствующий исходным данным.

Возвращает

void