GraphicsRingSkin

Class: GraphicsRingSkin

Defined in: skins/GraphicsRingSkin.ts:31

The default look: painted wedges, dividers, a rim, a hub and fitted labels. Good enough to ship a prototype, and every colour comes from the section styles so a config alone changes the palette.

Implements#

RingSkin

Constructors#

Constructor#

new GraphicsRingSkin(options?: GraphicsRingSkinOptions): GraphicsRingSkin;

Defined in: skins/GraphicsRingSkin.ts:44

Parameters#

Parameter	Type
`options`	`GraphicsRingSkinOptions`

Returns#

GraphicsRingSkin

Accessors#

isDestroyed#

Get Signature#

get isDestroyed(): boolean;

Defined in: skins/GraphicsRingSkin.ts:170

Returns

boolean

Implementation of#

RingSkin.isDestroyed

Methods#

attach()#

attach(ctx: RingSkinContext): void;

Defined in: skins/GraphicsRingSkin.ts:48

Parameters#

Parameter	Type
`ctx`	`RingSkinContext`

Returns#

void

Implementation of#

RingSkin.attach

destroy()#

destroy(): void;

Defined in: skins/GraphicsRingSkin.ts:174

Returns#

void

Implementation of#

RingSkin.destroy

highlight()#

highlight(sectionId: string | null): void;

Defined in: skins/GraphicsRingSkin.ts:81

Turn a highlight on one section (or off with null).

Parameters#

Parameter	Type
`sectionId`	`string` \| `null`

Returns#

void

Implementation of#

RingSkin.highlight

layout()#

layout(): void;

Defined in: skins/GraphicsRingSkin.ts:59

Returns#

void

Implementation of#

RingSkin.layout

syncRotation()#

syncRotation(rotationDeg: number): void;

Defined in: skins/GraphicsRingSkin.ts:77

Every frame, the disc rotation in degrees. For upright labels and bone-driven skins.

Parameters#

Parameter	Type
`rotationDeg`	`number`

Returns#

void

Implementation of#

RingSkin.syncRotation