Excel.ChartPivotOptions class

Пакет:

excel

Объединяет параметры для сводной таблицы.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
showAxisFieldButtons	Указывает, должны ли отображаться кнопки поля оси на сводной диаграмме. Свойство showAxisFieldButtons соответствует команде "Показать кнопки поля оси" в раскрывающемся списке "Кнопки поля" вкладки "Анализ", которая доступна при выборе сводной диаграммы.
showLegendFieldButtons	Указывает, должны ли отображаться кнопки поля легенды в сводной диаграмме.
showReportFilterFieldButtons	Указывает, должны ли отображаться кнопки поля фильтра отчета в сводной диаграмме.
showValueFieldButtons	Указывает, должны ли отображаться кнопки поля отображения значения в сводной диаграмме.

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

showAxisFieldButtons

Указывает, должны ли отображаться кнопки поля оси на сводной диаграмме. Свойство showAxisFieldButtons соответствует команде "Показать кнопки поля оси" в раскрывающемся списке "Кнопки поля" вкладки "Анализ", которая доступна при выборе сводной диаграммы.

showAxisFieldButtons: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

showLegendFieldButtons

Указывает, должны ли отображаться кнопки поля легенды в сводной диаграмме.

showLegendFieldButtons: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

showReportFilterFieldButtons

Указывает, должны ли отображаться кнопки поля фильтра отчета в сводной диаграмме.

showReportFilterFieldButtons: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

showValueFieldButtons

Указывает, должны ли отображаться кнопки поля отображения значения в сводной диаграмме.

showValueFieldButtons: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

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

load(options)

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

load(options?: Excel.Interfaces.ChartPivotOptionsLoadOptions): Excel.ChartPivotOptions;

Параметры

options

Excel.Interfaces.ChartPivotOptionsLoadOptions

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

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

Excel.ChartPivotOptions

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ChartPivotOptions

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.ChartPivotOptions

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.ChartPivotOptionsUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.ChartPivotOptions): void;

Параметры

properties

Excel.ChartPivotOptions

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartPivotOptionsData;

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

Excel.Interfaces.ChartPivotOptionsData