Skip to content

pencil.js / checkbox / CheckboxOptions

Interface: CheckboxOptions ​

Defined in: checkbox.ts:8

Checkbox options

Extends ​

Properties ​

PropertyTypeDescriptionOverridesInherited fromDefined in
cap?CanvasLineCapHow lines end-InputOptions.capcomponent.ts:85
clip| Component<ComponentOptions> | nullOther component used to clip the rendering-InputOptions.clipcontainer.ts:26
cursorstring | nullCursor to use when hover-InputOptions.cursorcomponent.ts:81
dashedboolean | number[]Should the line be dashed, you can also specify the dash pattern (ex: [4, 4] or Component.dashes.dots)-InputOptions.dashedcomponent.ts:79
fillStyleColor used to fill, set to null for transparent-InputOptions.fillcomponent.ts:73
foregroundStyleColor of the foreground elements-InputOptions.foregroundwidget.ts:13
hoverStyleColor of the background when hovered-InputOptions.hoverinput.ts:13
joinCanvasLineJoinHow lines join between them-InputOptions.joincomponent.ts:83
opacitynumber | nullOpacity level from 0 to 1 (multiplied with its parents opacity, null means 1)-InputOptions.opacitycontainer.ts:16
origin| string | PositionDefinitionRelative offset (Rectangle based shapes also accept named origins like "center")-InputOptions.origincomponent.ts:87
rotationnumberRotation ratio from 0 to 1 (clockwise)-InputOptions.rotationcontainer.ts:18
rotationCenterPositionDefinitionCenter of rotation relative to this position-InputOptions.rotationCentercontainer.ts:20
scale| number | PositionDefinitionScaling ratio or a pair of value for horizontal and vertical scaling-InputOptions.scalecontainer.ts:22
shadowPartial<ShadowOptions>Set of options to set a shadow-InputOptions.shadowcomponent.ts:89
shownbooleanIs shown-InputOptions.showncontainer.ts:14
sizenumberWidth and height of the checkbox--checkbox.ts:10
strokeStyleColor used to stroke, set to null for transparent-InputOptions.strokecomponent.ts:75
strokeWidthnumberStroke line thickness in pixels-InputOptions.strokeWidthcomponent.ts:77
valuebooleanWhether it's check ot notInputOptions.value-checkbox.ts:12
zIndexnumberDepth ordering-InputOptions.zIndexcontainer.ts:24

Released under the MIT License.