Excel.ChartTrendline class

Ссылка

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

Свойства

backwardPeriod	Представляет число периодов, на которые линия тренда расширяется назад.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
format	Представляет форматирование линии тренда диаграммы.
forwardPeriod	Представляет число периодов, на которые линия тренда расширяется вперед.
intercept	Представляет значение отсекаемого отрезка линии тренда. Можно указать в виде числового значения или пустой строки (для автоматически заданных значений). Возвращаемое значение всегда является числом.
label	Представляет метку линии тренда диаграммы.
movingAveragePeriod	Представляет период линии тренда диаграммы. Применимо только к линиям тренда с типом `MovingAverage`.
name	Представляет имя линии тренда. Можно задать строковое значение, значение представляет `null` автоматические значения. Возвращаемое значение всегда является строковым
polynomialOrder	Представляет порядок линии тренда диаграммы. Применимо только к линиям тренда с типом `Polynomial`.
showEquation	Значение true, если формула для линии тренда отображается на диаграмме.
showRSquared	Значение true, если на диаграмме отображается значение в квадрате r для линии тренда.
type	Представляет тип линии тренда диаграммы.

Методы

delete()	Удаляет объект линии тренда.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный объект Excel.ChartTrendline является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.ChartTrendlineData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

backwardPeriod

Представляет число периодов, на которые линия тренда расширяется назад.

backwardPeriod: number;

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

number

context

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

context: RequestContext;

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

Excel.RequestContext

format

Представляет форматирование линии тренда диаграммы.

readonly format: Excel.ChartTrendlineFormat;

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

Excel.ChartTrendlineFormat

forwardPeriod

Представляет число периодов, на которые линия тренда расширяется вперед.

forwardPeriod: number;

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

number

intercept

Представляет значение отсекаемого отрезка линии тренда. Можно указать в виде числового значения или пустой строки (для автоматически заданных значений). Возвращаемое значение всегда является числом.

intercept: any;

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

any

label

Представляет метку линии тренда диаграммы.

readonly label: Excel.ChartTrendlineLabel;

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

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

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

Примеры

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

Параметры

options: Excel.Interfaces.ChartTrendlineLoadOptions

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

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

Excel.ChartTrendline

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.ChartTrendline

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartTrendline;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

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

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

Excel.ChartTrendline

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.ChartTrendlineUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Excel.Interfaces.ChartTrendlineUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

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

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

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;

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

Excel.Interfaces.ChartTrendlineData

Excel.ChartTrendline class

Комментарии

Свойства

Методы

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

backwardPeriod

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

Комментарии

context

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

format

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

Комментарии

forwardPeriod

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

Комментарии

intercept

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

Комментарии

label

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

Комментарии

movingAveragePeriod

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

Комментарии

name

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

Комментарии

polynomialOrder

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

Комментарии

showEquation

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

Комментарии

showRSquared

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

Комментарии

type

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

Комментарии

Примеры

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

delete()

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

Обратная связь

Дополнительные ресурсы