Class Axis

Hierarchy

Axis

Index

Constructors

Properties

_flipX _flipY _labelXDesc _labelYDesc _offsetX _offsetY _scaleX _scaleY _showLabels _unitOfMeasure mainGroup visible

Accessors

offsetX offsetY scaleX scaleY

Methods

createOrGet flipX flipY hide hideLabels onRescale onResize render renderGx renderGy renderLabelx renderLabely setLabelX setLabelY setLabels setUnitOfMeasure show showLabels

Constructors

constructor

new Axis(mainGroup: Selection<SVGElement, unknown, null, undefined>, showLabels?: boolean, labelXDesc: string, labelYDesc: string, unitOfMeasure: string, options?: Options): Axis
Parameters
- mainGroup: Selection<SVGElement, unknown, null, undefined>
- showLabels: boolean = true
- labelXDesc: string
- labelYDesc: string
- unitOfMeasure: string
- Optional options: Options
Returns Axis
- Defined in components/axis.ts:26

Properties

`Private` _flipX

_flipX: boolean = false

`Private` _flipY

_flipY: boolean = false

`Private` _labelXDesc

_labelXDesc: string

`Private` _labelYDesc

_labelYDesc: string

`Private` _offsetX

_offsetX: number = 0

`Private` _offsetY

_offsetY: number = 0

`Private` _scaleX

_scaleX: ScaleLinear<number, number, never>

`Private` _scaleY

_scaleY: ScaleLinear<number, number, never>

`Private` _showLabels

_showLabels: boolean = true

`Private` _unitOfMeasure

_unitOfMeasure: string

`Private` mainGroup

mainGroup: Selection<SVGElement, unknown, null, undefined>

`Private` visible

visible: boolean = true

Accessors

offsetX

get offsetX(): number
Returns number
- Defined in components/axis.ts:224
set offsetX(offset: number): void
Parameters
- offset: number
Returns void
- Defined in components/axis.ts:228

offsetY

get offsetY(): number
Returns number
- Defined in components/axis.ts:232
set offsetY(offset: number): void
Parameters
- offset: number
Returns void
- Defined in components/axis.ts:236

scaleX

get scaleX(): ScaleLinear<number, number, never>
Returns ScaleLinear<number, number, never>
- Defined in components/axis.ts:240

scaleY

get scaleY(): ScaleLinear<number, number, never>
Returns ScaleLinear<number, number, never>
- Defined in components/axis.ts:244

Methods

`Private` createOrGet

createOrGet(name: string): Selection<BaseType, unknown, null, undefined>
Parameters
- name: string
Returns Selection<BaseType, unknown, null, undefined>
- Defined in components/axis.ts:124

flipX

flipX(flipX: boolean): Axis
Parameters
- flipX: boolean
Returns Axis
- Defined in components/axis.ts:174

flipY

flipY(flipY: boolean): Axis
Parameters
- flipY: boolean
Returns Axis
- Defined in components/axis.ts:182

hide

hide(): Axis
Returns Axis
- Defined in components/axis.ts:168

hideLabels

hideLabels(): Axis
Returns Axis
- Defined in components/axis.ts:196

onRescale

onRescale(event: OnRescaleEvent): void
Parameters
- event: OnRescaleEvent
Returns void
- Defined in components/axis.ts:142

onResize

onResize(event: OnResizeEvent): void
Parameters
- event: OnResizeEvent
Returns void
- Defined in components/axis.ts:138

render

render(): void
Returns void
- Defined in components/axis.ts:133

`Private` renderGx

renderGx(): Selection<BaseType, unknown, null, undefined>
Returns Selection<BaseType, unknown, null, undefined>
- Defined in components/axis.ts:113

`Private` renderGy

renderGy(): Selection<BaseType, unknown, null, undefined>
Returns Selection<BaseType, unknown, null, undefined>
- Defined in components/axis.ts:102

`Private` renderLabelx

renderLabelx(): Selection<BaseType, unknown, null, undefined>
Returns Selection<BaseType, unknown, null, undefined>
- Defined in components/axis.ts:54

`Private` renderLabely

renderLabely(): Selection<BaseType, unknown, null, undefined>
Returns Selection<BaseType, unknown, null, undefined>
- Defined in components/axis.ts:78

setLabelX

setLabelX(label: string): Axis
Parameters
- label: string
Returns Axis
- Defined in components/axis.ts:202

setLabelY

setLabelY(label: string): Axis
Parameters
- label: string
Returns Axis
- Defined in components/axis.ts:207

setLabels

setLabels(labelX: string, labelY: string, unitOfMeasure: string): Axis
Parameters
- labelX: string
- labelY: string
- unitOfMeasure: string
Returns Axis
- Defined in components/axis.ts:217

setUnitOfMeasure

setUnitOfMeasure(uom: string): Axis
Parameters
- uom: string
Returns Axis
- Defined in components/axis.ts:212

show

show(): Axis
Returns Axis
- Defined in components/axis.ts:161

showLabels

showLabels(): Axis
Returns Axis
- Defined in components/axis.ts:190

Generated using TypeDoc