cupertino-files / ChartLegendStyle

Class: ChartLegendStyle

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

The legend's background, border and opacity.

Extends

• ChartStyleArchive

Constructors

Constructor

new ChartLegendStyle(store, object): ChartLegendStyle

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

Parameters

store

ObjectStore

object

IwaObject

Returns

ChartLegendStyle

Inherited from

ChartStyleArchive.constructor

Properties

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:306

Returns

number | undefined

Methods

fill()

fill(): Fill | undefined

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

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

---

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:293

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:310

Parameters

value

number

Returns

void

---

setStroke()

setStroke(stroke): void

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

Parameters

stroke

Stroke

Returns

void

---

stroke()

stroke(): Stroke | undefined

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

Returns

Stroke | undefined