Excel.ChartPlotArea class
Этот объект представляет атрибуты области построения диаграммы.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| format | Определяет форматирование области построения диаграммы. |
| height | Задает значение высоты области построения. |
| inside |
Задает значение внутренней высоты области построения. |
| inside |
Задает внутреннее левое значение области построения. |
| inside |
Задает внутреннее верхнее значение области построения. |
| inside |
Задает значение внутренней ширины области построения. |
| left | Задает левое значение области построения. |
| position | Задает положение области построения. |
| top | Задает верхнее значение области построения. |
| width | Задает значение ширины области построения. |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
format
Определяет форматирование области построения диаграммы.
readonly format: Excel.ChartPlotAreaFormat;Значение свойства
Комментарии
height
Задает значение высоты области построения.
height: number;Значение свойства
number
Комментарии
insideHeight
Задает значение внутренней высоты области построения.
insideHeight: number;Значение свойства
number
Комментарии
insideLeft
Задает внутреннее левое значение области построения.
insideLeft: number;Значение свойства
number
Комментарии
insideTop
Задает внутреннее верхнее значение области построения.
insideTop: number;Значение свойства
number
Комментарии
insideWidth
Задает значение внутренней ширины области построения.
insideWidth: number;Значение свойства
number
Комментарии
left
Задает левое значение области построения.
left: number;Значение свойства
number
Комментарии
position
Задает положение области построения.
position: Excel.ChartPlotAreaPosition | "Automatic" | "Custom";Значение свойства
Excel.ChartPlotAreaPosition | "Automatic" | "Custom"
Комментарии
top
Задает верхнее значение области построения.
top: number;Значение свойства
number
Комментарии
width
Задает значение ширины области построения.
width: number;Значение свойства
number
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.ChartPlotAreaLoadOptions): Excel.ChartPlotArea;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.ChartPlotArea;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartPlotArea;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.ChartPlotAreaUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.ChartPlotAreaUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.ChartPlotArea): void;Параметры
- properties
- Excel.ChartPlotArea
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartPlotArea объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ChartPlotAreaData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.ChartPlotAreaData;