Excel.GeometricShape class

Пакет:

excel

Представляет геометрическую фигуру внутри листа. Геометрическая фигура может быть прямоугольником, блок-стрелкой, символом уравнения, элементом блок-схемы, звездочкой, баннером, выноской или любой другой базовой фигурой в Excel.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

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

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

id

Возвращает идентификатор фигуры.

readonly id: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

shape

Shape Возвращает объект для геометрической фигуры.

readonly shape: Excel.Shape;

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

Excel.Shape

Комментарии

[ Набор API: ExcelApi 1.9 ]

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

load(options)

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

load(options?: Excel.Interfaces.GeometricShapeLoadOptions): Excel.GeometricShape;

Параметры

options

Excel.Interfaces.GeometricShapeLoadOptions

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

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

Excel.GeometricShape

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.GeometricShape

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.GeometricShape

toJSON()

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

toJSON(): Excel.Interfaces.GeometricShapeData;

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

Excel.Interfaces.GeometricShapeData