Excel.Interfaces.ShapeLoadOptions interface

表示工作表中的泛型形状对象。 形状可以是几何形状、线条、一组形状等。若要了解有关形状对象模型的详细信息,请阅读 使用 Excel JavaScript API 处理形状。

注解

[ API 集:ExcelApi 1.9 ]

属性

$all

$all为加载选项指定将加载所有标量属性 ((例如Range.address) ,但不加载导航属性 (如 Range.format.fill.color) )。

altTextDescription

指定对象的可选说明文本 Shape

altTextTitle

指定对象的可选标题文本 Shape

connectionSiteCount

返回此形状上的连接站点数。

displayName

获取形状的显示名称。 新创建的形状具有已本地化且可能与其 name不匹配的生成名称。 在此方案中,可以使用此 API 获取 UI 中显示的名称。

fill

返回此形状的填充格式。

geometricShape

返回与形状关联的几何形状。 如果形状类型不是“GeometricShape”,则会引发错误。

geometricShapeType

指定此几何形状的几何形状类型。 有关详细信息,请参阅 Excel.GeometricShapeTypenull如果形状类型不是“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.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 获取 UI 中显示的名称。

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.GeometricShapeTypenull如果形状类型不是“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 ]