Excel.Interfaces.ShapeLoadOptions interface

Представляет на листе универсальный объект-фигуру. Фигурой может быть геометрическая фигура, линия, группа фигур и т. д. Дополнительные сведения о объектной модели фигуры см. в статье Работа с фигурами с помощью API JavaScript в Excel.

Комментарии

Набор API: ExcelApi 1.9

Используется

Свойства

$all

Указание $all параметров загрузки загружает все скалярные свойства (такие как ), но не навигационные свойства (такие какRange.addressRange.format.fill.color ).

altTextDescription

Задает замещающий текст описания объекта Shape .

altTextTitle

Задает замещающий текст заголовка для Shape объекта.

connectionSiteCount

Возвращает количество точек соединения на фигуре.

displayName

Получает отображаемое имя фигуры. У только что созданной фигуры есть сгенерированное имя, которое локализовано и может не совпадать с именем nameфигуры. В этом сценарии вы можете использовать этот API, чтобы получить имя, отображаемое в пользовательском интерфейсе.

fill

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

geometricShape

Возвращает геометрическую фигуру, связанную с линией. Если тип фигуры отличается от GeometricShape, возникает ошибка.

geometricShapeType

Определяет тип геометрической фигуры данной геометрической фигуры. См. Excel.GeometricShapeType дополнительные сведения. Возвращается null , если тип фигуры не "GeometricShape".

group

Возвращает группу фигур, связанную с фигурой. Если тип фигуры отличается от GroupShape, возникает ошибка.

height

Указывает высоту фигуры в точках. Создает InvalidArgument исключение, если задано отрицательное значение или ноль в качестве входных данных.

id

Идентификатор фигуры.

image

Возвращает изображение, связанное с фигурой. Если тип фигуры отличается от Image, возникает ошибка.

left

Расстояние в пунктах от левого края фигуры до левого края листа. Создает InvalidArgument исключение, если задано отрицательное значение в качестве входных данных.

level

Задает уровень заданной фигуры. Например, уровень 0 означает, что фигура не является частью групп; уровень 1 означает, что фигура является частью группы верхнего уровня; уровень 2 означает, что фигура является частью подгруппы верхнего уровня.

line

Возвращает линию, связанную с фигурой. Если тип фигуры отличается от Line, возникает ошибка.

lineFormat

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

lockAspectRatio

Пропорции фигуры заблокированы.

name

Указывает имя фигуры.

parentGroup

Определяет родительскую группу фигуры.

placement

Представляет способ прикрепления объекта к ячейкам под ним.

rotation

Угол поворота фигуры (в градусах).

textFrame

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

top

Расстояние в пунктах от верхнего края фигуры до верхнего края листа. Создает InvalidArgument исключение, если задано отрицательное значение в качестве входных данных.

type

Возвращает тип фигуры. См. Excel.ShapeType дополнительные сведения.

visible

Указывает, отображается ли фигура.

width

Определяет ширину фигуры (в точках). Создает InvalidArgument исключение, если задано отрицательное значение или ноль в качестве входных данных.

zOrderPosition

Возвращает положение указанной фигуры по оси Z. Значение 0 представляет нижнее положение по оси.

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

$all

Указание $all параметров загрузки загружает все скалярные свойства (такие как ), но не навигационные свойства (такие какRange.addressRange.format.fill.color ).

$all?: boolean;

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

boolean

altTextDescription

Задает замещающий текст описания объекта Shape .

altTextDescription?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

altTextTitle

Задает замещающий текст заголовка для Shape объекта.

altTextTitle?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

connectionSiteCount

Возвращает количество точек соединения на фигуре.

connectionSiteCount?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

displayName

Получает отображаемое имя фигуры. У только что созданной фигуры есть сгенерированное имя, которое локализовано и может не совпадать с именем nameфигуры. В этом сценарии вы можете использовать этот API, чтобы получить имя, отображаемое в пользовательском интерфейсе.

displayName?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.15

fill

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

fill?: Excel.Interfaces.ShapeFillLoadOptions;

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

Комментарии

Набор API: ExcelApi 1.9

geometricShape

Возвращает геометрическую фигуру, связанную с линией. Если тип фигуры отличается от GeometricShape, возникает ошибка.

geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;

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

Комментарии

Набор API: ExcelApi 1.9

geometricShapeType

Определяет тип геометрической фигуры данной геометрической фигуры. См. Excel.GeometricShapeType дополнительные сведения. Возвращается null , если тип фигуры не "GeometricShape".

geometricShapeType?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

group

Возвращает группу фигур, связанную с фигурой. Если тип фигуры отличается от GroupShape, возникает ошибка.

group?: Excel.Interfaces.ShapeGroupLoadOptions;

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

Комментарии

Набор API: ExcelApi 1.9

height

Указывает высоту фигуры в точках. Создает InvalidArgument исключение, если задано отрицательное значение или ноль в качестве входных данных.

height?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

id

Идентификатор фигуры.

id?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

image

Возвращает изображение, связанное с фигурой. Если тип фигуры отличается от Image, возникает ошибка.

image?: Excel.Interfaces.ImageLoadOptions;

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

Комментарии

Набор API: ExcelApi 1.9

left

Расстояние в пунктах от левого края фигуры до левого края листа. Создает InvalidArgument исключение, если задано отрицательное значение в качестве входных данных.

left?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

level

Задает уровень заданной фигуры. Например, уровень 0 означает, что фигура не является частью групп; уровень 1 означает, что фигура является частью группы верхнего уровня; уровень 2 означает, что фигура является частью подгруппы верхнего уровня.

level?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

line

Возвращает линию, связанную с фигурой. Если тип фигуры отличается от Line, возникает ошибка.

line?: Excel.Interfaces.LineLoadOptions;

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

Комментарии

Набор API: ExcelApi 1.9

lineFormat

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

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

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

Комментарии

Набор API: ExcelApi 1.9

lockAspectRatio

Пропорции фигуры заблокированы.

lockAspectRatio?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

name

Указывает имя фигуры.

name?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

parentGroup

Определяет родительскую группу фигуры.

parentGroup?: Excel.Interfaces.ShapeLoadOptions;

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

Комментарии

Набор API: ExcelApi 1.9

placement

Представляет способ прикрепления объекта к ячейкам под ним.

placement?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.10

rotation

Угол поворота фигуры (в градусах).

rotation?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

textFrame

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

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

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

Комментарии

Набор API: ExcelApi 1.9

top

Расстояние в пунктах от верхнего края фигуры до верхнего края листа. Создает InvalidArgument исключение, если задано отрицательное значение в качестве входных данных.

top?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

type

Возвращает тип фигуры. См. Excel.ShapeType дополнительные сведения.

type?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

visible

Указывает, отображается ли фигура.

visible?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

width

Определяет ширину фигуры (в точках). Создает InvalidArgument исключение, если задано отрицательное значение или ноль в качестве входных данных.

width?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

zOrderPosition

Возвращает положение указанной фигуры по оси Z. Значение 0 представляет нижнее положение по оси.

zOrderPosition?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9