Class DataSet<TItemType, XDimensionType, YDimensionType>

Type Parameters

TItemType
XDimensionType extends number | string | Date
YDimensionType extends number | string | Date | undefined = undefined

Hierarchy

DataSet

Constructors

constructor

new DataSet<TItemType, XDimensionType, YDimensionType>(elements: TItemType[], metrics: {
[id: string]: Metric<TItemType>;
}, dimensionXFunc: ((item: TItemType) => XDimensionType), dimensionYFunc?: ((item: TItemType) => Exclude<YDimensionType, undefined>), dimensionsSorting?: Sorting): DataSet<TItemType, XDimensionType, YDimensionType>
Type Parameters
- TItemType
- XDimensionType extends string | number | Date
- YDimensionType extends undefined | string | number | Date = undefined
Parameters
- elements: TItemType[]
- metrics: {
  [id: string]: Metric<TItemType>;
  }
  - [id: string]: Metric<TItemType>
- dimensionXFunc: ((item: TItemType) => XDimensionType)
  - - (item: TItemType): XDimensionType
    - Parameters
      
      item: TItemType
      
      Returns XDimensionType
- Optional dimensionYFunc: ((item: TItemType) => Exclude<YDimensionType, undefined>)
  - - (item: TItemType): Exclude<YDimensionType, undefined>
    - Parameters
      
      item: TItemType
      
      Returns Exclude<YDimensionType, undefined>
- dimensionsSorting: Sorting = Sorting.Asc
Returns DataSet<TItemType, XDimensionType, YDimensionType>
- Defined in projects/some-charts-lib/src/data/data-set.ts:60

Properties

`Private` _dimensionXType

_dimensionXType: undefined | DimensionType

`Private` _dimensionXValues

_dimensionXValues: DimensionValue<XDimensionType>[]

`Private` _dimensionYType

_dimensionYType: undefined | DimensionType

`Private` `Optional` _dimensionYValues

_dimensionYValues?: DimensionValue<Exclude<YDimensionType, undefined>>[]

`Private` _dimensionsValues

_dimensionsValues: DimensionValue<XDimensionType>[] | [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>][]

`Private` `Readonly` dimensionXFunc

dimensionXFunc: ((item: TItemType) => XDimensionType)

Type declaration

- (item: TItemType): XDimensionType
- Parameters
  - item: TItemType
  Returns XDimensionType

`Private` `Readonly` dimensionYFunc

dimensionYFunc: undefined | ((item: TItemType) => Exclude<YDimensionType, undefined>)

`Private` `Readonly` dimensionsSorting

dimensionsSorting: Sorting

`Readonly` eventTarget

eventTarget: ACEventTarget<Changed>

`Private` indexByXDimension

indexByXDimension: Map<string | number, number>

`Private` indexByYDimension

indexByYDimension: undefined | Map<string | number, number>

`Private` `Readonly` metrics

metrics: {
[id: string]: Metric<TItemType>;
}

Type declaration

[id: string]: Metric<TItemType>

`Readonly` metricsIds

metricsIds: readonly string[]

`Private` metricsRanges

metricsRanges: Map<string, Range<number>> = ...

`Private` metricsValues

metricsValues: Map<string, (number | number[])[]>

Accessors

dimensionXType

get dimensionXType(): undefined | DimensionType
Returns undefined | DimensionType
- Defined in projects/some-charts-lib/src/data/data-set.ts:45

dimensionXValues

get dimensionXValues(): readonly DimensionValue<XDimensionType>[]
Returns readonly DimensionValue<XDimensionType>[]
- Defined in projects/some-charts-lib/src/data/data-set.ts:28

dimensionYType

get dimensionYType(): undefined | DimensionType
Returns undefined | DimensionType
- Defined in projects/some-charts-lib/src/data/data-set.ts:49

dimensionYValues

get dimensionYValues(): undefined | readonly DimensionValue<Exclude<YDimensionType, undefined>>[]
Returns undefined | readonly DimensionValue<Exclude<YDimensionType, undefined>>[]
- Defined in projects/some-charts-lib/src/data/data-set.ts:32

dimensionsValues

get dimensionsValues(): readonly DimensionValue<XDimensionType>[] | readonly [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>][]
Returns readonly DimensionValue<XDimensionType>[] | readonly [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>][]
- Defined in projects/some-charts-lib/src/data/data-set.ts:36

is1D

get is1D(): boolean
Returns boolean
- Defined in projects/some-charts-lib/src/data/data-set.ts:89

is2D

get is2D(): boolean
Returns boolean
- Defined in projects/some-charts-lib/src/data/data-set.ts:93

Methods

clear

clear(): void
Clears this DataSet.

Returns void
- Defined in projects/some-charts-lib/src/data/data-set.ts:392

`Private` clearInternal

clearInternal(triggerChange: boolean): void
Parameters
- triggerChange: boolean
Returns void
- Defined in projects/some-charts-lib/src/data/data-set.ts:404

getArrayMetricValue

getArrayMetricValue(metricId: string, x: XDimensionType, y?: YDimensionType): undefined | number[]
Parameters
- metricId: string
- x: XDimensionType
- Optional y: YDimensionType
Returns undefined | number[]
- Defined in projects/some-charts-lib/src/data/data-set.ts:190

getBoundingRectangle

getBoundingRectangle(metricsIds: string[]): undefined | NumericDataRect
Calculates bounding rectangle for the specified metrics of this DataSet.

Returns
Parameters
- metricsIds: string[]
  
  ids of metrics to take into consideration.
Returns undefined | NumericDataRect
- Defined in projects/some-charts-lib/src/data/data-set.ts:501

`Protected` getDimensionType

getDimensionType(firstDimValue: undefined | string | number | Date): undefined | DimensionType
Parameters
- firstDimValue: undefined | string | number | Date
Returns undefined | DimensionType
- Defined in projects/some-charts-lib/src/data/data-set.ts:422

getMetricRange

getMetricRange(metricId: string): Range<number>
Parameters
- metricId: string
Returns Range<number>
- Defined in projects/some-charts-lib/src/data/data-set.ts:105

getMetricValue

getMetricValue(metricId: string, x: XDimensionType, y?: YDimensionType): undefined | number | number[]
Parameters
- metricId: string
- x: XDimensionType
- Optional y: YDimensionType
Returns undefined | number | number[]
- Defined in projects/some-charts-lib/src/data/data-set.ts:144

getMetricValueForDimensions

getMetricValueForDimensions(metricId: string, xDimVal: DimensionValue<XDimensionType>, yDimVal: undefined | DimensionValue<Exclude<YDimensionType, undefined>>): undefined | number | number[]
Parameters
- metricId: string
- xDimVal: DimensionValue<XDimensionType>
- yDimVal: undefined | DimensionValue<Exclude<YDimensionType, undefined>>
Returns undefined | number | number[]
- Defined in projects/some-charts-lib/src/data/data-set.ts:164

getMetricValues

getMetricValues(metricId: string): undefined | (number | number[])[]
Parameters
- metricId: string
Returns undefined | (number | number[])[]
- Defined in projects/some-charts-lib/src/data/data-set.ts:180

getSingleMetricValue

getSingleMetricValue(metricId: string, x: XDimensionType, y?: YDimensionType): undefined | number
Parameters
- metricId: string
- x: XDimensionType
- Optional y: YDimensionType
Returns undefined | number
- Defined in projects/some-charts-lib/src/data/data-set.ts:184

getSingleMetricValueForDimensions

getSingleMetricValueForDimensions(metricId: string, xDimVal: DimensionValue<XDimensionType>, yDimVal: undefined | DimensionValue<Exclude<YDimensionType, undefined>>): undefined | number
Parameters
- metricId: string
- xDimVal: DimensionValue<XDimensionType>
- yDimVal: undefined | DimensionValue<Exclude<YDimensionType, undefined>>
Returns undefined | number
- Defined in projects/some-charts-lib/src/data/data-set.ts:196

getSingleMetricValues

getSingleMetricValues(metricId: string): undefined | (number | number[])[]
Parameters
- metricId: string
Returns undefined | (number | number[])[]
- Defined in projects/some-charts-lib/src/data/data-set.ts:202

isArrayMetricValue

isArrayMetricValue(metricId: string): boolean
Parameters
- metricId: string
Returns boolean
- Defined in projects/some-charts-lib/src/data/data-set.ts:101

isSingleMetricValue

isSingleMetricValue(metricId: string): boolean
Parameters
- metricId: string
Returns boolean
- Defined in projects/some-charts-lib/src/data/data-set.ts:97

numericToXDimensionValue

numericToXDimensionValue(value: number): undefined | XDimensionType
Convert numeric value to value on X axis

Returns
XDimensionType
Parameters
- value: number
  
  value of X dimension
Returns undefined | XDimensionType
- Defined in projects/some-charts-lib/src/data/data-set.ts:466

numericToYDimensionValue

numericToYDimensionValue(value: number): undefined | YDimensionType
Convert numeric value to value on X axis

Returns
YDimensionType
Parameters
- value: number
  
  value of X dimension
Returns undefined | YDimensionType
- Defined in projects/some-charts-lib/src/data/data-set.ts:484

replace

replace(elements: TItemType[]): void
Replaces content of the DataSet with specified array of elements.
Parameters
- elements: TItemType[]
Returns void
- Defined in projects/some-charts-lib/src/data/data-set.ts:399

update

update(elements: TItemType[]): void
Updates elements to the specified DataSet. For numeric or Date dimensions, the update operation can only add values larger than those already in the DataSet, or override the existing values. For string dimensions, there is no such rule.
Parameters
- elements: TItemType[]
Returns void
- Defined in projects/some-charts-lib/src/data/data-set.ts:214

xDimensionValueToNumeric

xDimensionValueToNumeric(value: XDimensionType): undefined | number
Convert value on X axis to it's numeric counterpart

Returns
number
Parameters
- value: XDimensionType
  
  value of X dimension
Returns undefined | number
- Defined in projects/some-charts-lib/src/data/data-set.ts:441

yDimensionValueToNumeric

yDimensionValueToNumeric(value: YDimensionType): undefined | number
Convert value on Y axis to it's numeric counterpart

Returns
number
Parameters
- value: YDimensionType
  
  value of Y dimension
Returns undefined | number
- Defined in projects/some-charts-lib/src/data/data-set.ts:453

`Static` `Private` buildMetricIsNotArrayError

buildMetricIsNotArrayError(metricId: string): Error
Parameters
- metricId: string
Returns Error
- Defined in projects/some-charts-lib/src/data/data-set.ts:553

`Static` `Private` buildMetricIsNotSingleError

buildMetricIsNotSingleError(metricId: string): Error
Parameters
- metricId: string
Returns Error
- Defined in projects/some-charts-lib/src/data/data-set.ts:549

Class DataSet<TItemType, XDimensionType, YDimensionType>

Type Parameters

TItemType

XDimensionType extends number | string | Date

YDimensionType extends number | string | Date | undefined = undefined

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TItemType

XDimensionType extends string | number | Date

YDimensionType extends undefined | string | number | Date = undefined

Parameters

elements: TItemType[]

metrics: { [id: string]: Metric<TItemType>; }

[id: string]: Metric<TItemType>

dimensionXFunc: ((item: TItemType) => XDimensionType)

Parameters

item: TItemType

Returns XDimensionType

Optional dimensionYFunc: ((item: TItemType) => Exclude<YDimensionType, undefined>)

Parameters

item: TItemType

Returns Exclude<YDimensionType, undefined>

dimensionsSorting: Sorting = Sorting.Asc

Returns DataSet<TItemType, XDimensionType, YDimensionType>

Properties

Private _dimensionXType

Private _dimensionXValues

Private _dimensionYType

Private Optional _dimensionYValues

Private _dimensionsValues

Private Readonly dimensionXFunc

Type declaration

Parameters

item: TItemType

Returns XDimensionType

Private Readonly dimensionYFunc

Private Readonly dimensionsSorting

Readonly eventTarget

Private indexByXDimension

Private indexByYDimension

Private Readonly metrics

Type declaration

[id: string]: Metric<TItemType>

Readonly metricsIds

Private metricsRanges

Private metricsValues

Accessors

dimensionXType

Returns undefined | DimensionType

dimensionXValues

Returns readonly DimensionValue<XDimensionType>[]

dimensionYType

Returns undefined | DimensionType

dimensionYValues

Returns undefined | readonly DimensionValue<Exclude<YDimensionType, undefined>>[]

dimensionsValues

Returns readonly DimensionValue<XDimensionType>[] | readonly [DimensionValue<XDimensionType>, DimensionValue<Exclude<YDimensionType, undefined>>][]

is1D

Returns boolean

is2D

Returns boolean

Methods

clear

Returns void

Private clearInternal

Parameters

triggerChange: boolean

Returns void

getArrayMetricValue

Parameters

metricId: string

x: XDimensionType

Optional y: YDimensionType

metrics: {
[id: string]: Metric<TItemType>;
}

`Optional` dimensionYFunc: ((item: TItemType) => Exclude<YDimensionType, undefined>)

`Private` _dimensionXType

`Private` _dimensionXValues

`Private` _dimensionYType

`Private` `Optional` _dimensionYValues

`Private` _dimensionsValues

`Private` `Readonly` dimensionXFunc

`Private` `Readonly` dimensionYFunc

`Private` `Readonly` dimensionsSorting

`Readonly` eventTarget

`Private` indexByXDimension

`Private` indexByYDimension

`Private` `Readonly` metrics

`Readonly` metricsIds

`Private` metricsRanges

`Private` metricsValues

`Private` clearInternal

`Optional` y: YDimensionType

`Protected` getDimensionType

`Optional` y: YDimensionType

`Optional` y: YDimensionType