Skip to main content

Interface: CountdownTimerOptions

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

draggable?​

optional draggable: boolean

Can the node be dragged?

Inherited from​

CompositeOptions.draggable

Defined in​

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

fontColor?​

optional fontColor: RgbaColor

Font size for timer text (numbers). Default is white.

Defined in​

m2c2kit/packages/addons/src/composites/countdown-timer.ts:32

fontName?​

optional fontName: string

Font name for timer text (numbers).

Defined in​

m2c2kit/packages/addons/src/composites/countdown-timer.ts:28

fontSize?​

optional fontSize: number

Font size for timer text (numbers). Default is 50.

Defined in​

m2c2kit/packages/addons/src/composites/countdown-timer.ts:30

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 node respond to user events, such as taps? Default is false

Inherited from​

CompositeOptions.isUserInteractionEnabled

Defined in​

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

layout?​

optional layout: Layout

FOR INTERNAL USE ONLY

Inherited from​

CompositeOptions.layout

Defined in​

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

milliseconds?​

optional milliseconds: number

Duration of the countdown, in milliseconds. Must be multiple of 1000. Default is 3000.

Defined in​

m2c2kit/packages/addons/src/composites/countdown-timer.ts:24

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

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

textVerticalBias?​

optional textVerticalBias: number

Default is to center the timer text (numbers) vertically within the timer shape (verticalBias = .5). Setting verticalBias less than .5 will pull the text towards the top of the timer shape. Setting verticalBias greater than .5 will pull the text towards the bottom of the timer shape.

Defined in​

m2c2kit/packages/addons/src/composites/countdown-timer.ts:38

tickIntervalMilliseconds?​

optional tickIntervalMilliseconds: number

Duration of each tick interval, in milliseconds. Default is 1000.

Defined in​

m2c2kit/packages/addons/src/composites/countdown-timer.ts:26

timerShape?​

optional timerShape: TimerShape

Shape of the timer. Default is a Royal Blue circle with a radius of 100.

Defined in​

m2c2kit/packages/addons/src/composites/countdown-timer.ts:36

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

zeroString?​

optional zeroString: string

String to show when the timer reaches zero. Default is "0". This could be changed to another value, such as "GO!"

Defined in​

m2c2kit/packages/addons/src/composites/countdown-timer.ts:34

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