createGridView

info

This functionality is available in the PRO edition only.

Description

Creates the Grid view in the scheduler

createGridView: (config: any) => void

Parameters

• config - (required) object - the configuration object of the Grid view

Example

scheduler.createGridView({
    name:"grid",
    fields:[
        {id:"id",       label:'Book Title',    width:'*',    align:'right',     sort:'str'},
        {id:"date",     label:'Author',     width:100},
        {id:"text",     label:'Votes',         width:200,    align:'left',    sort:'int'}
    ],
    from:new  Date(2000, 00, 01),
    to:new Date(2013, 00, 01)
});

Applicable views: Grid view

Related samples

• Grid view

Details

note

The method requires the grid_view plugin to be activated.

The configuration object of the Grid view can have the following properties:

name	(string) the view's id
fields	(array of objects) configures columns of the grid. Each object in the array specifies a single column and can take these properties: id - (string) the column's id. Must be set to the name of the related data property, you will load data from label - (string) the column's header width - (string) the column's width. You can use '' (asterisk) as the width value, to force a specific column to fill up the remaining width. If you use '' for several columns,they will share out the remaining width equally. align - (right, center or left) the horizontal text alignment valign - (top, middle or bottom) the vertical text alignment template - (function) the data template sort - ('int','date','str' or custom function) enables sorting for the column (triggered by a single click on the header) and assigns one of predefined sorting types or the name of a sorting function css - (string) the name of a css class that will be applied to the column
select	(boolean)enables/disables selection in the grid (by default, selection is enabled)
rowHeight	(number) the height of rows in the grid
paging	(boolean) enables/disables navigation with buttons in the grid (details)
unit	(minute, hour, day, week, month, year) the scrolling time unit. By default, 'month'
step	(number) the number of units scrolled at a time. By default, 1.
from	(Date) sets the left border of the allowable date range. Used to limit date range in the scheduler
to	(Date) sets the right border of the allowable date range. Used to limit date range in the scheduler

Related Guides

• Grid View