Excel.ChartSeriesCollection class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
count	Возвращает количество рядов в коллекции.
items	Получает загруженные дочерние элементы в этой коллекции.

Методы

add(name, index)	Добавляет новый ряд в коллекцию. Новый добавленный ряд не отображается до тех пор, пока не будут заданы значения, значения оси X или размеры пузырьков (в зависимости от типа диаграммы).
getCount()	Возвращает количество рядов в коллекции.
getItemAt(index)	Возвращает ряд в зависимости от его позиции в коллекции.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartSeriesCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ChartSeriesCollectionData), который содержит массив "items" с неглубокими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

Excel.RequestContext

count

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

readonly count: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Excel.ChartSeries[];

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

Excel.ChartSeries[]

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

add(name, index)

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

add(name?: string, index?: number): Excel.ChartSeries;

Параметры

name

string

Необязательный параметр. Имя серии.

index

number

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

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

Excel.ChartSeries

Комментарии

[ Набор API: ExcelApi 1.7 ]

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: ExcelApi 1.4 ]

getItemAt(index)

Возвращает ряд в зависимости от его позиции в коллекции.

getItemAt(index: number): Excel.ChartSeries;

Параметры

index

number

Значение индекса получаемого объекта. Используется нулевой индекс.

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

Excel.ChartSeries

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

// Get the name of the first series in the series collection.
await Excel.run(async (context) => { 
    const seriesCollection = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
    seriesCollection.load('items');
    await context.sync();
    
    console.log(seriesCollection.items[0].name);
});

load(options)

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

load(options?: Excel.Interfaces.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartSeriesCollection;

Параметры

options

Excel.Interfaces.ChartSeriesCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.ChartSeriesCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ChartSeriesCollection

Примеры

// Get the number of chart series in the collection.
await Excel.run(async (context) => { 
    const seriesCollection = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
    seriesCollection.load('count');
    await context.sync();

    console.log("series: Count= " + seriesCollection.count);
});

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ChartSeriesCollection;

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Excel.ChartSeriesCollection

toJSON()

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

toJSON(): Excel.Interfaces.ChartSeriesCollectionData;

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

Excel.Interfaces.ChartSeriesCollectionData