Excel.ChartSeries class

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

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml

// The following code adds data labels to the chart and positions them to demonstrate leader lines.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem(sheetName);
  const chart = sheet.charts.getItemAt(0);
  const series = chart.series.getItemAt(0);
  
  // Enable data labels for the series. Leader lines are enabled by default.
  series.hasDataLabels = true;
  series.points.load("items");
  await context.sync();
  
  // Load the top position for each data label.
  series.points.items.forEach((point) => point.dataLabel.load("top"));
  await context.sync();

  // Move some data labels to create distance from their chart points.
  const point1 = series.points.items[1]; 
  const point2 = series.points.items[2]; 
  point1.dataLabel.top -= 50; 
  point2.dataLabel.top += 50;
  
  // Format the data labels.
  series.dataLabels.geometricShapeType = Excel.GeometricShapeType.rectangle;
  series.dataLabels.showCategoryName = true;
  series.dataLabels.format.border.weight = 1;
  
  await context.sync();
});

Свойства

axisGroup	Указывает группу для указанного ряда.
binOptions	Объединяет параметры интервалов для гистограмм и диаграмм Парето.
boxwhiskerOptions	Объединяет параметры для диаграмм "ящик с усами"
bubbleScale	Может быть целым числом от 0 (нуля) до 300, представляющим процентное значение от размера по умолчанию. Это свойство применяется только к пузырьковым диаграммам.
chartType	Представляет тип диаграммы для ряда. См. `Excel.ChartType` дополнительные сведения.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
dataLabels	Представляет коллекцию всех меток данных в ряду.
doughnutHoleSize	Представляет размер отверстия ряда кольцевой диаграммы. Доступно только для кольцевых и кольцевых диаграмм. Выдает ошибку `InvalidArgument` на недопустимых диаграммах.
explosion	Значение взрыва для круговой или кольцевой диаграммы. Возвращает нуль (0) при отсутствии развертывания (верхушка сектора — в центре круговой диаграммы).
filtered	Указывает, фильтруется ли ряд. Неприменимо для поверхностных диаграмм.
firstSliceAngle	Угол первого среза круговой или кольцевой диаграммы (по часовой стрелке от вертикали). Применяется только к круговым, объемным круговым и кольцевым диаграммам. Может находиться в диапазоне от 0 до 360.
format	Представляет форматирование ряда диаграммы, включая формат заливки и линий.
gapWidth	Представляет ширину разрывов рядов диаграммы. Применяется только к линейчатым и гистограммам, а также к отдельным классам графиков и круговых диаграмм. Создает исключение недопустимого аргумента на недопустимых диаграммах.
gradientMaximumColor	Цвет максимального значения серии диаграмм региональной карты.
gradientMaximumType	Тип максимального значения серии диаграмм региональной карты.
gradientMaximumValue	Определяет максимальное значение серии диаграмм региональной карты.
gradientMidpointColor	Цвет среднего значения серии диаграмм региональной карты.
gradientMidpointType	Тип среднего значения серии диаграмм региональной карты.
gradientMidpointValue	Задает среднее значение ряда диаграмм региональной карты.
gradientMinimumColor	Цвет минимального значения серии диаграмм региональной карты.
gradientMinimumType	Тип минимального значения серии диаграмм с региональной картой.
gradientMinimumValue	Определяет минимальное значение серии диаграмм с региональной картой.
gradientStyle	Определяет стиль градиента ряда диаграммы на карте региона.
hasDataLabels	Указывает, есть ли в ряду метки данных.
invertColor	Определяет цвет заливки для отрицательных точек данных в ряду.
invertIfNegative	Имеет значение "True", если Excel инвертирует шаблон элемента, когда он соответствует отрицательному числу.
mapOptions	Объединяет параметры для диаграммы с картой региона.
markerBackgroundColor	Определяет цвет фона маркера ряда диаграмм.
markerForegroundColor	Определяет цвет маркера переднего плана ряда диаграмм.
markerSize	Определяет размер маркера ряда диаграмм. Поддерживаемый диапазон размеров — от 2 до 72. Этот метод возвращает ошибку InvalidArgument, если его размер задан за пределами поддерживаемого диапазона.
markerStyle	Стиль маркера ряда диаграмм. См. `Excel.ChartMarkerStyle` дополнительные сведения.
name	Указывает имя ряда на диаграмме. Длина имени не должна превышать 255 символов.
overlap	Указывает на расположение строк и столбцов. Может находиться в диапазоне от -100 до 100. Применяется только к двумерным диаграммам и гистограммам.
parentLabelStrategy	Определяет область стратегии родительских меток ряда для диаграммы "дерево".
plotOrder	Определяет порядок построения ряда диаграмм в группе диаграмм.
points	Возвращает коллекцию всех точек в ряду.
secondPlotSize	Определяет размер вторичного раздела круговой или круговой диаграммы в процентах от размера основной круговой диаграммы. Может находиться в диапазоне от 5 до 200.
showConnectorLines	Указывает, отображаются ли соединительные линии на каскадных диаграммах.
showLeaderLines	Указывает, отображаются ли линии выноски для каждой метки данных в ряду.
showShadow	Указывает, есть ли в ряду тень.
smooth	Указывает, является ли ряд гладким. Применимо только к линейным и точечным диаграммам.
splitType	Определяет способ разделения двух секторов круговой и круговой диаграмм.
splitValue	Определяет пороговое значение, разделяющее два раздела круговой и круговой диаграмм.
trendlines	Коллекция линий тренда в серии.
varyByCategories	Имеет значение "True", если Excel назначает каждому маркеру данных свой цвет или узор. Диаграмма должна содержать только один ряд.
xErrorBars	Представляет объект планки погрешностей для ряда диаграммы.
yErrorBars	Представляет объект планки погрешностей для ряда диаграммы.

Методы

delete()	Удаляет ряд диаграммы.
getDimensionDataSourceString(dimension)	Получает строковое представление источника данных ряда диаграмм. Строковым представлением может быть информация, например адрес ячейки.
getDimensionDataSourceString(dimension)	Получает строковое представление источника данных ряда диаграмм. Строковым представлением может быть информация, например адрес ячейки.
getDimensionDataSourceType(dimension)	Получает тип источника данных ряда диаграмм.
getDimensionDataSourceType(dimension)	Получает тип источника данных ряда диаграмм.
getDimensionValues(dimension)	Получает значения из одного измерения ряда диаграмм. Это могут быть либо значения категорий, либо значения данных, в зависимости от указанного измерения и способа сопоставления данных для ряда диаграмм.
getDimensionValues(dimension)	Получает значения из одного измерения ряда диаграмм. Это могут быть либо значения категорий, либо значения данных, в зависимости от указанного измерения и способа сопоставления данных для ряда диаграмм.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
setBubbleSizes(sourceData)	Размер пузырьков для ряда диаграмм. Применяется только для пузырьковых диаграмм.
setValues(sourceData)	Задает значения для ряда диаграмм. Для точечных диаграмм оно относится к значениям оси Y.
setXAxisValues(sourceData)	Задает значения оси X для ряда диаграмм.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.ChartSeries` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Excel.Interfaces.ChartSeriesData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

axisGroup

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

axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";

Значение свойства

Excel.ChartAxisGroup | "Primary" | "Secondary"

binOptions

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

readonly binOptions: Excel.ChartBinOptions;

Значение свойства

Excel.ChartBinOptions

boxwhiskerOptions

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

readonly boxwhiskerOptions: Excel.ChartBoxwhiskerOptions;

Значение свойства

Excel.ChartBoxwhiskerOptions

bubbleScale

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

bubbleScale: number;

Значение свойства

number

chartType

Представляет тип диаграммы для ряда. См. Excel.ChartType дополнительные сведения.

chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx";

Значение свойства

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

dataLabels

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

readonly dataLabels: Excel.ChartDataLabels;

Значение свойства

Excel.ChartDataLabels

doughnutHoleSize

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

doughnutHoleSize: number;

Значение свойства

number

explosion

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

explosion: number;

Значение свойства

number

filtered

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

filtered: boolean;

Значение свойства

boolean

firstSliceAngle

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

firstSliceAngle: number;

Значение свойства

number

format

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

readonly format: Excel.ChartSeriesFormat;

Значение свойства

Excel.ChartSeriesFormat

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-formatting.yaml

await Excel.run(async (context) => {
    const worksheet = context.workbook.worksheets.getActiveWorksheet();
    const chart = worksheet.charts.getItem("SlopeChart");
    chart.series.load("count");
    await context.sync();

    // Color everything gray before highlighting spokes.
    for (let i = 0; i < chart.series.count; i++) {
        chart.series.getItemAt(i).format.line.color = "#636363";
        chart.series.getItemAt(i).dataLabels.format.font.color = "#636363";
    }

    const highlight: Excel.ChartSeries = chart.series.getItemAt(5);
    highlight.format.line.color = "#4472C4";
    highlight.dataLabels.format.font.color = "#D9D9D9";

    highlight.load("name");
    await context.sync();
    highlight.name += " (Focus)";
    await context.sync();
});

gapWidth

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

gapWidth: number;

Значение свойства

number

gradientMaximumColor

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

gradientMaximumColor: string;

Значение свойства

string

gradientMaximumType

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

gradientMaximumType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";

Значение свойства

Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"

gradientMaximumValue

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

gradientMaximumValue: number;

Значение свойства

number

gradientMidpointColor

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

gradientMidpointColor: string;

Значение свойства

string

gradientMidpointType

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

gradientMidpointType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";

Значение свойства

Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"

gradientMidpointValue

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

gradientMidpointValue: number;

Значение свойства

number

gradientMinimumColor

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

gradientMinimumColor: string;

Значение свойства

string

gradientMinimumType

Тип минимального значения серии диаграмм с региональной картой.

gradientMinimumType: Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent";

Значение свойства

Excel.ChartGradientStyleType | "ExtremeValue" | "Number" | "Percent"

gradientMinimumValue

Определяет минимальное значение серии диаграмм с региональной картой.

gradientMinimumValue: number;

Значение свойства

number

gradientStyle

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

gradientStyle: Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor";

Значение свойства

Excel.ChartGradientStyle | "TwoPhaseColor" | "ThreePhaseColor"

hasDataLabels

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

hasDataLabels: boolean;

Значение свойства

boolean

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml

// The following code adds data labels to the chart and positions them to demonstrate leader lines.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem(sheetName);
  const chart = sheet.charts.getItemAt(0);
  const series = chart.series.getItemAt(0);
  
  // Enable data labels for the series. Leader lines are enabled by default.
  series.hasDataLabels = true;
  series.points.load("items");
  await context.sync();
  
  // Load the top position for each data label.
  series.points.items.forEach((point) => point.dataLabel.load("top"));
  await context.sync();

  // Move some data labels to create distance from their chart points.
  const point1 = series.points.items[1]; 
  const point2 = series.points.items[2]; 
  point1.dataLabel.top -= 50; 
  point2.dataLabel.top += 50;
  
  // Format the data labels.
  series.dataLabels.geometricShapeType = Excel.GeometricShapeType.rectangle;
  series.dataLabels.showCategoryName = true;
  series.dataLabels.format.border.weight = 1;
  
  await context.sync();
});

invertColor

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

invertColor: string;

Значение свойства

string

invertIfNegative

Имеет значение "True", если Excel инвертирует шаблон элемента, когда он соответствует отрицательному числу.

invertIfNegative: boolean;

Значение свойства

boolean

mapOptions

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

readonly mapOptions: Excel.ChartMapOptions;

Значение свойства

Excel.ChartMapOptions

markerBackgroundColor

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

markerBackgroundColor: string;

Значение свойства

string

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let salesTable = sheet.tables.getItem("SalesTable");
    let dataRange = sheet.getRange("A1:E7");

    // Create an XY scatter chart.
    let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Quarterly Sales"; 
  
    let series = chart.series;
    let series0 = series.getItemAt(0);
    let series1 = series.getItemAt(1);
    let series2 = series.getItemAt(2);
    let series3 = series.getItemAt(3);

    // Set markers.
    series0.markerStyle = "Dash";
    series0.markerForegroundColor = "black";
    series1.markerStyle = "Star";
    series1.markerForegroundColor = "black";
    series2.markerStyle = "X";
    series2.markerSize = 12;
    series3.markerStyle = "Triangle";
    series3.markerBackgroundColor = "purple";

    await context.sync();
});

markerForegroundColor

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

markerForegroundColor: string;

Значение свойства

string

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let salesTable = sheet.tables.getItem("SalesTable");
    let dataRange = sheet.getRange("A1:E7");

    // Create an XY scatter chart.
    let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Quarterly Sales"; 
  
    let series = chart.series;
    let series0 = series.getItemAt(0);
    let series1 = series.getItemAt(1);
    let series2 = series.getItemAt(2);
    let series3 = series.getItemAt(3);

    // Set markers.
    series0.markerStyle = "Dash";
    series0.markerForegroundColor = "black";
    series1.markerStyle = "Star";
    series1.markerForegroundColor = "black";
    series2.markerStyle = "X";
    series2.markerSize = 12;
    series3.markerStyle = "Triangle";
    series3.markerBackgroundColor = "purple";

    await context.sync();
});

markerSize

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

markerSize: number;

Значение свойства

number

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let salesTable = sheet.tables.getItem("SalesTable");
    let dataRange = sheet.getRange("A1:E7");

    // Create an XY scatter chart.
    let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Quarterly Sales"; 
  
    let series = chart.series;
    let series0 = series.getItemAt(0);
    let series1 = series.getItemAt(1);
    let series2 = series.getItemAt(2);
    let series3 = series.getItemAt(3);

    // Set markers.
    series0.markerStyle = "Dash";
    series0.markerForegroundColor = "black";
    series1.markerStyle = "Star";
    series1.markerForegroundColor = "black";
    series2.markerStyle = "X";
    series2.markerSize = 12;
    series3.markerStyle = "Triangle";
    series3.markerBackgroundColor = "purple";

    await context.sync();
});

markerStyle

Стиль маркера ряда диаграмм. См. Excel.ChartMarkerStyle дополнительные сведения.

markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture";

Значение свойства

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series-markers.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let salesTable = sheet.tables.getItem("SalesTable");
    let dataRange = sheet.getRange("A1:E7");

    // Create an XY scatter chart.
    let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Quarterly Sales"; 
  
    let series = chart.series;
    let series0 = series.getItemAt(0);
    let series1 = series.getItemAt(1);
    let series2 = series.getItemAt(2);
    let series3 = series.getItemAt(3);

    // Set markers.
    series0.markerStyle = "Dash";
    series0.markerForegroundColor = "black";
    series1.markerStyle = "Star";
    series1.markerForegroundColor = "black";
    series2.markerStyle = "X";
    series2.markerSize = 12;
    series3.markerStyle = "Triangle";
    series3.markerBackgroundColor = "purple";

    await context.sync();
});

name

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

name: string;

Значение свойства

string

overlap

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

overlap: number;

Значение свойства

number

parentLabelStrategy

Определяет область стратегии родительских меток ряда для диаграммы "дерево".

parentLabelStrategy: Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping";

Значение свойства

Excel.ChartParentLabelStrategy | "None" | "Banner" | "Overlapping"

plotOrder

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

plotOrder: number;

Значение свойства

number

points

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

readonly points: Excel.ChartPointsCollection;

Значение свойства

Excel.ChartPointsCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml

// The following code adds data labels to the chart and positions them to demonstrate leader lines.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem(sheetName);
  const chart = sheet.charts.getItemAt(0);
  const series = chart.series.getItemAt(0);
  
  // Enable data labels for the series. Leader lines are enabled by default.
  series.hasDataLabels = true;
  series.points.load("items");
  await context.sync();
  
  // Load the top position for each data label.
  series.points.items.forEach((point) => point.dataLabel.load("top"));
  await context.sync();

  // Move some data labels to create distance from their chart points.
  const point1 = series.points.items[1]; 
  const point2 = series.points.items[2]; 
  point1.dataLabel.top -= 50; 
  point2.dataLabel.top += 50;
  
  // Format the data labels.
  series.dataLabels.geometricShapeType = Excel.GeometricShapeType.rectangle;
  series.dataLabels.showCategoryName = true;
  series.dataLabels.format.border.weight = 1;
  
  await context.sync();
});

secondPlotSize

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

secondPlotSize: number;

Значение свойства

number

showConnectorLines

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

showConnectorLines: boolean;

Значение свойства

boolean

showLeaderLines

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

showLeaderLines: boolean;

Значение свойства

boolean

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-leader-lines.yaml

// The following code disables leader lines for chart data labels.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem(sheetName);
  const chart = sheet.charts.getItemAt(0);
  const series = chart.series.getItemAt(0);
  const dataLabels = series.dataLabels;
  
  // Disable leader lines.
  dataLabels.showLeaderLines = false;
  
  await context.sync();
});

showShadow

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

showShadow: boolean;

Значение свойства

boolean

smooth

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

smooth: boolean;

Значение свойства

boolean

splitType

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

splitType: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit";

Значение свойства

Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit"

splitValue

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

splitValue: number;

Значение свойства

number

trendlines

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

readonly trendlines: Excel.ChartTrendlineCollection;

Значение свойства

Excel.ChartTrendlineCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-trendlines.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    let seriesCollection = sheet.charts.getItemAt(0).series;

     // Add a trendline.  
    seriesCollection.getItemAt(0).trendlines.add("Linear");

    await context.sync();
});

varyByCategories

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

varyByCategories: boolean;

Значение свойства

boolean

xErrorBars

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

readonly xErrorBars: Excel.ChartErrorBars;

Значение свойства

Excel.ChartErrorBars

yErrorBars

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

readonly yErrorBars: Excel.ChartErrorBars;

Значение свойства

Excel.ChartErrorBars

delete()

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

delete(): void;

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series.yaml

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");
  const seriesCollection = sheet.charts.getItemAt(0).series;
  seriesCollection.load("count");
  await context.sync();

  if (seriesCollection.count > 0) {
    const series = seriesCollection.getItemAt(0);

    // Delete the first series.
    series.delete();
  }

  await context.sync();
});

getDimensionDataSourceString(dimension)

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

getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<string>;

Параметры

dimension: Excel.ChartSeriesDimension

Размер оси, из которой берутся данные.

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

OfficeExtension.ClientResult<string>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-source.yaml

// This function retrieves the data source information of a chart series in the Sample worksheet.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");

  // Get the first chart series from the first chart on the worksheet.
  const seriesCollection = sheet.charts.getItemAt(0).series;
  const series = seriesCollection.getItemAt(0);

  // Get the series data source string and type values. 
  const dataSourceString = series.getDimensionDataSourceString("Values");
  const dataSourceType = series.getDimensionDataSourceType("Values");

  series.load("name");
  await context.sync();
  
  // Log the data source information to the console.
  console.log(series.name + " data source string: " + dataSourceString.value);
  console.log(series.name + " data source type: " + dataSourceType.value);
});

getDimensionDataSourceString(dimension)

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

getDimensionDataSourceString(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<string>;

Параметры

dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"

Размер оси, из которой берутся данные.

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

OfficeExtension.ClientResult<string>

getDimensionDataSourceType(dimension)

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

getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;

Параметры

dimension: Excel.ChartSeriesDimension

Размер оси, из которой берутся данные.

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

OfficeExtension.ClientResult<Excel.ChartDataSourceType>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-source.yaml

// This function retrieves the data source information of a chart series in the Sample worksheet.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");

  // Get the first chart series from the first chart on the worksheet.
  const seriesCollection = sheet.charts.getItemAt(0).series;
  const series = seriesCollection.getItemAt(0);

  // Get the series data source string and type values. 
  const dataSourceString = series.getDimensionDataSourceString("Values");
  const dataSourceType = series.getDimensionDataSourceType("Values");

  series.load("name");
  await context.sync();
  
  // Log the data source information to the console.
  console.log(series.name + " data source string: " + dataSourceString.value);
  console.log(series.name + " data source type: " + dataSourceType.value);
});

getDimensionDataSourceType(dimension)

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

getDimensionDataSourceType(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;

Параметры

dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"

Размер оси, из которой берутся данные.

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

OfficeExtension.ClientResult<Excel.ChartDataSourceType>

getDimensionValues(dimension)

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

getDimensionValues(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<string[]>;

Параметры

dimension: Excel.ChartSeriesDimension

Размер оси, из которой берутся данные.

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

OfficeExtension.ClientResult<string[]>

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-bubble-chart.yaml

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");

  // The sample chart is of type `Excel.ChartType.bubble`.
  const bubbleChart = sheet.charts.getItem("Product Chart");

  // Get the first series in the chart.
  const firstSeries = bubbleChart.series.getItemAt(0);

  // Get the values for the dimensions we're interested in.
  const bubbleSize = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.bubbleSizes);
  const xValues = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.xvalues);
  const yValues = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.yvalues);
  const category = firstSeries.getDimensionValues(Excel.ChartSeriesDimension.categories);

  await context.sync();

  // Log the information.
  console.log(`Series ${category.value} - X: ${xValues.value}, Y: ${yValues.value}, Bubble: ${bubbleSize.value}`);
});

getDimensionValues(dimension)

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

getDimensionValues(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<string[]>;

Параметры

dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"

Размер оси, из которой берутся данные.

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

OfficeExtension.ClientResult<string[]>

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.ChartSeriesLoadOptions): Excel.ChartSeries;

Параметры

options: Excel.Interfaces.ChartSeriesLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

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

Excel.ChartSeries

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.ChartSeries;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

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

Excel.ChartSeries

Примеры

// Rename the 1st series of Chart1 to "New Series Name".
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.series.getItemAt(0).name = "New Series Name";
    await context.sync();

    console.log("Series1 Renamed");
});

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartSeries;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

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

Excel.ChartSeries

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties: Interfaces.ChartSeriesUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Excel.Interfaces.ChartSeriesUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

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

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Excel.ChartSeries): void;

Параметры

properties: Excel.ChartSeries

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

void

setBubbleSizes(sourceData)

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

setBubbleSizes(sourceData: Range): void;

Параметры

sourceData: Excel.Range

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

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-bubble-chart.yaml

await Excel.run(async (context) => {
  /*
    The table is expected to look like this:
    Product, Inventory, Price, Current Market Share
    Calamansi, 2000, $2.45, 10%
    ...

    We want each bubble to represent a single row.
  */

  // Get the worksheet and table data.
  const sheet = context.workbook.worksheets.getItem("Sample");
  const table = sheet.tables.getItem("Sales");
  const dataRange = table.getDataBodyRange();

  // Get the table data without the row names.
  const valueRange = dataRange.getOffsetRange(0, 1).getResizedRange(0, -1);

  // Create the chart.
  const bubbleChart = sheet.charts.add(Excel.ChartType.bubble, valueRange);
  bubbleChart.name = "Product Chart";

  // Remove the default series, since we want a unique series for each row.
  bubbleChart.series.getItemAt(0).delete();

  // Load the data necessary to make a chart series.
  dataRange.load(["rowCount", "values"]);
  await context.sync();

  // For each row, create a chart series (a bubble).
  for (let i = 0; i < dataRange.rowCount; i++) {
    const newSeries = bubbleChart.series.add(dataRange.values[i][0], i);
    newSeries.setXAxisValues(dataRange.getCell(i, 1));
    newSeries.setValues(dataRange.getCell(i, 2));
    newSeries.setBubbleSizes(dataRange.getCell(i, 3));

    // Show the product name and market share percentage.
    newSeries.dataLabels.showSeriesName = true;
    newSeries.dataLabels.showBubbleSize = true;
    newSeries.dataLabels.showValue = false;
  }

  await context.sync();
});

setValues(sourceData)

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

setValues(sourceData: Range): void;

Параметры

sourceData: Excel.Range

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

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-series.yaml

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");

  const chart: Excel.Chart = sheet.charts.getItemAt(0);
  let rangeSelection = sheet.getRange("C2:C7");
  let xRangeSelection = sheet.getRange("A1:A7");

  // Add a series.
  const newSeries: Excel.ChartSeries = chart.series.add("Qtr2");
  newSeries.setValues(rangeSelection);
  newSeries.setXAxisValues(xRangeSelection);

  await context.sync();
});

setXAxisValues(sourceData)

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

setXAxisValues(sourceData: Range): void;

Параметры

sourceData: Excel.Range

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

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/create-doughnut-chart.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    let seriesCollection = sheet.charts.getItemAt(0);
    let rangeSelection = sheet.getRange("C2:C7");
    let xRangeSelection = sheet.getRange("A1:A7");

    // Add a series.
    const newSeries: Excel.ChartSeries = seriesCollection.series.add("Qtr2");
    newSeries.setValues(rangeSelection);
    newSeries.setXAxisValues(xRangeSelection);

    // Set the size of the doughnut hole.
    // The hole size is expressed as a percentage of the chart size.
    newSeries.doughnutHoleSize = 80;

    await context.sync();
});

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartSeries объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ChartSeriesData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Excel.Interfaces.ChartSeriesData;

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

Excel.Interfaces.ChartSeriesData

Комментарии

Используется

Примеры

Свойства

Методы

Сведения о свойстве

axisGroup

Значение свойства

Комментарии

binOptions

Значение свойства

Комментарии

boxwhiskerOptions

Значение свойства

Комментарии

bubbleScale

Значение свойства

Комментарии

chartType

Значение свойства

Комментарии

context

Значение свойства

dataLabels

Значение свойства

Комментарии

doughnutHoleSize

Значение свойства

Комментарии

explosion

Значение свойства

Комментарии

filtered

Значение свойства

Комментарии

firstSliceAngle

Значение свойства

Комментарии

format

Значение свойства

Комментарии

Примеры

gapWidth

Значение свойства

Комментарии

gradientMaximumColor

Значение свойства

Комментарии

gradientMaximumType

Значение свойства

Комментарии

gradientMaximumValue

Значение свойства

Комментарии

gradientMidpointColor

Значение свойства

Комментарии

gradientMidpointType

Значение свойства

Комментарии

gradientMidpointValue

Значение свойства

Комментарии

gradientMinimumColor

Значение свойства

Комментарии

gradientMinimumType

Значение свойства

Комментарии

gradientMinimumValue

Значение свойства

Комментарии

gradientStyle

Значение свойства

Комментарии

hasDataLabels

Значение свойства

Комментарии

Примеры