cupertino-files / ChartAxisStyle

Class: ChartAxisStyle

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

One axis's gridlines, tick marks and visibility.

Extends

• ChartStyleArchive

Constructors

Constructor

new ChartAxisStyle(store, object, kind, index): ChartAxisStyle

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

Parameters

store

ObjectStore

object

IwaObject

kind

AxisKind

index

number

Returns

ChartAxisStyle

Overrides

ChartStyleArchive.constructor

Properties

index

readonly index: number

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

Position among the axes of this kind.

---

kind

readonly kind: AxisKind

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

---

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

---

showAxis

Get Signature

get showAxis(): boolean | undefined

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

Returns

boolean | undefined

---

showMajorGridlines

Get Signature

get showMajorGridlines(): boolean | undefined

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

Returns

boolean | undefined

Methods

bool()

bool(property): boolean | undefined

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

Parameters

property

string

Returns

boolean | undefined

---

describe()

describe(): Record<string, unknown>

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

Everything this module names, for inspection.

Returns

Record<string, unknown>

---

field()

field(property): number

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

Resolve a [category, value] pair against this axis's kind.

Parameters

property

string

Returns

number

---

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

---

majorGridlineStroke()

majorGridlineStroke(): Stroke | undefined

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

Returns

Stroke | undefined

---

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

---

setBool()

setBool(property, value): void

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

Parameters

property

string

value

boolean

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

---

setMajorGridlineStroke()

setMajorGridlineStroke(stroke): void

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

Parameters

stroke

Stroke

Returns

void

---

setShowAxis()

setShowAxis(value): void

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

Parameters

value

boolean

Returns

void

---

setShowMajorGridlines()

setShowMajorGridlines(value): void

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

Parameters

value

boolean

Returns

void

---

setStroke()

setStroke(property, stroke): void

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

Parameters

property

string

stroke

Stroke

Returns

void

---

stroke()

stroke(property): Stroke | undefined

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

Parameters

property

string

Returns

Stroke | undefined