Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: avoid label collision #247

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

feat: avoid label collision #247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
188fecf
feat: avoid label collision
MAudelGisaia Jan 30, 2025
95726be
fix: add comment
MAudelGisaia Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 92 additions & 14 deletions src/histograms/AbstractHistogram.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import {
import { HistogramParams } from './HistogramParams';
import { scaleUtc, scaleLinear, scaleTime, ScaleTime, ScaleLinear, ScaleBand } from 'd3-scale';
import { min, max } from 'd3-array';
import { Selection } from 'd3-selection';

export abstract class AbstractHistogram {

Expand Down Expand Up @@ -65,6 +66,9 @@ export abstract class AbstractHistogram {
protected plottingCount = 0;
protected minusSign = 1;

protected _xlabelMeanWidth = 0;


public constructor() {
this.brushCornerTooltips = this.createEmptyBrushCornerTooltips();
}
Expand Down Expand Up @@ -225,20 +229,7 @@ export abstract class AbstractHistogram {
// leftOffset is the width of Y labels, so x axes are translated by leftOffset
// Y axis is translated to the left of 1px so that the chart doesn't hide it
// Therefore, we substruct 1px (leftOffset - 1) so that the first tick of xAxis will coincide with y axis
let horizontalOffset = this.chartDimensions.height;
if (isChartAxes(chartAxes)) {
if (!this.histogramParams.yAxisFromZero) {
const minMax = chartAxes.yDomain.domain();
if (minMax[0] >= 0) {
horizontalOffset = chartAxes.yDomain(minMax[0]);
} else {
horizontalOffset = chartAxes.yDomain(minMax[1]);
}
} else {
horizontalOffset = chartAxes.yDomain(0);

}
}
const horizontalOffset = this.getHorizontalOffset(chartAxes);
this.xAxis = this.allAxesContext.append('g')
.attr('class', 'histogram__only-axis')
.attr('transform', 'translate(' + (leftOffset - 1) + ',' + horizontalOffset + ')')
Expand All @@ -251,6 +242,7 @@ export abstract class AbstractHistogram {
.attr('class', 'histogram__labels-axis')
.attr('transform', 'translate(' + (leftOffset - 1) + ',' + this.chartDimensions.height * this.histogramParams.xAxisPosition + ')')
.call(chartAxes.xLabelsAxis);

this.xTicksAxis.selectAll('path').attr('class', 'histogram__axis');
this.xAxis.selectAll('path').attr('class', 'histogram__axis');
this.xTicksAxis.selectAll('line').attr('class', 'histogram__ticks');
Expand All @@ -263,6 +255,92 @@ export abstract class AbstractHistogram {
}
}

public getHorizontalOffset(chartAxes){
let h = this.chartDimensions.height;
if (isChartAxes(chartAxes)) {
if (!this.histogramParams.yAxisFromZero) {
const minMax = chartAxes.yDomain.domain();
if (minMax[0] >= 0) {
h = chartAxes.yDomain(minMax[0]);
} else {
h = chartAxes.yDomain(minMax[1]);
}
} else {
h = chartAxes.yDomain(0);
}
}
return h;
}

public updateNumberOfLabelDisplayedIfOverlap(chartAxes: ChartAxes | SwimlaneAxes, leftOffset = 0){
// Get the offset used when we will draw the labels.
const horizontalOffset = this.getHorizontalOffset(chartAxes);
let sumWidth = 0;
// create virtual nodes. Helps to get label's width.
const virtualLabels = this.chartDimensions.svg.append('g');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can try to select the already existing labels.
Or you need to use one common method between the real label axis and the virtual one in order to avoid duplication

const labels = virtualLabels.append('g')
.attr('class', 'histogram__labels-axis')
.attr('transform', 'translate(' + (leftOffset - 1) + ',' + this.chartDimensions.height * this.histogramParams.xAxisPosition + ')')
.call(chartAxes.xLabelsAxis).selectAll('text');

// check for all label if there is an overlap.
let hasOverlap = false;
const nodes = labels.nodes();
for (let i = 0; i < labels.size(); i++) {
const next = i + 1;
if(nodes[next]){
const c = this.getDimension(nodes[i]);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do 'c' and 'n' stand for current and next ? if so, can you add a comment for those var names or rename the variable ?

const n = this.getDimension(nodes[next]);
if(!this.isOverlapXAxis(c,n)) {
hasOverlap = true;
}
sumWidth += c.width;
}
}

// remove virtual node. If we do not it ill be displayed
virtualLabels.remove();

// calc label mean width once.
if(!this._xlabelMeanWidth) {
this._xlabelMeanWidth = Math.round(sumWidth / this.histogramParams.xLabels);
}


if(!hasOverlap) {
return;
}

// get the min value between default label size an
const labelCount = min([
this.histogramParams.xLabels,
Math.floor(this.histogramParams.chartWidth / (this._xlabelMeanWidth + horizontalOffset))]
);

// update ticks for label and ticks axisis
chartAxes.xLabelsAxis.ticks(labelCount);
// 4 is an arbitrary value to displayed one or 2 ticks between each value.
chartAxes.xTicksAxis.ticks(labelCount * 4);
}

public getDimension(node): DOMRect {
if (typeof node.getBoundingClientRect === 'function') {
return node.getBoundingClientRect();
} else if (node instanceof SVGGraphicsElement) { // check if node is svg element
return node.getBBox();
}
}

public isOverlapXAxis (l, r) {
const a = {left: 0, right: 0};
const b = {left: 0, right: 0};
a.left = l.x - this.histogramParams.overlapXTolerance;
a.right = l.x + l.width + this.histogramParams.overlapXTolerance;
b.left = r.x - this.histogramParams.overlapXTolerance;
b.right = r.x + r.width + this.histogramParams.overlapXTolerance;
return a.left >= b.right || a.right <= b.left;
}

protected plotBars(data: Array<HistogramData>, axes: ChartAxes | SwimlaneAxes, xDataDomain: ScaleBand<string>, barWeight?: number): void {
const barWidth = barWeight ? axes.stepWidth * barWeight : axes.stepWidth * this.histogramParams.barWeight;
this.barsContext = this.context.append('g').attr('class', 'histogram__bars').selectAll('.bar')
Expand Down
1 change: 1 addition & 0 deletions src/histograms/HistogramParams.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ export class HistogramParams {
public ticksDateFormat: string = null;
public xAxisPosition: Position = Position.bottom;
public descriptionPosition: Position = Position.bottom;
public overlapXTolerance = 2;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why 2?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could be more if needed, it apply a padding of 2 on left and right side, to detect the overlap before the label collide.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it should be an input ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could be a good idea !

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes good Idea, we should add a new input for this overlap tolerance


/** Desctiption */
public chartTitle = '';
Expand Down
3 changes: 3 additions & 0 deletions src/histograms/charts/AbstractChart.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ export abstract class AbstractChart extends AbstractHistogram {
/** Maximum number of buckets that a chart can have */
private MAX_BUCKET_NUMBER = 1000;


public plot(inputData: Array<HistogramData>) {
super.init();
this.dataDomain = inputData;
Expand All @@ -84,6 +85,7 @@ export abstract class AbstractChart extends AbstractHistogram {
this.customizeData(data);
const extendedData = this.extendData(data);
this.createChartAxes(extendedData);
this.updateNumberOfLabelDisplayedIfOverlap(this.chartAxes, 0);
this.drawChartAxes(this.chartAxes, 0);
this.plotChart(data);
this.showTooltips(data);
Expand Down Expand Up @@ -405,6 +407,7 @@ export abstract class AbstractChart extends AbstractHistogram {
const labelPadding = (this.histogramParams.xAxisPosition === Position.bottom) ? 9 : -15;
this.chartAxes.xLabelsAxis = axisBottom(this.chartAxes.xDomain).tickSize(0)
.tickPadding(labelPadding).ticks(this.histogramParams.xLabels);

this.applyFormatOnXticks(data);
if (this.histogramParams.dataType === DataType.time) {
if (this.histogramParams.ticksDateFormat) {
Expand Down
4 changes: 4 additions & 0 deletions src/histograms/charts/ChartCurve.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,14 @@ export class ChartCurve extends AbstractChart {
this.histogramParams.margin.right = 10;
}
this.initializeChartDimensions();

const extendedData = this.extendData(data);
if (chartIdToData.size === 1) {
// We add just one Y axis on the left
// No normalization
this.createChartXAxes(extendedData);
this.createChartYLeftAxes(data);
this.updateNumberOfLabelDisplayedIfOverlap(this.chartAxes, 0);
this.drawChartAxes(this.chartAxes, 0);
this.drawYAxis(this.chartAxes, chartIdsToSides, Array.from(chartIds)[0]);
this.createClipperContext();
Expand All @@ -129,6 +131,7 @@ export class ChartCurve extends AbstractChart {
this.createChartYRightAxes(dataArray[1]);
this.createChartYLeftAxes(dataArray[0]);
}
this.updateNumberOfLabelDisplayedIfOverlap(this.chartAxes, 0);
this.drawChartAxes(this.chartAxes, 0);
const chartIdsArray = Array.from(chartIds);
if (!!this.histogramParams.mainChartId && chartIdToData.has(this.histogramParams.mainChartId)) {
Expand All @@ -153,6 +156,7 @@ export class ChartCurve extends AbstractChart {
// We normalize the data
this.createChartXAxes(extendedData);
this.createChartNormalizeLeftAxes();
this.updateNumberOfLabelDisplayedIfOverlap(this.chartAxes, 0);
this.drawChartAxes(this.chartAxes, 0);
this.createClipperContext();
dataArray.forEach(chartData => {
Expand Down
4 changes: 4 additions & 0 deletions test/app.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@
* specific language governing permissions and limitations
* under the License.
*/
body, html {
width: 100%;
}


.histogram{
background: rgba(0,0,255,0);
Expand Down
19 changes: 15 additions & 4 deletions test/app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ import { Dimensions, Granularity, Margins, Timeline } from '../dist/index.js'


const inputCharts = {
"xTicks": 9,
"xTicks": 60,
"yTicks": 2,
"xLabels": 9,
"xLabels": 50,
"yLabels": 2,
"xUnit": "",
"yUnit": "",
Expand All @@ -39,7 +39,7 @@ const inputCharts = {
"ticksDateFormat": "%b %d %Y %H:%M",
"chartType": "bars",
"chartHeight": 150,
"chartWidth": 500,
"chartWidth": null,
"yAxisStartsFromZero": true,
"descriptionPosition": "top",
"showXTicks": true,
Expand Down Expand Up @@ -76,6 +76,8 @@ const defaultHistogramData = [
{ value: 100, key: 12000, chartId: '1' },
{ value: 222, key: 13000, chartId: '1' },
{ value: 120, key: 14000, chartId: '1' },
{ value: 123, key: 15000, chartId: '1' },
{ value: 123, key: 16000, chartId: '1' },


{ value: 212 + 200, key: 5000, chartId: '2' },
Expand Down Expand Up @@ -124,9 +126,11 @@ const timeHistogramBars = new ChartBars();
displayHistogram(timeHistogramBars, 'containerHistTime', timeHistogramData, false, DataType.time)

function displayHistogram(histogram, containerName, data, selectionOverflow = false, dataType = DataType.numeric) {
histogram.histogramParams = histogramParams;
histogram.histogramParams = {...histogramParams};
histogram.histogramParams.dataType = dataType;
histogram.histogramParams.multiselectable = true;
histogram.histogramParams.chartWidth = null;

// histogram.histogramParams.selectionType = 'slider';
histogram.histogramParams.intervalSelectedMap = new Map();
histogram.histogramParams.histogramContainer = document.getElementById(containerName)
Expand All @@ -141,6 +145,13 @@ function displayHistogram(histogram, containerName, data, selectionOverflow = fa
});
}

window.addEventListener('resize', () => {
histogramBars.resize(document.getElementById('containerBars'));
histogramCurve.resize(document.getElementById('containerCurve'));
histogramArea.resize(document.getElementById('containerArea'));
timeHistogramBars.resize(document.getElementById('containerHistTime'));
});

/** Timeline */

const svg = document.getElementById('containerTimeline').querySelector('svg');
Expand Down
28 changes: 14 additions & 14 deletions test/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,31 @@
</head>

<body>
<div style="width: 1000px; height: 150px;">
<div id="containerBars" style="width: 1000px; height: 150px;">
<svg id="svgixBars" style="width: 1000px; height: 150px"></svg>
<div style="width: 100%; height: 150px;">
<div id="containerBars" style="width: 100%; height: 150px;">
<svg id="svgixBars" style="width: 100%; height: 150px"></svg>
</div>
<div id="containerCurve" style="width: 1000px; height: 150px;">
<svg id="svgixCurve" style="width: 1000px; height: 150px"></svg>
<div id="containerCurve" style="width: 100%; height: 150px;">
<svg id="svgixCurve" style="width: 100%; height: 150px"></svg>
</div>
<div id="containerArea" style="width: 1000px; height: 150px;">
<svg id="svgixArea" style="width: 1000px; height: 150px"></svg>
<div id="containerArea" style="width: 100%; height: 150px;">
<svg id="svgixArea" style="width: 100%; height: 150px"></svg>
</div>
<div id="containerHistTime" style="width: 1000px; height: 150px;">
<svg id="svgixHistTime" style="width: 1000px; height: 150px"></svg>
<div id="containerHistTime" style="width: 100%; height: 150px;">
<svg id="svgixHistTime" style="width: 100%; height: 150px"></svg>
</div>
<div id="containerTimeline" style="width: 1000px; height: 150px;">
<svg id="svgixTimeline" style="width: 1000px; height: 150px"></svg>
</div>
<div id="containerSwimlane" style="width: 1000px; height: 150px;">
<svg id="svgixSwimlane" style="width: 1000px; height: 150px"></svg>
<div id="containerSwimlane" style="width: 100%; height: 150px;">
<svg id="svgixSwimlane" style="width: 100%; height: 150px"></svg>
</div>
<div id="containerDonut" style="width: 1000px; height: 150px;">
<svg id="svgixDonut" style="width: 1000px; height: 150px"></svg>
<div id="containerDonut" style="width: 100%; height: 150px;">
<svg id="svgixDonut" style="width: 100%; height: 150px"></svg>
</div>
</div>

<script src='app.js'></script>
</body>

</html>
</html>
Loading