Skip to content

@feds01/graphika


@feds01/graphika / core/axis

core/axis

Classes

default

Defined in: core/axis.ts:37

Constructors

Constructor
ts
new default(
   manager, 
   type, 
   options): default;

Defined in: core/axis.ts:45

Parameters
ParameterType
managerdefault
typeAxisType
optionsAxisOptions
Returns

default

Properties

PropertyModifierTypeDefault valueDefined in
startpublicnumber0core/axis.ts:39
yStartpublicnumber0core/axis.ts:38

Accessors

max
Get Signature
ts
get max(): number;

Defined in: core/axis.ts:160

Returns

number

min
Get Signature
ts
get min(): number;

Defined in: core/axis.ts:152

Returns

number

roundedMin
Get Signature
ts
get roundedMin(): number;

Defined in: core/axis.ts:156

Returns

number

scaleLabels
Get Signature
ts
get scaleLabels(): string[];

Defined in: core/axis.ts:164

Returns

string[]

scaleStep
Get Signature
ts
get scaleStep(): number;

Defined in: core/axis.ts:148

Returns

number

Methods

determineAxisPosition()
ts
determineAxisPosition(): void;

Defined in: core/axis.ts:69

Returns

void

Since

v0.0.1 Takes in input as the lengths object from a graph object.

draw()
ts
draw(): void;

Defined in: core/axis.ts:189

Returns

void

generateScaleNumbers()
ts
generateScaleNumbers(): string[];

Defined in: core/axis.ts:124

Returns

string[]

getColour()
ts
getColour(): string;

Defined in: core/axis.ts:177

Returns

string

Type Aliases

AxisOptions

ts
type AxisOptions = {
  axisColour?: string;
  drawLabels?: boolean;
  drawTicks?: boolean;
  labelDirection?: string;
  optimiseTicks?: boolean;
  startAtZero?: boolean;
  tickLabels?: string[];
  ticks?: number;
};

Defined in: core/axis.ts:26

Properties

PropertyTypeDefined in
axisColour?stringcore/axis.ts:27
drawLabels?booleancore/axis.ts:28
drawTicks?booleancore/axis.ts:29
labelDirection?stringcore/axis.ts:30
optimiseTicks?booleancore/axis.ts:31
startAtZero?booleancore/axis.ts:32
tickLabels?string[]core/axis.ts:33
ticks?numbercore/axis.ts:34

AxisType

ts
type AxisType = "x" | "y";

Defined in: core/axis.ts:24

Released under the ISC License.