PowerPoint.Interfaces.ShapeData interface

一个描述通过调用 shape.toJSON()返回的数据的接口。

注解

使用方

属性

altTextDescription

形状的替换文字说明。

替换文字提供形状中包含的信息的替代的基于文本的表示形式。 这些信息对于可能无法看到或理解形状的有视觉或认知障碍的人很有用。

altTextTitle

形状的替换文字标题。

替换文字提供形状中包含的信息的替代的基于文本的表示形式。 这些信息对于可能无法看到或理解形状的有视觉或认知障碍的人很有用。 可以向残障人士朗读标题,并用于确定他们是否希望听到对内容的描述。

creationId

获取形状的创建 ID。 如果形状没有创建 ID,则返回 null 。

height

指定形状的高度(以磅为单位)。 使用负值设置时引发 InvalidArgument 异常。

id

获取形状的唯一 ID。

isDecorative

表示形状是否为装饰性。

装饰物增加了视觉趣味,但没有信息 (例如风格边框) 。 使用屏幕阅读器的 People 会听到这些是装饰性的,因此他们知道他们没有遗漏任何重要信息。

left

从形状左侧到幻灯片左侧的距离(以磅为单位)。

level

返回指定形状的级别。

  • 级别为 0 表示形状不属于组。

  • 级别为 1 表示形状是顶层组的一部分。

  • 级别大于 1 表示形状是嵌套组。

name

指定此形状的名称。

rotation

指定形状绕 z 轴的旋转(以度为单位)。 正值表示顺时针旋转,负值表示逆时针旋转。

top

从形状的顶部边缘到幻灯片顶部边缘的距离(以磅为单位)。

type

返回此形状的类型。 有关详细信息,请参阅 PowerPoint.ShapeType 。

visible

指定形状是否可见。

width

指定形状的宽度(以磅为单位)。 使用负值设置时引发 InvalidArgument 异常。

zOrderPosition

返回形状的 z 顺序位置,0 表示顺序堆栈的底部。 幻灯片上的每种形状都有唯一的 z 顺序,但每张幻灯片都有唯一的 z 顺序堆栈,因此不同幻灯片上的两个形状可能具有相同的 z 顺序编号。

属性详细信息

altTextDescription

形状的替换文字说明。

替换文字提供形状中包含的信息的替代的基于文本的表示形式。 这些信息对于可能无法看到或理解形状的有视觉或认知障碍的人很有用。

altTextDescription?: string;

属性值

string

注解

API 集:PowerPointApi 1.10

altTextTitle

形状的替换文字标题。

替换文字提供形状中包含的信息的替代的基于文本的表示形式。 这些信息对于可能无法看到或理解形状的有视觉或认知障碍的人很有用。 可以向残障人士朗读标题,并用于确定他们是否希望听到对内容的描述。

altTextTitle?: string;

属性值

string

注解

API 集:PowerPointApi 1.10

creationId

获取形状的创建 ID。 如果形状没有创建 ID,则返回 null 。

creationId?: string | null;

属性值

string | null

注解

API 集:PowerPointApi 1.10

height

指定形状的高度(以磅为单位)。 使用负值设置时引发 InvalidArgument 异常。

height?: number;

属性值

number

注解

API 集:PowerPointApi 1.4

id

获取形状的唯一 ID。

id?: string;

属性值

string

注解

API 集:PowerPointApi 1.3

isDecorative

表示形状是否为装饰性。

装饰物增加了视觉趣味,但没有信息 (例如风格边框) 。 使用屏幕阅读器的 People 会听到这些是装饰性的,因此他们知道他们没有遗漏任何重要信息。

isDecorative?: boolean;

属性值

boolean

注解

API 集:PowerPointApi 1.10

left

从形状左侧到幻灯片左侧的距离(以磅为单位)。

left?: number;

属性值

number

注解

API 集:PowerPointApi 1.4

level

返回指定形状的级别。

  • 级别为 0 表示形状不属于组。

  • 级别为 1 表示形状是顶层组的一部分。

  • 级别大于 1 表示形状是嵌套组。

level?: number;

属性值

number

注解

API 集:PowerPointApi 1.8

name

指定此形状的名称。

name?: string;

属性值

string

注解

API 集:PowerPointApi 1.4

rotation

指定形状绕 z 轴的旋转(以度为单位)。 正值表示顺时针旋转,负值表示逆时针旋转。

rotation?: number;

属性值

number

注解

API 集:PowerPointApi 1.10

top

从形状的顶部边缘到幻灯片顶部边缘的距离(以磅为单位)。

top?: number;

属性值

number

注解

API 集:PowerPointApi 1.4

type

返回此形状的类型。 有关详细信息,请参阅 PowerPoint.ShapeType 。

type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";

属性值

PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox"

注解

API 集:PowerPointApi 1.4

visible

指定形状是否可见。

visible?: boolean;

属性值

boolean

注解

API 集:PowerPointApi 1.10

width

指定形状的宽度(以磅为单位)。 使用负值设置时引发 InvalidArgument 异常。

width?: number;

属性值

number

注解

API 集:PowerPointApi 1.4

zOrderPosition

返回形状的 z 顺序位置,0 表示顺序堆栈的底部。 幻灯片上的每种形状都有唯一的 z 顺序,但每张幻灯片都有唯一的 z 顺序堆栈,因此不同幻灯片上的两个形状可能具有相同的 z 顺序编号。

zOrderPosition?: number;

属性值

number

注解

API 集:PowerPointApi 1.8