Rename LayoutItem.fullWidth to fullSize (#8358)

diff --git a/docs/docs/configuration/legend.md b/docs/docs/configuration/legend.md
index 9d6b42ef68c67dd203e503de5ab2467e3958dcf7..a669ca64dd40c0a2b8b9f7517bf8020bcf69b5f9 100644 (file)
--- a/docs/docs/configuration/legend.md
+++ b/docs/docs/configuration/legend.md
@@ -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]`.

diff --git a/docs/docs/getting-started/v3-migration.md b/docs/docs/getting-started/v3-migration.md
index 1897f88a6b69740eae9953166a3240b1c9382ada..bce18903c1f25bbe614afed231ad75f1c2478a4c 100644 (file)
--- a/docs/docs/getting-started/v3-migration.md
+++ b/docs/docs/getting-started/v3-migration.md
@@ -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`
 
@@ -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`
 

diff --git a/src/core/core.controller.js b/src/core/core.controller.js
index c459fcc60612bab980d79e0480862b1497b4fbe8..4360c01ef9e5ccd716afd5f3608d0e1bae2f3851 100644 (file)
--- a/src/core/core.controller.js
+++ b/src/core/core.controller.js
@@ -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);

diff --git a/src/core/core.layouts.js b/src/core/core.layouts.js
index 5002f0b5f2678d56de7af157a844faf4a76fe49e..970a2a10b5140197d8883fd4e216268364a0460c 100644 (file)
--- a/src/core/core.layouts.js
+++ b/src/core/core.layouts.js
@@ -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;
                }
        }
 }
@@ -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);
                }
        }
@@ -184,8 +184,8 @@ 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;
@@ -193,8 +193,8 @@ function placeBoxes(boxes, chartArea, params) {
                } 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;
                }
@@ -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
@@ -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
@@ -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;

diff --git a/src/core/core.scale.js b/src/core/core.scale.js
index 4bcabe0224fd7322ddfa7b22b44c1631d2288c65..785d2d868d97d4fdeb14af21da4fbe26c4b272b1 100644 (file)
--- a/src/core/core.scale.js
+++ b/src/core/core.scale.js
@@ -906,8 +906,8 @@ export default class Scale extends Element {
        /**
         * @return {boolean}
         */
-       isFullWidth() {
-               return this.options.fullWidth;
+       isFullSize() {
+               return this.options.fullSize;
        }
 
        /**

diff --git a/src/plugins/plugin.legend.js b/src/plugins/plugin.legend.js
index f0fa067b71f1b20757fd7f4c591cd8dcfe143352..bf32e359a6b9cdf091e035c5ede940de58f524cd 100644 (file)
--- a/src/plugins/plugin.legend.js
+++ b/src/plugins/plugin.legend.js
@@ -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) {
@@ -540,7 +540,7 @@ export default {
                display: true,
                position: 'top',
                align: 'center',
-               fullWidth: true,
+               fullSize: true,
                reverse: false,
                weight: 1000,
 

diff --git a/src/plugins/plugin.title.js b/src/plugins/plugin.title.js
index 8a2e6085ee0625d8e7806f5e511a767b07fb4494..415afc76053cd0c7652a0fa2a8451326b71a45b8 100644 (file)
--- a/src/plugins/plugin.title.js
+++ b/src/plugins/plugin.title.js
@@ -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) {
@@ -170,7 +170,7 @@ export default {
                font: {
                        style: 'bold',
                },
-               fullWidth: true,
+               fullSize: true,
                padding: 10,
                position: 'top',
                text: '',

diff --git a/test/specs/core.layouts.tests.js b/test/specs/core.layouts.tests.js
index d0f7138e763262961fbc92640b4ffdbbd93fbe61..cf70ddda63e290a11dba2e0332852f1d734ae11f 100644 (file)
--- a/test/specs/core.layouts.tests.js
+++ b/test/specs/core.layouts.tests.js
@@ -206,7 +206,7 @@ describe('Chart.layouts', function() {
                                        x2: {
                                                type: 'category',
                                                position: 'top',
-                                               fullWidth: true,
+                                               fullSize: true,
                                                offset: false
                                        },
                                        y: {

diff --git a/test/specs/plugin.legend.tests.js b/test/specs/plugin.legend.tests.js
index 198c3785af758af01156aa009730686a84137899..a4acdf6e20bdd2d37c8af3cfc5a11fe63c16a596 100644 (file)
--- a/test/specs/plugin.legend.tests.js
+++ b/test/specs/plugin.legend.tests.js
@@ -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,
 
@@ -768,7 +768,7 @@ describe('Legend block tests', function() {
                                options: {
                                        plugins: {
                                                legend: {
-                                                       fullWidth: true,
+                                                       fullSize: true,
                                                        position: 'top',
                                                        weight: 150
                                                }
@@ -776,16 +776,16 @@ describe('Legend block tests', function() {
                                }
                        });
 
-                       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);
                });

diff --git a/test/specs/plugin.title.tests.js b/test/specs/plugin.title.tests.js
index 29c0298f7ddbedf92184609a0b7a37df32941395..351e1dcd5278b0e1d8f9c4d2634386e423c48201 100644 (file)
--- a/test/specs/plugin.title.tests.js
+++ b/test/specs/plugin.title.tests.js
@@ -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'
@@ -291,7 +291,7 @@ describe('Title block tests', function() {
                                options: {
                                        plugins: {
                                                title: {
-                                                       fullWidth: true,
+                                                       fullSize: true,
                                                        position: 'top',
                                                        weight: 150
                                                }
@@ -299,16 +299,16 @@ describe('Title block tests', function() {
                                }
                        });
 
-                       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);
                });

diff --git a/types/index.esm.d.ts b/types/index.esm.d.ts
index 9fafa6b16a0bcbeb60617f49c0f64c2e20e17092..ad1ebdbe3683d50776314a815ea19827cf80c658 100644 (file)
--- a/types/index.esm.d.ts
+++ b/types/index.esm.d.ts
@@ -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;
 
        /**
@@ -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;
@@ -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
@@ -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.
         */

diff --git a/types/layout.d.ts b/types/layout.d.ts
index ef8935db74c4e1953697ae1b9e2ce7bcb4e772af..a0ec1aa11d0ea0a41bcb586d7467a7e7dd4fc93a 100644 (file)
--- a/types/layout.d.ts
+++ b/types/layout.d.ts
@@ -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()
         */