Class DimensionValue<XDimensionType>

Type Parameters

XDimensionType extends number | string | Date

Hierarchy

DimensionValue

Index

Constructors

constructor

new DimensionValue<XDimensionType>(value: XDimensionType, index?: number): DimensionValue<XDimensionType>
Type Parameters
- XDimensionType extends string | number | Date
Parameters
- value: XDimensionType
- index: number = -1
Returns DimensionValue<XDimensionType>
- Defined in projects/some-charts-lib/src/data/dimension-value.ts:9

Properties

`Readonly` index

index: number

`Readonly` primitiveValue

primitiveValue: string | number

`Readonly` value

value: XDimensionType

Methods

toNumericValue

toNumericValue(): number
Converts dimension value to its numeric representation.

Returns
- For numbers, it returns the number. Otherwise, it will return index.
Returns number
- Defined in projects/some-charts-lib/src/data/dimension-value.ts:83

toPoint

toPoint(): Point<string | number>
Returns Point<string | number>
- Defined in projects/some-charts-lib/src/data/dimension-value.ts:75

withIndex

withIndex(index: number): DimensionValue<XDimensionType>
Parameters
- index: number
Returns DimensionValue<XDimensionType>
- Defined in projects/some-charts-lib/src/data/dimension-value.ts:25

`Static` buildForDateFromPrimitive

buildForDateFromPrimitive(primitiveValue: number): DimensionValue<Date>
Parameters
- primitiveValue: number
Returns DimensionValue<Date>
- Defined in projects/some-charts-lib/src/data/dimension-value.ts:21

`Static` getCompareFunc

getCompareFunc<XDimensionType>(sorting?: Sorting): ((left: DimensionValue<XDimensionType>, right: DimensionValue<XDimensionType>) => 1 | -1 | 0)
Type Parameters
- XDimensionType extends string | number | Date
Parameters
- sorting: Sorting = Sorting.Asc
Returns ((left: DimensionValue<XDimensionType>, right: DimensionValue<XDimensionType>) => 1 | -1 | 0)
- - (left: DimensionValue<XDimensionType>, right: DimensionValue<XDimensionType>): 1 | -1 | 0
  - Parameters
    - left: DimensionValue<XDimensionType>
    - right: DimensionValue<XDimensionType>
    Returns 1 | -1 | 0
- Defined in projects/some-charts-lib/src/data/dimension-value.ts:29

`Static` getCompareFunc2D

getCompareFunc2D<XDimensionType, YDimensionType>(sorting?: Sorting): ((left: [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>], right: [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>]) => 1 | -1 | 0)
Type Parameters
- XDimensionType extends string | number | Date
- YDimensionType extends string | number | Date
Parameters
- sorting: Sorting = Sorting.Asc
Returns ((left: [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>], right: [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>]) => 1 | -1 | 0)
- - (left: [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>], right: [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>]): 1 | -1 | 0
  - Parameters
    - left: [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>]
    - right: [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>]
    Returns 1 | -1 | 0
- Defined in projects/some-charts-lib/src/data/dimension-value.ts:46

`Static` makePrimitive

makePrimitive(value: string | number | Date): string | number
Parameters
- value: string | number | Date
Returns string | number
- Defined in projects/some-charts-lib/src/data/dimension-value.ts:15

Class DimensionValue<XDimensionType>

Type Parameters

XDimensionType extends number | string | Date

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

XDimensionType extends string | number | Date

Parameters

value: XDimensionType

index: number = -1

Returns DimensionValue<XDimensionType>

Properties

Readonly index

Readonly primitiveValue

Readonly value

Methods

toNumericValue

Returns

Returns number

toPoint

Returns Point<string | number>

withIndex

Parameters

index: number

Returns DimensionValue<XDimensionType>

Static buildForDateFromPrimitive

Parameters

primitiveValue: number

Returns DimensionValue<Date>

Static getCompareFunc

Type Parameters

XDimensionType extends string | number | Date

Parameters

sorting: Sorting = Sorting.Asc

Returns ((left: DimensionValue<XDimensionType>, right: DimensionValue<XDimensionType>) => 1 | -1 | 0)

Parameters

left: DimensionValue<XDimensionType>

right: DimensionValue<XDimensionType>

Returns 1 | -1 | 0

Static getCompareFunc2D

Type Parameters

XDimensionType extends string | number | Date

YDimensionType extends string | number | Date

Parameters

sorting: Sorting = Sorting.Asc

Returns ((left: [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>], right: [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>]) => 1 | -1 | 0)

Parameters

left: [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>]

right: [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>]

Returns 1 | -1 | 0

Static makePrimitive

Parameters

value: string | number | Date

Returns string | number

Settings

Member Visibility

Theme

`Readonly` index

`Readonly` primitiveValue

`Readonly` value

`Static` buildForDateFromPrimitive

`Static` getCompareFunc

`Static` getCompareFunc2D

`Static` makePrimitive