Skip to main content

Interface: ShapeOptions

Extends​

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​

M2NodeOptions.alpha

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:12

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​

DrawableOptions.anchorPoint

Defined in​

m2c2kit/packages/core/src/DrawableOptions.ts:5

circleOfRadius?​

optional circleOfRadius: number

If provided, shape will be a circle with given radius

Defined in​

m2c2kit/packages/core/src/ShapeOptions.ts:14

cornerRadius?​

optional cornerRadius: number

Radius of rectangle's corners

Defined in​

m2c2kit/packages/core/src/ShapeOptions.ts:18

draggable?​

optional draggable: boolean

Can the node be dragged?

Inherited from​

M2NodeOptions.draggable

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:18

fillColor?​

optional fillColor: RgbaColor

Color with which to fill shape. Default is Constants.DEFAULT_SHAPE_FILL_COLOR (WebColors.Red)

Defined in​

m2c2kit/packages/core/src/ShapeOptions.ts:20

hidden?​

optional hidden: boolean

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

Inherited from​

M2NodeOptions.hidden

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:20

isAntialiased?​

optional isAntialiased: boolean

Should the shape be drawn with anti-aliasing. Default is yes.

Defined in​

m2c2kit/packages/core/src/ShapeOptions.ts:30

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​

M2NodeOptions.isPartOfComposite

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:27

isUserInteractionEnabled?​

optional isUserInteractionEnabled: boolean

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

Inherited from​

M2NodeOptions.isUserInteractionEnabled

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:16

layout?​

optional layout: Layout

FOR INTERNAL USE ONLY

Inherited from​

M2NodeOptions.layout

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:22

lineWidth?​

optional lineWidth: number

Width of outline. Default is undefined for rectangle and circle, 2 for path.

Defined in​

m2c2kit/packages/core/src/ShapeOptions.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​

M2NodeOptions.name

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:6

path?​

optional path: M2Path | M2ColorfulPath | SvgStringPath

A path from which to create the shape

Defined in​

m2c2kit/packages/core/src/ShapeOptions.ts:26

position?​

optional position: Point

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

Inherited from​

M2NodeOptions.position

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:8

rect?​

optional rect: RectOptions

If provided, shape will be a rectangle as specified in Rect

Defined in​

m2c2kit/packages/core/src/ShapeOptions.ts:16

scale?​

optional scale: number

Scale of the node. Default is 1.0

Inherited from​

M2NodeOptions.scale

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:10

shapeType?​

optional shapeType: ShapeType

Defined in​

m2c2kit/packages/core/src/ShapeOptions.ts:12

size?​

optional size: Size

Size of container "view box" for M2Path and M2ColorfulPath shapes. Leave undefined for circle, rectangle, and SvgStringPath shapes.

Defined in​

m2c2kit/packages/core/src/ShapeOptions.ts:28

strokeColor?​

optional strokeColor: RgbaColor

Color with which to outline shape. Default is no color for rectangle and circle, red for path.

Defined in​

m2c2kit/packages/core/src/ShapeOptions.ts:22

uuid?​

optional uuid: string

Internal

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

Inherited from​

M2NodeOptions.uuid

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:24

zPosition?​

optional zPosition: number

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

Inherited from​

DrawableOptions.zPosition

Defined in​

m2c2kit/packages/core/src/DrawableOptions.ts:7

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​

M2NodeOptions.zRotation

Defined in​

m2c2kit/packages/core/src/M2NodeOptions.ts:14