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:76

Properties

aBucketIsEncountred

Protected aBucketIsEncountred: boolean = false

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:37


allAxesContext

Protected allAxesContext: any

Inherited from

AbstractHistogram.allAxesContext

Defined in

src/histograms/AbstractHistogram.ts:42


barsContext

Protected barsContext: any

Inherited from

AbstractHistogram.barsContext

Defined in

src/histograms/AbstractHistogram.ts:38


brushContext

Protected brushContext: any

Inherited from

AbstractHistogram.brushContext

Defined in

src/histograms/AbstractHistogram.ts:40


brushCornerTooltips

brushCornerTooltips: BrushCornerTooltips

Inherited from

AbstractHistogram.brushCornerTooltips

Defined in

src/histograms/AbstractHistogram.ts:32


brushHandles

Protected brushHandles: any

Inherited from

AbstractHistogram.brushHandles

Defined in

src/histograms/AbstractHistogram.ts:57


brushHandlesHeight

Protected brushHandlesHeight: number = null

Inherited from

AbstractHistogram.brushHandlesHeight

Defined in

src/histograms/AbstractHistogram.ts:56


chartDimensions

Protected chartDimensions: ChartDimensions

Chart dimensions

Inherited from

AbstractHistogram.chartDimensions

Defined in

src/histograms/AbstractHistogram.ts:45


context

Protected context: any

Contexts

Inherited from

AbstractHistogram.context

Defined in

src/histograms/AbstractHistogram.ts:37


dataDomain

Protected dataDomain: HistogramData[]

Data

Inherited from

AbstractHistogram.dataDomain

Defined in

src/histograms/AbstractHistogram.ts:50


dataInterval

Protected dataInterval: number

Inherited from

AbstractHistogram.dataInterval

Defined in

src/histograms/AbstractHistogram.ts:51


fromSetInterval

Protected fromSetInterval: boolean = false

Inherited from

AbstractHistogram.fromSetInterval

Defined in

src/histograms/AbstractHistogram.ts:62


hasSelectionExceededData

Protected hasSelectionExceededData: any = null

Inherited from

AbstractHistogram.hasSelectionExceededData

Defined in

src/histograms/AbstractHistogram.ts:60


histogramParams

histogramParams: HistogramParams

Inherited from

AbstractHistogram.histogramParams

Defined in

src/histograms/AbstractHistogram.ts:31


hoveredBucketKey

Protected hoveredBucketKey: number | Date

Inherited from

AbstractHistogram.hoveredBucketKey

Defined in

src/histograms/AbstractHistogram.ts:70


isBrushed

Protected isBrushed: boolean = false

Inherited from

AbstractHistogram.isBrushed

Defined in

src/histograms/AbstractHistogram.ts:58


isBrushing

isBrushing: boolean = false

Inherited from

AbstractHistogram.isBrushing

Defined in

src/histograms/AbstractHistogram.ts:34


isHeightFixed

Protected isHeightFixed: boolean = false

Inherited from

AbstractHistogram.isHeightFixed

Defined in

src/histograms/AbstractHistogram.ts:47


isSwimlaneHeightFixed

Protected isSwimlaneHeightFixed: boolean = false

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:32


isWidthFixed

Protected isWidthFixed: boolean = false

Inherited from

AbstractHistogram.isWidthFixed

Defined in

src/histograms/AbstractHistogram.ts:46


labelsContext

Protected labelsContext: any

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:36


labelsContextList

Protected labelsContextList: { context: any ; name: string }[]

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:39


labelsRectContextList

Protected labelsRectContextList: { context: any ; name: string }[]

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:40


minusSign

Protected minusSign: number = 1

Inherited from

AbstractHistogram.minusSign

Defined in

src/histograms/AbstractHistogram.ts:74


noDatabarsContext

Protected noDatabarsContext: any

Inherited from

AbstractHistogram.noDatabarsContext

Defined in

src/histograms/AbstractHistogram.ts:39


plottingCount

Protected plottingCount: number = 0

Inherited from

AbstractHistogram.plottingCount

Defined in

src/histograms/AbstractHistogram.ts:73


selectedBars

Protected selectedBars: Set<number>

Inherited from

AbstractHistogram.selectedBars

Defined in

src/histograms/AbstractHistogram.ts:61


selectionBrush

Protected selectionBrush: BrushBehavior<any>

Brush selection

Inherited from

AbstractHistogram.selectionBrush

Defined in

src/histograms/AbstractHistogram.ts:54


selectionInterval

Protected selectionInterval: SelectedOutputValues

Inherited from

AbstractHistogram.selectionInterval

Defined in

src/histograms/AbstractHistogram.ts:55


swimlaneAxes

Protected swimlaneAxes: SwimlaneAxes

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:30


swimlaneBarsWeight

Protected swimlaneBarsWeight: any

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:38


swimlaneContextList

Protected swimlaneContextList: { context: any ; name: string }[]

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:34


swimlaneHasMoreThanTwoBuckets

Protected swimlaneHasMoreThanTwoBuckets: boolean = false

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:33


swimlaneIntervalBorders

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

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:31


tooltipCursorContext

Protected tooltipCursorContext: any

Inherited from

AbstractHistogram.tooltipCursorContext

Defined in

src/histograms/AbstractHistogram.ts:41


verticalTooltipLine

Protected verticalTooltipLine: any

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:35


xAxis

Protected xAxis: any

Inherited from

AbstractHistogram.xAxis

Defined in

src/histograms/AbstractHistogram.ts:67


xLabelsAxis

Protected xLabelsAxis: any

Inherited from

AbstractHistogram.xLabelsAxis

Defined in

src/histograms/AbstractHistogram.ts:66


xTicksAxis

Protected xTicksAxis: any

Axes && ticks

Inherited from

AbstractHistogram.xTicksAxis

Defined in

src/histograms/AbstractHistogram.ts:65


yDimension

Protected yDimension: number = 1

Inherited from

AbstractHistogram.yDimension

Defined in

src/histograms/AbstractHistogram.ts:72

Methods

addLabels

Protected addLabels(swimlanesMapData): void

Parameters

Name Type
swimlanesMapData Map<string, HistogramData[]>

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:451


applyHoverStyleOnSwimlaneLabels

Protected applyHoverStyleOnSwimlaneLabels(labelRectContext): void

Parameters

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

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:178


applyStyleOnSwimlanes

applyStyleOnSwimlanes(): void

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:153


buildLegend

buildLegend(stats): void

Parameters

Name Type
stats SwimlaneStats

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:67


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:218


createSwimlaneAxes

Protected createSwimlaneAxes(data): void

Parameters

Name Type
data Map<string, HistogramData[]>

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:236


drawChartAxes

Protected drawChartAxes(swimlaneAxes): void

Parameters

Name Type
swimlaneAxes SwimlaneAxes

Returns

void

Overrides

AbstractHistogram.drawChartAxes

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:297


drawLineSeparators

Protected drawLineSeparators(): void

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:303


getAxes

Protected getAxes(): SwimlaneAxes

Returns

SwimlaneAxes

Overrides

AbstractHistogram.getAxes

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:579


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:419


getDataInterval

Protected getDataInterval(swimlaneData): number

Parameters

Name Type
swimlaneData Map<string, HistogramData[]>

Returns

number

Overrides

AbstractHistogram.getDataInterval

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:500


getFollowingLastBucket

Protected getFollowingLastBucket(data): HistogramData

Parameters

Name Type
data any

Returns

HistogramData

Inherited from

AbstractHistogram.getFollowingLastBucket

Defined in

src/histograms/AbstractHistogram.ts:164


getHistogramDataInterval

Protected getHistogramDataInterval(data): number

Parameters

Name Type
data HistogramData[]

Returns

number

Inherited from

AbstractHistogram.getHistogramDataInterval

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]

Overrides

AbstractHistogram.getHistogramMinMaxBorders

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:575


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:183


getXDomainScale

Protected getXDomainScale(): any

Returns

any

Inherited from

AbstractHistogram.getXDomainScale

Defined in

src/histograms/AbstractHistogram.ts:151


init

init(): void

Returns

void

Inherited from

AbstractHistogram.init

Defined in

src/histograms/AbstractHistogram.ts:82


initializeChartDimensions

Protected initializeChartDimensions(): void

Returns

void

Overrides

AbstractHistogram.initializeChartDimensions

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:206


initializeChartHeight

Protected initializeChartHeight(): void

Returns

void

Inherited from

AbstractHistogram.initializeChartHeight

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

Inherited from

AbstractHistogram.initializeDescriptionValues

Defined in

src/histograms/AbstractHistogram.ts:125


isValueValid

Protected isValueValid(bucket): boolean

Parameters

Name Type
bucket HistogramData

Returns

boolean

Inherited from

AbstractHistogram.isValueValid

Defined in

src/histograms/AbstractHistogram.ts:285


plot

plot(inputData): void

Parameters

Name Type
inputData SwimlaneData

Returns

void

Overrides

AbstractHistogram.plot

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:42


plotBars

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

Parameters

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

Returns

void

Inherited from

AbstractHistogram.plotBars

Defined in

src/histograms/AbstractHistogram.ts:270


plotOneLane

Protected Abstract plotOneLane(data, indexOfLane): void

Parameters

Name Type
data HistogramData[]
indexOfLane number

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:583


plotSwimlane

Protected plotSwimlane(data): void

Parameters

Name Type
data Map<string, HistogramData[]>

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:190


resize

resize(histogramContainer): void

Parameters

Name Type
histogramContainer HTMLElement

Returns

void

Overrides

AbstractHistogram.resize

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:114


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

AbstractHistogram.setBrushCornerTooltipsPositions

Defined in

src/histograms/AbstractHistogram.ts:292


setBrushHorizontalTooltipsXPositions

Protected setBrushHorizontalTooltipsXPositions(leftPosition, rightPosition): void

Parameters

Name Type
leftPosition number
rightPosition number

Returns

void

Inherited from

AbstractHistogram.setBrushHorizontalTooltipsXPositions

Defined in

src/histograms/AbstractHistogram.ts:344


setBrushHorizontalTooltipsYPositions

Protected setBrushHorizontalTooltipsYPositions(): void

Returns

void

Inherited from

AbstractHistogram.setBrushHorizontalTooltipsYPositions

Defined in

src/histograms/AbstractHistogram.ts:349


setBrushVerticalTooltipsXPositions

Protected setBrushVerticalTooltipsXPositions(leftPosition, rightPosition): void

Parameters

Name Type
leftPosition number
rightPosition number

Returns

void

Inherited from

AbstractHistogram.setBrushVerticalTooltipsXPositions

Defined in

src/histograms/AbstractHistogram.ts:330


setBrushVerticalTooltipsYPositions

Protected setBrushVerticalTooltipsYPositions(): void

Returns

void

Inherited from

AbstractHistogram.setBrushVerticalTooltipsYPositions

Defined in

src/histograms/AbstractHistogram.ts:335


setDataInterval

Protected setDataInterval(swimlaneData): void

Parameters

Name Type
swimlaneData Map<string, HistogramData[]>

Returns

void

Overrides

AbstractHistogram.setDataInterval

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:497


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:96


setHistogramMargins

Protected setHistogramMargins(): void

Returns

void

Inherited from

AbstractHistogram.setHistogramMargins

Defined in

src/histograms/AbstractHistogram.ts:104


setSelectedSwimlanes

Protected setSelectedSwimlanes(labelContext): void

Parameters

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

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:542


setSwimlaneDataInterval

Protected setSwimlaneDataInterval(swimlaneData): void

Parameters

Name Type
swimlaneData Map<string, HistogramData[]>

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:493


setSwimlaneMinMaxBorders

Protected setSwimlaneMinMaxBorders(swimlaneStats): void

Parameters

Name Type
swimlaneStats SwimlaneStats

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:555


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:350


setTooltipXposition

Protected setTooltipXposition(xPosition, tooltip): number

Parameters

Name Type
xPosition number
tooltip Tooltip

Returns

number

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:394


setTooltipYposition

Protected setTooltipYposition(yPosition): number

Parameters

Name Type
yPosition number

Returns

number

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:406


setVerticalTooltipsWidth

Protected setVerticalTooltipsWidth(): void

Returns

void

Inherited from

AbstractHistogram.setVerticalTooltipsWidth

Defined in

src/histograms/AbstractHistogram.ts:326


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:312


truncateLabels

truncateLabels(): void

Returns

void

Defined in

src/histograms/swimlanes/AbstractSwimlane.ts:137