Class AxisInterval

The range of an axis is the physical (start, end) pixels on the screen for the axis. This is the pixel-space of the axis (where as the domain is the data-space of the axis, for example, the tick values).

Index

Properties

Methods

asTuple copy equals equalsInterval isEmpty isNotEmpty map measure translate translateEnd translateStart as empty from

Properties

`Readonly`end

end: number

`Readonly`start

start: number

Methods

asTuple

asTuple(): [start: number, end: number]
Converts the axis interval to a tuple

Returns [start: number, end: number]
The axis interval as a tuple
- Defined in app/charts/axes/AxisInterval.ts:78

copy

copy(): AxisInterval
Creates a copy of the specified axis interval

Returns AxisInterval
A copy of the specified axis interval
- Defined in app/charts/axes/AxisInterval.ts:70

equals

equals(other: AxisInterval): boolean
Determines whether the specified axis interval is equal to this one.
Parameters
- other: AxisInterval
  The other axis interval to compare to
Returns boolean
true if the specified axis interval is equal to this one, false otherwise.
- Defined in app/charts/axes/AxisInterval.ts:62

equalsInterval

equalsInterval(start: number, end: number): boolean
Parameters
- start: number
- end: number
Returns boolean
true if the specified axis interval is equal to this one, false otherwise
- Defined in app/charts/axes/AxisInterval.ts:53

isEmpty

isEmpty(): boolean
Returns boolean
true if the axis interval is empty, false otherwise
- Defined in app/charts/axes/AxisInterval.ts:39

isNotEmpty

isNotEmpty(): boolean
Returns boolean
true if the axis interval is not empty, false otherwise
- Defined in app/charts/axes/AxisInterval.ts:46

map

map(
fn: (start: number, end: number) => [start: number, end: number],
): AxisInterval
Applies the specified function to the axis interval and returns the result
Parameters
- fn: (start: number, end: number) => [start: number, end: number]
  The function to apply to the axis interval
Returns AxisInterval
The result of the function application
- Defined in app/charts/axes/AxisInterval.ts:87

measure

measure(): number
Calculates the measure (end - start) of the specified axis interval. The measure of an empty axis interval is 0.

Returns number
The measure (end - start) of the specified axis interval
- Defined in app/charts/axes/AxisInterval.ts:97

translate

translate(delta: number): AxisInterval
Translates the specified axis interval by the specified delta.
Parameters
- delta: number
  The amount by which to translate the axis interval
Returns AxisInterval
The new axis interval
- Defined in app/charts/axes/AxisInterval.ts:124

translateEnd

translateEnd(delta: number): AxisInterval
Updates the end value of the specified axis interval
Parameters
- delta: number
  The amount by which to update the end value
Returns AxisInterval
The new axis interval
- Defined in app/charts/axes/AxisInterval.ts:115

translateStart

translateStart(delta: number): AxisInterval
Updates the start value of the specified axis interval
Parameters
- delta: number
  The amount by which to update the start value
Returns AxisInterval
A new axis interval
- Defined in app/charts/axes/AxisInterval.ts:106

`Static`as

as(tuple: [start: number, end: number]): AxisInterval
Creates an axis interval from the specified tuple
Parameters
- tuple: [start: number, end: number]
  The tuple to convert
Returns AxisInterval
The axis-interval
- Defined in app/charts/axes/AxisInterval.ts:24

`Static`empty

empty(): AxisInterval
Creates an empty axis interval

Returns AxisInterval
An empty axis interval
- Defined in app/charts/axes/AxisInterval.ts:32

`Static`from

from(start: number, end: number): AxisInterval
Creates an axis interval from the specified start and end values
Parameters
- start: number
  The axis-range start value
- end: number
  The axis-range end value
Returns AxisInterval
The axis-interval
- Defined in app/charts/axes/AxisInterval.ts:15