cupertino-files / ChartSeriesStyle

Class: ChartSeriesStyle

Defined in: src/tsch/appearance.ts:210

The style of one series — in practice, its colour.

Extends

• ChartStyleArchive

Constructors

Constructor

new ChartSeriesStyle(store, object, index): ChartSeriesStyle

Defined in: src/tsch/appearance.ts:214

Parameters

store

ObjectStore

object

IwaObject

index

number

Returns

ChartSeriesStyle

Overrides

ChartStyleArchive.constructor

Properties

index

readonly index: number

Defined in: src/tsch/appearance.ts:212

Position of the series this styles, from the sparse array.

---

object

readonly object: IwaObject

Defined in: src/tsch/appearance.ts:154

Inherited from

ChartStyleArchive.object

---

store

readonly store: ObjectStore

Defined in: src/tsch/appearance.ts:153

Inherited from

ChartStyleArchive.store

Accessors

id

Get Signature

get id(): bigint

Defined in: src/tsch/appearance.ts:161

Returns

bigint

Inherited from

ChartStyleArchive.id

---

opacity

Get Signature

get opacity(): number | undefined

Defined in: src/tsch/appearance.ts:257

Returns

number | undefined

Methods

fill()

fill(): Fill | undefined

Defined in: src/tsch/appearance.ts:226

The series colour.

Read from the column fill, which every chart carries whatever its geometry, falling back through the other geometries and finally to the template default so that a chart authored as a pie still answers.

Returns

Fill | undefined

---

fillProperty()

fillProperty(field): Fill | undefined

Defined in: src/tsch/appearance.ts:189

A TSD.FillArchive property, decoded.

Parameters

field

number

Returns

Fill | undefined

Inherited from

ChartStyleArchive.fillProperty

---

fills()

fills(): Record<string, Fill | undefined>

Defined in: src/tsch/appearance.ts:245

Per-geometry fills, for callers that need the distinction.

Returns

Record<string, Fill | undefined>

---

floatProperty()

floatProperty(field): number | undefined

Defined in: src/tsch/appearance.ts:199

A float property, e.g. an opacity.

Parameters

field

number

Returns

number | undefined

Inherited from

ChartStyleArchive.floatProperty

---

properties()

properties(): RawMessage | undefined

Defined in: src/tsch/appearance.ts:173

The property bag, or undefined on an archive that carries none.

An archive with no field 10000 is inheriting everything from its preset. Reading returns undefined rather than inventing defaults, because the value that applies then is the preset's, and this module does not resolve preset inheritance.

Returns

RawMessage | undefined

Inherited from

ChartStyleArchive.properties

---

requireProperties()

protected requireProperties(): RawMessage

Defined in: src/tsch/appearance.ts:178

The bag, created if the archive has none.

Returns

RawMessage

Inherited from

ChartStyleArchive.requireProperties

---

setFill()

setFill(fill): void

Defined in: src/tsch/appearance.ts:240

Set the series colour across every geometry.

See the module note: Apple keeps the six geometry fills identical and the seventh — the template default — distinct, so this writes the six.

Parameters

fill

Fill

Returns

void

---

setFillProperty()

setFillProperty(field, fill): void

Defined in: src/tsch/appearance.ts:193

Parameters

field

number

fill

Fill

Returns

void

Inherited from

ChartStyleArchive.setFillProperty

---

setFloatProperty()

setFloatProperty(field, value): void

Defined in: src/tsch/appearance.ts:203

Parameters

field

number

value

number

Returns

void

Inherited from

ChartStyleArchive.setFloatProperty

---

setOpacity()

setOpacity(value): void

Defined in: src/tsch/appearance.ts:261

Parameters

value

number

Returns

void