RingBuilder

Class: RingBuilder

Defined in: core/WheelBuilder.ts:48

Configures one ring. Reached through WheelBuilder.ring(id, (r) => ...); the wheel builder’s own section methods are this, for the main ring.

Constructors#

Constructor#

new RingBuilder(id: string): RingBuilder;

Defined in: core/WheelBuilder.ts:61

Parameters#

Parameter	Type
`id`	`string`

Returns#

RingBuilder

Properties#

Property	Modifier	Type	Defined in
`id`	`readonly`	`string`	core/WheelBuilder.ts:49

Methods#

direction()#

direction(dir: SpinDirection): this;

Defined in: core/WheelBuilder.ts:102

Spin direction for this ring. Default the wheel’s.

Parameters#

Parameter	Type
`dir`	`SpinDirection`

Returns#

this

dynamic()#

dynamic(config: DynamicSectionsConfig): this;

Defined in: core/WheelBuilder.ts:130

Dynamic sections: named weight steps the ring moves between.

Parameters#

Parameter	Type
`config`	`DynamicSectionsConfig`

Returns#

this

innerRadius()#

innerRadius(r: number): this;

Defined in: core/WheelBuilder.ts:78

Parameters#

Parameter	Type
`r`	`number`

Returns#

this

outerRadius()#

outerRadius(r: number): this;

Defined in: core/WheelBuilder.ts:73

Parameters#

Parameter	Type
`r`	`number`

Returns#

this

palette()#

palette(colors: readonly number[]): this;

Defined in: core/WheelBuilder.ts:136

Colours cycled for sections without an explicit fill.

Parameters#

Parameter	Type
`colors`	readonly `number`[]

Returns#

this

pegs()#

pegs(config?: false | PegConfig): this;

Defined in: core/WheelBuilder.ts:118

The pegs the tongues touch: one per divider by default, size 6 px, set just inside the first tongue’s tip. Every ring has them unless you pass false, which leaves flapping pointers at rest.

Parameters#

Parameter	Type
`config`	`false` \| `PegConfig`

Returns#

this

pointer()#

pointer(spec?: PointerSpec): this;

Defined in: core/WheelBuilder.ts:108

Add a pointer. Repeatable. A ring with none gets one at twelve o’clock.

Parameters#

Parameter	Type
`spec`	`PointerSpec`

Returns#

this

radius()#

radius(outer: number, inner?: number): this;

Defined in: core/WheelBuilder.ts:67

Outer radius in pixels, and the hub (inner) radius.

Parameters#

Parameter	Type	Default value
`outer`	`number`	`undefined`
`inner`	`number`	`0`

Returns#

this

section()#

section(config: WheelSectionConfig): this;

Defined in: core/WheelBuilder.ts:90

Append one section.

Parameters#

Parameter	Type
`config`	`WheelSectionConfig`

Returns#

this

sections()#

sections(list: readonly WheelSectionConfig[]): this;

Defined in: core/WheelBuilder.ts:84

Replace the section list.

Parameters#

Parameter	Type
`list`	readonly `WheelSectionConfig`[]

Returns#

this

skin()#

skin(skin: 
  | RingSkin
  | RingSkinConfig): this;

Defined in: core/WheelBuilder.ts:124

The look: a skin instance, or a serialisable skin config. Default GraphicsRingSkin.

Parameters#

Parameter	Type
`skin`	\| `RingSkin` \| `RingSkinConfig`

Returns#

this

startAngle()#

startAngle(deg: number): this;

Defined in: core/WheelBuilder.ts:96

Where section 0 begins, wheel-local degrees. Default -90 (twelve o’clock).

Parameters#

Parameter	Type
`deg`	`number`

Returns#

this