@feds01/graphika

---

@feds01/graphika / core/scale

core/scale

Classes

default

Defined in: core/scale.ts:38

Constructors

Constructor

new default(options): default;

Defined in: core/scale.ts:45

Parameters

Parameter	Type
options	ScaleOptions

Returns

default

Properties

Property	Modifier	Type	Default value	Defined in
range	public	number	0	core/scale.ts:40
roundedMinimum	public	number	Number.NEGATIVE_INFINITY	core/scale.ts:43
scaleLabels	public	(string | number)[]	undefined	core/scale.ts:42
scaleStep	public	number	0	core/scale.ts:41

Accessors

closestToZero

Get Signature

get closestToZero(): number;

Defined in: core/scale.ts:156

Get the closest number to zero in the scale. This is a useful utility to have when trying to work out the orientation of the scale.

Returns

number

the closest number to zero in the scale.

max

Get Signature

get max(): number;

Defined in: core/scale.ts:90

Returns

number

min

Get Signature

get min(): number;

Defined in: core/scale.ts:86

Returns

number

tickCount

Get Signature

get tickCount(): number;

Defined in: core/scale.ts:108

Returns

number

Set Signature

set tickCount(val): void;

Defined in: core/scale.ts:112

Parameters

Parameter	Type
val	number

Returns

void

ticks

Get Signature

get ticks(): number[];

Defined in: core/scale.ts:79

Generate the ticks for the scale. This function will generate the numeric ticks for the scale.

Returns

number[]

tickStep

Set Signature

set tickStep(val): void;

Defined in: core/scale.ts:119

Parameters

Parameter	Type
val	number

Returns

void

Methods

calculate()

calculate(): void;

Defined in: core/scale.ts:50

Returns

void

generateScaleLabels()

generateScaleLabels(): (string | number)[];

Defined in: core/scale.ts:94

Returns

(string | number)[]

getScaleLabels()

getScaleLabels(rtl): string[];

Defined in: core/scale.ts:138

Function to get scale values for the given scale object. The function also accepts values that allow the scale values to be transformed to be represented on a axis/graph.

Parameters

Parameter	Type	Default value	Description
rtl	boolean	false	If the numbers should be returned from Right-To-Left (largest to smallest) or else.

Returns

string[]

the scale labels.

getScaleStep()

getScaleStep(): number;

Defined in: core/scale.ts:145

Returns

number

getTickCount()

getTickCount(): number;

Defined in: core/scale.ts:124

Returns

number

niceNum()

static niceNum(range, round): number;

Defined in: core/scale.ts:170

Parameters

Parameter	Type
range	number
round	boolean

Returns

number

Type Aliases

ScaleOptions

type ScaleOptions = {
  axisColour?: string;
  drawLabels?: boolean;
  drawTicks?: boolean;
  labelDirection?: string;
  max: number;
  min: number;
  minimumScaleStep?: number;
  startAtZero?: boolean;
  tickCount: number;
  tickLabels?: string[] | null;
  ticks?: number;
};

Defined in: core/scale.ts:17

Properties

Property	Type	Defined in
axisColour?	string	core/scale.ts:18
drawLabels?	boolean	core/scale.ts:19
drawTicks?	boolean	core/scale.ts:20
labelDirection?	string	core/scale.ts:21
max	number	core/scale.ts:29
min	number	core/scale.ts:27
minimumScaleStep?	number	core/scale.ts:32
startAtZero?	boolean	core/scale.ts:22
tickCount	number	core/scale.ts:35
tickLabels?	string[] | null	core/scale.ts:23
ticks?	number	core/scale.ts:25