Winter Cardinal UI - v0.457.0 / DChartAxisBaseOptionParser

Class: DChartAxisBaseOptionParser<THEME, OPTIONS>

Type parameters

Name	Type
THEME	extends DThemeChartAxisBase = DThemeChartAxisBase
OPTIONS	extends DChartAxisBaseOptions<THEME> = DChartAxisBaseOptions<THEME>

Table of contents

Constructors

• constructor

Properties

• bar
• coordinate
• guide
• label
• padding
• position
• tick

Methods

• toBar
• toBarStroke
• toGuide
• toLabel
• toLabelAlign
• toLabelColor
• toLabelDirection
• toLabelOffset
• toLabelOutline
• toLabelPadding
• toLabelSpacing
• toPosition
• toStroke
• toStrokeStyle
• toTick
• toTickMajor
• toTickMajorFormatter
• toTickMajorGridline
• toTickMajorGridlineStroke
• toTickMajorStroke
• toTickMajorText
• toTickMajorTextAlign
• toTickMajorTextColor
• toTickMajorTextDirection
• toTickMajorTextOffset
• toTickMajorTextOutline
• toTickMajorTextPadding
• toTickMajorTextSpacing
• toTickMinor
• toTickMinorFormatter
• toTickMinorStroke
• toTickMinorText
• toTickMinorTextAlign
• toTickMinorTextColor
• toTickMinorTextDirection
• toTickMinorTextOffset
• toTickMinorTextOutline
• toTickMinorTextPadding
• toTickMinorTextSpacing
• toTickPosition

Constructors

constructor

• new DChartAxisBaseOptionParser<THEME, OPTIONS>(theme, options?): DChartAxisBaseOptionParser<THEME, OPTIONS>

Type parameters

Name	Type
THEME	extends DThemeChartAxisBase = DThemeChartAxisBase
OPTIONS	extends DChartAxisBaseOptions<THEME> = DChartAxisBaseOptions<THEME>

Parameters

Name	Type
theme	THEME
options?	OPTIONS

Returns

DChartAxisBaseOptionParser<THEME, OPTIONS>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:121

Properties

bar

• bar: DChartAxisBaseOptionParserBar

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:118

---

coordinate

• coordinate: number

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:113

---

guide

• guide: DChartAxisBaseOptionParserGuide

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:119

---

label

• label: undefined | DeepPartial<EShapeTextLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:116

---

padding

• padding: number

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:117

---

position

• position: DChartAxisPosition

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:114

---

tick

• tick: DChartAxisBaseOptionParserTick

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:115

Methods

toBar

▸ toBar(theme, options?): DChartAxisBaseOptionParserBar

Parameters

Name	Type
theme	THEME
options?	OPTIONS

Returns

DChartAxisBaseOptionParserBar

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:147

---

toBarStroke

▸ toBarStroke(theme, options?): Partial<EShapeStrokeLike>

Parameters

Name	Type
theme	THEME
options?	DChartAxisBaseStrokeOptions

Returns

Partial<EShapeStrokeLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:261

---

toGuide

▸ toGuide(theme, options?): DChartAxisBaseOptionParserGuide

Parameters

Name	Type
theme	THEME
options?	OPTIONS

Returns

DChartAxisBaseOptionParserGuide

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:141

---

toLabel

▸ toLabel(theme, options?): undefined | DeepPartial<EShapeTextLike>

Parameters

Name	Type
theme	THEME
options?	OPTIONS

Returns

undefined | DeepPartial<EShapeTextLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:646

---

toLabelAlign

▸ toLabelAlign(theme, options?): undefined | Partial<EShapeTextAlignLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextAlignLike>

Returns

undefined | Partial<EShapeTextAlignLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:682

---

toLabelColor

▸ toLabelColor(theme, options?): undefined | number

Parameters

Name	Type
theme	THEME
options?	number

Returns

undefined | number

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:734

---

toLabelDirection

▸ toLabelDirection(theme, options?): EShapeTextDirection

Parameters

Name	Type
theme	THEME
options?	DChartAxisBaseTextDirectionOption

Returns

EShapeTextDirection

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:727

---

toLabelOffset

▸ toLabelOffset(theme, options?): undefined | Partial<EShapeTextOffsetLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextOffsetLike>

Returns

undefined | Partial<EShapeTextOffsetLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:693

---

toLabelOutline

▸ toLabelOutline(theme, options?): undefined | Partial<EShapeTextOutlineLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextOutlineLike>

Returns

undefined | Partial<EShapeTextOutlineLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:668

---

toLabelPadding

▸ toLabelPadding(theme, options?): Partial<EShapeTextOffsetLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextOffsetLike>

Returns

Partial<EShapeTextOffsetLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:717

---

toLabelSpacing

▸ toLabelSpacing(theme, options?): undefined | Partial<EShapeTextOffsetLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextOffsetLike>

Returns

undefined | Partial<EShapeTextOffsetLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:705

---

toPosition

▸ toPosition(theme, options?): DChartAxisPosition

Parameters

Name	Type
theme	THEME
options?	OPTIONS

Returns

DChartAxisPosition

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:131

---

toStroke

▸ toStroke(optionsA, optionsB, enable, color, alpha, width, align, side, style): Partial<EShapeStrokeLike>

Parameters

Name	Type
optionsA	undefined | DChartAxisBaseStrokeOptions
optionsB	undefined | DChartAxisBaseStrokeOptions
enable	undefined | boolean
color	undefined | number
alpha	undefined | number
width	undefined | number
align	undefined | number
side	undefined | number
style	undefined | number

Returns

Partial<EShapeStrokeLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:332

---

toStrokeStyle

▸ toStrokeStyle(target?): undefined | number

Parameters

Name

Type

target?

number | "NONE" | "NON_EXPANDING_WIDTH" | "NON_SHRINKING_WIDTH" | "NON_SCALING_DOT_AND_DASH" | "NON_SCALING_MASK" | "DOTTED" | "DOTTED_DENSELY" | "DOTTED_LOOSELY" | "DOTTED_MASK" | "DASHED" | "DASHED_DENSELY" | "DASHED_LOOSELY" | "DASHED_MASK" | "NON_SCALING" | ("NONE" | "NON_EXPANDING_WIDTH" | "NON_SHRINKING_WIDTH" | "NON_SCALING_DOT_AND_DASH" | "NON_SCALING_MASK" | "DOTTED" | "DOTTED_DENSELY" | "DOTTED_LOOSELY" | "DOTTED_MASK" | "DASHED" | "DASHED_DENSELY" | "DASHED_LOOSELY" | "DASHED_MASK" | "NON_SCALING")[]

Returns

undefined | number

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:388

---

toTick

▸ toTick(theme, options?): DChartAxisBaseOptionParserTick

Parameters

Name	Type
theme	THEME
options?	OPTIONS

Returns

DChartAxisBaseOptionParserTick

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:154

---

toTickMajor

▸ toTickMajor(theme, options?): DChartAxisBaseOptionParserTickMajor

Parameters

Name	Type
theme	THEME
options?	DChartAxisBaseTickOptions

Returns

DChartAxisBaseOptionParserTickMajor

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:163

---

toTickMajorFormatter

▸ toTickMajorFormatter(theme, options?): undefined | NumberFormatter

Parameters

Name	Type
theme	THEME
options?	DChartAxisBaseTickMajorOptions

Returns

undefined | NumberFormatter

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:406

---

toTickMajorGridline

▸ toTickMajorGridline(theme, options, optionsStyle, optionsStroke): DChartAxisBaseOptionParserGridline

Parameters

Name	Type
theme	THEME
options	undefined | DChartAxisBaseTickMajorGridlineOptions
optionsStyle	undefined | EShapePointsStyleOption
optionsStroke	undefined | DChartAxisBaseStrokeOptions

Returns

DChartAxisBaseOptionParserGridline

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:191

---

toTickMajorGridlineStroke

▸ toTickMajorGridlineStroke(theme, optionsA?, optionsB?): Partial<EShapeStrokeLike>

Parameters

Name	Type
theme	THEME
optionsA?	DChartAxisBaseStrokeOptions
optionsB?	DChartAxisBaseStrokeOptions

Returns

Partial<EShapeStrokeLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:296

---

toTickMajorStroke

▸ toTickMajorStroke(theme, optionsA?, optionsB?): Partial<EShapeStrokeLike>

Parameters

Name	Type
theme	THEME
optionsA?	DChartAxisBaseStrokeOptions
optionsB?	DChartAxisBaseStrokeOptions

Returns

Partial<EShapeStrokeLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:278

---

toTickMajorText

▸ toTickMajorText(theme, options?): undefined | DChartAxisBaseOptionParserText

Parameters

Name	Type
theme	THEME
options?	DChartAxisBaseTickTextOptions

Returns

undefined | DChartAxisBaseOptionParserText

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:433

---

toTickMajorTextAlign

▸ toTickMajorTextAlign(theme, options?): undefined | Partial<EShapeTextAlignLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextAlignLike>

Returns

undefined | Partial<EShapeTextAlignLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:470

---

toTickMajorTextColor

▸ toTickMajorTextColor(theme, options?): undefined | number

Parameters

Name	Type
theme	THEME
options?	number

Returns

undefined | number

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:522

---

toTickMajorTextDirection

▸ toTickMajorTextDirection(theme, options?): EShapeTextDirection

Parameters

Name	Type
theme	THEME
options?	DChartAxisBaseTextDirectionOption

Returns

EShapeTextDirection

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:515

---

toTickMajorTextOffset

▸ toTickMajorTextOffset(theme, options?): undefined | Partial<EShapeTextOffsetLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextOffsetLike>

Returns

undefined | Partial<EShapeTextOffsetLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:481

---

toTickMajorTextOutline

▸ toTickMajorTextOutline(theme, options?): undefined | Partial<EShapeTextOutlineLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextOutlineLike>

Returns

undefined | Partial<EShapeTextOutlineLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:456

---

toTickMajorTextPadding

▸ toTickMajorTextPadding(theme, options?): Partial<EShapeTextOffsetLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextOffsetLike>

Returns

Partial<EShapeTextOffsetLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:505

---

toTickMajorTextSpacing

▸ toTickMajorTextSpacing(theme, options?): undefined | Partial<EShapeTextOffsetLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextOffsetLike>

Returns

undefined | Partial<EShapeTextOffsetLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:493

---

toTickMinor

▸ toTickMinor(theme, options?): DChartAxisBaseOptionParserTickMinor

Parameters

Name	Type
theme	THEME
options?	DChartAxisBaseTickOptions

Returns

DChartAxisBaseOptionParserTickMinor

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:240

---

toTickMinorFormatter

▸ toTickMinorFormatter(theme, options?): undefined | NumberFormatter

Parameters

Name	Type
theme	THEME
options?	DChartAxisBaseTickMinorOptions

Returns

undefined | NumberFormatter

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:526

---

toTickMinorStroke

▸ toTickMinorStroke(theme, optionsA?, optionsB?): Partial<EShapeStrokeLike>

Parameters

Name	Type
theme	THEME
optionsA?	DChartAxisBaseStrokeOptions
optionsB?	DChartAxisBaseStrokeOptions

Returns

Partial<EShapeStrokeLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:314

---

toTickMinorText

▸ toTickMinorText(theme, options?): undefined | DChartAxisBaseOptionParserText

Parameters

Name	Type
theme	THEME
options?	DChartAxisBaseTickTextOptions

Returns

undefined | DChartAxisBaseOptionParserText

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:553

---

toTickMinorTextAlign

▸ toTickMinorTextAlign(theme, options?): undefined | Partial<EShapeTextAlignLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextAlignLike>

Returns

undefined | Partial<EShapeTextAlignLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:590

---

toTickMinorTextColor

▸ toTickMinorTextColor(theme, options?): undefined | number

Parameters

Name	Type
theme	THEME
options?	number

Returns

undefined | number

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:642

---

toTickMinorTextDirection

▸ toTickMinorTextDirection(theme, options?): EShapeTextDirection

Parameters

Name	Type
theme	THEME
options?	DChartAxisBaseTextDirectionOption

Returns

EShapeTextDirection

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:635

---

toTickMinorTextOffset

▸ toTickMinorTextOffset(theme, options?): undefined | Partial<EShapeTextOffsetLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextOffsetLike>

Returns

undefined | Partial<EShapeTextOffsetLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:601

---

toTickMinorTextOutline

▸ toTickMinorTextOutline(theme, options?): undefined | Partial<EShapeTextOutlineLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextOutlineLike>

Returns

undefined | Partial<EShapeTextOutlineLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:576

---

toTickMinorTextPadding

▸ toTickMinorTextPadding(theme, options?): Partial<EShapeTextOffsetLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextOffsetLike>

Returns

Partial<EShapeTextOffsetLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:625

---

toTickMinorTextSpacing

▸ toTickMinorTextSpacing(theme, options?): undefined | Partial<EShapeTextOffsetLike>

Parameters

Name	Type
theme	THEME
options?	Partial<EShapeTextOffsetLike>

Returns

undefined | Partial<EShapeTextOffsetLike>

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:613

---

toTickPosition

▸ toTickPosition(tickPosition): EShapeBarPosition

Parameters

Name	Type
tickPosition	"INSIDE" | "OUTSIDE" | DChartAxisTickPosition

Returns

EShapeBarPosition

Defined in

src/main/typescript/wcardinal/ui/d-chart-axis-base-options-parser.ts:207

Edit this page.