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

Scale: refactor drawTitle, add tests #8598

Merged
merged 3 commits into from
Mar 9, 2021
Merged

Scale: refactor drawTitle, add tests #8598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
792f228
Scale: refactor drawTitle, add tests
kurkle Mar 9, 2021
5a67cca
CC, lint
kurkle Mar 9, 2021
60b5c74
update
kurkle Mar 9, 2021
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
98 changes: 46 additions & 52 deletions src/core/core.scale.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@ import defaults from './core.defaults';
import Element from './core.element';
import {_alignPixel, _measureText, renderText, clipArea, unclipArea} from '../helpers/helpers.canvas';
import {callback as call, each, finiteOrDefault, isArray, isFinite, isNullOrUndef, isObject, valueOrDefault} from '../helpers/helpers.core';
import {_factorize, toDegrees, toRadians, _int16Range, HALF_PI, _limitValue} from '../helpers/helpers.math';
import {_factorize, toDegrees, toRadians, _int16Range, _limitValue, HALF_PI} from '../helpers/helpers.math';
import {_alignStartEnd, _toLeftRightCenter} from '../helpers/helpers.extras';
import {toFont, toPadding} from '../helpers/helpers.options';
import Ticks from './core.ticks';

const reverseAlign = (align) => align === 'left' ? 'right' : align === 'right' ? 'left' : align;
const offsetFromEdge = (scale, edge, offset) => edge === 'top' || edge === 'left' ? scale[edge] + offset : scale[edge] - offset;

/**
* @typedef { import("./core.controller").default } Chart
* @typedef {{value:number | string, label?:string, major?:boolean, $context?:any}} Tick
Expand Down Expand Up @@ -317,6 +321,31 @@ function createTickContext(parent, index, tick) {
});
}

function titleAlign(align, position, reverse) {
let ret = _toLeftRightCenter(align);
if ((reverse && position !== 'right') || (!reverse && position === 'right')) {
ret = reverseAlign(ret);
}
return ret;
}

function titleArgs(scale, offset, position, align) {
const {top, left, bottom, right} = scale;
let rotation = 0;
let maxWidth, titleX, titleY;

if (scale.isHorizontal()) {
titleX = _alignStartEnd(align, left, right);
titleY = offsetFromEdge(scale, position, offset);
maxWidth = right - left;
} else {
titleX = offsetFromEdge(scale, position, offset);
titleY = _alignStartEnd(align, bottom, top);
rotation = position === 'left' ? -HALF_PI : HALF_PI;
}
return {titleX, titleY, maxWidth, rotation};
}

export default class Scale extends Element {

// eslint-disable-next-line max-statements
Expand Down Expand Up @@ -1661,69 +1690,34 @@ export default class Scale extends Element {
/**
* @protected
*/
drawTitle(chartArea) { // eslint-disable-line no-unused-vars
const me = this;
const ctx = me.ctx;
const options = me.options;
const title = options.title;
drawTitle() {
const {ctx, options: {position, title, reverse}} = this;

if (!title.display) {
return;
}

const titleFont = toFont(title.font);
const titlePadding = toPadding(title.padding);
const halfLineHeight = titleFont.lineHeight / 2;
const titleAlign = title.align;
const position = options.position;
const isReverse = me.options.reverse;
let rotation = 0;
/** @type CanvasTextAlign */
let textAlign;
let titleX, titleY;
const font = toFont(title.font);
const padding = toPadding(title.padding);
const align = title.align;
let offset = font.lineHeight / 2;

if (me.isHorizontal()) {
switch (titleAlign) {
case 'start':
titleX = me.left + (isReverse ? me.width : 0);
textAlign = isReverse ? 'right' : 'left';
break;
case 'end':
titleX = me.left + (isReverse ? 0 : me.width);
textAlign = isReverse ? 'left' : 'right';
break;
default:
titleX = me.left + me.width / 2;
textAlign = 'center';
if (position === 'bottom') {
offset += padding.bottom;
if (isArray(title.text)) {
offset += font.lineHeight * (title.text.length - 1);
}
titleY = position === 'top'
? me.top + halfLineHeight + titlePadding.top
: me.bottom - halfLineHeight - titlePadding.bottom;
} else {
const isLeft = position === 'left';
titleX = isLeft
? me.left + halfLineHeight + titlePadding.top
: me.right - halfLineHeight - titlePadding.top;
switch (titleAlign) {
case 'start':
titleY = me.top + (isReverse ? 0 : me.height);
textAlign = isReverse === isLeft ? 'right' : 'left';
break;
case 'end':
titleY = me.top + (isReverse ? me.height : 0);
textAlign = isReverse === isLeft ? 'left' : 'right';
break;
default:
titleY = me.top + me.height / 2;
textAlign = 'center';
}
rotation = isLeft ? -HALF_PI : HALF_PI;
offset += padding.top;
}

renderText(ctx, title.text, 0, 0, titleFont, {
const {titleX, titleY, maxWidth, rotation} = titleArgs(this, offset, position, align);

renderText(ctx, title.text, 0, 0, font, {
color: title.color,
maxWidth,
rotation,
textAlign,
textAlign: titleAlign(align, position, reverse),
textBaseline: 'middle',
translation: [titleX, titleY],
});
Expand Down
32 changes: 0 additions & 32 deletions test/fixtures/core.scale/title-multi-line.js
View file
Open in desktop

This file was deleted.

Binary file removed test/fixtures/core.scale/title-multi-line.png
View file
Open in desktop
Binary file not shown.
77 changes: 77 additions & 0 deletions test/fixtures/core.scale/title/align-end.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
module.exports = {
config: {
type: 'line',
options: {
events: [],
scales: {
top: {
type: 'linear',
position: 'top',
ticks: {
display: false
},
gridLines: {
display: false
},
title: {
display: true,
align: 'end',
text: 'top'
}
},
left: {
type: 'linear',
position: 'left',
ticks: {
display: false
},
gridLines: {
display: false
},
title: {
display: true,
align: 'end',
text: 'left'
}
},
bottom: {
type: 'linear',
position: 'bottom',
ticks: {
display: false
},
gridLines: {
display: false
},
title: {
display: true,
align: 'end',
text: 'bottom'
}
},
right: {
type: 'linear',
position: 'right',
ticks: {
display: false
},
gridLines: {
display: false
},
title: {
display: true,
align: 'end',
text: 'right'
}
},
}
}
},
options: {
spriteText: true,
canvas: {
height: 256,
width: 256
},
}
};
Binary file added test/fixtures/core.scale/title/align-end.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
77 changes: 77 additions & 0 deletions test/fixtures/core.scale/title/align-start.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
module.exports = {
config: {
type: 'line',
options: {
events: [],
scales: {
top: {
type: 'linear',
position: 'top',
ticks: {
display: false
},
gridLines: {
display: false
},
title: {
display: true,
align: 'start',
text: 'top'
}
},
left: {
type: 'linear',
position: 'left',
ticks: {
display: false
},
gridLines: {
display: false
},
title: {
display: true,
align: 'start',
text: 'left'
}
},
bottom: {
type: 'linear',
position: 'bottom',
ticks: {
display: false
},
gridLines: {
display: false
},
title: {
display: true,
align: 'start',
text: 'bottom'
}
},
right: {
type: 'linear',
position: 'right',
ticks: {
display: false
},
gridLines: {
display: false
},
title: {
display: true,
align: 'start',
text: 'right'
}
},
}
}
},
options: {
spriteText: true,
canvas: {
height: 256,
width: 256
},
}
};
Binary file added test/fixtures/core.scale/title/align-start.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
73 changes: 73 additions & 0 deletions test/fixtures/core.scale/title/default.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
module.exports = {
config: {
type: 'line',
options: {
events: [],
scales: {
top: {
type: 'linear',
position: 'top',
ticks: {
display: false
},
gridLines: {
display: false
},
title: {
display: true,
text: 'top'
}
},
left: {
type: 'linear',
position: 'left',
ticks: {
display: false
},
gridLines: {
display: false
},
title: {
display: true,
text: 'left'
}
},
bottom: {
type: 'linear',
position: 'bottom',
ticks: {
display: false
},
gridLines: {
display: false
},
title: {
display: true,
text: 'bottom'
}
},
right: {
type: 'linear',
position: 'right',
ticks: {
display: false
},
gridLines: {
display: false
},
title: {
display: true,
text: 'right'
}
},
}
}
},
options: {
spriteText: true,
canvas: {
height: 256,
width: 256
},
}
};
Binary file added test/fixtures/core.scale/title/default.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading