arlas-d3 / Exports / AbstractHistogram

Class: AbstractHistogram

Hierarchy

• AbstractHistogram

↳ AbstractChart

↳ AbstractSwimlane

Table of contents

Constructors

• constructor

Properties

• allAxesContext
• barsContext
• brushContext
• brushCornerTooltips
• brushHandles
• brushHandlesHeight
• chartDimensions
• context
• dataDomain
• dataInterval
• fromSetInterval
• hasSelectionExceededData
• histogramParams
• hoveredBucketKey
• isBrushed
• isBrushing
• isHeightFixed
• isWidthFixed
• minusSign
• noDatabarsContext
• plottingCount
• selectedBars
• selectionBrush
• selectionInterval
• tooltipCursorContext
• xAxis
• xLabelsAxis
• xTicksAxis
• yDimension

Methods

• clearTooltipCursor
• drawChartAxes
• getAxes
• getDataInterval
• getFollowingLastBucket
• getHistogramDataInterval
• getHistogramMinMaxBorders
• getXDomainExtent
• getXDomainScale
• init
• initializeChartDimensions
• initializeChartHeight
• initializeDescriptionValues
• isValueValid
• plot
• plotBars
• resize
• setBrushCornerTooltipsPositions
• setBrushHorizontalTooltipsXPositions
• setBrushHorizontalTooltipsYPositions
• setBrushVerticalTooltipsXPositions
• setBrushVerticalTooltipsYPositions
• setDataInterval
• setHTMLElementsOfBrushCornerTooltips
• setHistogramMargins
• setVerticalTooltipsWidth

Constructors

constructor

• new AbstractHistogram()

Defined in

src/histograms/AbstractHistogram.ts:76

Properties

allAxesContext

• Protected allAxesContext: any

Defined in

src/histograms/AbstractHistogram.ts:42

---

barsContext

• Protected barsContext: any

Defined in

src/histograms/AbstractHistogram.ts:38

---

brushContext

• Protected brushContext: any

Defined in

src/histograms/AbstractHistogram.ts:40

---

brushCornerTooltips

• brushCornerTooltips: BrushCornerTooltips

Defined in

src/histograms/AbstractHistogram.ts:32

---

brushHandles

• Protected brushHandles: any

Defined in

src/histograms/AbstractHistogram.ts:57

---

brushHandlesHeight

• Protected brushHandlesHeight: number = null

Defined in

src/histograms/AbstractHistogram.ts:56

---

chartDimensions

• Protected chartDimensions: ChartDimensions

Chart dimensions

Defined in

src/histograms/AbstractHistogram.ts:45

---

context

• Protected context: any

Contexts

Defined in

src/histograms/AbstractHistogram.ts:37

---

dataDomain

• Protected dataDomain: HistogramData[]

Data

Defined in

src/histograms/AbstractHistogram.ts:50

---

dataInterval

• Protected dataInterval: number

Defined in

src/histograms/AbstractHistogram.ts:51

---

fromSetInterval

• Protected fromSetInterval: boolean = false

Defined in

src/histograms/AbstractHistogram.ts:62

---

hasSelectionExceededData

• Protected hasSelectionExceededData: any = null

Defined in

src/histograms/AbstractHistogram.ts:60

---

histogramParams

• histogramParams: HistogramParams

Defined in

src/histograms/AbstractHistogram.ts:31

---

hoveredBucketKey

• Protected hoveredBucketKey: number | Date

Defined in

src/histograms/AbstractHistogram.ts:70

---

isBrushed

• Protected isBrushed: boolean = false

Defined in

src/histograms/AbstractHistogram.ts:58

---

isBrushing

• isBrushing: boolean = false

Defined in

src/histograms/AbstractHistogram.ts:34

---

isHeightFixed

• Protected isHeightFixed: boolean = false

Defined in

src/histograms/AbstractHistogram.ts:47

---

isWidthFixed

• Protected isWidthFixed: boolean = false

Defined in

src/histograms/AbstractHistogram.ts:46

---

minusSign

• Protected minusSign: number = 1

Defined in

src/histograms/AbstractHistogram.ts:74

---

noDatabarsContext

• Protected noDatabarsContext: any

Defined in

src/histograms/AbstractHistogram.ts:39

---

plottingCount

• Protected plottingCount: number = 0

Defined in

src/histograms/AbstractHistogram.ts:73

---

selectedBars

• Protected selectedBars: Set<number>

Defined in

src/histograms/AbstractHistogram.ts:61

---

selectionBrush

• Protected selectionBrush: BrushBehavior<any>

Brush selection

Defined in

src/histograms/AbstractHistogram.ts:54

---

selectionInterval

• Protected selectionInterval: SelectedOutputValues

Defined in

src/histograms/AbstractHistogram.ts:55

---

tooltipCursorContext

• Protected tooltipCursorContext: any

Defined in

src/histograms/AbstractHistogram.ts:41

---

xAxis

• Protected xAxis: any

Defined in

src/histograms/AbstractHistogram.ts:67

---

xLabelsAxis

• Protected xLabelsAxis: any

Defined in

src/histograms/AbstractHistogram.ts:66

---

xTicksAxis

• Protected xTicksAxis: any

Axes && ticks

Defined in

src/histograms/AbstractHistogram.ts:65

---

yDimension

• Protected yDimension: number = 1

Defined in

src/histograms/AbstractHistogram.ts:72

Methods

clearTooltipCursor

▸ Protected clearTooltipCursor(): void

Removes the indicator behind the hovered bucket of the histogram

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:218

---

drawChartAxes

▸ Protected drawChartAxes(chartAxes, leftOffset): void

Parameters

Name	Type
chartAxes	ChartAxes | SwimlaneAxes
leftOffset	number

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:220

---

getAxes

▸ Protected Abstract getAxes(): ChartAxes | SwimlaneAxes

Returns

ChartAxes | SwimlaneAxes

Defined in

src/histograms/AbstractHistogram.ts:386

---

getDataInterval

▸ Protected Abstract getDataInterval(data): number

Parameters

Name	Type
data	HistogramData[] | Map<string, HistogramData[]>

Returns

number

Defined in

src/histograms/AbstractHistogram.ts:385

---

getFollowingLastBucket

▸ Protected getFollowingLastBucket(data): HistogramData

Parameters

Name	Type
data	any

Returns

HistogramData

Defined in

src/histograms/AbstractHistogram.ts:164

---

getHistogramDataInterval

▸ Protected getHistogramDataInterval(data): number

Parameters

Name	Type
data	HistogramData[]

Returns

number

Defined in

src/histograms/AbstractHistogram.ts:358

---

getHistogramMinMaxBorders

▸ Protected getHistogramMinMaxBorders(data): [number | Date, number | Date]

Parameters

Name	Type
data	HistogramData[]

Returns

[number | Date, number | Date]

Defined in

src/histograms/AbstractHistogram.ts:157

---

getXDomainExtent

▸ Protected getXDomainExtent(data, selectedStartValue, selectedEndValue): (number | Date | { valueOf: () => number })[]

Parameters

Name	Type
data	HistogramData[]
selectedStartValue	number | Date
selectedEndValue	number | Date

Returns

(number | Date | { valueOf: () => number })[]

Defined in

src/histograms/AbstractHistogram.ts:183

---

getXDomainScale

▸ Protected getXDomainScale(): any

Returns

any

Defined in

src/histograms/AbstractHistogram.ts:151

---

init

▸ init(): void

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:82

---

initializeChartDimensions

▸ Protected initializeChartDimensions(): void

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:134

---

initializeChartHeight

▸ Protected initializeChartHeight(): void

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:143

---

initializeDescriptionValues

▸ Protected initializeDescriptionValues(start, end, dataInterval): void

Parameters

Name	Type
start	number | Date
end	number | Date
dataInterval	number

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:125

---

isValueValid

▸ Protected isValueValid(bucket): boolean

Parameters

Name	Type
bucket	HistogramData

Returns

boolean

Defined in

src/histograms/AbstractHistogram.ts:285

---

plot

▸ plot(data): void

Parameters

Name	Type
data	HistogramData[] | SwimlaneData

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:80

---

plotBars

▸ Protected plotBars(data, axes, xDataDomain, barWeight?): void

Parameters

Name	Type
data	HistogramData[]
axes	ChartAxes | SwimlaneAxes
xDataDomain	any
barWeight?	number

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:270

---

resize

▸ Abstract resize(histogramContainer): void

Parameters

Name	Type
histogramContainer	HTMLElement

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:91

---

setBrushCornerTooltipsPositions

▸ Protected setBrushCornerTooltipsPositions(): void

This method is called whenever the brush is being moved. It sets the positions the brush's left and right corner tooltips.

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:292

---

setBrushHorizontalTooltipsXPositions

▸ Protected setBrushHorizontalTooltipsXPositions(leftPosition, rightPosition): void

Parameters

Name	Type
leftPosition	number
rightPosition	number

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:344

---

setBrushHorizontalTooltipsYPositions

▸ Protected setBrushHorizontalTooltipsYPositions(): void

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:349

---

setBrushVerticalTooltipsXPositions

▸ Protected setBrushVerticalTooltipsXPositions(leftPosition, rightPosition): void

Parameters

Name	Type
leftPosition	number
rightPosition	number

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:330

---

setBrushVerticalTooltipsYPositions

▸ Protected setBrushVerticalTooltipsYPositions(): void

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:335

---

setDataInterval

▸ Protected Abstract setDataInterval(data): void

Parameters

Name	Type
data	HistogramData[] | Map<string, HistogramData[]>

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:384

---

setHTMLElementsOfBrushCornerTooltips

▸ setHTMLElementsOfBrushCornerTooltips(rightHTMLElement, leftHTMLElement): void

initialize a new BrushCornerTooltips object

Parameters

Name	Type
rightHTMLElement	HTMLElement
leftHTMLElement	any

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:96

---

setHistogramMargins

▸ Protected setHistogramMargins(): void

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:104

---

setVerticalTooltipsWidth

▸ Protected setVerticalTooltipsWidth(): void

Returns

void

Defined in

src/histograms/AbstractHistogram.ts:326