AdornmentShape

Defined in: parts/Adornment.ts:134

A shape within an adornment (e.g., a resize handle, rotation handle).

Constructors

Constructor

new AdornmentShape(options): AdornmentShape

Defined in: parts/Adornment.ts:147

Parameters

options

bounds

Rect

cursor?

string

fill?

string

name

string

relativeOffset?

{ x: number; y: number; }

relativeOffset.x

number

relativeOffset.y

number

relativeSpot?

{ x: number; y: number; }

relativeSpot.x

number

relativeSpot.y

number

stroke?

string

strokeWidth?

number

visible?

boolean

Returns

AdornmentShape

Accessors

bounds

Get Signature

get bounds(): Rect

Defined in: parts/Adornment.ts:187

Returns

Rect

Set Signature

set bounds(value): void

Defined in: parts/Adornment.ts:191

Parameters

value

Rect

Returns

void

---

cursor

Get Signature

get cursor(): string

Defined in: parts/Adornment.ts:219

Returns

string

Set Signature

set cursor(value): void

Defined in: parts/Adornment.ts:223

Parameters

value

string

Returns

void

---

fill

Get Signature

get fill(): string

Defined in: parts/Adornment.ts:195

Returns

string

Set Signature

set fill(value): void

Defined in: parts/Adornment.ts:199

Parameters

value

string

Returns

void

---

name

Get Signature

get name(): string

Defined in: parts/Adornment.ts:183

Returns

string

---

stroke

Get Signature

get stroke(): string

Defined in: parts/Adornment.ts:203

Returns

string

Set Signature

set stroke(value): void

Defined in: parts/Adornment.ts:207

Parameters

value

string

Returns

void

---

strokeWidth

Get Signature

get strokeWidth(): number

Defined in: parts/Adornment.ts:211

Returns

number

Set Signature

set strokeWidth(value): void

Defined in: parts/Adornment.ts:215

Parameters

value

number

Returns

void

---

visible

Get Signature

get visible(): boolean

Defined in: parts/Adornment.ts:227

Returns

boolean

Set Signature

set visible(value): void

Defined in: parts/Adornment.ts:231

Parameters

value

boolean

Returns

void

Methods

containsPoint()

containsPoint(point): boolean

Defined in: parts/Adornment.ts:236

Check if a point is inside this shape.

Parameters

point

x

number

y

number

Returns

boolean

---

repositionRelativeTo()

repositionRelativeTo(partBounds): void

Defined in: parts/Adornment.ts:174

Move this shape so its center sits at its stored relative spot (plus any fixed offset) within the given (current) part bounds. A shape created without a relativeSpot is left untouched.

Parameters

partBounds

Rect

Returns

void