GridComponent

ejs-grid represents the VueJS Grid Component.

<ejs-grid :dataSource='data' allowPaging='true' allowSorting='true'></ejs-grid>

Properties

adaptiveUIMode

AdaptiveMode

One of the adaptiveUIMode enumeration that specifies the Adaptive Mode. The default value is Both.

Defaults to Both

aggregates

AggregateRowModel[]

Configures the Grid aggregate rows.

<template>
        <ejs-grid :dataSource='data'>
            <e-columns>
                <e-column field='OrderID' headerText='Order ID' textAlign='right' width=120></e-column>
                <e-column field='Freight' format='C2' width=150 textAlign='right'></e-column>
            </e-columns>
            <e-aggregates>
                <e-aggregate>
                    <e-columns>
                        <e-column format='C2' type="Sum" field="Freight" :footerTemplate='footerSum'></e-column>
                    </e-columns>
                </e-aggregate>
          </e-aggregates>
        </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Aggregate } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
      footerSum: function () {
        return  { template : Vue.component('sumTemplate', {template: `<span>Sum: {{data.Sum}}</span>`, data () {return { data: {}}; }})
          }}};
  },
  provide: { grid: [Aggregate] }
}
</script>

Check the Aggregates for its configuration.

Defaults to []

allowExcelExport

boolean

If allowExcelExport set to true, then it will allow the user to export grid to Excel file.

Check the ExcelExport to configure exporting document.

<template>
  <div id="app">
    <ejs-grid ref="grid" id="Grid" :dataSource="data" :toolbar="toolbarOptions" :allowExcelExport="true">
    </ejs-grid>
  </div>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Toolbar, ExcelExport } from "@syncfusion/ej2-vue-grids";
import { orderData } from "./dataSource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: orderData,
      toolbarOptions: ["ExcelExport"]
    };
  },
  provide: { grid: [Toolbar, ExcelExport] }
};
</script>

Defaults to false

allowFiltering

boolean

If allowFiltering set to true the filter bar will be displayed. If set to false the filter bar will not be displayed. Filter bar allows the user to filter grid records with required criteria.

Check the Filtering to customize its default behavior.

<template>
  <ejs-grid :dataSource="data" :allowFiltering="true"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Filter } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    };
  },
  provide: { grid: [Filter] }
};
</script>

Defaults to false

allowGrouping

boolean

If allowGrouping set to true, then it will allow the user to dynamically group or ungroup columns. Grouping can be done by drag and drop columns from column header to group drop area.

Check the Grouping to customize its default behavior.

<template>
  <ejs-grid :dataSource="data" :allowGrouping="true"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Group  } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    };
  },
  provide: { grid: [Group ] }
};
</script>

Defaults to false

allowKeyboard

boolean

Enables or disables the key board interaction of Grid.

Defaults to true

allowMultiSorting

boolean

If allowMultiSorting set to true, then it will allow the user to sort multiple column in the grid.

allowSorting should be true.

<template>
  <ejs-grid :dataSource="data" :allowSorting="true" :allowMultiSorting="true"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Sort } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    }; },
  provide: { grid: [Sort] }
};
</script>

Defaults to false

allowPaging

boolean

If allowPaging is set to true, the pager renders at the footer of the Grid. It is used to handle page navigation in the Grid.

Check the Paging to configure the grid pager.

Defaults to false

allowPdfExport

boolean

If allowPdfExport set to true, then it will allow the user to export grid to Pdf file.

Check the Pdfexport to configure the exporting document.

<template>
<ejs-grid :dataSource="data" :toolbar="toolbarOptions" :allowPdfExport="true"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Toolbar, PdfExport } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data,
      toolbarOptions: ["PdfExport"]
    }; },
  provide: { grid: [Toolbar, PdfExport] }
};
</script>

Defaults to false

allowReordering

boolean

If allowReordering is set to true, Grid columns can be reordered. Reordering can be done by drag and drop of a particular column from one index to another index.

If Grid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.

<template>
  <ejs-grid :dataSource="data" :allowReordering="true"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Reorder } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    }; },
  provide: { grid: [Reorder] }
};
</script>

Defaults to false

allowResizing

boolean

If allowResizing is set to true, Grid columns can be resized.

<template>
  <ejs-grid :dataSource="data" :allowResizing='true'></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Resize  } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    }; },
  provide: { grid: [Resize ] }
};
</script>

Defaults to false

allowRowDragAndDrop

boolean

If allowRowDragAndDrop is set to true, you can drag and drop grid rows at another grid.

<template>
  <ejs-grid :dataSource="data" :allowRowDragAndDrop="true"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, RowDD  } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    };  },
  provide: { grid: [RowDD ] }
};
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-grids/styles/material.css";
</style>
</script>

Defaults to false

allowSelection

boolean

If allowSelection is set to true, it allows selection of (highlight row) Grid records by clicking it.

<template>
  <ejs-grid :dataSource="data" :allowSelection="true"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    }; },
};
</script>
</script>

Defaults to true

allowSorting

boolean

If allowSorting is set to true, it allows sorting of grid records when column header is clicked.

Check the Sorting to customize its default behavior.

<template>
  <ejs-grid :dataSource="data" :allowSorting="true"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Sort } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    }; },
  provide: { grid: [Sort] }
};
</script>

Defaults to false

allowTextWrap

boolean

If allowTextWrap set to true, then text content will wrap to the next line when its text content exceeds the width of the Column Cells.

<template>
  <ejs-grid :dataSource="data" allowTextWrap="true"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    }; }
};
</script>

Defaults to false

autoFit

boolean

If autoFit set to true, then it will auto fit the columns based on given width.

Defaults to false

childGrid

GridModel

Defines Grid options to render child Grid. It requires the queryString for parent and child relationship.

Check the Child Grid for its configuration.

Defaults to ”

clipMode

ClipMode

Defines the mode of clip. The available modes are, Clip: Truncates the cell content when it overflows its area. Ellipsis: Displays ellipsis when the cell content overflows its area. EllipsisWithTooltip: Displays ellipsis when the cell content overflows its area, also it will display the tooltip while hover on ellipsis is applied.

<template>
  <ejs-grid :dataSource="data" clipMode="Clip"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    };
  },
};
</script>

Defaults to Ellipsis

clipboardModule

Clipboard

clipboardModule is used to handle Grid copy action.

columnChooserSettings

ColumnChooserSettingsModel

Configures the column chooser in the Grid.

Defaults to { columnChooserOperator: ‘startsWith’ }

columnMenuItems

ColumnMenuItem[] | ColumnMenuItemModel[]

columnMenuItems defines both built-in and custom column menu items.

The available built-in items are,

• AutoFitAll - Auto fit the size of all columns.
• AutoFit - Auto fit the current column.
• Group - Group by current column.
• Ungroup - Ungroup by current column.
• SortAscending - Sort the current column in ascending order.
• SortDescending - Sort the current column in descending order.
• Filter - Filter options will show based on filterSettings property like checkbox filter, excel filter, menu filter.

Defaults to null

columnMenuModule

ColumnMenu

The columnMenuModule is used to manipulate column menu items and its action in the Grid.

columnQueryMode

ColumnQueryModeType

columnQueryModeprovides options to retrive data from the datasource.Their types are

• All: It Retrives whole datasource.
• Schema: Retrives data for all the defined columns in grid from the datasource.
• ExcludeHidden: Retrives data only for visible columns of grid from the dataSource.

Defaults to All

columns

Column[] | string[] | ColumnModel[]

Defines the schema of dataSource. If the columns declaration is empty or undefined then the columns are automatically generated from data source.

<template>
  <ejs-grid :dataSource="data">
    <e-columns>
      <e-column field="OrderID" headerText="Order ID" textAlign="right" width="120"></e-column>
      <e-column field="Freight" format="C2" width="150" textAlign="right"></e-column>
    </e-columns>
  </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    }; },
};
</script>

Defaults to []

contextMenuItems

ContextMenuItem[] | ContextMenuItemModel[]

contextMenuItems defines both built-in and custom context menu items.

The available built-in items are,

• AutoFitAll - Auto fit the size of all columns.
• AutoFit - Auto fit the current column.
• Group - Group by current column.
• Ungroup - Ungroup by current column.
• Edit - Edit the current record.
• Delete - Delete the current record.
• Save - Save the edited record.
• Cancel - Cancel the edited state.
• Copy - Copy the selected records.
• PdfExport - Export the grid as Pdf format.
• ExcelExport - Export the grid as Excel format.
• CsvExport - Export the grid as CSV format.
• SortAscending - Sort the current column in ascending order.
• SortDescending - Sort the current column in descending order.
• FirstPage - Go to the first page.
• PrevPage - Go to the previous page.
• LastPage - Go to the last page.
• NextPage - Go to the next page.

Defaults to null

contextMenuModule

ContextMenu

The contextMenuModule is used to handle context menu items and its action in the Grid.

cssClass

string

Defines the own class for the grid element.

Defaults to ”

currentAction

ActionArgs

Gets or sets the current action details.

Defaults to {}

currentViewData

Object[]

Gets the currently visible records of the Grid.

Defaults to []

dataSource

Object | DataManager | DataResult

It is used to render grid table rows. If the dataSource is an array of JavaScript objects, then Grid will create instance of DataManager from this dataSource. If the dataSource is an existing DataManager, the Grid will not initialize a new one.

Check the available Adaptors to customize the data operation.

<template>
  <ejs-grid :dataSource="data"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    }; },
};
</script>

Defaults to []

detailTemplate

string | Function

The detail template allows you to show or hide additional information about a particular row.

It accepts either the template string or the HTML element ID.

Defaults to null

editModule

Edit

The editModule is used to handle Grid content manipulation.

editSettings

EditSettingsModel

Configures the edit settings.

<template>
  <ejs-grid :dataSource="data" :editSettings="editSettings" :toolbar="toolbar"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Edit, Toolbar } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data,
      editSettings: {allowEditing: true, allowAdding: true, allowDeleting: true },
      toolbar: ["Add", "Edit", "Delete", "Update", "Cancel"]
    }; },
  provide: { grid: [Edit, Toolbar] }
};
</script>

Defaults to { allowAdding: false, allowEditing: false, allowDeleting: false, mode:‘Normal’,allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }

ej2StatePersistenceVersion

string

Defines the version for Grid persistence.

Defaults to ”

emptyRecordTemplate

string | Function

The empty record template that renders customized element or text or image instead of displaying the empty record message in the grid.

It accepts either the template string or the HTML element ID.

Defaults to null

enableAdaptiveUI

boolean

If enableAdaptiveUI set to true the grid filter, sort, and edit dialogs render adaptively.

Defaults to false

enableAltRow

boolean

If enableAltRow is set to true, the grid will render with e-altrow CSS class to the alternative tr elements.

Check the AltRow to customize the styles of alternative rows.

<template>
  <ejs-grid :dataSource="data" :enableAltRow="false"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    }; },
};
</script>

Defaults to true

enableAutoFill

boolean

If enableAutoFill is set to true, then the auto fill icon will displayed on cell selection for copy cells. It requires the selection mode to be Cell and cellSelectionMode to be Box.

<template>
  <ejs-grid :dataSource="data" :enableAutoFill="true" :selectionSettings="selectionOptions"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data,
      selectionOptions: { cellSelectionMode: "Box", mode: "Cell" }
    }; }
};
</script>

Defaults to false

enableColumnVirtualization

boolean

If enableColumnVirtualization set to true, then the Grid will render only the columns visible within the view-port and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Grid.

<template>
  <ejs-grid :dataSource="data" height=300 :enableVirtualization="true" :enableColumnVirtualization="true"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, VirtualScroll  } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    }; },
  provide: { grid: [VirtualScroll] }
};
</script>

Defaults to false

enableHeaderFocus

boolean

If enableHeaderFocus set to true, then header element will be focused when focus moves to grid.

Defaults to false

enableHover

boolean

If enableHover is set to true, the row hover is enabled in the Grid.

<template>
  <ejs-grid :dataSource="data" :enableHover='true' ></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data,
    }; }
};
</script>

Defaults to true

enableHtmlSanitizer

boolean

Specifies whether to display or remove the untrusted HTML values in the Grid component. If ‘enableHtmlSanitizer’ set to true, the component will sanitize any suspected untrusted strings and scripts before rendering them.

Defaults to false

enableImmutableMode

boolean

If enableImmutableMode is set to true, the grid will reuse old rows if it exists in the new result instead of full refresh while performing the grid actions.

Defaults to false

enableInfiniteScrolling

boolean

If enableInfiniteScrolling set to true, then the data will be loaded in Grid when the scrollbar reaches the end. This helps to load large dataset in Grid.

<template>
  <ejs-grid :dataSource="data" height="300" :enableInfiniteScrolling="true"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, VirtualScroll } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    }; },
  provide: { grid: [VirtualScroll] }
};
</script>

Defaults to false

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

enableStickyHeader

boolean

If ‘enableStickyHeader’ set to true, then the user can able to make the column headers visible when the document is scrolled.

Defaults to false

enableVirtualMaskRow

boolean

Specifies the shimmer effect for Grid virtual and infinite scrolling.

Defaults to true

enableVirtualization

boolean

If enableVirtualization set to true, then the Grid will render only the rows visible within the view-port and load subsequent rows on vertical scrolling. This helps to load large dataset in Grid.

<template>
  <ejs-grid :dataSource="data" height=300 :enableVirtualization="true"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, VirtualScroll  } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data
    }; },
  provide: { grid: [VirtualScroll] }
};
</script>

Defaults to false

excelExportModule

ExcelExport

The excelExportModule is used to handle Excel exporting feature in the Grid.

exportGrids

string[]

Defines the id of the grids that needs to be exported

Defaults to null

filterModule

Filter

The filterModule is used to manipulate filtering in the Grid.

filterSettings

FilterSettingsModel

Configures the filter settings of the Grid.

<template>
  <ejs-grid :dataSource="data" :allowFiltering="true" :filterSettings="filterOptions"></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Filter } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data,
      filterOptions: { type: "Menu" }
    }; },
  provide: { grid: [Filter] }
};
</script>
<style>
@import "../node_modules/@syncfusion/ej2-vue-grids/styles/material.css";
</style>

Defaults to {columns: [], type: ‘FilterBar’, mode: ‘Immediate’, showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}

frozenColumns

number

Gets or sets the number of frozen columns.

<template>
  <ejs-grid :dataSource="data" :frozenColumns=2 ></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Freeze } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data,
    }; },
  provide: { grid: [Freeze] }
};
</script>

Defaults to 0

frozenRows

number

Gets or sets the number of frozen rows.

<template>
  <ejs-grid :dataSource="data" :frozenRows=2></ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Freeze } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource" ;
Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: data,
    }; },
  provide: { grid: [Freeze] }
};
</script>

Defaults to 0

gridLines

GridLine

Defines the mode of grid lines. The available modes are,

• Both: Displays both horizontal and vertical grid lines.
• None: No grid lines are displayed.
• Horizontal: Displays the horizontal grid lines only.
• Vertical: Displays the vertical grid lines only.
• Default: Displays grid lines based on the theme.

<template>
    <ejs-grid :dataSource='data' gridLines='Both'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
    };
  },
}
</script>

Defaults to Default

groupModule

Group

The groupModule is used to manipulate grouping behavior in the Grid.

groupSettings

GroupSettingsModel

Configures the group settings.

<template>
    <ejs-grid :dataSource='data' :allowGrouping='true' :groupSettings='groupOptions'>
        <e-columns>
            <e-column field='OrderID' headerText='Order ID' textAlign='right' width=120></e-column>
            <e-column field='Freight' format='C2' width=150 textAlign='right'></e-column>
        </e-columns>
    </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Group } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
      groupOptions: { columns: ['Freight'] }
    };
  },
  provide: { grid: [Group] }
}
</script>

Defaults to {showDropArea: true, showToggleButton: false, showGroupedColumn: false, showUngroupButton: true, columns: []}

height

string | number

Defines the scrollable height of the grid content.

<template>
    <ejs-grid :dataSource='data' height='400'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
    };
  },
}
</script>

Defaults to ‘auto’

hierarchyPrintMode

HierarchyGridPrintMode

Defines the hierarchy grid print modes. The available modes are

• Expanded - Prints the master grid with expanded child grids.
• All - Prints the master grid with all the child grids.
• None - Prints the master grid alone.

Defaults to Expanded

infiniteScrollModule

InfiniteScroll

The infiniteScrollModule is used to manipulate infinite scrolling in the Grid.

infiniteScrollSettings

InfiniteScrollSettingsModel

Configures the infinite scroll settings.

<template>
   <ejs-grid :dataSource='data' height=300 :enableInfiniteScrolling='true' :pageSettings='pageOptions' :infiniteScrollSettings='infiniteOptions'>
   </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, InfiniteScroll } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
      pageOptions: { pageSize: 50 },
      infiniteScrollSettings: { enableCache: true, maxBlocks: 3, initialBlocks: 3 }
    };
  },
  provide: { grid: [InfiniteScroll] }
}
</script>

Defaults to { enableCache: false, maxBlocks: 5, initialBlocks: 5 }

keyboardModule

KeyboardEvents

The keyboardModule is used to manipulate keyboard interactions in the Grid.

loadingIndicator

LoadingIndicatorModel

Configures the Loading Indicator of the Grid.

Defaults to {indicatorType: ‘Spinner’}

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to ”

pageSettings

PageSettingsModel

Configures the pager in the Grid.

<template>
    <ejs-grid :dataSource='data' :allowPaging="true" :pageSettings='pageOptions'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Page } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
      pageOptions: { currentPage: 1, pageSize: 12, pageCount: 8, pageSizes: true },
    };
  },
  provide: { grid: [Page] }
}
</script>

Defaults to {currentPage: 1, pageSize: 12, pageCount: 8, enableQueryString: false, pageSizes: false, template: null}

pagerModule

Page

The pagerModule is used to manipulate paging in the Grid.

pagerTemplate

string | Function

It used to render pager template

Defaults to null

parentDetails

ParentDetails

Gets the parent Grid details.

Defaults to {}

pdfExportModule

PdfExport

The pdfExportModule is used to handle PDF exporting feature in the Grid.

printMode

PrintMode

Defines the print modes. The available print modes are

• AllPages: Prints all pages of the Grid.
• CurrentPage: Prints the current page of the Grid.

<template>
    <ejs-grid :dataSource='data' printMode='CurrentPage' :allowPaging="true" :toolbar='toolbarOptions'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Page, Toolbar } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
      toolbarOptions: ['Print'],
    };
  },
  provide: { grid: [Page, Toolbar] }
}
</script>

Defaults to AllPages

printModule

Print

The printModule is used to handle the printing feature of the Grid.

query

Query

Defines the external Query that will be executed along with data processing.

<template>
    <ejs-grid :dataSource='data' :query='query'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { DataManager, ODataAdaptor, Query } from "@syncfusion/ej2-data";

Vue.use(GridPlugin);
export default {
  data() {
    let SERVICE_URI = "https://js.syncfusion.com/demos/ejServices/Wcf/Northwind.svc/Orders?$top=7";
    return {
      data: new DataManager({
        url: SERVICE_URI,
        adaptor: new ODataAdaptor()
      }),
      query: new Query().addParams('ej2grid', 'true');
    };
  },
}
</script>

Defaults to null

queryString

string

Defines the relationship between parent and child datasource. It acts as the foreign key for parent datasource.

Defaults to ”

reorderModule

Reorder

The reorderModule is used to manipulate reordering in the Grid.

requireTemplateRef

boolean

• If requireTemplateRef is set to false in the load event, then the template element can’t be accessed in grid queryCellInfo, and rowDataBound events.
• By default, React’s grid queryCellInfo and rowDataBound events allow access to the template element.
• Avoid accessing the template elements in the grid queryCellInfo and rowDataBound events to improve rendering performance by setting this value as false.

Defaults to true

resizeSettings

ResizeSettingsModel

Defines the resizing behavior of the Grid.

Defaults to {mode:“Normal”}

rowDragAndDropModule

RowDD

The rowDragAndDropModule is used to manipulate row reordering in the Grid.

rowDropSettings

RowDropSettingsModel

Configures the row drop settings.

Defaults to {targetID: ”}

rowHeight

number

Defines the height of Grid rows.

<template>
    <ejs-grid :dataSource='data' rowHeight='20'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
    };
  },
}
</script>

Defaults to null

rowRenderingMode

RowRenderingDirection

Defines the grid row elements rendering direction. The available directions are,

• Horizontal: Renders the grid row elements in the horizontal direction
• Vertical: Renders the grid row elements in the vertical direction

Defaults to Horizontal

rowTemplate

string | Function

The row template that renders customized rows from the given template. By default, Grid renders a table row for every data source item.

• It accepts either template string or HTML element ID.
• The row template must be a table row. Check the Row Template customization.

Defaults to null

scrollModule

Scroll

The scrollModule is used to manipulate scrolling in the Grid.

searchModule

Search

The searchModule is used to manipulate searching in the Grid.

searchSettings

SearchSettingsModel

Configures the search behavior in the Grid.

<template>
    <ejs-grid :dataSource='data' :searchSettings='searchOptions' :toolbar='toolbarOptions'>
        <e-columns>
            <e-column field='CustomerID' headerText='Customer ID' width=120></e-column>
            <e-column field='Freight' format='C2' width=150 textAlign='right'></e-column>
        </e-columns>
    </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Search, Toolbar } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
      toolbarOptions: ['Search'],
      searchOptions: { fields: ['CustomerID'], key: 'Ha' }
    };
  },
  provide: { grid: [Search, Toolbar] }
}
</script>

Defaults to { ignoreCase: true, fields: [], operator: ‘contains’, key: ” }

selectedRowIndex

number

The selectedRowIndex allows you to select a row at initial rendering. You can also get the currently selected row index.

<template>
    <ejs-grid :dataSource='data' :selectedRowIndex='1'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
    };
  },
}
</script>

Defaults to -1

selectionModule

Selection

The selectionModule is used to manipulate selection behavior in the Grid.

selectionSettings

SelectionSettingsModel

Configures the selection settings.

<template>
    <ejs-grid :dataSource='data' :selectionSettings='selectionOptions'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
      selectionOptions: { mode: 'Cell', cellSelectionMode: 'Box', type: 'Multiple' }
    };
  },
}
</script>

Defaults to {mode: ‘Row’, cellSelectionMode: ‘Flow’, type: ‘Single’}

showColumnChooser

boolean

If showColumnChooser is set to true, it allows you to dynamically show or hide columns.

Check the ColumnChooser for its configuration.

<template>
    <ejs-grid :dataSource='data' :showColumnChooser='true' :toolbar='toolbarOptions'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, ColumnChooser, Toolbar } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
      toolbarOptions: ['ColumnChooser']
    };
  },
  provide: { grid: [ColumnChooser, Toolbar] }
}
</script>

Defaults to false

showColumnMenu

boolean

If showColumnMenu set to true, then it will enable the column menu options in each columns.

Check the Column menu for its configuration.

<template>
    <ejs-grid :dataSource='data' :showColumnMenu='true'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, ColumnMenu } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
    };
  },
  provide: { grid: [ColumnMenu] }
}
</script>

Defaults to false

showHider

ShowHide

The showHider is used to manipulate column’s show/hide operation in the Grid.

Defaults to ”

sortModule

Sort

The sortModule is used to manipulate sorting in the Grid.

sortSettings

SortSettingsModel

Configures the sort settings.

<template>
    <ejs-grid :dataSource='data' :allowSorting='true' :sortSettings='sortOptions' >
        <e-columns>
            <e-column field='OrderID' headerText='Order ID' textAlign='right' width=120></e-column>
            <e-column field='Freight' format='C2' width=150 textAlign='right'></e-column>
        </e-columns>
    </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Sort } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
      sortOptions: { columns: [{ field: 'OrderID', direction: 'Ascending' }] }
    };
  },
  provide: { grid: [Sort] }
}
</script>

Defaults to {columns:[]}

textWrapSettings

TextWrapSettingsModel

Configures the text wrap in the Grid.

<template>
    <ejs-grid :dataSource='data' :allowTextWrap='true' :textWrapSettings='textOption'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
      textOption:  { wrapMode: 'Both' },
    };
  },
}
</script>

Defaults to {wrapMode:“Both”}

toolbar

[]

toolbar defines the ToolBar items of the Grid. It contains built-in and custom toolbar items. If a string value is assigned to the toolbar option, it is considered as the template for the whole Grid ToolBar. If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the Grid’s Toolbar.

The available built-in ToolBar items are:

• Add: Adds a new record.
• Edit: Edits the selected record.
• Update: Updates the edited record.
• Delete: Deletes the selected record.
• Cancel: Cancels the edit state.
• Search: Searches records by the given key.
• Print: Prints the Grid.
• ExcelExport - Export the Grid to Excel(excelExport() method manually to make export.)
• PdfExport - Export the Grid to PDF(pdfExport() method manually to make export.)

• CsvExport - Export the Grid to CSV(csvExport() method manually to make export.)
  
  The following code example implements the custom toolbar items.

  Check the Toolbar to customize its default items.

<template>
    <ejs-grid :dataSource='data' :toolbar='toolbarOptions'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Toolbar } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
      toolbarOptions: ['Search','Print']
    };
  },
  provide: { grid: [Toolbar] }
}
</script>

Defaults to null

toolbarModule

Toolbar

The toolbarModule is used to manipulate ToolBar items and its action in the Grid.

toolbarTemplate

string | Function

It used to render toolbar template

Defaults to null

width

string | number

Defines the Grid width.

<template>
    <ejs-grid :dataSource='data' width='700'> </ejs-grid>
</template>
<script>
import Vue from "vue";
import { GridPlugin } from "@syncfusion/ej2-vue-grids";
import { gridData } from './data';

Vue.use(GridPlugin);
export default {
  data() {
    return {
      data: gridData,
    };
  },
}
</script>

Defaults to ‘auto’

Methods

addRecord

Adds a new record to the Grid. Without passing parameters, it adds empty rows.

editSettings.allowEditing should be true.

Returns void

autoFitColumns

Changes the column width to automatically fit its content to ensure that the width shows the content without wrapping/hiding.

• This method ignores the hidden columns.
• Uses the autoFitColumns method in the dataBound event to resize at initial rendering.
• By specifying the start row index and end row index, providing the range within which the maximum width for that column should be considered when applying autoFitColumns.
• The width of header rows is always calculated. If the width of a header row exceeds the specified range, its width will be allocated to the specific content rows.

Returns void

batchAsyncUpdate

Apply the changes to the Grid in one batch after 50ms without refreshing the rows.

Returns void

batchUpdate

Apply the changes to the Grid without refreshing the rows.

Returns void

calculatePageSizeByParentHeight

Calculates the page size by parent element height

Returns number

changeDataSource

Remove the existing columns along with the grid actions like sorting, filtering, searching, grouping, aggregate, etc., and grid will refresh with new columns based on the updated new data source.

• If no columns are specified while changing the data source, then the columns are auto generated in the Grid based on the list of columns in the updated data source.

Returns void

clearCellSelection

Deselects the currently selected cells.

Returns void

clearFiltering

Clears all the filtered rows of the Grid.

Returns void

clearGrouping

Clears all the grouped columns of the Grid.

Returns void

clearRowSelection

Deselects the currently selected rows.

Returns void

clearSelection

Deselects the current selected rows and cells.

Returns void

clearSorting

Clears all the sorted columns of the Grid.

Returns void

closeEdit

Cancels edited state.

Returns void

copy

Copy the selected rows or cells data into clipboard.

Returns void

csvExport

Export Grid data to CSV file.

Returns Promise

deleteRecord

Delete a record with Given options. If fieldname and data is not given then grid will delete the selected record.

editSettings.allowDeleting should be true.

Returns void

deleteRow

Delete any visible row by TR element.

Returns void

destroy

Destroys the component (detaches/removes all event handlers, attributes, classes, and empties the component element).

Returns void

destroyTemplate

Destroys the given template reference.

Returns void

detailCollapseAll

Collapses all the detail rows of the Grid.

Returns void

detailExpandAll

Expands all the detail rows of the Grid.

Returns void

editCell

Changes a particular cell into edited state based on the row index and field name provided in the batch mode.

Returns void

enableToolbarItems

Enables or disables ToolBar items.

Returns void

endEdit

If Grid is in editable state, you can save a record by invoking endEdit.

Returns void

excelExport

Export Grid data to Excel file(.xlsx).

Returns Promise

filterByColumn

Filters grid row by column name with the given options.

Returns void

getBatchChanges

Gets the added, edited,and deleted data before bulk save to the DataSource in batch mode.

Returns Object

getCellFromIndex

Gets a cell by row and column index.

Returns Element

getColumnByField

Gets a Column by column name.

Returns Column

getColumnByUid

Gets a column by UID.

Returns Column

getColumnFieldNames

Gets the collection of column fields.

Returns string[]

getColumnHeaderByField

Gets a column header by column name.

Returns Element

getColumnHeaderByIndex

Gets a column header by column index.

Returns Element

getColumnHeaderByUid

Gets a column header by UID.

Returns Element

getColumnIndexByField

Gets a column index by column name.

Returns number

getColumnIndexByUid

Gets a column index by UID.

Returns number

getColumns

Gets the columns from the Grid.

Returns Column[]

getContent

Gets the content div of the Grid.

Returns Element

getContentTable

Gets the content table of the Grid.

Returns Element

getCurrentViewRecords

Get current visible data of grid.

Returns Object[]

getDataModule

Gets the data module.

Returns Data

getDataRows

Gets all the Grid’s data rows.

Returns Element[]

getFilterUIInfo

Get the current Filter operator and field.

Returns FilterUI

getFilteredRecords

Get all filtered records from the Grid and it returns array of objects for the local dataSource, returns a promise object if the Grid has remote data.

Returns Object[] | Promise

getFooterContent

Gets the footer div of the Grid.

Returns Element

getFooterContentTable

Gets the footer table element of the Grid.

Returns Element

getForeignKeyColumns

Gets the foreign columns from Grid.

Returns Column[]

getFrozenDataRows

Gets all the Grid’s frozen table data rows.

Returns Element[]

getFrozenLeftColumnHeaderByIndex

Gets a frozen left column header by column index.

Returns Element

getFrozenRightCellFromIndex

Gets a frozen right table cell by row and column index.

Returns Element

getFrozenRightColumnHeaderByIndex

Gets a frozen right column header by column index.

Returns Element

getFrozenRightDataRows

Gets all the Grid’s frozen right table data rows.

Returns Element[]

getFrozenRightRowByIndex

Gets a frozen right tables row element by index.

Returns Element

getFrozenRightRows

Gets the Grid’s frozen right content rows from frozen grid.

Returns Element[]

getFrozenRowByIndex

Gets a frozen tables row by index.

Returns Element

getHeaderContent

Gets the header div of the Grid.

Returns Element

getHeaderTable

Gets the header table element of the Grid.

Returns Element

getHiddenColumns

Gets the hidden columns from the Grid.

Returns Column[]

getMovableCellFromIndex

Gets a movable table cell by row and column index.

Returns Element

getMovableColumnHeaderByIndex

Gets a movable column header by column index.

Returns Element

getMovableDataRows

Gets all the Grid’s movable table data rows.

Returns Element[]

getMovableRowByIndex

Gets a movable tables row by index.

Returns Element

getMovableRows

Gets the Grid’s movable content rows from frozen grid.

Returns Element[]

getPager

Gets the pager of the Grid.

Returns Element

getPersistData

Get the properties to be maintained in the persisted state.

Returns string

getPrimaryKeyFieldNames

Get the names of the primary key columns of the Grid.

Returns string[]

getRowByIndex

Gets a row by index.

Returns Element

getRowIndexByPrimaryKey

Get row index by primary key or row data.

Returns number

getRowInfo

Get a row information based on cell

Returns RowInfo

getRows

Gets all the data rows of the Grid.

Returns Element[]

getSelectedColumnsUid

Gets the collection of selected columns uid.

Returns string[]

getSelectedRecords

Gets the collection of selected records.

Returns Object[]

getSelectedRowCellIndexes

Gets the collection of selected row and cell indexes.

Returns ISelectedCell[]

getSelectedRowIndexes

Gets the collection of selected row indexes.

Returns number[]

getSelectedRows

Gets the collection of selected rows.

Returns Element[]

getSummaryValues

To perform aggregate operation on a column.

Returns number

getUidByColumnField

Gets UID by column name.

Returns string

getVisibleColumns

Gets the visible columns from the Grid.

Returns Column[]

goToPage

Navigates to the specified target page.

Returns void

groupCollapseAll

Collapses all the grouped rows of the Grid.

Returns void

groupColumn

Groups a column by column name.

Returns void

groupExpandAll

Expands all the grouped rows of the Grid.

Returns void

hideColumns

Hides a column by column name.

Returns void

hideScroll

Hides the scrollbar placeholder of Grid content when grid content is not overflown.

Returns void

hideSpinner

By default, grid shows the spinner for all its actions. You can use this method to show spinner at your needed time.

Returns void

openColumnChooser

Column chooser can be displayed on screen by given position(X and Y axis).

Returns void

pdfExport

Export Grid data to PDF document.

Returns Promise

print

By default, prints all the pages of the Grid and hides the pager.

You can customize print options using the printMode.

Returns void

refresh

Refreshes the Grid header and content.

Returns void

refreshColumns

Refreshes the Grid column changes.

Returns void

refreshHeader

Refreshes the Grid header.

Returns void

reorderColumnByIndex

Changes the Grid column positions by field index. If you invoke reorderColumnByIndex multiple times, then you won’t get the same results every time.

Returns void

reorderColumnByTargetIndex

Changes the Grid column positions by field index. If you invoke reorderColumnByTargetIndex multiple times, then you will get the same results every time.

Returns void

reorderColumns

Changes the Grid column positions by field names.

Returns void

reorderRows

Changes the Grid Row position with given indexes.

Returns void

saveCell

Saves the cell that is currently edited. It does not save the value to the DataSource.

Returns void

search

Searches Grid records using the given key. You can customize the default search option by using the searchSettings.

Returns void

selectCell

Selects a cell by the given index.

Returns void

selectCells

Selects a collection of cells by row and column indexes.

Returns void

selectCellsByRange

Selects a range of cells from start and end indexes.

Returns void

selectRow

Selects a row by given index.

Returns void

selectRows

Selects a collection of rows by indexes.

Returns void

selectRowsByRange

Selects a range of rows from start and end row indexes.

Returns void

serverCsvExport

Sends a Post request to export Grid to CSV file in server side.

Returns void

serverExcelExport

Sends a Post request to export Grid to Excel file in server side.

Returns void

serverPdfExport

Sends a Post request to export Grid to Pdf file in server side.

Returns void

setCellValue

Updates particular cell value based on the given primary key value.

Primary key column must be specified using columns.isPrimaryKey property.

Returns void

setGridContent

Sets the content div of the Grid to replace the old Grid content.

Returns void

setGridContentTable

Sets the content table of the Grid to replace the old content table.

Returns void

setGridHeaderContent

Sets the header div of the Grid to replace the old header.

Returns void

setGridHeaderTable

Sets the header table of the Grid to replace the old one.

Returns void

setGridPager

Sets the pager of the Grid to replace the old pager.

Returns void

setRowData

Updates and refresh the particular row values based on the given primary key value.

Primary key column must be specified using columns.isPrimaryKey property.

Returns void

showAdaptiveFilterDialog

To manually show the vertical row mode filter dialog

Returns void

showAdaptiveSortDialog

To manually show the vertical row sort filter dialog

Returns void

showColumns

Shows a column by its column name.

Returns void

showSpinner

By default, grid shows the spinner for all its actions. You can use this method to show spinner at your needed time.

Returns void

sortColumn

Sorts a column with the given options.

Returns void

startEdit

Starts edit the selected row. At least one row must be selected before invoking this method. editSettings.allowEditing should be true.

<template>
  <div id="app">
    <button v-on:click="click">Click</button>
    <ejs-grid ref="grid" :dataSource='data' :editSettings='editSettings' height='270'>
            <e-columns>
                <e-column field='OrderID' textAlign='Right' :isPrimaryKey='true' width=100></e-column>
                <e-column field='CustomerID' headerText='Customer ID' width=120></e-column>
                <e-column field='ShipCountry' headerText='Ship Country' width=150></e-column>
            </e-columns>
        </ejs-grid>
  </div>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Edit  } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";

Vue.use(GridPlugin);

export default {
  data() {
    return {
      data: data,
      editSettings: { allowEditing: true, allowAdding: true, allowDeleting: true },
    };
  },
  methods: {
    click: function(args) {
    // Select Row in given index
    this.$refs.grid.ej2Instances.selectRow(1)
    // Edit the seleted row
    this.$refs.grid.ej2Instances.startEdit();
    }
  },
  provide: {
    grid: [Edit ]
  }
};
</script>

Returns void

ungroupColumn

Ungroups a column by column name.

<template>
  <div id="app">
    <button v-on:click="click">Click</button>
    <ejs-grid ref="grid" :dataSource="data" allowGrouping="true" :groupSettings='groupOptions' height="270">
      <e-columns>
        <e-column field="OrderID" headerText="Order ID" textAlign="Right" width="100"></e-column>
        <e-column field="CustomerID" headerText="Customer ID" width="120"></e-column>
        <e-column field="ShipCountry" headerText="Ship Country" width="150"></e-column>
      </e-columns>
    </ejs-grid>
  </div>
</template>
<script>
import Vue from "vue";
import { GridPlugin, Group } from "@syncfusion/ej2-vue-grids";
import { data } from "./datasource";

Vue.use(GridPlugin);

export default {
  data() {
    return {
      data: data,
      groupOptions: {columns: ['CustomerID']}
    };
  },
  methods: {
    click: function(args) {
      // Ungroup a column by field name.
      this.$refs.grid.ej2Instances.ungroupColumn("CustomerID");
    }
  },
  provide: {
    grid: [Group]
  }
};
</script>