Skip to content

pencil.js / widget / WidgetOptions

Interface: WidgetOptions ​

Defined in: widget.ts:9

Widget options

Extends ​

Extended by ​

Properties ​

PropertyTypeDescriptionInherited fromDefined in
cap?CanvasLineCapHow lines endComponentOptions.capcomponent.ts:85
clip| Component<ComponentOptions> | nullOther component used to clip the renderingComponentOptions.clipcontainer.ts:26
cursorstring | nullCursor to use when hoverComponentOptions.cursorcomponent.ts:81
dashedboolean | number[]Should the line be dashed, you can also specify the dash pattern (ex: [4, 4] or Component.dashes.dots)ComponentOptions.dashedcomponent.ts:79
fillStyleColor used to fill, set to null for transparentComponentOptions.fillcomponent.ts:73
foregroundStyleColor of the foreground elements-widget.ts:13
joinCanvasLineJoinHow lines join between themComponentOptions.joincomponent.ts:83
opacitynumber | nullOpacity level from 0 to 1 (multiplied with its parents opacity, null means 1)ComponentOptions.opacitycontainer.ts:16
origin| string | PositionDefinitionRelative offset (Rectangle based shapes also accept named origins like "center")ComponentOptions.origincomponent.ts:87
rotationnumberRotation ratio from 0 to 1 (clockwise)ComponentOptions.rotationcontainer.ts:18
rotationCenterPositionDefinitionCenter of rotation relative to this positionComponentOptions.rotationCentercontainer.ts:20
scale| number | PositionDefinitionScaling ratio or a pair of value for horizontal and vertical scalingComponentOptions.scalecontainer.ts:22
shadowPartial<ShadowOptions>Set of options to set a shadowComponentOptions.shadowcomponent.ts:89
shownbooleanIs shownComponentOptions.showncontainer.ts:14
strokeStyleColor used to stroke, set to null for transparentComponentOptions.strokecomponent.ts:75
strokeWidthnumberStroke line thickness in pixelsComponentOptions.strokeWidthcomponent.ts:77
valueunknownInitial value-widget.ts:11
zIndexnumberDepth orderingComponentOptions.zIndexcontainer.ts:24

Released under the MIT License.