Rows and columns in Vue Spreadsheet component
16 Mar 202324 minutes to read
Spreadsheet is a tabular format consisting of rows and columns. The intersection point of rows and columns are called as cells. The list of operations that you can perform in rows and columns are,
- Insert
- Delete
- Show and Hide
Insert
You can insert rows or columns anywhere in a spreadsheet. Use the allowInsert
property to enable or disable the insert option in Spreadsheet.
Row
The rows can be inserted in the following ways,
- Using
insertRow
method, you can insert the rows once the component is loaded. - Using context menu, insert the empty rows in the desired position.
The following code example shows the options for inserting rows in the spreadsheet.
<template>
<ejs-spreadsheet ref="spreadsheet" :created="created" :showFormulaBar="false"
:showSheetTabs="false" :showRibbon="false">
<e-sheets>
<e-sheet>
<e-ranges>
<e-range :dataSource="dataSource" startCell="B1"></e-range>
</e-ranges>
<e-columns>
<e-column :width=20></e-column>
<e-column :width=90></e-column>
<e-column :width=220></e-column>
<e-column :width=90></e-column>
<e-column :width=140></e-column>
<e-column :width=90></e-column>
<e-column :width=100></e-column>
<e-column :width=100></e-column>
</e-columns>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>
</template>
<script>
import Vue from "vue";
import { SpreadsheetPlugin } from "@syncfusion/ej2-vue-spreadsheet";
import { data } from './data.js';
Vue.use(SpreadsheetPlugin);
export default {
data: () => {
return {
dataSource: data,
// Rows model that is going to insert dynamically
rowsModel: [
{
index: 9, // Need to specify the index for the first row collection, the specified rows will be inserted in this index.
cells: [{ value: '' }, { value: '8' }, { value: 'Northwoods Cranberry Sauce' }, { value: '3' }, { value: '12 - 12 oz jars' },
{ value: '40.00' }, { value: '6' }, { value: 'false' }]
},
{
cells: [{ value: '' }, { value: '9' }, { value: 'Mishi Kobe Niku' }, { value: '4' }, { value: '18 - 500 g pkgs.' },
{ value: '97.00' }, { value: '29' }, { value: 'true' }]
}
]
}
},
methods: {
created: function () {
var spreadsheet = this.$refs.spreadsheet;
// Applies style formatting before inserting the rows
spreadsheet.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'B1:H1');
// inserting a empty row at 0th index
spreadsheet.insertRow();
// inserting 2 rows at the 9th index with data
spreadsheet.insertRow(this.rowsModel);
// Applies style formatting after the rows are inserted
spreadsheet.cellFormat({ textAlign: 'center' }, 'B3:B12');
spreadsheet.cellFormat({ textAlign: 'center' }, 'D3:D12');
spreadsheet.cellFormat({ textAlign: 'center' }, 'F3:H12');
}
}
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-spreadsheet/styles/material.css";
@import '../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../node_modules/@syncfusion/ej2-buttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';
@import '../node_modules/@syncfusion/ej2-inputs/styles/material.css';
@import '../node_modules/@syncfusion/ej2-navigations/styles/material.css';
@import '../node_modules/@syncfusion/ej2-popups/styles/material.css';
@import '../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-grids/styles/material.css';
@import "../node_modules/@syncfusion/ej2-spreadsheet/styles/material.css";
</style>
Column
The columns can be inserted in the following ways,
- Using
insertColumn
method, you can insert the columns once the component is loaded. - Using context menu, insert the empty columns in the desired position.
The following code example shows the options for inserting columns in the spreadsheet.
<template>
<ejs-spreadsheet ref="spreadsheet" :created="created" :showFormulaBar="false"
:showSheetTabs="false" :showRibbon="false">
<e-sheets>
<e-sheet>
<e-ranges>
<e-range :dataSource="dataSource" startCell="A2"></e-range>
</e-ranges>
<e-columns>
<e-column :width=90></e-column>
<e-column :width=220></e-column>
<e-column :width=90></e-column>
<e-column :width=140></e-column>
<e-column :width=100></e-column>
<e-column :width=100></e-column>
</e-columns>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>
</template>
<script>
import Vue from "vue";
import { SpreadsheetPlugin, getCellAddress } from "@syncfusion/ej2-vue-spreadsheet";
import { data } from './data.js';
Vue.use(SpreadsheetPlugin);
export default {
data: () => {
return {
dataSource: data,
}
},
methods: {
created: function () {
var spreadsheet = this.$refs.spreadsheet;
// Applies style formatting before inserting the column
spreadsheet.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'A2:G2');
// inserting a empty column at 0th index
spreadsheet.insertColumn();
// inserting 1 column at the 5th index with column model
spreadsheet.insertColumn([{ index: 5, width: 90 }]);
let rowIndex = 1;
// Updating the 5th column data
var cellsModel= [{ value: 'Unit Price', style: { fontWeight: 'bold', textAlign: 'center' } }, { value: '18.00' },
{ value: '19.00' }, { value: '10.00' }, { value: '22.00' }, { value: '21.35' }, { value: '25.00' }, { value: '30.00' },
{ value: '21.00' }, { value: '40.00' }, { value: '97.00' }]
cellsModel.forEach((cell) => {
spreadsheet.updateCell(cell, getCellAddress(rowIndex, 5)); rowIndex++;
});
// Applies style formatting after the rows are inserted
spreadsheet.cellFormat({ textAlign: 'center' }, 'B3:B12');
spreadsheet.cellFormat({ textAlign: 'center' }, 'D3:D12');
spreadsheet.cellFormat({ textAlign: 'center' }, 'F3:H12');
}
}
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-spreadsheet/styles/material.css";
@import '../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../node_modules/@syncfusion/ej2-buttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';
@import '../node_modules/@syncfusion/ej2-inputs/styles/material.css';
@import '../node_modules/@syncfusion/ej2-navigations/styles/material.css';
@import '../node_modules/@syncfusion/ej2-popups/styles/material.css';
@import '../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-grids/styles/material.css';
@import "../node_modules/@syncfusion/ej2-spreadsheet/styles/material.css";
</style>
Delete
Delete support provides an option for deleting the rows and columns in the spreadsheet. Use allowDelete
property to enable or disable the delete option in Spreadsheet.
The rows and columns can be deleted dynamically in the following ways,
- Using
delete
method, you can delete the loaded rows and columns. - Using context menu, you can delete the selected rows and columns.
The following code example shows the delete operation of rows and columns in the spreadsheet.
<template>
<ejs-spreadsheet ref="spreadsheet" :created="created" :showFormulaBar="false"
:allowDelete="true" :showRibbon="false">
<e-sheets>
<e-sheet name="Sheet1">
<e-ranges>
<e-range :dataSource="dataSource" ></e-range>
</e-ranges>
<e-columns>
<e-column :width=90></e-column>
<e-column :width=220></e-column>
<e-column :width=90></e-column>
<e-column :width=140></e-column>
<e-column :width=90></e-column>
<e-column :width=100></e-column>
<e-column :width=100></e-column>
</e-columns>
</e-sheet>
<e-sheet name="Sheet2">
<e-ranges>
<e-range :dataSource="dataSource" ></e-range>
</e-ranges>
<e-columns>
<e-column :width=90></e-column>
<e-column :width=220></e-column>
<e-column :width=90></e-column>
<e-column :width=140></e-column>
<e-column :width=90></e-column>
<e-column :width=100></e-column>
<e-column :width=100></e-column>
</e-columns>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>
</template>
<script>
import Vue from "vue";
import { SpreadsheetPlugin } from "@syncfusion/ej2-vue-spreadsheet";
import { data } from './data.js';
Vue.use(SpreadsheetPlugin);
export default {
data: () => {
return {
dataSource: data,
}
},
methods: {
created: function () {
var spreadsheet = this.$refs.spreadsheet;
spreadsheet.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'A1:H1');
// deleting the rows from 8th to 10th index. To delete row, the third argument of enum type is passed as 'Row', the last argument specifies the sheet name or index in which the delete operation will perform. By default,active sheet will be considered. It is applicable only for model type Row and Column.
spreadsheet.delete(8, 10, 'Row', 0); // startIndex, endIndex, Row, sheet index
// deleting the 2nd and 5th indexed columns
spreadsheet.delete(2, 2, 'Column', 'Sheet2');
spreadsheet.delete(5, 5, 'Column');
spreadsheet.delete(0, 0, "Sheet"); // delete the first sheet. sheet index starts from 0
// Applies style formatting after deleted the rows and columns
spreadsheet.cellFormat({ textAlign: 'center' }, 'A2:A8');
spreadsheet.cellFormat({ textAlign: 'center' }, 'D2:G8');
}
}
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-spreadsheet/styles/material.css";
@import '../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../node_modules/@syncfusion/ej2-buttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';
@import '../node_modules/@syncfusion/ej2-inputs/styles/material.css';
@import '../node_modules/@syncfusion/ej2-navigations/styles/material.css';
@import '../node_modules/@syncfusion/ej2-popups/styles/material.css';
@import '../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-grids/styles/material.css';
@import "../node_modules/@syncfusion/ej2-spreadsheet/styles/material.css";
</style>
Limitations of insert and delete
The following features have some limitations in Insert/Delete:
- Insert row/column between the formatting applied cells.
- Insert row/column between the data validation.
- Insert row/column between the conditional formatting applied cells.
- Insert/delete row/column between the filter applied cells.
Hide and show
You can show or hide the rows and columns in the spreadsheet through property binding, method, and context menu.
Row
The rows can be hidden or shown through the following ways,
- Using
hidden
property in row, you can hide/show the rows at initial load. - Using
hideRow
method, you can hide the rows by specifying the start and end row index, set the last argumenthide
asfalse
to unhide the hidden rows. - Right-click on the row header and select the desired option from context menu
Column
The columns can be hidden or shown through following ways,
- Using
hidden
property in columns, you can hide/show the columns at initial load. - Using
hideColumn
method, you can hide the columns by specifying the start and end column index, set the last argumenthide
asfalse
to unhide the hidden columns. - Right-click on the column header and select the desired option from context menu
The following code example shows the hide/show rows and columns operation in the spreadsheet.
<template>
<ejs-spreadsheet ref="spreadsheet" :created="created" :showFormulaBar="false"
:showSheetTabs="false" :showRibbon="false">
<e-sheets>
<e-sheet>
<e-ranges>
<e-range :dataSource="dataSource"></e-range>
</e-ranges>
<e-columns>
<e-column :width=150></e-column>
<!-- Hiding the 1st and 2nd column index through property binding -->
<e-column :width=100 :hidden="true"></e-column>
<e-column :width=100 :hidden="true"></e-column>
<e-column :width=80></e-column>
<e-column :width=80></e-column>
<e-column :width=80></e-column>
<e-column :width=80></e-column>
<e-column :width=80></e-column>
</e-columns>
<e-rows>
<e-row index=2 :hidden="true"></e-row>
<e-row :hidden="true"></e-row>
</e-rows>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>
</template>
<script>
import Vue from "vue";
import { SpreadsheetPlugin } from "@syncfusion/ej2-vue-spreadsheet";
import { data } from './data.js';
Vue.use(SpreadsheetPlugin);
export default {
data: () => {
return {
dataSource: data,
}
},
methods: {
created: function () {
var spreadsheet = this.$refs.spreadsheet;
spreadsheet.cellFormat({ fontWeight: 'bold', textAlign: 'center' }, 'A1:H1');
// Unhide the 2nd index hidden column
spreadsheet.hideColumn(1, 1, false);
// Unhide the 3rd index hidden row
spreadsheet.hideRow(3, 3, false);
// Hiding the 6th index column
spreadsheet.hideColumn(6);
// Hiding the 8th and 9th index row
spreadsheet.hideRow(8, 9);
spreadsheet.cellFormat({ textAlign: 'center' }, 'D2:H11');
}
}
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-spreadsheet/styles/material.css";
@import '../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../node_modules/@syncfusion/ej2-buttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';
@import '../node_modules/@syncfusion/ej2-inputs/styles/material.css';
@import '../node_modules/@syncfusion/ej2-navigations/styles/material.css';
@import '../node_modules/@syncfusion/ej2-popups/styles/material.css';
@import '../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-grids/styles/material.css';
@import "../node_modules/@syncfusion/ej2-spreadsheet/styles/material.css";
</style>
Size
You can change the size of rows and columns in the spreadsheet by using setRowsHeight and setColumnsWidth methods.
Row
You can change the height of single or multiple rows by using the setRowsHeight method.
You can provide the following type of ranges to the method:
- Single row range:
['2:2']
- Multiple rows range:
['1:100']
- Multiple rows with discontinuous range:
['1:10', '15:25', '30:40']
- Multiple rows with different sheets:
[Sheet1!1:50, 'Sheet2!1:50', 'Sheet3!1:50']
The following code example shows how to change the height for single/multiple rows in the spreadsheet.
<template>
<ejs-spreadsheet ref="spreadsheet" :created="created">
<e-sheets>
<e-sheet>
<e-ranges>
<e-range :dataSource="dataSource"></e-range>
</e-ranges>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>
</template>
<script>
import Vue from "vue";
import { SpreadsheetPlugin } from "@syncfusion/ej2-vue-spreadsheet";
import { data } from './data.js';
Vue.use(SpreadsheetPlugin);
export default {
data: () => {
return {
dataSource: data,
}
},
methods: {
created: function () {
var spreadsheet = this.$refs.spreadsheet;
// To change height for single row
spreadsheet.setRowsHeight(40, ['2']);
// To change height for multiple rows
spreadsheet.setRowsHeight(40, ['4:8', '10:12']);
}
}
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-spreadsheet/styles/material.css";
@import '../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../node_modules/@syncfusion/ej2-buttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';
@import '../node_modules/@syncfusion/ej2-inputs/styles/material.css';
@import '../node_modules/@syncfusion/ej2-navigations/styles/material.css';
@import '../node_modules/@syncfusion/ej2-popups/styles/material.css';
@import '../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-grids/styles/material.css';
@import "../node_modules/@syncfusion/ej2-spreadsheet/styles/material.css";
</style>
Column
You can change the width of single or multiple columns by using the setColumnsWidth method.
You can provide the following type of ranges to the method:
- Single column range:
['F:F']
- Multiple columns range:
['A:F']
- Multiple columns with discontinuous range:
['A:C', 'G:I', 'K:M']
- Multiple columns with different sheets:
[Sheet1!A:H, 'Sheet2!A:H', 'Sheet3!A:H']
The following code example shows how to change the width for single/multiple columns in the spreadsheet.
<template>
<ejs-spreadsheet ref="spreadsheet" :created="created">
<e-sheets>
<e-sheet>
<e-ranges>
<e-range :dataSource="dataSource"></e-range>
</e-ranges>
</e-sheet>
</e-sheets>
</ejs-spreadsheet>
</template>
<script>
import Vue from "vue";
import { SpreadsheetPlugin } from "@syncfusion/ej2-vue-spreadsheet";
import { data } from './data.js';
Vue.use(SpreadsheetPlugin);
export default {
data: () => {
return {
dataSource: data,
}
},
methods: {
created: function () {
var spreadsheet = this.$refs.spreadsheet;
// To change width of single column
spreadsheet.setColumnsWidth(100, ['F']);
// To change width of multiple columns
spreadsheet.setColumnsWidth(120, ['A:C', 'G:I', 'K:M']);
}
}
}
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-spreadsheet/styles/material.css";
@import '../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../node_modules/@syncfusion/ej2-buttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';
@import '../node_modules/@syncfusion/ej2-inputs/styles/material.css';
@import '../node_modules/@syncfusion/ej2-navigations/styles/material.css';
@import '../node_modules/@syncfusion/ej2-popups/styles/material.css';
@import '../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-grids/styles/material.css';
@import "../node_modules/@syncfusion/ej2-spreadsheet/styles/material.css";
</style>
Note
You can refer to our Vue Spreadsheet feature tour page for its groundbreaking feature representations. You can also explore our Vue Spreadsheet example to knows how to present and manipulate data.