interface-ilinewidget

Interface: ILineWidget

Defines a widget of type LINE.

Currently line widgets can only be created between two widget.
// The startWidgetId and endWidgetId fields are required to create a line widget.

Hierarchy

Index

Properties

Properties

bounds

Readonly bounds: IBounds

Inherited from IWidget.bounds


capabilities

capabilities: WidgetCapabilities

Inherited from IWidgetNamespaces.capabilities


captions

Readonly captions: { text: string }[]


clientVisible

clientVisible: boolean

Inherited from IWidgetNamespaces.clientVisible


createdUserId

Readonly createdUserId: string

Inherited from IWidget.createdUserId


endPosition

Readonly endPosition: IPoint


endWidgetId

endWidgetId: string | undefined

Mandatory field


groupId

Optional Readonly groupId: undefined | string

Inherited from IWidget.groupId


id

Readonly id: string

Inherited from IWidget.id


lastModifiedUserId

Readonly lastModifiedUserId: string

Inherited from IWidget.lastModifiedUserId


metadata

metadata: WidgetMetadata

Inherited from IWidgetNamespaces.metadata


startPosition

Readonly startPosition: IPoint


startWidgetId

startWidgetId: string | undefined

Mandatory field


style

style: { lineColor: LineColorStyle ; lineEndStyle: LineArrowheadStyle ; lineStartStyle: LineArrowheadStyle ; lineStyle: LineStyle ; lineThickness: LineThicknessStyle ; lineType: LineType }

Type declaration:

NameType
lineColorLineColorStyle
lineEndStyleLineArrowheadStyle
lineStartStyleLineArrowheadStyle
lineStyleLineStyle
lineThicknessLineThicknessStyle
lineTypeLineType

type

type: "LINE"

Overrides IWidget.type


Did this page help you?