arlas-d3 / Exports / AbstractSwimlane

Class: AbstractSwimlane

Hierarchy

↳ AbstractSwimlane

↳↳ SwimlaneBars

↳↳ SwimlaneCircles

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new AbstractSwimlane()

Inherited from

AbstractHistogram.constructor

Defined in

src/histograms/AbstractHistogram.ts:68

Properties

aBucketIsEncountred

• Protected aBucketIsEncountred: boolean = false

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:39

allAxesContext

• Protected allAxesContext: HistogramSVGG

Inherited from

AbstractHistogram.allAxesContext

Defined in

src/histograms/AbstractHistogram.ts:38

barsContext

• Protected barsContext: HistogramSVGG

Inherited from

AbstractHistogram.barsContext

Defined in

src/histograms/AbstractHistogram.ts:35

brushCornerTooltips

• brushCornerTooltips: BrushCornerTooltips

Inherited from

AbstractHistogram.brushCornerTooltips

Defined in

src/histograms/AbstractHistogram.ts:31

chartDimensions

• Protected chartDimensions: ChartDimensions

Chart dimensions

Inherited from

AbstractHistogram.chartDimensions

Defined in

src/histograms/AbstractHistogram.ts:41

context

• Protected context: HistogramSVGG

Contexts

Inherited from

AbstractHistogram.context

Defined in

src/histograms/AbstractHistogram.ts:34

dataDomain

• Protected dataDomain: HistogramData[]

Data

Inherited from

AbstractHistogram.dataDomain

Defined in

src/histograms/AbstractHistogram.ts:46

dataInterval

• Protected dataInterval: number

Inherited from

AbstractHistogram.dataInterval

Defined in

src/histograms/AbstractHistogram.ts:47

fromSetInterval

• Protected fromSetInterval: boolean = false

Inherited from

AbstractHistogram.fromSetInterval

Defined in

src/histograms/AbstractHistogram.ts:54

hasSelectionExceededData

• Protected hasSelectionExceededData: any = null

Inherited from

AbstractHistogram.hasSelectionExceededData

Defined in

src/histograms/AbstractHistogram.ts:52

histogramParams

• histogramParams: HistogramParams

Inherited from

AbstractHistogram.histogramParams

Defined in

src/histograms/AbstractHistogram.ts:30

hoveredBucketKey

• Protected hoveredBucketKey: number | Date

Inherited from

AbstractHistogram.hoveredBucketKey

Defined in

src/histograms/AbstractHistogram.ts:62

isHeightFixed

• Protected isHeightFixed: boolean = false

Inherited from

AbstractHistogram.isHeightFixed

Defined in

src/histograms/AbstractHistogram.ts:43

isSwimlaneHeightFixed

• Protected isSwimlaneHeightFixed: boolean = false

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:34

isWidthFixed

• Protected isWidthFixed: boolean = false

Inherited from

AbstractHistogram.isWidthFixed

Defined in

src/histograms/AbstractHistogram.ts:42

labelsContext

• Protected labelsContext: HistogramSVGG

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:38

labelsContextList

• Protected labelsContextList: { context: Selection<SVGTextElement, HistogramData, BaseType, HistogramData> ; name: string }[]

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:41

labelsRectContextList

• Protected labelsRectContextList: { context: HistogramSVGRect ; name: string }[]

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:42

minusSign

• Protected minusSign: number = 1

Inherited from

AbstractHistogram.minusSign

Defined in

src/histograms/AbstractHistogram.ts:66

noDatabarsContext

• Protected noDatabarsContext: HistogramSVGG

Inherited from

AbstractHistogram.noDatabarsContext

Defined in

src/histograms/AbstractHistogram.ts:36

plottingCount

• Protected plottingCount: number = 0

Inherited from

AbstractHistogram.plottingCount

Defined in

src/histograms/AbstractHistogram.ts:65

selectedBars

• Protected selectedBars: Set<number>

Inherited from

AbstractHistogram.selectedBars

Defined in

src/histograms/AbstractHistogram.ts:53

selectionInterval

• Protected selectionInterval: SelectedOutputValues

Brush selection

Inherited from

AbstractHistogram.selectionInterval

Defined in

src/histograms/AbstractHistogram.ts:50

swimlaneAxes

• Protected swimlaneAxes: SwimlaneAxes

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:32

swimlaneBarsWeight

• Protected swimlaneBarsWeight: number

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:40

swimlaneContextList

• Protected swimlaneContextList: { context: HistogramSVGG ; name: string }[]

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:36

swimlaneHasMoreThanTwoBuckets

• Protected swimlaneHasMoreThanTwoBuckets: boolean = false

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:35

swimlaneIntervalBorders

• Protected swimlaneIntervalBorders: [number | Date, number | Date]

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:33

tooltipCursorContext

• Protected tooltipCursorContext: HistogramSVGG

Inherited from

AbstractHistogram.tooltipCursorContext

Defined in

src/histograms/AbstractHistogram.ts:37

verticalTooltipLine

• Protected verticalTooltipLine: Selection<SVGLineElement, HistogramData, BaseType, HistogramData>

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:37

xAxis

• Protected xAxis: any

Inherited from

AbstractHistogram.xAxis

Defined in

src/histograms/AbstractHistogram.ts:59

xLabelsAxis

• Protected xLabelsAxis: any

Inherited from

AbstractHistogram.xLabelsAxis

Defined in

src/histograms/AbstractHistogram.ts:58

xTicksAxis

• Protected xTicksAxis: any

Axes && ticks

Inherited from

AbstractHistogram.xTicksAxis

Defined in

src/histograms/AbstractHistogram.ts:57

yDimension

• Protected yDimension: number = 1

Inherited from

AbstractHistogram.yDimension

Defined in

src/histograms/AbstractHistogram.ts:64

Methods

addLabels

▸ Protected addLabels(swimlanesMapData): void

Parameters

Name Type
swimlanesMapData Map<string, HistogramData[]>

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:447

applyHoverStyleOnSwimlaneLabels

▸ Protected applyHoverStyleOnSwimlaneLabels(labelRectContext): void

Parameters

Name Type
labelRectContext Object
labelRectContext.context HistogramSVGRect
labelRectContext.name string

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:180

applyStyleOnSwimlanes

▸ applyStyleOnSwimlanes(): void

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:155

buildLegend

▸ buildLegend(stats): void

Parameters

Name Type
stats SwimlaneStats

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:69

clearTooltipCursor

▸ Protected clearTooltipCursor(): void

Removes the indicator behind the hovered bucket of the histogram

Returns

void

Inherited from

AbstractHistogram.clearTooltipCursor

Defined in

src/histograms/AbstractHistogram.ts:214

createSwimlaneAxes

▸ Protected createSwimlaneAxes(data): void

Parameters

Name Type
data Map<string, HistogramData[]>

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:238

drawChartAxes

▸ Protected drawChartAxes(swimlaneAxes): void

Parameters

Name Type
swimlaneAxes SwimlaneAxes

Returns

void

Overrides

AbstractHistogram.drawChartAxes

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:296

drawLineSeparators

▸ Protected drawLineSeparators(): void

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:302

getAxes

▸ Protected getAxes(): SwimlaneAxes

Returns

SwimlaneAxes

Overrides

AbstractHistogram.getAxes

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:575

getBucketColor

▸ Protected getBucketColor(bucket, swimOptions, swimStats, representation, colors): string

returns a color in hex form (#abcdef)

Parameters

Name Type Description
bucket HistogramData the bucket to be colorized
swimOptions SwimlaneOptions -
swimStats SwimlaneStats stats of the swimlane used to put bucket in the context of all the data
representation SwimlaneRepresentation what information to represent: - column: the bucket value is compared to other values of the same column (vertical lane) - global: the bucket value is compated to all data.
colors string | [number, number] Either a hex string color or a color name (in English) or a saturation interval.

Returns

string

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:415

getDataInterval

▸ Protected getDataInterval(swimlaneData): number

Parameters

Name Type
swimlaneData Map<string, HistogramData[]>

Returns

number

Overrides

AbstractHistogram.getDataInterval

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:496

getFollowingLastBucket

▸ Protected getFollowingLastBucket(data): HistogramData

Parameters

Name Type
data any

Returns

HistogramData

Inherited from

AbstractHistogram.getFollowingLastBucket

Defined in

src/histograms/AbstractHistogram.ts:160

getHistogramDataInterval

▸ Protected getHistogramDataInterval(data): number

Parameters

Name Type
data HistogramData[]

Returns

number

Inherited from

AbstractHistogram.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]

Overrides

AbstractHistogram.getHistogramMinMaxBorders

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:571

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

AbstractHistogram.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

AbstractHistogram.getXDomainScale

Defined in

src/histograms/AbstractHistogram.ts:146

init

▸ init(): void

Returns

void

Inherited from

AbstractHistogram.init

Defined in

src/histograms/AbstractHistogram.ts:74

initializeChartDimensions

▸ Protected initializeChartDimensions(): void

Returns

void

Overrides

AbstractHistogram.initializeChartDimensions

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:208

initializeChartHeight

▸ Protected initializeChartHeight(): void

Returns

void

Inherited from

AbstractHistogram.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

AbstractHistogram.initializeDescriptionValues

Defined in

src/histograms/AbstractHistogram.ts:117

isValueValid

▸ Protected isValueValid(bucket): boolean

Parameters

Name Type
bucket HistogramData

Returns

boolean

Inherited from

AbstractHistogram.isValueValid

Defined in

src/histograms/AbstractHistogram.ts:281

plot

▸ plot(inputData): void

Parameters

Name Type
inputData SwimlaneData

Returns

void

Overrides

AbstractHistogram.plot

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:44

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

AbstractHistogram.plotBars

Defined in

src/histograms/AbstractHistogram.ts:266

plotOneLane

▸ Protected Abstract plotOneLane(data, indexOfLane): void

Parameters

Name Type
data HistogramData[]
indexOfLane number

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:579

plotSwimlane

▸ Protected plotSwimlane(data): void

Parameters

Name Type
data Map<string, HistogramData[]>

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:192

resize

▸ resize(histogramContainer): void

Parameters

Name Type
histogramContainer HTMLElement

Returns

void

Overrides

AbstractHistogram.resize

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:116

setDataInterval

▸ Protected setDataInterval(swimlaneData): void

Parameters

Name Type
swimlaneData Map<string, HistogramData[]>

Returns

void

Overrides

AbstractHistogram.setDataInterval

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:493

setHTMLElementsOfBrushCornerTooltips

▸ setHTMLElementsOfBrushCornerTooltips(rightHTMLElement, leftHTMLElement): void

initialize a new BrushCornerTooltips object

Parameters

Name Type
rightHTMLElement HTMLElement
leftHTMLElement any

Returns

void

Inherited from

AbstractHistogram.setHTMLElementsOfBrushCornerTooltips

Defined in

src/histograms/AbstractHistogram.ts:88

setHistogramMargins

▸ Protected setHistogramMargins(): void

Returns

void

Inherited from

AbstractHistogram.setHistogramMargins

Defined in

src/histograms/AbstractHistogram.ts:96

setSelectedSwimlanes

▸ Protected setSelectedSwimlanes(labelContext): void

Parameters

Name Type
labelContext Object
labelContext.context HistogramSVGG
labelContext.name string

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:538

setSwimlaneDataInterval

▸ Protected setSwimlaneDataInterval(swimlaneData): void

Parameters

Name Type
swimlaneData Map<string, HistogramData[]>

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:489

setSwimlaneMinMaxBorders

▸ Protected setSwimlaneMinMaxBorders(swimlaneStats): void

Parameters

Name Type
swimlaneStats SwimlaneStats

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:551

setTooltipPositionForSwimlane

▸ Protected setTooltipPositionForSwimlane(event, data, key, indexOfKey, swimStats, representation, container): void

Parameters

Name Type
event any
data HistogramData[]
key string
indexOfKey number
swimStats SwimlaneStats
representation SwimlaneRepresentation
container ContainerElement

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:349

setTooltipXposition

▸ Protected setTooltipXposition(xPosition, tooltip): number

Parameters

Name Type
xPosition number
tooltip Tooltip

Returns

number

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:390

setTooltipYposition

▸ Protected setTooltipYposition(yPosition): number

Parameters

Name Type
yPosition number

Returns

number

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:402

showTooltipsForSwimlane

▸ Protected showTooltipsForSwimlane(swimlaneMapData, swimStats, representation): void

Parameters

Name Type
swimlaneMapData Map<string, HistogramData[]>
swimStats SwimlaneStats
representation SwimlaneRepresentation

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:311

truncateLabels

▸ truncateLabels(): void

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:139