Vue UI Components Documentation

Vue DataTable Component

The DataTable component for Vue represents a lightweight Table widget built to easily replace your HTML Tables.

Prerequisites

Refer to Vue Getting Started before you start with this help topic.

Configuration

After you have created your App.vue file, here is how you should structure it:

The DataTable component for Vue requires the following import:

import JqxDataTable from "jqwidgets-scripts/jqwidgets-vue/vue_jqxdatatable.vue";

Add the jqxDataTable component to the components section of the the Vue class:

 components: {
    JqxDataTable
 },

Template

The App.vue has a <template> structural tag where we determine the application structure. There we will also set the tags for the new components - <JqxDataTable/>

<template>
    <JqxDataTable :width="width" :source="dataAdapter" :columns="columns"
                  :altRows="true" :pageable="true" :filterable="true">
    </JqxDataTable>
</template>

Properties

The properties of the <JqxDataTable/> component are defined in the data member of the Vue class. We should put them in the return object of the data function:

data: function () {
    return {
        width: 500,
        dataAdapter: new jqx.dataAdapter(this.source),
        columns: [
            { text: 'Supplier Name', cellsAlign: 'center', align: 'center', dataField: 'SupplierName', width: 250 },
            { text: 'Name', cellsAlign: 'center', align: 'center', dataField: 'ProductName', width: 250 },
            { text: 'Quantity', dataField: 'Quantity', cellsFormat: 'd', cellsAlign: 'center', align: 'center', width: 120 },
            { text: 'Price', dataField: 'Price', cellsFormat: 'c2', align: 'center', cellsAlign: 'center', width: 120 },
            { text: 'City', cellsAlign: 'center', align: 'center', dataField: 'City' }
        ]
    }
}

Events

The events in Vue are set as an attribute with @ prefix, for example:

<JqxDataTable @filter="onFilter()" :width="width" :source="dataAdapter" 
              :columns="columns":altRows="true" :pageable="true" :filterable="true">
</JqxDataTable>

All events that are bound to a component are implemented in the methods member of the Vue class.

methods: {
    onFilter: function () {
        // Do something...
    }
}

Methods

To use a component's method we should have its reference. In Vue we refer to a component by the special $refs property. Before that we need to add the desired name reference to that component:

<JqxDataTable ref="datatable"></JqxDataTable>

Here how you can use a component's method:

this.$refs.datatable.refresh();

methods: {
    // Add here all used callbacks and/or events
    onFilter: function () {
        // Do something on filter
        this.$refs.datatable.refresh();
    }
}

If we want to add additional methods we should also implement them in the methods member.

In case we need to do some precalculation or something else before the components are rendered, we should use the beforeCreate member. In this case:

beforeCreate: function () {
    // Add here any data where you want to transform before components be rendered
    this.source = {
        dataType: 'xml',
        dataFields: [
            { name: 'SupplierName', type: 'string' },
            { name: 'Quantity', type: 'number' },
            { name: 'OrderDate', type: 'date' },
            { name: 'OrderAddress', type: 'string' },
            { name: 'Freight', type: 'number' },
            { name: 'Price', type: 'number' },
            { name: 'City', type: 'string' },
            { name: 'ProductName', type: 'string' },
            { name: 'Address', type: 'string' }
        ],
        url: 'sampledata/orderdetailsextended.xml',
        root: 'DATA',
        record: 'ROW'
    };
}

If you have followed the above steps, you App.vue file would look like this:

App.vue:

DataTable Example

Run Code