Skip to main content

Interface: VirtualKeyboardOptions

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

Source​

core/dist/index.d.ts:100

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

Source​

core/dist/index.d.ts:43

backgroundColor?​

optional backgroundColor: RgbaColor

Background color of keyboard.

Source​

addons/src/composites/virtual-keyboard.ts:97

capitalLettersOnly?​

optional capitalLettersOnly: boolean

If true, only capital letters will be shown.

Source​

addons/src/composites/virtual-keyboard.ts:89

draggable?​

optional draggable: boolean

Can the node be dragged?

Inherited from​

CompositeOptions.draggable

Source​

core/dist/index.d.ts:106

fontNames?​

optional fontNames: string[]

The fonts for the key labels, if not the default font.

Source​

addons/src/composites/virtual-keyboard.ts:85

fontSize?​

optional fontSize: number

Size of font for keys.

Source​

addons/src/composites/virtual-keyboard.ts:83

hidden?​

optional hidden: boolean

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

Inherited from​

CompositeOptions.hidden

Source​

core/dist/index.d.ts:108

hiddenKeys?​

optional hiddenKeys: string

Comma-separated list of keys to hide.

Source​

addons/src/composites/virtual-keyboard.ts:87

isUserInteractionEnabled?​

optional isUserInteractionEnabled: boolean

Does the node respond to user events, such as taps? Default is false

Inherited from​

CompositeOptions.isUserInteractionEnabled

Source​

core/dist/index.d.ts:104

keyColor?​

optional keyColor: RgbaColor

Color of keys.

Source​

addons/src/composites/virtual-keyboard.ts:91

keyDownColor?​

optional keyDownColor: RgbaColor

Color of keys when pressed.

Source​

addons/src/composites/virtual-keyboard.ts:93

keyHorizontalPaddingPercent?​

optional keyHorizontalPaddingPercent: number

Percent of each key's width that should be used for padding on the left and right sides. Default is .10

Source​

addons/src/composites/virtual-keyboard.ts:75

keyVerticalPaddingPercent?​

optional keyVerticalPaddingPercent: number

Percent of each key's height that should be used for padding on the top and bottom sides. Default is .10

Source​

addons/src/composites/virtual-keyboard.ts:77

keyboardHorizontalPaddingPercent?​

optional keyboardHorizontalPaddingPercent: number

Percent of the keyboard width that should be used for padding on the left and right sides. Default is .02

Source​

addons/src/composites/virtual-keyboard.ts:71

keyboardVerticalPaddingPercent?​

optional keyboardVerticalPaddingPercent: number

Percent of the keyboard height that should be used for padding on the top and bottom sides. Default is .025

Source​

addons/src/composites/virtual-keyboard.ts:73

keysPerRow?​

optional keysPerRow: number

How many regular-sized keys should fit in a row? This is used for scaling purposes. If not provided, it will be inferred from the row configuration.

Source​

addons/src/composites/virtual-keyboard.ts:81

layout?​

optional layout: Layout

FOR INTERNAL USE ONLY

Inherited from​

CompositeOptions.layout

Source​

core/dist/index.d.ts:110

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

Source​

core/dist/index.d.ts:94

position?​

optional position: Point

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

Inherited from​

CompositeOptions.position

Source​

core/dist/index.d.ts:96

rows?​

optional rows: VirtualKeyboardRow[]

Configuration of keyboard rows. Order is from top to bottom rows.

Source​

addons/src/composites/virtual-keyboard.ts:79

scale?​

optional scale: number

Scale of the node. Default is 1.0

Inherited from​

CompositeOptions.scale

Source​

core/dist/index.d.ts:98

showKeyDownPreview?​

optional showKeyDownPreview: boolean

If true, a preview of the key that will be pressed will be shown.

Source​

addons/src/composites/virtual-keyboard.ts:99

size​

size: Size

Source​

addons/src/composites/virtual-keyboard.ts:69

specialKeyDownColor?​

optional specialKeyDownColor: RgbaColor

Color of special keys when pressed.

Source​

addons/src/composites/virtual-keyboard.ts:95

suppressEvents?​

optional suppressEvents: boolean

Should the node not emit events to the EventStore? Default is false.

Remarks​

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

Inherited from​

CompositeOptions.suppressEvents

Source​

core/dist/index.d.ts:115

uuid?​

Internal

optional uuid: string

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

Inherited from​

CompositeOptions.uuid

Source​

core/dist/index.d.ts:112

zPosition?​

optional zPosition: number

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

Inherited from​

CompositeOptions.zPosition

Source​

core/dist/index.d.ts:45

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

Source​

core/dist/index.d.ts:102