Interface: IShapeWidget

Hierarchy

• IWidget

  ↳ IShapeWidget

Index

Properties

• bounds
• capabilities
• clientVisible
• createdUserId
• groupId
• height
• id
• lastModifiedUserId
• metadata
• plainText
• rotation
• style
• text
• type
• width
• x
• y

Properties

bounds

• Readonly bounds: IBounds

Inherited from IWidget.bounds

---

capabilities

• capabilities: WidgetCapabilities

Inherited from IWidgetNamespaces.capabilities

---

clientVisible

• clientVisible: boolean

Inherited from IWidgetNamespaces.clientVisible

---

createdUserId

• Readonly createdUserId: string

Inherited from IWidget.createdUserId

---

groupId

• Optional Readonly groupId: undefined | string

Inherited from IWidget.groupId

---

height

• height: number

---

id

• Readonly id: string

Inherited from IWidget.id

---

lastModifiedUserId

• Readonly lastModifiedUserId: string

Inherited from IWidget.lastModifiedUserId

---

metadata

• metadata: WidgetMetadata

Inherited from IWidgetNamespaces.metadata

---

plainText

• plainText: string

This text does not include HTML characters.

---

rotation

• rotation: number

---

style

• style: { backgroundColor: BackgroundColorStyle ; backgroundOpacity: BackgroundOpacityStyle ; bold: BoldStyle ; borderColor: BorderColorStyle ; borderOpacity: BorderOpacityStyle ; borderStyle: BorderStyle ; borderWidth: BorderWidthStyle ; fontFamily: FontFamily ; fontSize: FontSizeStyle ; highlighting: HighlightingStyle ; italic: ItalicStyle ; shapeType: ShapeType ; strike: StrikeStyle ; textAlign: TextAlign ; textAlignVertical: TextAlignVertical ; textColor: TextColorStyle ; underline: UnderlineStyle }

Type declaration:

---

text

• text: string

This text will include HTML characters if present.

---

type

• type: "SHAPE"

Overrides IWidget.type

---

width

• width: number

---

x

• x: number

---

y

• y: number