Skip to main content

Interface: DrawPadOptions

Extends​

  • CompositeOptions

Properties​

alpha?​

optional alpha: number

Opacity of the node. 0 is fully transparent, 1 is fully opaque. Default is 1.0. Alpha has multiplicative inheritance. For example, if the node's parent is alpha .5 and this node's is alpha .4, then the node will appear with alpha .2.

Inherited from​

CompositeOptions.alpha

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:98

anchorPoint?​

optional anchorPoint: Point

Point within the node that determines its position. Default is { x: 0.5, y: 0.5 }, which centers the node on its position

Inherited from​

CompositeOptions.anchorPoint

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:38

backgroundColor?​

optional backgroundColor: RgbaColor

Background color of the DrawPad. Default is transparent.

Defined in​

m2c2kit/packages/addons/src/composites/draw-pad.ts:30

borderColor?​

optional borderColor: RgbaColor

Color of the border. Default is black

Defined in​

m2c2kit/packages/addons/src/composites/draw-pad.ts:34

borderWidth?​

optional borderWidth: number

Width of the border. Default is 1

Defined in​

m2c2kit/packages/addons/src/composites/draw-pad.ts:32

continuousDrawingOnly?​

optional continuousDrawingOnly: boolean

Should the user be permitted to draw only one continuous line? If so, no more drawing is allowed after the first stroke ends.

Defined in​

m2c2kit/packages/addons/src/composites/draw-pad.ts:40

continuousDrawingOnlyExceptionDistance?​

optional continuousDrawingOnlyExceptionDistance: number

If continuousDrawingOnly, this is the maximum pixel distance from the last stroke's end point that the user is allowed to continue drawing with a new stroke.

Defined in​

m2c2kit/packages/addons/src/composites/draw-pad.ts:42

draggable?​

optional draggable: boolean

Can the node be dragged?

Inherited from​

CompositeOptions.draggable

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:104

hidden?​

optional hidden: boolean

Is the node, and its children, hidden? (not displayed). Default is false

Inherited from​

CompositeOptions.hidden

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:106

isPartOfComposite?​

optional isPartOfComposite: boolean

Is the node part of a composite? Default is false.

Remarks​

This property is for use by authors of Composite nodes. It is not intended for general use.

Inherited from​

CompositeOptions.isPartOfComposite

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:113

isUserInteractionEnabled?​

optional isUserInteractionEnabled: boolean

Does the DrawPad respond to user interaction? Default is true.

Overrides​

CompositeOptions.isUserInteractionEnabled

Defined in​

m2c2kit/packages/addons/src/composites/draw-pad.ts:36

layout?​

optional layout: Layout

FOR INTERNAL USE ONLY

Inherited from​

CompositeOptions.layout

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:108

lineColor?​

optional lineColor: RgbaColor

Color of drawn lines. Default is red.

Defined in​

m2c2kit/packages/addons/src/composites/draw-pad.ts:26

lineWidth?​

optional lineWidth: number

Width of drawn lines. Default is 1

Defined in​

m2c2kit/packages/addons/src/composites/draw-pad.ts:28

name?​

optional name: string

Name of the node. Only needed if the node will be referred to by name in a later function

Inherited from​

CompositeOptions.name

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:92

position?​

optional position: Point

Position of the node within its parent coordinate system. Default is (0, 0)

Inherited from​

CompositeOptions.position

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:94

resumeDrawingOnReturn?​

optional resumeDrawingOnReturn: boolean

Should drawing resume when the pointer, in a down state, returns to the DrawPad area after exiting it while drawing? Default is false.

Defined in​

m2c2kit/packages/addons/src/composites/draw-pad.ts:38

scale?​

optional scale: number

Scale of the node. Default is 1.0

Inherited from​

CompositeOptions.scale

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:96

size​

size: Size

Size of the DrawPad

Defined in​

m2c2kit/packages/addons/src/composites/draw-pad.ts:24

uuid?​

optional uuid: string

Internal

Unique identifier (UUID). Will be generated automatically. For m2c2kit library use only

Inherited from​

CompositeOptions.uuid

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:110

zPosition?​

optional zPosition: number

Value along the z-axis to determine drawing and tap order. Larger values are on top.

Inherited from​

CompositeOptions.zPosition

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:40

zRotation?​

optional zRotation: number

Rotation of the node around the Z axis. Unit is radians. Default is 0 (no rotation). zRotation has inheritance. In addition to this node's zRotation, all ancestors' zRotations will be applied.

Inherited from​

CompositeOptions.zRotation

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:100