Excel.ChartSeriesCollection class
Представляет коллекцию рядов диаграммы.
- Extends
Комментарии
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| count | Возвращает количество рядов в коллекции. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(name, index) | Добавляет новый ряд в коллекцию. Новый добавленный ряд не отображается до тех пор, пока не будут заданы значения, значения оси X или размеры пузырьков (в зависимости от типа диаграммы). |
| get |
Возвращает количество рядов в коллекции. |
| get |
Возвращает ряд в зависимости от его позиции в коллекции. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
count
Возвращает количество рядов в коллекции.
readonly count: number;Значение свойства
number
Комментарии
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Excel.ChartSeries[];Значение свойства
Сведения о методе
add(name, index)
Добавляет новый ряд в коллекцию. Новый добавленный ряд не отображается до тех пор, пока не будут заданы значения, значения оси X или размеры пузырьков (в зависимости от типа диаграммы).
add(name?: string, index?: number): Excel.ChartSeries;Параметры
- name
-
string
Необязательный параметр. Имя серии.
- index
-
number
Необязательный параметр. Значение индекса добавляемого ряда. Используется нулевой индекс.
Возвращаемое значение
Комментарии
getCount()
Возвращает количество рядов в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getItemAt(index)
Возвращает ряд в зависимости от его позиции в коллекции.
getItemAt(index: number): Excel.ChartSeries;Параметры
- index
-
number
Значение индекса получаемого объекта. Используется нулевой индекс.
Возвращаемое значение
Комментарии
Примеры
// 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;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.ChartSeriesCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
Примеры
// 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 строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartSeriesCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ChartSeriesCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): Excel.Interfaces.ChartSeriesCollectionData;Возвращаемое значение
Office Add-ins