Excel.ChartSeries class

Ссылка

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

Свойства

axisGroup	Указывает группу для указанного ряда.
chartType	Представляет тип диаграммы для ряда. Дополнительные сведения см. в этой `Excel.ChartType` статье.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
dataLabels	Представляет коллекцию всех меток данных в ряде.
doughnutHoleSize	Представляет размер отверстия ряда кольцевой диаграммы. Действителен только для диаграмм с кольцевой и кольцевой диаграммами. Выдает ошибку `InvalidArgument` на недопустимых диаграммах.
explosion	Задает значение взрыва для круговой диаграммы или среза кольцевой диаграммы. Возвращает нуль (0) при отсутствии развертывания (верхушка сектора — в центре круговой диаграммы).
filtered	Указывает, фильтруется ли ряд. Неприменимо для поверхностных диаграмм.
firstSliceAngle	Задает угол первого среза круговой диаграммы или кольцевой диаграммы в градусах (по часовой стрелке по вертикали). Применяется только к круговым, объемным круговым и кольцевым диаграммам. Может находиться в диапазоне от 0 до 360.
format	Представляет форматирование ряда диаграммы, включая формат заливки и линий.
gapWidth	Представляет ширину разрывов рядов диаграммы. Допустимо только для линейчатых и столбцовых диаграмм, а также для определенных классов линейных и круговых диаграмм. Создает исключение недопустимого аргумента на недопустимых диаграммах.
hasDataLabels	Указывает, имеет ли ряд метки данных.
invertIfNegative	Значение true, если Excel инвертирует шаблон в элементе, если он соответствует отрицательному числу.
markerBackgroundColor	Задает цвет фона маркера ряда диаграммы.
markerForegroundColor	Задает цвет маркера переднего плана ряда диаграммы.
markerSize	Задает размер маркера ряда диаграммы. Поддерживаемый диапазон размеров — от 2 до 72. Этот метод возвращает ошибку InvalidArgument, если задан размер за пределами поддерживаемого диапазона.
markerStyle	Задает стиль маркера ряда диаграммы. Дополнительные сведения см. в этой `Excel.ChartMarkerStyle` статье.
name	Указывает имя ряда на диаграмме. Длина имени не должна превышать 255 символов.
overlap	Указывает на расположение строк и столбцов. Может находиться в диапазоне от -100 до 100. Применяется только к двумерным диаграммам и гистограммам.
plotOrder	Задает порядок построения ряда диаграммы в группе диаграмм.
points	Возвращает коллекцию всех точек ряда.
secondPlotSize	Задает размер вторичного раздела круговой диаграммы или линейчатой круговой диаграммы в процентах от размера основного кругового круга. Может находиться в диапазоне от 5 до 200.
showShadow	Указывает, имеет ли ряд тень.
smooth	Указывает, является ли ряд гладким. Применимо только к линейным диаграммам и точечным диаграммам.
splitType	Указывает способ разделения двух разделов круговой диаграммы или линейчатой диаграммы.
trendlines	Коллекция линий тренда в серии.
varyByCategories	Значение true, если Excel присваивает каждому маркеру данных другой цвет или узор. Диаграмма должна содержать только один ряд.

Методы

delete()	Удаляет ряд диаграммы.
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"

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";

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

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

gapWidth

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

gapWidth: number;

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

number

hasDataLabels

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

hasDataLabels: boolean;

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

boolean

invertIfNegative

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

invertIfNegative: boolean;

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

boolean

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

plotOrder

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

plotOrder: number;

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

number

points

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

readonly points: Excel.ChartPointsCollection;

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

Excel.ChartPointsCollection

secondPlotSize

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

secondPlotSize: number;

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

number

showShadow

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

showShadow: boolean;

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

boolean

smooth

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

smooth: boolean;

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

boolean

splitType

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

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

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

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

trendlines

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

readonly trendlines: Excel.ChartTrendlineCollection;

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

Excel.ChartTrendlineCollection

varyByCategories

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

varyByCategories: boolean;

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

boolean

Сведения о методе

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

load(options)

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

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

Параметры

options: Excel.Interfaces.ChartSeriesLoadOptions

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

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

Excel.ChartSeries

load(propertyNames)

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)

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

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

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

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

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

  // Add a series.
  let newSeries = seriesCollection.series.add("Qtr2");
  newSeries.setValues(rangeSelection);
  newSeries.setXAxisValues(xRangeSelection);

  await context.sync();
});

setXAxisValues(sourceData)

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

setXAxisValues(sourceData: Range): void;

Параметры

sourceData: Excel.Range

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

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartSeriesData;

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

Excel.Interfaces.ChartSeriesData

Excel.ChartSeries class

Комментарии

Свойства

Методы

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

axisGroup

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

Комментарии

chartType

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

Комментарии

context

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

dataLabels

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

Комментарии

doughnutHoleSize

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

Комментарии

explosion

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

Комментарии

filtered

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

Комментарии

firstSliceAngle

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

Комментарии

format

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

Комментарии

gapWidth

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

Комментарии

hasDataLabels

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

Комментарии

invertIfNegative

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

Комментарии

markerBackgroundColor

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

Комментарии

Примеры

markerForegroundColor

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

Комментарии

Примеры

markerSize

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

Комментарии

Примеры

markerStyle

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

Комментарии

Примеры

name

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

Комментарии

overlap

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

Комментарии

plotOrder

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

Комментарии

points

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

Комментарии

secondPlotSize

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

Комментарии

showShadow

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

Комментарии

smooth

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

Комментарии

splitType

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

Комментарии