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

Задает размер маркера ряда диаграммы.

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)

Задает размер маркера ряда диаграммы.

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

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;

Возвращаемое значение

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;

Возвращаемое значение

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

Задает размер маркера ряда диаграммы.

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

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

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)

Задает размер маркера ряда диаграммы.

setMarkerSize(markerSize: number): void;

Параметры

markerSize

number

Возвращаемое значение

void

setMarkerStyle(markerStyle)

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

setMarkerStyle(markerStyle: ChartMarkerStyle): void;

Параметры

Возвращаемое значение

void

setName(name)

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

setName(name: string): void;

Параметры

name

string

Возвращаемое значение

void

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