Excel.ChartTrendline class
Этот объект представляет атрибуты объекта линии тренда диаграммы.
- Extends
Комментарии
Используется
Свойства
| backward |
Представляет число периодов, на которые линия тренда расширяется назад. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| format | Представляет форматирование линии тренда диаграммы. |
| forward |
Представляет число периодов, на которые линия тренда расширяется вперед. |
| intercept | Представляет значение отсекаемого отрезка линии тренда. Можно указать в виде числового значения или пустой строки (для автоматически заданных значений). Возвращаемое значение всегда является числом. |
| label | Представляет метку линии тренда диаграммы. |
| moving |
Представляет период линии тренда диаграммы. Применимо только к линиям тренда с типом |
| name | Представляет имя линии тренда. Может быть задано строковое значение, значение |
| polynomial |
Представляет порядок линий тренда диаграммы. Применимо только к линиям тренда с типом |
| show |
Значение true, если формула для линии тренда отображается на диаграмме. |
| show |
True, если на графике отображается величина r-квадрат для линии тренда. |
| type | Представляет тип линии тренда диаграммы. |
Методы
| delete() | Удаляет объект линии тренда. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
backwardPeriod
Представляет число периодов, на которые линия тренда расширяется назад.
backwardPeriod: number;Значение свойства
number
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
format
Представляет форматирование линии тренда диаграммы.
readonly format: Excel.ChartTrendlineFormat;Значение свойства
Комментарии
forwardPeriod
Представляет число периодов, на которые линия тренда расширяется вперед.
forwardPeriod: number;Значение свойства
number
Комментарии
intercept
Представляет значение отсекаемого отрезка линии тренда. Можно указать в виде числового значения или пустой строки (для автоматически заданных значений). Возвращаемое значение всегда является числом.
intercept: any;Значение свойства
any
Комментарии
label
Представляет метку линии тренда диаграммы.
readonly label: Excel.ChartTrendlineLabel;Значение свойства
Комментарии
movingAveragePeriod
Представляет период линии тренда диаграммы. Применимо только к линиям тренда с типом MovingAverage.
movingAveragePeriod: number;Значение свойства
number
Комментарии
name
Представляет имя линии тренда. Может быть задано строковое значение, значение null представляет собой автоматические значения. Возвращаемое значение всегда является строковым
name: string;Значение свойства
string
Комментарии
polynomialOrder
Представляет порядок линий тренда диаграммы. Применимо только к линиям тренда с типом Polynomial.
polynomialOrder: number;Значение свойства
number
Комментарии
showEquation
Значение true, если формула для линии тренда отображается на диаграмме.
showEquation: boolean;Значение свойства
boolean
Комментарии
showRSquared
True, если на графике отображается величина r-квадрат для линии тренда.
showRSquared: boolean;Значение свойства
boolean
Комментарии
type
Представляет тип линии тренда диаграммы.
type: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power";Значение свойства
Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" | "Power"
Комментарии
Примеры
// 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;
// Get the trendline for series 1 and load its type property.
let trendline = seriesCollection.getItemAt(0).trendlines.getItem(0);
trendline.load("type");
await context.sync();
console.log("The trendline type is:" + trendline.type);
});
Сведения о методе
delete()
Удаляет объект линии тренда.
delete(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.ChartTrendlineLoadOptions): Excel.ChartTrendline;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.ChartTrendline;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartTrendline;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.ChartTrendlineUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.ChartTrendlineUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.ChartTrendline): void;Параметры
- properties
- Excel.ChartTrendline
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartTrendline объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ChartTrendlineData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.ChartTrendlineData;