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
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
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;
Возвращаемое значение
Office Add-ins