Excel.ChartPlotArea class

  • Ссылка
Пакет:
excel

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.8 ]

Свойства

context

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

Задает форматирование области диаграммы.
height

Задает значение высоты области диаграммы.
insideHeight

Задает значение внутренней высоты области диаграммы.
insideLeft

Задает внутреннее левое значение области диаграммы.
insideTop

Задает внутреннее верхнее значение области диаграммы.
insideWidth

Задает значение внутренней ширины области диаграммы.
left

Задает левое значение области диаграммы.
position

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

Задает максимальное значение области диаграммы.
width

Задает значение ширины области диаграммы.

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

format

Задает форматирование области диаграммы.

readonly format: Excel.ChartPlotAreaFormat;

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

Excel.ChartPlotAreaFormat

Комментарии

[ Набор API: ExcelApi 1.8 ]

height

Задает значение высоты области диаграммы.

height: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

insideHeight

Задает значение внутренней высоты области диаграммы.

insideHeight: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

insideLeft

Задает внутреннее левое значение области диаграммы.

insideLeft: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

insideTop

Задает внутреннее верхнее значение области диаграммы.

insideTop: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

insideWidth

Задает значение внутренней ширины области диаграммы.

insideWidth: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

left

Задает левое значение области диаграммы.

left: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

position

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

position: Excel.ChartPlotAreaPosition | "Automatic" | "Custom";

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

Excel.ChartPlotAreaPosition | "Automatic" | "Custom"

Комментарии

[ Набор API: ExcelApi 1.8 ]

top

Задает максимальное значение области диаграммы.

top: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

width

Задает значение ширины области диаграммы.

width: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.8 ]

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

load(options)

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

load(options?: Excel.Interfaces.ChartPlotAreaLoadOptions): Excel.ChartPlotArea;

Параметры

options
Excel.Interfaces.ChartPlotAreaLoadOptions

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

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

Excel.ChartPlotArea

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.ChartPlotArea

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.ChartPlotArea

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;

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

Excel.Interfaces.ChartPlotAreaData