arlas-d3 / Exports / SwimlaneCircles
Class: SwimlaneCircles
Hierarchy
↳ SwimlaneCircles
Table of contents
Constructors
Properties
- aBucketIsEncountred
- allAxesContext
- barsContext
- brushCornerTooltips
- chartDimensions
- context
- dataDomain
- dataInterval
- fromSetInterval
- hasSelectionExceededData
- histogramParams
- hoveredBucketKey
- isHeightFixed
- isSwimlaneHeightFixed
- isWidthFixed
- labelsContext
- labelsContextList
- labelsRectContextList
- minusSign
- noDatabarsContext
- plottingCount
- selectedBars
- selectionInterval
- swimlaneAxes
- swimlaneBarsWeight
- swimlaneContextList
- swimlaneHasMoreThanTwoBuckets
- swimlaneIntervalBorders
- tooltipCursorContext
- verticalTooltipLine
- xAxis
- xLabelsAxis
- xTicksAxis
- yDimension
Methods
- addLabels
- applyHoverStyleOnSwimlaneLabels
- applyStyleOnSwimlanes
- buildLegend
- clearTooltipCursor
- createSwimlaneAxes
- drawChartAxes
- drawLineSeparators
- getAxes
- getBucketColor
- getDataInterval
- getFollowingLastBucket
- getHistogramDataInterval
- getHistogramMinMaxBorders
- getXDomainExtent
- getXDomainScale
- init
- initializeChartDimensions
- initializeChartHeight
- initializeDescriptionValues
- isValueValid
- plot
- plotBars
- plotOneLane
- plotSwimlane
- resize
- setDataInterval
- setHTMLElementsOfBrushCornerTooltips
- setHistogramMargins
- setSelectedSwimlanes
- setSwimlaneDataInterval
- setSwimlaneMinMaxBorders
- setTooltipPositionForSwimlane
- setTooltipXposition
- setTooltipYposition
- showTooltipsForSwimlane
- truncateLabels
Constructors
constructor
• new SwimlaneCircles()
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:68
Properties
aBucketIsEncountred
• Protected
aBucketIsEncountred: boolean
= false
Inherited from
AbstractSwimlane.aBucketIsEncountred
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:39
allAxesContext
• Protected
allAxesContext: HistogramSVGG
Inherited from
AbstractSwimlane.allAxesContext
Defined in
src/histograms/AbstractHistogram.ts:38
barsContext
• Protected
barsContext: HistogramSVGG
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:35
brushCornerTooltips
• brushCornerTooltips: BrushCornerTooltips
Inherited from
AbstractSwimlane.brushCornerTooltips
Defined in
src/histograms/AbstractHistogram.ts:31
chartDimensions
• Protected
chartDimensions: ChartDimensions
Chart dimensions
Inherited from
AbstractSwimlane.chartDimensions
Defined in
src/histograms/AbstractHistogram.ts:41
context
• Protected
context: HistogramSVGG
Contexts
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:34
dataDomain
• Protected
dataDomain: HistogramData
[]
Data
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:46
dataInterval
• Protected
dataInterval: number
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:47
fromSetInterval
• Protected
fromSetInterval: boolean
= false
Inherited from
AbstractSwimlane.fromSetInterval
Defined in
src/histograms/AbstractHistogram.ts:54
hasSelectionExceededData
• Protected
hasSelectionExceededData: any
= null
Inherited from
AbstractSwimlane.hasSelectionExceededData
Defined in
src/histograms/AbstractHistogram.ts:52
histogramParams
• histogramParams: HistogramParams
Inherited from
AbstractSwimlane.histogramParams
Defined in
src/histograms/AbstractHistogram.ts:30
hoveredBucketKey
• Protected
hoveredBucketKey: number
| Date
Inherited from
AbstractSwimlane.hoveredBucketKey
Defined in
src/histograms/AbstractHistogram.ts:62
isHeightFixed
• Protected
isHeightFixed: boolean
= false
Inherited from
AbstractSwimlane.isHeightFixed
Defined in
src/histograms/AbstractHistogram.ts:43
isSwimlaneHeightFixed
• Protected
isSwimlaneHeightFixed: boolean
= false
Inherited from
AbstractSwimlane.isSwimlaneHeightFixed
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:34
isWidthFixed
• Protected
isWidthFixed: boolean
= false
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:42
labelsContext
• Protected
labelsContext: HistogramSVGG
Inherited from
AbstractSwimlane.labelsContext
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:38
labelsContextList
• Protected
labelsContextList: { context
: Selection
<SVGTextElement
, HistogramData
, BaseType
, HistogramData
> ; name
: string
}[]
Inherited from
AbstractSwimlane.labelsContextList
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:41
labelsRectContextList
• Protected
labelsRectContextList: { context
: HistogramSVGRect
; name
: string
}[]
Inherited from
AbstractSwimlane.labelsRectContextList
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:42
minusSign
• Protected
minusSign: number
= 1
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:66
noDatabarsContext
• Protected
noDatabarsContext: HistogramSVGG
Inherited from
AbstractSwimlane.noDatabarsContext
Defined in
src/histograms/AbstractHistogram.ts:36
plottingCount
• Protected
plottingCount: number
= 0
Inherited from
AbstractSwimlane.plottingCount
Defined in
src/histograms/AbstractHistogram.ts:65
selectedBars
• Protected
selectedBars: Set
<number
>
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:53
selectionInterval
• Protected
selectionInterval: SelectedOutputValues
Brush selection
Inherited from
AbstractSwimlane.selectionInterval
Defined in
src/histograms/AbstractHistogram.ts:50
swimlaneAxes
• Protected
swimlaneAxes: SwimlaneAxes
Inherited from
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:32
swimlaneBarsWeight
• Protected
swimlaneBarsWeight: number
Inherited from
AbstractSwimlane.swimlaneBarsWeight
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:40
swimlaneContextList
• Protected
swimlaneContextList: { context
: HistogramSVGG
; name
: string
}[]
Inherited from
AbstractSwimlane.swimlaneContextList
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:36
swimlaneHasMoreThanTwoBuckets
• Protected
swimlaneHasMoreThanTwoBuckets: boolean
= false
Inherited from
AbstractSwimlane.swimlaneHasMoreThanTwoBuckets
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:35
swimlaneIntervalBorders
• Protected
swimlaneIntervalBorders: [number
| Date
, number
| Date
]
Inherited from
AbstractSwimlane.swimlaneIntervalBorders
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:33
tooltipCursorContext
• Protected
tooltipCursorContext: HistogramSVGG
Inherited from
AbstractSwimlane.tooltipCursorContext
Defined in
src/histograms/AbstractHistogram.ts:37
verticalTooltipLine
• Protected
verticalTooltipLine: Selection
<SVGLineElement
, HistogramData
, BaseType
, HistogramData
>
Inherited from
AbstractSwimlane.verticalTooltipLine
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:37
xAxis
• Protected
xAxis: any
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:59
xLabelsAxis
• Protected
xLabelsAxis: any
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:58
xTicksAxis
• Protected
xTicksAxis: any
Axes && ticks
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:57
yDimension
• Protected
yDimension: number
= 1
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:64
Methods
addLabels
▸ Protected
addLabels(swimlanesMapData
): void
Parameters
Name | Type |
---|---|
swimlanesMapData |
Map <string , HistogramData []> |
Returns
void
Inherited from
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
Inherited from
AbstractSwimlane.applyHoverStyleOnSwimlaneLabels
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:180
applyStyleOnSwimlanes
▸ applyStyleOnSwimlanes(): void
Returns
void
Inherited from
AbstractSwimlane.applyStyleOnSwimlanes
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:155
buildLegend
▸ buildLegend(stats
): void
Parameters
Name | Type |
---|---|
stats |
SwimlaneStats |
Returns
void
Inherited from
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
AbstractSwimlane.clearTooltipCursor
Defined in
src/histograms/AbstractHistogram.ts:214
createSwimlaneAxes
▸ Protected
createSwimlaneAxes(data
): void
Parameters
Name | Type |
---|---|
data |
Map <string , HistogramData []> |
Returns
void
Inherited from
AbstractSwimlane.createSwimlaneAxes
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:238
drawChartAxes
▸ Protected
drawChartAxes(swimlaneAxes
): void
Parameters
Name | Type |
---|---|
swimlaneAxes |
SwimlaneAxes |
Returns
void
Inherited from
AbstractSwimlane.drawChartAxes
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:296
drawLineSeparators
▸ Protected
drawLineSeparators(): void
Returns
void
Inherited from
AbstractSwimlane.drawLineSeparators
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:302
getAxes
▸ Protected
getAxes(): SwimlaneAxes
Returns
SwimlaneAxes
Inherited from
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
Inherited from
AbstractSwimlane.getBucketColor
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:415
getDataInterval
▸ Protected
getDataInterval(swimlaneData
): number
Parameters
Name | Type |
---|---|
swimlaneData |
Map <string , HistogramData []> |
Returns
number
Inherited from
AbstractSwimlane.getDataInterval
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:496
getFollowingLastBucket
▸ Protected
getFollowingLastBucket(data
): HistogramData
Parameters
Name | Type |
---|---|
data |
any |
Returns
HistogramData
Inherited from
AbstractSwimlane.getFollowingLastBucket
Defined in
src/histograms/AbstractHistogram.ts:160
getHistogramDataInterval
▸ Protected
getHistogramDataInterval(data
): number
Parameters
Name | Type |
---|---|
data |
HistogramData [] |
Returns
number
Inherited from
AbstractSwimlane.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
AbstractSwimlane.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
AbstractSwimlane.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
AbstractSwimlane.getXDomainScale
Defined in
src/histograms/AbstractHistogram.ts:146
init
▸ init(): void
Returns
void
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:74
initializeChartDimensions
▸ Protected
initializeChartDimensions(): void
Returns
void
Inherited from
AbstractSwimlane.initializeChartDimensions
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:208
initializeChartHeight
▸ Protected
initializeChartHeight(): void
Returns
void
Inherited from
AbstractSwimlane.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
AbstractSwimlane.initializeDescriptionValues
Defined in
src/histograms/AbstractHistogram.ts:117
isValueValid
▸ Protected
isValueValid(bucket
): boolean
Parameters
Name | Type |
---|---|
bucket |
HistogramData |
Returns
boolean
Inherited from
Defined in
src/histograms/AbstractHistogram.ts:281
plot
▸ plot(inputData
): void
Parameters
Name | Type |
---|---|
inputData |
SwimlaneData |
Returns
void
Inherited from
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
Defined in
src/histograms/AbstractHistogram.ts:266
plotOneLane
▸ Protected
plotOneLane(data
, indexOfLane
): void
Parameters
Name | Type |
---|---|
data |
HistogramData [] |
indexOfLane |
number |
Returns
void
Overrides
Defined in
src/histograms/swimlanes/SwimlaneCircles.ts:25
plotSwimlane
▸ Protected
plotSwimlane(data
): void
Parameters
Name | Type |
---|---|
data |
Map <string , HistogramData []> |
Returns
void
Inherited from
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:192
resize
▸ resize(histogramContainer
): void
Parameters
Name | Type |
---|---|
histogramContainer |
HTMLElement |
Returns
void
Inherited from
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:116
setDataInterval
▸ Protected
setDataInterval(swimlaneData
): void
Parameters
Name | Type |
---|---|
swimlaneData |
Map <string , HistogramData []> |
Returns
void
Inherited from
AbstractSwimlane.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
AbstractSwimlane.setHTMLElementsOfBrushCornerTooltips
Defined in
src/histograms/AbstractHistogram.ts:88
setHistogramMargins
▸ Protected
setHistogramMargins(): void
Returns
void
Inherited from
AbstractSwimlane.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
Inherited from
AbstractSwimlane.setSelectedSwimlanes
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:538
setSwimlaneDataInterval
▸ Protected
setSwimlaneDataInterval(swimlaneData
): void
Parameters
Name | Type |
---|---|
swimlaneData |
Map <string , HistogramData []> |
Returns
void
Inherited from
AbstractSwimlane.setSwimlaneDataInterval
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:489
setSwimlaneMinMaxBorders
▸ Protected
setSwimlaneMinMaxBorders(swimlaneStats
): void
Parameters
Name | Type |
---|---|
swimlaneStats |
SwimlaneStats |
Returns
void
Inherited from
AbstractSwimlane.setSwimlaneMinMaxBorders
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
Inherited from
AbstractSwimlane.setTooltipPositionForSwimlane
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:349
setTooltipXposition
▸ Protected
setTooltipXposition(xPosition
, tooltip
): number
Parameters
Name | Type |
---|---|
xPosition |
number |
tooltip |
Tooltip |
Returns
number
Inherited from
AbstractSwimlane.setTooltipXposition
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:390
setTooltipYposition
▸ Protected
setTooltipYposition(yPosition
): number
Parameters
Name | Type |
---|---|
yPosition |
number |
Returns
number
Inherited from
AbstractSwimlane.setTooltipYposition
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
Inherited from
AbstractSwimlane.showTooltipsForSwimlane
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:311
truncateLabels
▸ truncateLabels(): void
Returns
void
Inherited from
AbstractSwimlane.truncateLabels
Defined in
src/histograms/swimlanes/AbstractSwimlane.ts:139