Excel.ChartTrendlineCollection class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.7 ]

Свойства

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

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

items

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

readonly items: Excel.ChartTrendline[];

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

Excel.ChartTrendline[]

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

add(type)

Добавляет новую линию тренда в коллекцию линий тренда.

add(type?: Excel.ChartTrendlineType): Excel.ChartTrendline;

Параметры

type

Excel.ChartTrendlineType

Указывает тип линии тренда. Значение по умолчанию — Linear. Дополнительные сведения см. в этой Excel.ChartTrendline статье.

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

Excel.ChartTrendline

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

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

add(typeString)

Добавляет новую линию тренда в коллекцию линий тренда.

add(typeString?: "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"): Excel.ChartTrendline;

Параметры

typeString

"Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"

Указывает тип линии тренда. Значение по умолчанию — Linear. Дополнительные сведения см. в этой Excel.ChartTrendline статье.

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

Excel.ChartTrendline

Комментарии

[ Набор API: ExcelApi 1.7 ]

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: ExcelApi 1.7 ]

getItem(index)

Возвращает объект линии тренда по индексу, который является порядком вставки в массиве элементов.

getItem(index: number): Excel.ChartTrendline;

Параметры

index

number

Представляет порядок вставки в массиве элементов.

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

Excel.ChartTrendline

Комментарии

[ Набор API: ExcelApi 1.7 ]

load(options)

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

load(options?: Excel.Interfaces.ChartTrendlineCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ChartTrendlineCollection;

Параметры

options

Excel.Interfaces.ChartTrendlineCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.ChartTrendlineCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ChartTrendlineCollection

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Excel.ChartTrendlineCollection

toJSON()

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

toJSON(): Excel.Interfaces.ChartTrendlineCollectionData;

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

Excel.Interfaces.ChartTrendlineCollectionData