Поделиться через

Excel.Interfaces.ShapeLoadOptions interface

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

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

$all

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

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

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

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

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

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

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

Указывает тип геометрической фигуры этой геометрической фигуры. Дополнительные сведения см. в этой Excel.GeometricShapeType статье. Возвращает значение null , если тип фигуры не является "GeometryShape".
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.address ), но не свойства навигации (например, Range.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;

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

Excel.Interfaces.ShapeFillLoadOptions

Комментарии

[ Набор API: ExcelApi 1.9 ]

geometricShape

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

geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;

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

Excel.Interfaces.GeometricShapeLoadOptions

Комментарии

[ Набор API: ExcelApi 1.9 ]

geometricShapeType

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

geometricShapeType?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

group

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

group?: Excel.Interfaces.ShapeGroupLoadOptions;

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

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;

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

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;

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

Excel.Interfaces.LineLoadOptions

Комментарии

[ Набор API: ExcelApi 1.9 ]

lineFormat

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

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

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

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;

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

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;

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

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 ]