arlas-d3 / Exports / ChartBars

Class: ChartBars

Hierarchy

↳ ChartBars

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new ChartBars()

Inherited from

AbstractChart.constructor

Defined in

src/histograms/AbstractHistogram.ts:68

Properties

NO_DATA_STRIPES_PATTERN

• Protected NO_DATA_STRIPES_PATTERN: string = 'M-1,1 l2,-2 M0,10 l10,-10 M9,11 l2,-2'

Inherited from

AbstractChart.NO_DATA_STRIPES_PATTERN

Defined in

src/histograms/charts/AbstractChart.ts:59

NO_DATA_STRIPES_SIZE

• Protected NO_DATA_STRIPES_SIZE: number = 10

Inherited from

AbstractChart.NO_DATA_STRIPES_SIZE

Defined in

src/histograms/charts/AbstractChart.ts:60

START_Y_FROM_MIN_STRIPES_PATTERN

• Protected START_Y_FROM_MIN_STRIPES_PATTERN: string = 'M-1,1 l2,-2 M0,4 l4,-4 M3,5 l2,-2'

Inherited from

AbstractChart.START_Y_FROM_MIN_STRIPES_PATTERN

Defined in

src/histograms/charts/AbstractChart.ts:57

START_Y_FROM_MIN_STRIPES_SIZE

• Protected START_Y_FROM_MIN_STRIPES_SIZE: number = 4

Inherited from

AbstractChart.START_Y_FROM_MIN_STRIPES_SIZE

Defined in

src/histograms/charts/AbstractChart.ts:58

allAxesContext

• Protected allAxesContext: HistogramSVGG

Inherited from

AbstractChart.allAxesContext

Defined in

src/histograms/AbstractHistogram.ts:38

barsContext

• Protected barsContext: HistogramSVGG

Inherited from

AbstractChart.barsContext

Defined in

src/histograms/AbstractHistogram.ts:35

brush

• brush: Brush

Inherited from

AbstractChart.brush

Defined in

src/histograms/charts/AbstractChart.ts:63

brushCornerTooltips

• brushCornerTooltips: BrushCornerTooltips

Inherited from

AbstractChart.brushCornerTooltips

Defined in

src/histograms/AbstractHistogram.ts:31

chartAxes

• Protected chartAxes: ChartAxes

Inherited from

AbstractChart.chartAxes

Defined in

src/histograms/charts/AbstractChart.ts:55

chartDimensions

• Protected chartDimensions: ChartDimensions

Chart dimensions

Inherited from

AbstractChart.chartDimensions

Defined in

src/histograms/AbstractHistogram.ts:41

clipPathContext

• Protected clipPathContext: HistogramSVGClipPath

Inherited from

AbstractChart.clipPathContext

Defined in

src/histograms/charts/AbstractChart.ts:64

context

• Protected context: HistogramSVGG

Contexts

Inherited from

AbstractChart.context

Defined in

src/histograms/AbstractHistogram.ts:34

currentClipPathContext

• Protected currentClipPathContext: HistogramSVGClipPath

Inherited from

AbstractChart.currentClipPathContext

Defined in

src/histograms/charts/AbstractChart.ts:65

dataDomain

• Protected dataDomain: HistogramData[]

Data

Inherited from

AbstractChart.dataDomain

Defined in

src/histograms/AbstractHistogram.ts:46

dataInterval

• Protected dataInterval: number

Inherited from

AbstractChart.dataInterval

Defined in

src/histograms/AbstractHistogram.ts:47

fromSetInterval

• Protected fromSetInterval: boolean = false

Inherited from

AbstractChart.fromSetInterval

Defined in

src/histograms/AbstractHistogram.ts:54

hasSelectionExceededData

• Protected hasSelectionExceededData: any = null

Inherited from

AbstractChart.hasSelectionExceededData

Defined in

src/histograms/AbstractHistogram.ts:52

histogramParams

• histogramParams: HistogramParams

Inherited from

AbstractChart.histogramParams

Defined in

src/histograms/AbstractHistogram.ts:30

hoveredBucketKey

• Protected hoveredBucketKey: number | Date

Inherited from

AbstractChart.hoveredBucketKey

Defined in

src/histograms/AbstractHistogram.ts:62

isHeightFixed

• Protected isHeightFixed: boolean = false

Inherited from

AbstractChart.isHeightFixed

Defined in

src/histograms/AbstractHistogram.ts:43

isWidthFixed

• Protected isWidthFixed: boolean = false

Inherited from

AbstractChart.isWidthFixed

Defined in

src/histograms/AbstractHistogram.ts:42

minusSign

• Protected minusSign: number = 1

Inherited from

AbstractChart.minusSign

Defined in

src/histograms/AbstractHistogram.ts:66

noDatabarsContext

• Protected noDatabarsContext: HistogramSVGG

Inherited from

AbstractChart.noDatabarsContext

Defined in

src/histograms/AbstractHistogram.ts:36

plottingCount

• Protected plottingCount: number = 0

Inherited from

AbstractChart.plottingCount

Defined in

src/histograms/AbstractHistogram.ts:65

rectangleCurrentClipper

• Protected rectangleCurrentClipper: HistogramSVGRect

Inherited from

AbstractChart.rectangleCurrentClipper

Defined in

src/histograms/charts/AbstractChart.ts:66

selectedBars

• Protected selectedBars: Set<number>

Inherited from

AbstractChart.selectedBars

Defined in

src/histograms/AbstractHistogram.ts:53

selectedIntervals

• Protected selectedIntervals: Map<string, { rect: HistogramSVGRect ; startEndValues: SelectedOutputValues }>

Inherited from

AbstractChart.selectedIntervals

Defined in

src/histograms/charts/AbstractChart.ts:67

selectionInterval

• Protected selectionInterval: SelectedOutputValues

Brush selection

Inherited from

AbstractChart.selectionInterval

Defined in

src/histograms/AbstractHistogram.ts:50

tooltipCursorContext

• Protected tooltipCursorContext: HistogramSVGG

Inherited from

AbstractChart.tooltipCursorContext

Defined in

src/histograms/AbstractHistogram.ts:37

xAxis

• Protected xAxis: any

Inherited from

AbstractChart.xAxis

Defined in

src/histograms/AbstractHistogram.ts:59

xLabelsAxis

• Protected xLabelsAxis: any

Inherited from

AbstractChart.xLabelsAxis

Defined in

src/histograms/AbstractHistogram.ts:58

xTicksAxis

• Protected xTicksAxis: any

Axes && ticks

Inherited from

AbstractChart.xTicksAxis

Defined in

src/histograms/AbstractHistogram.ts:57

yDimension

• Protected yDimension: number = 1

Inherited from

AbstractChart.yDimension

Defined in

src/histograms/AbstractHistogram.ts:64

yStartsFromMin

• Protected yStartsFromMin: boolean = false

Inherited from

AbstractChart.yStartsFromMin

Defined in

src/histograms/charts/AbstractChart.ts:56

Methods

addSelectionBrush

▸ Protected addSelectionBrush(selectionType, chartAxes, leftOffset): void

Parameters

Name Type
selectionType SelectionType
chartAxes ChartAxes
leftOffset number

Returns

void

Overrides

AbstractChart.addSelectionBrush

Defined in

src/histograms/charts/ChartBars.ts:193

addStrippedPattern

▸ Protected addStrippedPattern(id, pattern, size, cssClass): void

Parameters

Name Type
id string
pattern string
size number
cssClass string

Returns

void

Inherited from

AbstractChart.addStrippedPattern

Defined in

src/histograms/charts/AbstractChart.ts:643

applyFormatOnXticks

▸ Protected applyFormatOnXticks(data): void

Parameters

Name Type
data HistogramData[]

Returns

void

Inherited from

AbstractChart.applyFormatOnXticks

Defined in

src/histograms/charts/AbstractChart.ts:655

applyStyleOnClipper

▸ Protected applyStyleOnClipper(): void

Returns

void

Inherited from

AbstractChart.applyStyleOnClipper

Defined in

src/histograms/charts/AbstractChart.ts:836

applyStyleOnHeadBand

▸ Protected applyStyleOnHeadBand(headBandContext): void

Parameters

Name Type
headBandContext HistogramSVGG

Returns

void

Defined in

src/histograms/charts/ChartBars.ts:237

applyStyleOnSelectedBars

▸ Protected applyStyleOnSelectedBars(barsContext): void

Parameters

Name Type
barsContext HistogramSVGG

Returns

void

Inherited from

AbstractChart.applyStyleOnSelectedBars

Defined in

src/histograms/charts/AbstractChart.ts:769

applyStyleOnSelection

▸ Protected applyStyleOnSelection(): void

Returns

void

Overrides

AbstractChart.applyStyleOnSelection

Defined in

src/histograms/charts/ChartBars.ts:201

applyStyleOnStrippedSelectedBars

▸ Protected applyStyleOnStrippedSelectedBars(barsContext): void

Parameters

Name Type
barsContext HistogramSVGG

Returns

void

Defined in

src/histograms/charts/ChartBars.ts:309

checkDomainInitialized

▸ Protected checkDomainInitialized(): boolean

Returns

boolean

Inherited from

AbstractChart.checkDomainInitialized

Defined in

src/histograms/charts/AbstractChart.ts:984

clearTooltipCursor

▸ Protected clearTooltipCursor(): void

For bars charts, removes the rectangle behind the hovered bucket of the histogram

Returns

void

Overrides

AbstractChart.clearTooltipCursor

Defined in

src/histograms/charts/ChartBars.ts:233

createChartAxes

▸ Protected createChartAxes(data): void

Parameters

Name Type
data HistogramData[]

Returns

void

Overrides

AbstractChart.createChartAxes

Defined in

src/histograms/charts/ChartBars.ts:173

createChartXAxes

▸ Protected createChartXAxes(data): void

Parameters

Name Type
data HistogramData[]

Returns

void

Inherited from

AbstractChart.createChartXAxes

Defined in

src/histograms/charts/AbstractChart.ts:383

customizeData

▸ Protected customizeData(data): void

Parameters

Name Type
data HistogramData[]

Returns

void

Inherited from

AbstractChart.customizeData

Defined in

src/histograms/charts/AbstractChart.ts:365

drawChartAxes

▸ Protected drawChartAxes(chartAxes, leftOffset): void

Parameters

Name Type
chartAxes ChartAxes
leftOffset number

Returns

void

Overrides

AbstractChart.drawChartAxes

Defined in

src/histograms/charts/ChartBars.ts:188

drawTooltipCursor

▸ Protected drawTooltipCursor(data, axes): void

Draws a indicator behind the hovered bucket of the histogram. This has as objective to highlight it on the histogram For bars charts, a grey rectangle is drawn behind the bucket

Parameters

Name Type
data HistogramData[]
axes ChartAxes

Returns

void

Overrides

AbstractChart.drawTooltipCursor

Defined in

src/histograms/charts/ChartBars.ts:217

drawYAxis

▸ Protected drawYAxis(chartAxes, chartIdsToSide?, chartId?): void

Parameters

Name Type
chartAxes ChartAxes
chartIdsToSide? Map<string, "left" | "right">
chartId? string

Returns

void

Inherited from

AbstractChart.drawYAxis

Defined in

src/histograms/charts/AbstractChart.ts:470

extendData

▸ Protected extendData(data): HistogramData[]

When the selection is wider than the range of the data, adds "fake" buckets, for the x axis to be fully drawn

Parameters

Name Type Description
data HistogramData[] Data to plot

Returns

HistogramData[]

Extended data to fit the selection

Inherited from

AbstractChart.extendData

Defined in

src/histograms/charts/AbstractChart.ts:859

getAppendedRectangle

▸ Protected getAppendedRectangle(start, end): HistogramSVGRect

Parameters

Name Type
start number | Date
end number | Date

Returns

HistogramSVGRect

Inherited from

AbstractChart.getAppendedRectangle

Defined in

src/histograms/charts/AbstractChart.ts:827

getAxes

▸ Protected getAxes(): ChartAxes

Returns

ChartAxes

Overrides

AbstractChart.getAxes

Defined in

src/histograms/charts/ChartBars.ts:353

getDataInterval

▸ Protected getDataInterval(data): number

Parameters

Name Type
data HistogramData[]

Returns

number

Inherited from

AbstractChart.getDataInterval

Defined in

src/histograms/charts/AbstractChart.ts:667

getEndPosition

▸ Protected getEndPosition(data, index): number

Parameters

Name Type
data HistogramData[]
index number

Returns

number

Overrides

AbstractChart.getEndPosition

Defined in

src/histograms/charts/ChartBars.ts:331

getFollowingLastBucket

▸ Protected getFollowingLastBucket(data): HistogramData

Parameters

Name Type
data any

Returns

HistogramData

Inherited from

AbstractChart.getFollowingLastBucket

Defined in

src/histograms/AbstractHistogram.ts:160

getHistogramDataInterval

▸ Protected getHistogramDataInterval(data): number

Parameters

Name Type
data HistogramData[]

Returns

number

Inherited from

AbstractChart.getHistogramDataInterval

Defined in

src/histograms/AbstractHistogram.ts:285

getHistogramMinMaxBorders

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

Parameters

Name Type
data HistogramData[]

Returns

[number | Date, number | Date]

Inherited from

AbstractChart.getHistogramMinMaxBorders

Defined in

src/histograms/AbstractHistogram.ts:153

getIntervalMiddlePositon

▸ Protected getIntervalMiddlePositon(chartAxes, startvalue, endvalue): number

Parameters

Name Type
chartAxes ChartAxes
startvalue number
endvalue number

Returns

number

Inherited from

AbstractChart.getIntervalMiddlePositon

Defined in

src/histograms/charts/AbstractChart.ts:623

getSelectedBars

▸ Protected getSelectedBars(startvalue, endvalue): number[]

Parameters

Name Type
startvalue number
endvalue number

Returns

number[]

Inherited from

AbstractChart.getSelectedBars

Defined in

src/histograms/charts/AbstractChart.ts:629

getStartPosition

▸ Protected getStartPosition(data, index): number

Parameters

Name Type
data HistogramData[]
index number

Returns

number

Overrides

AbstractChart.getStartPosition

Defined in

src/histograms/charts/ChartBars.ts:327

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 })[]

Inherited from

AbstractChart.getXDomainExtent

Defined in

src/histograms/AbstractHistogram.ts:179

getXDomainScale

▸ Protected getXDomainScale(rangeStart, rangeEnd): ScaleTime<number, number, never> | ScaleLinear<number, number, never>

Create the link between the scale of the chart and the width available

Parameters

Name Type
rangeStart number
rangeEnd number

Returns

ScaleTime<number, number, never> | ScaleLinear<number, number, never>

Inherited from

AbstractChart.getXDomainScale

Defined in

src/histograms/AbstractHistogram.ts:146

getbucketInterval

▸ Protected getbucketInterval(bucketInterval, dataType): Object

Parameters

Name Type
bucketInterval number
dataType DataType

Returns

Object

Name Type
unit? string
value number

Inherited from

AbstractChart.getbucketInterval

Defined in

src/histograms/charts/AbstractChart.ts:671

init

▸ init(): void

Returns

void

Inherited from

AbstractChart.init

Defined in

src/histograms/AbstractHistogram.ts:74

initializeChartDimensions

▸ Protected initializeChartDimensions(): void

Returns

void

Inherited from

AbstractChart.initializeChartDimensions

Defined in

src/histograms/charts/AbstractChart.ts:367

initializeChartHeight

▸ Protected initializeChartHeight(): void

Returns

void

Inherited from

AbstractChart.initializeChartHeight

Defined in

src/histograms/AbstractHistogram.ts:135

initializeDescriptionValues

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

Parameters

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

Returns

void

Inherited from

AbstractChart.initializeDescriptionValues

Defined in

src/histograms/AbstractHistogram.ts:117

isValueValid

▸ Protected isValueValid(bucket): boolean

Parameters

Name Type
bucket HistogramData

Returns

boolean

Inherited from

AbstractChart.isValueValid

Defined in

src/histograms/AbstractHistogram.ts:281

moveDataByHalfInterval

▸ Protected moveDataByHalfInterval(data): HistogramData[]

Parameters

Name Type
data HistogramData[]

Returns

HistogramData[]

Inherited from

AbstractChart.moveDataByHalfInterval

Defined in

src/histograms/charts/AbstractChart.ts:361

onSelectionDoubleClick

▸ Protected onSelectionDoubleClick(axes): void

Parameters

Name Type
axes ChartAxes

Returns

void

Inherited from

AbstractChart.onSelectionDoubleClick

Defined in

src/histograms/charts/AbstractChart.ts:299

plot

▸ plot(inputData): void

Parameters

Name Type
inputData HistogramData[]

Returns

void

Overrides

AbstractChart.plot

Defined in

src/histograms/charts/ChartBars.ts:35

plotBackground

▸ Protected plotBackground(): void

Plots 3 rectangles behind data bars and selection brush. This rectangles are clippable in order to make a specific style for - non selected parts of the chart - current selected part - already selected parts

Returns

void

Defined in

src/histograms/charts/ChartBars.ts:74

plotBars

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

Parameters

Name Type
data HistogramData[]
axes ChartAxes | SwimlaneAxes
xDataDomain ScaleBand<string>
barWeight? number

Returns

void

Inherited from

AbstractChart.plotBars

Defined in

src/histograms/AbstractHistogram.ts:266

plotChart

▸ Protected plotChart(data): void

Parameters

Name Type
data HistogramData[]

Returns

void

Overrides

AbstractChart.plotChart

Defined in

src/histograms/charts/ChartBars.ts:105

plotHeadBand

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

Plots headbands on the top of each bar. A headband is small rectangle (that forms a band) on top of each bar. Those headbands are added for styling purposes

Parameters

Name Type
data HistogramData[]
axes ChartAxes
xDataDomain ScaleBand<string>
barWeight? number

Returns

void

Defined in

src/histograms/charts/ChartBars.ts:49

redrawSelectedIntervals

▸ redrawSelectedIntervals(): void

Returns

void

Inherited from

AbstractChart.redrawSelectedIntervals

Defined in

src/histograms/charts/AbstractChart.ts:249

removeSelectInterval

▸ removeSelectInterval(id): void

Parameters

Name Type
id string

Returns

void

Inherited from

AbstractChart.removeSelectInterval

Defined in

src/histograms/charts/AbstractChart.ts:212

resize

▸ resize(histogramContainer): void

Parameters

Name Type
histogramContainer HTMLElement

Returns

void

Overrides

AbstractChart.resize

Defined in

src/histograms/charts/ChartBars.ts:39

resizeSelectedIntervals

▸ Protected resizeSelectedIntervals(chartAxes): void

Parameters

Name Type
chartAxes ChartAxes

Returns

void

Inherited from

AbstractChart.resizeSelectedIntervals

Defined in

src/histograms/charts/AbstractChart.ts:346

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

Inherited from

AbstractChart.setBrushCornerTooltipsPositions

Defined in

src/histograms/charts/AbstractChart.ts:105

setBrushHorizontalTooltipsXPositions

▸ Protected setBrushHorizontalTooltipsXPositions(leftPosition, rightPosition): void

Parameters

Name Type
leftPosition number
rightPosition number

Returns

void

Inherited from

AbstractChart.setBrushHorizontalTooltipsXPositions

Defined in

src/histograms/charts/AbstractChart.ts:159

setBrushHorizontalTooltipsYPositions

▸ Protected setBrushHorizontalTooltipsYPositions(): void

Returns

void

Inherited from

AbstractChart.setBrushHorizontalTooltipsYPositions

Defined in

src/histograms/charts/AbstractChart.ts:164

setBrushVerticalTooltipsXPositions

▸ Protected setBrushVerticalTooltipsXPositions(leftPosition, rightPosition): void

Parameters

Name Type
leftPosition number
rightPosition number

Returns

void

Inherited from

AbstractChart.setBrushVerticalTooltipsXPositions

Defined in

src/histograms/charts/AbstractChart.ts:143

setBrushVerticalTooltipsYPositions

▸ Protected setBrushVerticalTooltipsYPositions(): void

Returns

void

Inherited from

AbstractChart.setBrushVerticalTooltipsYPositions

Defined in

src/histograms/charts/AbstractChart.ts:150

setDataInterval

▸ Protected setDataInterval(data): void

Parameters

Name Type
data HistogramData[]

Returns

void

Inherited from

AbstractChart.setDataInterval

Defined in

src/histograms/charts/AbstractChart.ts:663

setHTMLElementsOfBrushCornerTooltips

▸ setHTMLElementsOfBrushCornerTooltips(rightHTMLElement, leftHTMLElement): void

initialize a new BrushCornerTooltips object

Parameters

Name Type
rightHTMLElement HTMLElement
leftHTMLElement any

Returns

void

Inherited from

AbstractChart.setHTMLElementsOfBrushCornerTooltips

Defined in

src/histograms/AbstractHistogram.ts:88

setHistogramMargins

▸ Protected setHistogramMargins(): void

Returns

void

Inherited from

AbstractChart.setHistogramMargins

Defined in

src/histograms/AbstractHistogram.ts:96

setSelectedInterval

▸ setSelectedInterval(selectedInputValues): void

Parameters

Name Type
selectedInputValues SelectedInputValues

Returns

void

Inherited from

AbstractChart.setSelectedInterval

Defined in

src/histograms/charts/AbstractChart.ts:173

setTooltipPositions

▸ Protected setTooltipPositions(data, event, chartIsToSides?): void

Parameters

Name Type
data HistogramData[]
event MouseEvent
chartIsToSides? Map<string, string>

Returns

void

Inherited from

AbstractChart.setTooltipPositions

Defined in

src/histograms/charts/AbstractChart.ts:563

setTooltipXposition

▸ Protected setTooltipXposition(xPosition): number

Parameters

Name Type
xPosition number

Returns

number

Overrides

AbstractChart.setTooltipXposition

Defined in

src/histograms/charts/ChartBars.ts:335

setTooltipYposition

▸ Protected setTooltipYposition(yPosition): number

Parameters

Name Type
yPosition number

Returns

number

Overrides

AbstractChart.setTooltipYposition

Defined in

src/histograms/charts/ChartBars.ts:349

setVerticalTooltipsWidth

▸ Protected setVerticalTooltipsWidth(): void

Returns

void

Inherited from

AbstractChart.setVerticalTooltipsWidth

Defined in

src/histograms/charts/AbstractChart.ts:139

showTooltips

▸ Protected showTooltips(data, chartIsToSides?): void

Parameters

Name Type
data HistogramData[]
chartIsToSides? Map<string, string>

Returns

void

Inherited from

AbstractChart.showTooltips

Defined in

src/histograms/charts/AbstractChart.ts:539

updateSelectionStyle

▸ Protected updateSelectionStyle(id): void

Parameters

Name Type
id string

Returns

void

Inherited from

AbstractChart.updateSelectionStyle

Defined in

src/histograms/charts/AbstractChart.ts:288