interface-ilinewidget
Interface: ILineWidget
Defines a widget of type LINE
.
Currently line widgets can only be created between two widgets.
// The startWidgetId
and endWidgetId
fields are required to create a line widget.
Hierarchy
-
↳ ILineWidget
Index
Properties
- bounds
- capabilities
- captions
- clientVisible
- createdUserId
- endPosition
- endWidgetId
- groupId
- id
- lastModifiedUserId
- metadata
- startPosition
- startWidgetId
- style
- type
Properties
bounds
• Readonly
bounds: IBounds
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
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:
Name | Type |
---|---|
lineColor | LineColorStyle |
lineEndStyle | LineArrowheadStyle |
lineStartStyle | LineArrowheadStyle |
lineStyle | LineStyle |
lineThickness | LineThicknessStyle |
lineType | LineType |
type
• type: "LINE"
Updated almost 2 years ago