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.

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

Rename LayoutItem.fullWidth to fullSize #8358

Merged
merged 1 commit into from
Jan 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/docs/configuration/legend.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The legend configuration is passed into the `options.plugins.legend` namespace.
| `align` | `string` | `'center'` | Alignment of the legend. [more...](#align)
| `maxHeight` | `number` | | Maximum height of the legend, in pixels
| `maxWidth` | `number` | | Maximum width of the legend, in pixels
| `fullWidth` | `boolean` | `true` | Marks that this box should take the full width of the canvas (pushing down other boxes). This is unlikely to need to be changed in day-to-day use.
| `fullSize` | `boolean` | `true` | Marks that this box should take the full width/height of the canvas (moving other boxes). This is unlikely to need to be changed in day-to-day use.
| `onClick` | `function` | | A callback that is called when a click event is registered on a label item. Arguments: `[event, legendItem, legend]`.
| `onHover` | `function` | | A callback that is called when a 'mousemove' event is registered on top of a label item. Arguments: `[event, legendItem, legend]`.
| `onLeave` | `function` | | A callback that is called when a 'mousemove' event is registered outside of a previously hovered label item. Arguments: `[event, legendItem, legend]`.
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/getting-started/v3-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@ The following properties were renamed during v3 development:
* `helpers.callCallback` was renamed to `helpers.callback`
* `helpers.drawRoundedRectangle` was renamed to `helpers.roundedRect`
* `helpers.getValueOrDefault` was renamed to `helpers.valueOrDefault`
* `LayoutItem.fullWidth` was renamed to `LayoutItem.fullSize`
* `Scale.calculateTickRotation` was renamed to `Scale.calculateLabelRotation`
* `Tooltip.options.legendColorBackgroupd` was renamed to `Tooltip.options.multiKeyBackground`

Expand Down Expand Up @@ -434,6 +435,7 @@ The private APIs listed below were renamed:
* `DatasetController.onDataUnshift` was renamed to `DatasetController._onDataUnshift`
* `DatasetController.removeElements` was renamed to `DatasetController._removeElements`
* `DatasetController.resyncElements` was renamed to `DatasetController._resyncElements`
* `LayoutItem.isFullWidth` was renamed to `LayoutItem.isFullSize`
* `RadialLinearScale.setReductions` was renamed to `RadialLinearScale._setReductions`
* `Scale.handleMargins` was renamed to `Scale._handleMargins`

Expand Down
2 changes: 1 addition & 1 deletion src/core/core.controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ class Chart {

each(scales, (scale) => {
// Set LayoutItem parameters for backwards compatibility
scale.fullWidth = scale.options.fullWidth;
scale.fullSize = scale.options.fullSize;
scale.position = scale.options.position;
scale.weight = scale.options.weight;
layouts.addBox(me, scale);
Expand Down
20 changes: 10 additions & 10 deletions src/core/core.layouts.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ function setLayoutDims(layouts, params) {
layout = layouts[i];
// store dimensions used instead of available chartArea in fitBoxes
if (layout.horizontal) {
layout.width = layout.box.fullWidth && params.availableWidth;
layout.width = layout.box.fullSize && params.availableWidth;
layout.height = params.hBoxMaxHeight;
} else {
layout.width = params.vBoxMaxWidth;
layout.height = layout.box.fullWidth && params.availableHeight;
layout.height = layout.box.fullSize && params.availableHeight;
}
}
}
Expand Down Expand Up @@ -166,7 +166,7 @@ function fitBoxes(boxes, chartArea, params) {
refit = true;
}
}
if (!box.fullWidth) { // fullWidth boxes don't need to be re-fitted in any case
if (!box.fullSize) { // fullSize boxes don't need to be re-fitted in any case
refitBoxes.push(layout);
}
}
Expand All @@ -184,17 +184,17 @@ function placeBoxes(boxes, chartArea, params) {
layout = boxes[i];
box = layout.box;
if (layout.horizontal) {
box.left = box.fullWidth ? userPadding.left : chartArea.left;
box.right = box.fullWidth ? params.outerWidth - userPadding.right : chartArea.left + chartArea.w;
box.left = box.fullSize ? userPadding.left : chartArea.left;
box.right = box.fullSize ? params.outerWidth - userPadding.right : chartArea.left + chartArea.w;
box.top = y;
box.bottom = y + box.height;
box.width = box.right - box.left;
y = box.bottom;
} else {
box.left = x;
box.right = x + box.width;
box.top = box.fullWidth ? userPadding.top : chartArea.top;
box.bottom = box.fullWidth ? params.outerHeight - userPadding.right : chartArea.top + chartArea.h;
box.top = box.fullSize ? userPadding.top : chartArea.top;
box.bottom = box.fullSize ? params.outerHeight - userPadding.right : chartArea.top + chartArea.h;
box.height = box.bottom - box.top;
x = box.right;
}
Expand All @@ -219,7 +219,7 @@ defaults.set('layout', {
* @prop {string} position - The position of the item in the chart layout. Possible values are
* 'left', 'top', 'right', 'bottom', and 'chartArea'
* @prop {number} weight - The weight used to sort the item. Higher weights are further away from the chart area
* @prop {boolean} fullWidth - if true, and the item is horizontal, then push vertical boxes down
* @prop {boolean} fullSize - if true, and the item is horizontal, then push vertical boxes down
* @prop {function} isHorizontal - returns true if the layout item is horizontal (ie. top or bottom)
* @prop {function} update - Takes two parameters: width and height. Returns size of item
* @prop {function} draw - Draws the element
Expand Down Expand Up @@ -249,7 +249,7 @@ export default {
}

// initialize item with default values
item.fullWidth = item.fullWidth || false;
item.fullSize = item.fullSize || false;
item.position = item.position || 'top';
item.weight = item.weight || 0;
// @ts-ignore
Expand Down Expand Up @@ -284,7 +284,7 @@ export default {
* @param {object} options - the new item options.
*/
configure(chart, item, options) {
const props = ['fullWidth', 'position', 'weight'];
const props = ['fullSize', 'position', 'weight'];
const ilen = props.length;
let i = 0;
let prop;
Expand Down
4 changes: 2 additions & 2 deletions src/core/core.scale.js
Original file line number Diff line number Diff line change
Expand Up @@ -906,8 +906,8 @@ export default class Scale extends Element {
/**
* @return {boolean}
*/
isFullWidth() {
return this.options.fullWidth;
isFullSize() {
return this.options.fullSize;
}

/**
Expand Down
4 changes: 2 additions & 2 deletions src/plugins/plugin.legend.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ export class Legend extends Element {
this._margins = undefined;
this.position = undefined;
this.weight = undefined;
this.fullWidth = undefined;
this.fullSize = undefined;
}

update(maxWidth, maxHeight, margins) {
Expand Down Expand Up @@ -540,7 +540,7 @@ export default {
display: true,
position: 'top',
align: 'center',
fullWidth: true,
fullSize: true,
reverse: false,
weight: 1000,

Expand Down
4 changes: 2 additions & 2 deletions src/plugins/plugin.title.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export class Title extends Element {
this.height = undefined;
this.position = undefined;
this.weight = undefined;
this.fullWidth = undefined;
this.fullSize = undefined;
}

update(maxWidth, maxHeight) {
Expand Down Expand Up @@ -170,7 +170,7 @@ export default {
font: {
style: 'bold',
},
fullWidth: true,
fullSize: true,
padding: 10,
position: 'top',
text: '',
Expand Down
2 changes: 1 addition & 1 deletion test/specs/core.layouts.tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ describe('Chart.layouts', function() {
x2: {
type: 'category',
position: 'top',
fullWidth: true,
fullSize: true,
offset: false
},
y: {
Expand Down
10 changes: 5 additions & 5 deletions test/specs/plugin.legend.tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ describe('Legend block tests', function() {
display: true,
position: 'top',
align: 'center',
fullWidth: true, // marks that this box should take the full width of the canvas (pushing down other boxes)
fullSize: true,
reverse: false,
weight: 1000,

Expand Down Expand Up @@ -768,24 +768,24 @@ describe('Legend block tests', function() {
options: {
plugins: {
legend: {
fullWidth: true,
fullSize: true,
position: 'top',
weight: 150
}
}
}
});

expect(chart.legend.fullWidth).toBe(true);
expect(chart.legend.fullSize).toBe(true);
expect(chart.legend.position).toBe('top');
expect(chart.legend.weight).toBe(150);

chart.options.plugins.legend.fullWidth = false;
chart.options.plugins.legend.fullSize = false;
chart.options.plugins.legend.position = 'left';
chart.options.plugins.legend.weight = 42;
chart.update();

expect(chart.legend.fullWidth).toBe(false);
expect(chart.legend.fullSize).toBe(false);
expect(chart.legend.position).toBe('left');
expect(chart.legend.weight).toBe(42);
});
Expand Down
10 changes: 5 additions & 5 deletions test/specs/plugin.title.tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ describe('Title block tests', function() {
color: Chart.defaults.color,
display: false,
position: 'top',
fullWidth: true,
fullSize: true,
weight: 2000,
font: {
style: 'bold'
Expand Down Expand Up @@ -291,24 +291,24 @@ describe('Title block tests', function() {
options: {
plugins: {
title: {
fullWidth: true,
fullSize: true,
position: 'top',
weight: 150
}
}
}
});

expect(chart.titleBlock.fullWidth).toBe(true);
expect(chart.titleBlock.fullSize).toBe(true);
expect(chart.titleBlock.position).toBe('top');
expect(chart.titleBlock.weight).toBe(150);

chart.options.plugins.title.fullWidth = false;
chart.options.plugins.title.fullSize = false;
chart.options.plugins.title.position = 'left';
chart.options.plugins.title.weight = 42;
chart.update();

expect(chart.titleBlock.fullWidth).toBe(false);
expect(chart.titleBlock.fullSize).toBe(false);
expect(chart.titleBlock.position).toBe('left');
expect(chart.titleBlock.weight).toBe(42);
});
Expand Down
10 changes: 5 additions & 5 deletions types/index.esm.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -717,7 +717,7 @@ export const layouts: {
configure(
chart: Chart,
item: LayoutItem,
options: { fullWidth?: number; position?: LayoutPosition; weight?: number }
options: { fullSize?: number; position?: LayoutPosition; weight?: number }
): void;

/**
Expand Down Expand Up @@ -1222,7 +1222,7 @@ export interface Scale<O extends CoreScaleOptions = CoreScaleOptions> extends El
fit(): void;
afterFit(): void;

isFullWidth(): boolean;
isFullSize(): boolean;
}
export const Scale: {
prototype: Scale;
Expand Down Expand Up @@ -2022,10 +2022,10 @@ export interface LegendOptions {
*/
align: TextAlign;
/**
* Marks that this box should take the full width of the canvas (pushing down other boxes). This is unlikely to need to be changed in day-to-day use.
* Marks that this box should take the full width/height of the canvas (moving other boxes). This is unlikely to need to be changed in day-to-day use.
* @default true
*/
fullWidth: boolean;
fullSize: boolean;
/**
* Legend will show datasets in reverse order.
* @default false
Expand Down Expand Up @@ -2145,7 +2145,7 @@ export interface TitleOptions {
*/
color: Color;
font: FontSpec;
// fullWidth: boolean;
// fullSize: boolean;
/**
* Adds padding above and below the title text if a single number is specified. It is also possible to change top and bottom padding separately.
*/
Expand Down
2 changes: 1 addition & 1 deletion types/layout.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export interface LayoutItem {
/**
* if true, and the item is horizontal, then push vertical boxes down
*/
fullWidth: boolean;
fullSize: boolean;
/**
* Width of item. Must be valid after update()
*/
Expand Down