Skip to content

pencil.js / input / InputOptions

Interface: InputOptions ​

Defined in: input.ts:11

Input options

Extends ​

Extended by ​

Properties ​

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

Released under the MIT License.