arlas-d3 / Exports / HistogramUtils

Class: HistogramUtils

Table of contents

Constructors

• constructor

Methods

• generateUID
• getColor
• getFormatFromDateInterval
• getIntervalGUID
• getRoundPrecision
• isDataDomainWithinSelection
• isSelectionBeyondDataDomain
• isValueValid
• numToString
• parseDataKey
• parseSelectedValues
• parseSwimlaneDataKey
• round
• roundValue
• splitData
• toString

Constructors

constructor

• new HistogramUtils()

Methods

generateUID

▸ Static generateUID(): string

Returns

string

Defined in

src/histograms/utils/HistogramUtils.ts:429

---

getColor

▸ Static getColor(zeroToOne, paletteColors): Instance

Parameters

Name	Type
zeroToOne	number
paletteColors	string | [number, number]

Returns

Instance

Defined in

src/histograms/utils/HistogramUtils.ts:304

---

getFormatFromDateInterval

▸ Static getFormatFromDateInterval(dateInterval): string

Parameters

Name	Type
dateInterval	any

Returns

string

Defined in

src/histograms/utils/HistogramUtils.ts:398

---

getIntervalGUID

▸ Static getIntervalGUID(start, end): string

Parameters

Name	Type
start	number | Date
end	number | Date

Returns

string

Defined in

src/histograms/utils/HistogramUtils.ts:433

---

getRoundPrecision

▸ Static getRoundPrecision(dataInterval): number

Parameters

Name	Type
dataInterval	number

Returns

number

Defined in

src/histograms/utils/HistogramUtils.ts:443

---

isDataDomainWithinSelection

▸ Static isDataDomainWithinSelection(selectedInputValues, inputData, intervalSelectedMap): boolean

Parameters

Name	Type
selectedInputValues	SelectedInputValues
inputData	HistogramData[]
intervalSelectedMap	Map<string, { values: SelectedOutputValues ; x_position: number }>

Returns

boolean

Defined in

src/histograms/utils/HistogramUtils.ts:232

---

isSelectionBeyondDataDomain

▸ Static isSelectionBeyondDataDomain(selectedInputValues, inputData, intervalSelectedMap): boolean

Parameters

Name	Type
selectedInputValues	SelectedInputValues
inputData	HistogramData[]
intervalSelectedMap	Map<string, { values: SelectedOutputValues ; x_position: number }>

Returns

boolean

Defined in

src/histograms/utils/HistogramUtils.ts:209

---

isValueValid

▸ Static isValueValid(bucket): boolean

Parameters

Name	Type
bucket	HistogramData

Returns

boolean

Defined in

src/histograms/utils/HistogramUtils.ts:393

---

numToString

▸ Static numToString(value): string

Parameters

Name	Type
value	number

Returns

string

Defined in

src/histograms/utils/HistogramUtils.ts:467

---

parseDataKey

▸ Static parseDataKey(inputData, dataType): HistogramData[]

Parameters

Name	Type
inputData	HistogramData[]
dataType	DataType

Returns

HistogramData[]

Defined in

src/histograms/utils/HistogramUtils.ts:256

---

parseSelectedValues

▸ Static parseSelectedValues(selectedValues, dataType): SelectedOutputValues

Parameters

Name	Type
selectedValues	SelectedInputValues
dataType	DataType

Returns

SelectedOutputValues

Defined in

src/histograms/utils/HistogramUtils.ts:269

---

parseSwimlaneDataKey

▸ Static parseSwimlaneDataKey(swimlanesInputData, dataType): Map<string, HistogramData[]>

Parameters

Name	Type
swimlanesInputData	Map<string, { key: number ; value: number }[]>
dataType	DataType

Returns

Map<string, HistogramData[]>

Defined in

src/histograms/utils/HistogramUtils.ts:285

---

round

▸ Static round(value, precision): number

Parameters

Name	Type
value	any
precision	any

Returns

number

Defined in

src/histograms/utils/HistogramUtils.ts:457

---

roundValue

▸ Static roundValue(value, histogramParams, dateInterval?): number | Date

Parameters

Name	Type
value	number
histogramParams	HistogramParams
dateInterval?	number

Returns

number | Date

Defined in

src/histograms/utils/HistogramUtils.ts:329

---

splitData

▸ Static splitData(data): [HistogramData[][], HistogramData[][]]

Parameters

Name	Type
data	HistogramData[]

Returns

[HistogramData[][], HistogramData[][]]

Defined in

src/histograms/utils/HistogramUtils.ts:492

---

toString

▸ Static toString(value, histogramParams, dateInterval?): string

Parameters

Name	Type
value	number | Date
histogramParams	HistogramParams
dateInterval?	number

Returns

string

Defined in

src/histograms/utils/HistogramUtils.ts:346