Excel.RowColumnPivotHierarchy class

Пакет:

excel

Представляет excel RowColumnPivotHierarchy.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.8 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
fields	Возвращает сводные поля, связанные с RowColumnPivotHierarchy.
id	Идентификатор RowColumnPivotHierarchy.
name	Имя RowColumnPivotHierarchy.
position	Положение RowColumnPivotHierarchy.

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

fields

Возвращает сводные поля, связанные с RowColumnPivotHierarchy.

readonly fields: Excel.PivotFieldCollection;

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

Excel.PivotFieldCollection

Комментарии

[ Набор API: ExcelApi 1.8 ]

id

Идентификатор RowColumnPivotHierarchy.

readonly id: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.8 ]

name

Имя RowColumnPivotHierarchy.

name: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.8 ]

position

Положение RowColumnPivotHierarchy.

position: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

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

load(options)

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

load(options?: Excel.Interfaces.RowColumnPivotHierarchyLoadOptions): Excel.RowColumnPivotHierarchy;

Параметры

options

Excel.Interfaces.RowColumnPivotHierarchyLoadOptions

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

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

Excel.RowColumnPivotHierarchy

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.RowColumnPivotHierarchy

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.RowColumnPivotHierarchy

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.RowColumnPivotHierarchyUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.RowColumnPivotHierarchy): void;

Параметры

properties

Excel.RowColumnPivotHierarchy

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

void

setToDefault()

Сбрасывает RowColumnPivotHierarchy до значений по умолчанию.

setToDefault(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.8 ]

toJSON()

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

toJSON(): Excel.Interfaces.RowColumnPivotHierarchyData;

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

Excel.Interfaces.RowColumnPivotHierarchyData