Excel.ChartErrorBars class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.9

Используется

• Excel.ChartSeries: xErrorBars, yErrorBars

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
endStyleCap	Указывает, есть ли у полос погрешностей конечная заглавная черта.
format	Указывает тип форматирования планок погрешностей.
include	Указывает, какие части планок погрешностей нужно включить.
type	Тип диапазона, помеченного планками погрешностей.
visible	Определяет, отображаются ли полосы погрешностей

Методы

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.ChartErrorBars объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ChartErrorBarsData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

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

context

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

context: RequestContext;

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

Excel.RequestContext

endStyleCap

Указывает, есть ли у полос погрешностей конечная заглавная черта.

endStyleCap: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

format

Указывает тип форматирования планок погрешностей.

readonly format: Excel.ChartErrorBarsFormat;

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

Excel.ChartErrorBarsFormat

Комментарии

Набор API: ExcelApi 1.9

include

Указывает, какие части планок погрешностей нужно включить.

include: Excel.ChartErrorBarsInclude | "Both" | "MinusValues" | "PlusValues";

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

Excel.ChartErrorBarsInclude | "Both" | "MinusValues" | "PlusValues"

Комментарии

Набор API: ExcelApi 1.9

type

Тип диапазона, помеченного планками погрешностей.

type: Excel.ChartErrorBarsType | "FixedValue" | "Percent" | "StDev" | "StError" | "Custom";

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

Excel.ChartErrorBarsType | "FixedValue" | "Percent" | "StDev" | "StError" | "Custom"

Комментарии

Набор API: ExcelApi 1.9

visible

Определяет, отображаются ли полосы погрешностей

visible: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

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

load(options)

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

load(options?: Excel.Interfaces.ChartErrorBarsLoadOptions): Excel.ChartErrorBars;

Параметры

options

Excel.Interfaces.ChartErrorBarsLoadOptions

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

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

Excel.ChartErrorBars

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ChartErrorBars

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.ChartErrorBars

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.ChartErrorBarsUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Excel.ChartErrorBars): void;

Параметры

properties

Excel.ChartErrorBars

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartErrorBarsData;

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

Excel.Interfaces.ChartErrorBarsData