\Hazaar\View\Widgets
Grid

Basic button widget.

Tags

Since

1.1

Summary
Methods Properties Constants
No constants
Properties
Inherited
$element
$element
Inherited
$name
$name
Inherited
$script
$script
Methods
__construct()
__construct($name)

Initialise a grid

Parameters

$name

No description

addfilter()
addfilter($datafield, $filtergroup)

Parameters

$datafield

No description

$filtergroup\Hazaar\View\Widgets\FilterGroup

No description

addgroup()
addgroup($datafield) : \\Hazaar\\Widgets\\JavaScript

Groups by a column.

Tags

Since

1.1

Parameters

$datafieldstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

addrow()
addrow($index, $data) : \\Hazaar\\Widgets\\JavaScript

Adds a row.

Tags

Since

1.1

Parameters

$index

No description

$data

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

altrows()
altrows($value) : \\Hazaar\\Widgets\\Grid

Enables or disables the alternating rows.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
altstart()
altstart($value) : \\Hazaar\\Widgets\\Grid

This property specifies the first alternating row.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
altstep()
altstep($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the alternating step

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
applyfilters()
applyfilters() : \\Hazaar\\Widgets\\JavaScript

Applies all filters to the Grid.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

autoheight()
autoheight($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the height of the grid to be equal to the summary height of the grid rows. This option should be set when the Grid is in paging mode.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
autoloadstate()
autoloadstate($value) : \\Hazaar\\Widgets\\Grid

Determines whether the Grid automatically loads its current state(if there’s already saved one). The Grid’s state is loaded when the page is refreshed.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
autoresizecolumn()
autoresizecolumn($column, $mode = null) : \\Hazaar\\Widgets\\JavaScript

Auto-resizes a column.

First Parameter – the column’s datafield. Second Parameter(optional:

  • ‘all’ – resize columns to fit to cells and column header. This is the default option.
  • ‘cells’ – resize columns to fit to the cells text.
  • ‘column’ – resize columns to fit to the columns text.

Tags

Since

1.1

Parameters

$columnstring

No description

$mode

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

autoresizecolumns()
autoresizecolumns($mode = null) : \\Hazaar\\Widgets\\JavaScript

Auto-resizes all columns.

Optional parameter:

  • ‘all’ – resize columns to fit to cells and column header. This is the default option.
  • ‘cells’ – resize columns to fit to the cells text.
  • ‘column’ – resize columns to fit to the columns text.

Tags

Since

1.1

Parameters

$mode

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

autorowheight()
autorowheight($value) : \\Hazaar\\Widgets\\Grid

This property works along with the “autoheight” property. When it is set to true, the height of the Grid rows is dynamically changed depending on the cell values.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
autosavestate()
autosavestate($value) : \\Hazaar\\Widgets\\Grid

Determines whether the Grid automatically saves its current state.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
autoshowcolumnsmenubutton()
autoshowcolumnsmenubutton($value) : \\Hazaar\\Widgets\\Grid

Sets or gets whether the columns menu button will be displayed only when the mouse cursor is over a columns header or will be always displayed.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
autoshowfiltericon()
autoshowfiltericon($value) : \\Hazaar\\Widgets\\Grid

Displays the filter icon only when the column is filtered. When the value of this property is set to false, all grid columns will display a filter icon when the filtering is enabled.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
autoshowloadelement()
autoshowloadelement($value) : \\Hazaar\\Widgets\\Grid

Determines whether the loading image should be displayed until the Grid’s data is loaded.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
begincelledit()
begincelledit($index, $cell) : \\Hazaar\\Widgets\\JavaScript

Shows the cell’s editor.

Tags

Since

1.1

Parameters

$index

No description

$cell

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

beginupdate()
beginupdate() : \\Hazaar\\Widgets\\JavaScript

Starts an update operation. This is appropriate when calling multiple methods or set multiple properties at once.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

clear()
clear() : \\Hazaar\\Widgets\\JavaScript

Clears the Grid contents.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

clearfilters()
clearfilters() : \\Hazaar\\Widgets\\JavaScript

Clears all filters from the Grid. You can call the method with optional boolean parameter. If the parameter is “true” or you call the method without parameter, the Grid will clear the filters and refresh the Grid(default behavior). If the parameter is “false”, the method will clear the filters without refreshing the Grid.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

cleargroups()
cleargroups() : \\Hazaar\\Widgets\\JavaScript

Clears all groups.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

clearselection()
clearselection() : \\Hazaar\\Widgets\\JavaScript

Clears the selection.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

closeablegroups()
closeablegroups($value) : \\Hazaar\\Widgets\\Grid

When the value of this property is true, a close button is displayed in each grouping column.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
collapseallgroups()
collapseallgroups() : \\Hazaar\\Widgets\\JavaScript

Collapses all groups.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

collapsegroup()
collapsegroup($index) : \\Hazaar\\Widgets\\JavaScript

Collapses a group.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

columns()
columns($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the Grid columns.

Tags

Since

1.1

Parameters

$valueArray

The value to set

Returns

\\Hazaar\\Widgets\\Grid
columnsheight()
columnsheight($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the columns height.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
columnsmenu()
columnsmenu($value) : \\Hazaar\\Widgets\\Grid

Enables or disables the columns dropdown menu.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
columnsmenuwidth()
columnsmenuwidth($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the columns menu width.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
columnsreorder()
columnsreorder($value) : \\Hazaar\\Widgets\\Grid

Enables or disables the columns reordering.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
columnsresize()
columnsresize($value) : \\Hazaar\\Widgets\\Grid

Enables or disables the columns resizing.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
deferreddatafields()
deferreddatafields($value) : \\Hazaar\\Widgets\\Grid

Determines the cell values displayed in a tooltip next to the scrollbar when the “scrollmode” is set to “deferred”.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
deleterow()
deleterow($index) : \\Hazaar\\Widgets\\JavaScript

Deletes a row. Returns a boolean value.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

editable()
editable($value) : \\Hazaar\\Widgets\\Grid

The editable property enables or disables the Grid editing feature.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
editmode()
editmode($value) : \\Hazaar\\Widgets\\Grid

The editmode property specifies the action that the end-user should make to open an editor.

Possible Values:

  • ‘click’ – Marks the clicked cell as selected and shows the editor. The editor’s value is equal to the cell’s value
  • ‘selectedcell’ – Marks the cell as selected. A second click on the selected cell shows the editor. The editor’s value is equal to the cell’s value
  • ‘dblclick’ – Marks the clicked cell as selected and shows the editor. The editor’s value is equal to the cell’s value
  • ‘programmatic’ – Cell editors are activated and deactivated only through the API

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Grid
enableanimations()
enableanimations($value) : \\Hazaar\\Widgets\\Grid

Enables or disables the grid animations.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
enablebrowserselection()
enablebrowserselection($value) : \\Hazaar\\Widgets\\Grid

Enables the text selection of the browser.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
enableellipsis()
enableellipsis($value) : \\Hazaar\\Widgets\\Grid

Determines whether ellipsis will be displayed, if the cells or columns content overflows.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
enablehover()
enablehover($value) : \\Hazaar\\Widgets\\Grid

Enables or disables the grid rows hover state.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
enablemousewheel()
enablemousewheel($value) : \\Hazaar\\Widgets\\Grid

Determines whether mousewheel scrolling is enabled.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
enablerowdetailsindent()
enablerowdetailsindent($value) : \\Hazaar\\Widgets\\Grid

When the enablerowdetailsindent is true, the content of a details row is displayed with left offset equal to the width of the row details column.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
enabletooltips()
enabletooltips($value) : \\Hazaar\\Widgets\\Grid

Enables or disables the grid tooltips.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
endcelledit()
endcelledit($index, $datafield, $cancel = null) : \\Hazaar\\Widgets\\JavaScript

Hides the edit cell’s editor and saves or cancels the changes.

Tags

Since

1.1

Parameters

$index

No description

$datafield

No description

$cancel

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

endupdate()
endupdate() : \\Hazaar\\Widgets\\JavaScript

Ends the update operation.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

ensurerowvisible()
ensurerowvisible($index) : \\Hazaar\\Widgets\\JavaScript

Scrolls to a row. The parameter is a bound index.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

expandallgroups()
expandallgroups() : \\Hazaar\\Widgets\\JavaScript

Expands all groups.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

expandgroup()
expandgroup($index) : \\Hazaar\\Widgets\\JavaScript

Expands a group.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

exportdata()
exportdata() : \\Hazaar\\Widgets\\JavaScript

Exports all rows loaded within the Grid to Excel, XML, CSV, TSV, HTML, PDF or JSON.

The first parameter of the export method determines the export’s type – ‘xls’, ‘xml’, ‘html’, ‘json’, ‘tsv’ or ‘csv’. The second parameter is the file’s name. If you don’t provide a file name, the Grid will export the data to a local variable. For example:

var data = $("#jqxgrid").jqxGrid('exportdata', 'json');

The third parameter is optional and determines whether to export the column’s header or not. Acceptable values are – true and false. By default, the exporter exports the columns header. The fourth parameter is optional and determines the array of rows to be exported. By default all rows are exported. Set null, if you want all rows to be exported. The fifth parameter is optional and determines whether to export hidden columns. Acceptable values are – true and false. By default, the exporter does not export the hidden columns. The last parameter is optional and determines the url of the export server. By default, the exporter is hosted on a jQWidgets server.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

filterable()
filterable($value) : \\Hazaar\\Widgets\\Grid

Enables or disables the Grid Filtering feature. When the value of this property is true, the Grid displays a filtering panel in the columns popup menus.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
getcell()
getcell($index, $datafield) : \\Hazaar\\Widgets\\JavaScript

Gets a cell. Returns an object with the following fields:

  • value – cell’s value.
  • row – cell’s row number.
  • column – column’s datafield.

Tags

Since

1.1

Parameters

$index

No description

$datafield

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getcellatposition()
getcellatposition($left, $top) : \\Hazaar\\Widgets\\JavaScript

Gets a cell at specific position. Returns an object with the following fields:

  • value – cell’s value.
  • row – cell’s row number.
  • column – column’s datafield.

Tags

Since

1.1

Parameters

$left

No description

$top

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getcelltext()
getcelltext($index, $datafield) : \\Hazaar\\Widgets\\JavaScript

Gets the text of a cell.

Tags

Since

1.1

Parameters

$index

No description

$datafield

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getcellvalue()
getcellvalue($index, $datafield) : \\Hazaar\\Widgets\\JavaScript

Gets the value of a cell.

Tags

Since

1.1

Parameters

$index

No description

$datafield

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getcolumn()
getcolumn($value) : \\Hazaar\\Widgets\\JavaScript

Gets a column by datafield value.Column’s fields:

  • datafield – column’s datafield. To get the cells labels and values from the data source, the Grid uses the “datafield” and “displayfield” properties. If the “displayfield” is not set, the “displayfield” is equal to the “datafield’.
  • text – column’s text.
  • displayfield – column’s displayfield. To get the cells labels and values from the data source, the Grid uses the “datafield” and “displayfield” properties. If the “displayfield” is not set, the “displayfield” is equal to the “datafield’.
  • sortable – determines whether the column is sortable.
  • filterable – determines whether the column is filterable.
  • exportable – determines whether the column will be exported through the “exportdata” method.
  • editable – determines whether the column is editable.
  • groupable – determines whether the column is groupable.
  • resizable – determines whether the column is resizable.
  • draggable – determines whether the column is draggable.
  • classname – determines the column’s header classname.
  • cellclassname – determines the column’s cells classname.
  • width – determines the column’s width.
  • menu – determines whether the column has an associated popup menu or not.

Tags

Since

1.1

Parameters

$value

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getcolumnaggregateddata()
getcolumnaggregateddata($column, $aggregate) : \\Hazaar\\Widgets\\JavaScript

Gets the aggregated data of a Grid column. Returns a JSON object. Each field name is the aggregate’s type(‘min’, ‘max’, ‘sum’, etc.).

Tags

Since

1.1

Parameters

$columnstring

No description

$aggregate

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getcolumnindex()
getcolumnindex($column) : \\Hazaar\\Widgets\\JavaScript

Gets the index of a column in the columns collection.

Tags

Since

1.1

Parameters

$columnstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getcolumnproperty()
getcolumnproperty($column, $property) : \\Hazaar\\Widgets\\JavaScript

Gets a property of a column. Possible property names: ‘text’, ‘hidden’, ‘hideable’, ‘renderer’, ‘cellsrenderer’, ‘align’, ‘cellsalign’, ‘cellsformat’, ‘pinned’, ‘contenttype’, ‘resizable’, ‘filterable’, ‘editable’, ‘cellclassname’, ‘classname’, ‘width’, ‘minwidth’, ‘maxwidth’

Tags

Since

1.1

Parameters

$columnstring

No description

$property

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getdatainformation()
getdatainformation() : \\Hazaar\\Widgets\\JavaScript

Gets bound data information.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getfilterinformation()
getfilterinformation() : \\Hazaar\\Widgets\\JavaScript

Gets the information about the Grid filters. The method returns an array of the applied filters. The returned information includes the filter objects and filter columns.

Each filter in the Array has the following fields:

  • filter – a filter object which may contain one or more filters. Properties and Methods of the filter object.
  • * getfilters – returns an array of all filters in the filter object. Each filter in the Array has:
  • * * filtervalue – filter’s value.
  • * * comparisonoperator – filter’s operator. For String filter the value could be: ‘EMPTY’, ‘NOT_EMPTY’, ‘CONTAINS’, ‘CONTAINS_CASE_SENSITIVE’, ‘DOES_NOT_CONTAIN’, ‘DOES_NOT_CONTAIN_CASE_SENSITIVE’, ‘STARTS_WITH’, ‘STARTS_WITH_CASE_SENSITIVE’, ‘ENDS_WITH’, ‘ENDS_WITH_CASE_SENSITIVE’, ‘EQUAL’, ‘EQUAL_CASE_SENSITIVE’, ‘NULL’, ‘NOT_NULL. For Date and Number filter the value could be: ‘EQUAL’, ‘NOT_EQUAL’, ‘LESS_THAN’, ‘LESS_THAN_OR_EQUAL’, ‘GREATER_THAN’, ‘GREATER_THAN_OR_EQUAL’, ‘NULL’, ‘NOT_NULL’. For Boolean filter, the value could be: ‘EQUAL’, ‘NOT_EQUAL’
  • * * type – filter’s type – ‘stringfilter’, ‘numericfilter’, ‘booleanfilter’ or ‘datefilter’.
  • * operator – ‘and’ or ‘or’. Determines the connection between the filters in the group.
  • filtercolumn – the column’s datafield.
  • filtercolumntext – the column’s text.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getgroup()
getgroup($index) : \\Hazaar\\Widgets\\JavaScript

Gets a group. The method returns an Object with details about the Group.

The object has the following fields:

  • group – group’s name.
  • level – group’s level in the group’s hierarchy.
  • expanded – group’s expand state.
  • subgroups – an array of sub groups or null.
  • subrows – an array of rows or null.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getloadedrows()
getloadedrows() : \\Hazaar\\Widgets\\JavaScript

Gets an array of the rows loaded in the Grid. Each record in the array includes Grid specific properties like boundindex and uid(unique row identifier).

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getpaginginformation()
getpaginginformation() : \\Hazaar\\Widgets\\JavaScript

Gets the paging information.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getrenderedcell()
getrenderedcell($index, $datafield) : \\Hazaar\\Widgets\\JavaScript

Gets a cell. Returns an object with the following fields:

  • value – cell’s value.
  • row – cell’s row number.
  • column – column’s datafield.

Tags

Since

1.1

Parameters

$index

No description

$datafield

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getrenderedrowdata()
getrenderedrowdata($index) : \\Hazaar\\Widgets\\JavaScript

Gets the data of a row. The parameter is a visible index.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getrootgroupscount()
getrootgroupscount() : \\Hazaar\\Widgets\\JavaScript

Gets the number of root groups.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getrowboundindex()
getrowboundindex($index) : \\Hazaar\\Widgets\\JavaScript

Returns the bound index of a row in jqxGrid. The parameter that is expected to be passed is a visible index(i.e the display index of the row).

Tags

Since

1.1

Parameters

$indexstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getrowboundindexbyid()
getrowboundindexbyid($rowid) : \\Hazaar\\Widgets\\JavaScript

Returns the bound index of a row in jqxGrid. The parameter that is expected to be passed is the row’s id.

Tags

Since

1.1

Parameters

$rowidstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getrowdata()
getrowdata($index) : \\Hazaar\\Widgets\\JavaScript

Gets the data of a row. The returned value is a JSON Object. The parameter is the row’s bound index.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getrowdatabyid()
getrowdatabyid($index) : \\Hazaar\\Widgets\\JavaScript

Gets the data of a row. The returned value is a JSON Object. The parameter is the row’s id.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getrowdetails()
getrowdetails($index) : \\Hazaar\\Widgets\\JavaScript

Gets the rows details.

Returns an object with the following fields:

  • rowdetailshidden – determines whether the details are visible or not.
  • rowdetailsheight – determines the details height.
  • rowdetails – HTML string which contains the row details.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getrowid()
getrowid($index) : \\Hazaar\\Widgets\\JavaScript

Gets the id of a row. The returned value is a ‘String’ or ‘Number’ depending on the id’s type. The parameter is the row’s bound index.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getrows()
getrows() : \\Hazaar\\Widgets\\JavaScript

Gets all rows. Returns an array of all rows loaded in the Grid. If the Grid is filtered, the returned value is an array of the filtered records.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getselectedcell()
getselectedcell() : \\Hazaar\\Widgets\\JavaScript

The expected selection mode is ‘singlecell’, ‘multiplecells’ or ‘multiplecellsextended’

Gets the selected cell. The returned value is an Object with two fields: ‘rowindex’ – the row’s bound index and ‘datafield’ – the column’s datafield.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getselectedcells()
getselectedcells() : \\Hazaar\\Widgets\\JavaScript

The expected selection mode is ‘singlecell’, ‘multiplecells’ or ‘multiplecellsextended’

Gets all selected cells. Returns an array of all selected cells. Each cell in the array is an Object with two fields: ‘rowindex’ – the row’s bound index and ‘datafield’ – the column’s datafield.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getselectedrowindex()
getselectedrowindex() : \\Hazaar\\Widgets\\JavaScript

The expected selection mode is ‘singlerow’, ‘multiplerows’ or ‘multiplerowsextended’

Gets the bound index of the selected row. Returns -1, if there’s no selection.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getselectedrowindexes()
getselectedrowindexes() : \\Hazaar\\Widgets\\JavaScript

The expected selection mode is ‘singlerow’, ‘multiplerows’ or ‘multiplerowsextended’

Gets the indexes of the selected rows. Returns an array of the selected rows.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getsortcolumn()
getsortcolumn() : \\Hazaar\\Widgets\\JavaScript

Gets the sort column. Returns the column’s datafield or null, if sorting is not applied.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getsortinformation()
getsortinformation() : \\Hazaar\\Widgets\\JavaScript

Gets the sort information.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getstate()
getstate() : \\Hazaar\\Widgets\\JavaScript

Gets the Grid’s state. the getstate method gets the following information: ‘sort column, sort order, page number, page size, applied filters and filter row values, column widths and visibility, cells and rows selection and groups.

The returned value is a JSON object with the following fields:

  • width – the Grid’s width.
  • height – the Grid’s height.
  • pagenum – the Grid’s page number.
  • pagesize – the Grid’s page size.
  • pagesizeoptions – the Grid’s page size options – an array of the available page sizes.
  • sortcolumn – the Grid’s sort column. The value is the column’s datafield or null, if sorting is not applied.
  • sortdirection – JSON Object with two boolean fields: ‘ascending’ and ‘descending’.
  • filters – the applied filters. See the ‘getfilterinformation’ method.
  • groups – the Grid’s groups array which contains the grouped columns data fields.
  • columns – an array of Columns. Each column in the array has the following fields:
  • * width – column’s width.
  • * hidden – column’s visible state.
  • * pinned – column’s pinned state.
  • * groupable – column’s groupable state.
  • * resizable – column’s resizable state.
  • * draggable – column’s draggable state.
  • * text – column’s text.
  • * align – column’s align.
  • * cellsalign – column’s cells align.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getvisibleindex()
getvisibleindex($index) : \\Hazaar\\Widgets\\JavaScript

Returns the visible index of a row in jqxGrid. The parameter that is expected to be passed is bound index(i.e the row’s index in your data source).

Tags

Since

1.1

Parameters

$indexstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

getvisiblerows()
getvisiblerows() : \\Hazaar\\Widgets\\JavaScript

Gets the rows in the view which are displayed to the user. The returned value is an Array.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

gotonextpage()
gotonextpage() : \\Hazaar\\Widgets\\JavaScript

Navigates to a next page when the Grid paging is enabled i.e when the pageable property value is true.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

gotopage()
gotopage($page) : \\Hazaar\\Widgets\\JavaScript

Navigates to a page when the Grid paging is enabled i.e when the pageable property value is true.

Tags

Since

1.1

Parameters

$page

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

gotoprevpage()
gotoprevpage() : \\Hazaar\\Widgets\\JavaScript

Navigates to a previous page when the Grid paging is enabled i.e when the pageable property value is true.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

groupable()
groupable($value) : \\Hazaar\\Widgets\\Grid

This property enables or disables the grouping feature.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
groupcolumnrenderer()
groupcolumnrenderer($value) : \\Hazaar\\Widgets\\Grid

Sets or gets a custom renderer for the grouping columns displayed in the grouping header when the grouping feature is enabled.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
groupindentwidth()
groupindentwidth($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the group indent size. This size is used when the grid is grouped. This is the size of the columns with expand/collapse toggle buttons.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
groups()
groups($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the Grid groups when the Grouping feature is enabled.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
groupsexpandedbydefault()
groupsexpandedbydefault($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the default state of the grouped rows.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
groupsheaderheight()
groupsheaderheight($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the height of the Grid Groups Header.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
groupsrenderer()
groupsrenderer($value) : \\Hazaar\\Widgets\\Grid

This function is called when a group is rendered. You can use it to customize the default group rendering.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
handlekeyboardnavigation()
handlekeyboardnavigation($value) : \\Hazaar\\Widgets\\Grid

The function is called when a key is pressed. If the result of the function is true, the default keyboard navigation will be overriden for the pressed key.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
hidecolumn()
hidecolumn($column) : \\Hazaar\\Widgets\\JavaScript

Hides a column.

Tags

Since

1.1

Parameters

$columnstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

hideloadingelement()
hideloadingelement() : \\Hazaar\\Widgets\\JavaScript

Hides the data loading image.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

hiderowdetails()
hiderowdetails($index) : \\Hazaar\\Widgets\\JavaScript

Hides the details of a row.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

horizontalscrollbarlargestep()
horizontalscrollbarlargestep($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the scrollbar’s large step. This property specifies the step with which the horizontal scrollbar’s value is changed when the user clicks the area above or below the thumb.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
horizontalscrollbarstep()
horizontalscrollbarstep($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the scrollbar’s step when the user clicks the scroll arrows.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
initrowdetails()
initrowdetails($value) : \\Hazaar\\Widgets\\Grid

This function is called when the user expands the row details and the details are going to be rendered.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
insertgroup()
insertgroup($index, $datafield) : \\Hazaar\\Widgets\\JavaScript

Groups by a column.

Tags

Since

1.1

Parameters

$indexstring

No description

$datafieldstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

iscolumngroupable()
iscolumngroupable($datafield) : \\Hazaar\\Widgets\\JavaScript

Gets whether the user can group by a column. Returns a boolean value.

Tags

Since

1.1

Parameters

$datafield

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

iscolumnhideable()
iscolumnhideable($column) : \\Hazaar\\Widgets\\JavaScript

Gets whether a column is hideable. Returns a boolean value.

Tags

Since

1.1

Parameters

$columnstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

iscolumnpinned()
iscolumnpinned($column) : \\Hazaar\\Widgets\\JavaScript

Gets whether a column is pinned. Returns a boolean value.

Tags

Since

1.1

Parameters

$columnstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

iscolumnvisible()
iscolumnvisible($column) : \\Hazaar\\Widgets\\JavaScript

Gets whether a column is visible. Returns a boolean value.

Tags

Since

1.1

Parameters

$columnstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

keyboardnavigation()
keyboardnavigation($value) : \\Hazaar\\Widgets\\Grid

Enables or disables the keyboard navigation.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
loadstate()
loadstate($state = null) : \\Hazaar\\Widgets\\JavaScript

Loads the Grid’s state. the loadstate method loads the following information: ‘sort column, sort order, page number, page size, applied filters and filter row values, column widths and visibility, cells and rows selection and groups.

Tags

Since

1.1

Parameters

$state

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

localizestrings()
localizestrings() : \\Hazaar\\Widgets\\JavaScript

Localizes the grid strings. This method allows you to change the valus of all Grid strings and also to change the cells formatting settings.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

onBindingComplete()
onBindingComplete($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when the binding is completed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onCellBeginEdit()
onCellBeginEdit($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a cell’s editor is displayed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onCellClick()
onCellClick($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a cell is clicked.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onCellDoubleClick()
onCellDoubleClick($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a cell is double-clicked.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onCellEndEdit()
onCellEndEdit($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a cell’s edit operation has ended.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onCellSelect()
onCellSelect($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a cell is selected.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onCellUnselect()
onCellUnselect($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a cell is unselected.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onCellValueChanged()
onCellValueChanged($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a cell’s value is changed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onColumnClick()
onColumnClick($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a column is clicked.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onColumnReordered()
onColumnReordered($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a Grid Column is moved to a new position.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onColumnResized()
onColumnResized($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a Grid Column is resized.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onFilter()
onFilter($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when the Grid is filtered.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onGroupCollapse()
onGroupCollapse($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a group is collapsed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onGroupExpand()
onGroupExpand($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a group is expanded.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onGroupsChanged()
onGroupsChanged($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a group is added, inserted or removed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onInitialized()
onInitialized($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when the Grid is initialized.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onPageChanged()
onPageChanged($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when the current page is changed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onPageSizeChanged()
onPageSizeChanged($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when the page size is changed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onRowClick()
onRowClick($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a row is clicked.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onRowCollapse()
onRowCollapse($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a row with details is collapsed.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onRowDoubleClick()
onRowDoubleClick($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a row is double clicked.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onRowExpand()
onRowExpand($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a row with details is expanded.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onRowSelect()
onRowSelect($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a row is selected.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onRowUnselect()
onRowUnselect($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when a row is unselected.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
onSort()
onSort($code) : \\Hazaar\\Widgets\\Grid

This event is triggered when the Grid is sorted.

Tags

Since

1.1

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\Grid
pageable()
pageable($value) : \\Hazaar\\Widgets\\Grid

Enables or disables the Grid Paging feature. When the value of this property is true, the Grid displays a pager below the rows.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
pagerheight()
pagerheight($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the height of the Grid Pager.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
pagerrenderer()
pagerrenderer($value) : \\Hazaar\\Widgets\\Grid

The function is called when the Grid Pager is rendered. This allows you to customize the default rendering of the pager.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
pagesize()
pagesize($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the number of visible rows per page when the Grid paging is enabled.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
pagesizeoptions()
pagesizeoptions($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the available page size options.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
pincolumn()
pincolumn($column) : \\Hazaar\\Widgets\\JavaScript

Pins the column.

Tags

Since

1.1

Parameters

$columnstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

ready()
ready($value) : \\Hazaar\\Widgets\\Grid

This function is called when the grid is initialized and the binding is complete.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
refresh()
refresh() : \\Hazaar\\Widgets\\JavaScript

Repaints the Grid View.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

refreshaggregates()
refreshaggregates() : \\Hazaar\\Widgets\\JavaScript

Refreshes the Aggregates in the Grid’s status bar.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

refreshdata()
refreshdata() : \\Hazaar\\Widgets\\JavaScript

Refreshes the data.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

refreshfilterrow()
refreshfilterrow() : \\Hazaar\\Widgets\\JavaScript

Refreshes the filter row and updates the filter widgets. The filter row’s widgets are synchronized with the applied filters.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

removefilter()
removefilter($datafield, $refresh = null) : \\Hazaar\\Widgets\\JavaScript

Removes a filter from the Grid.

Tags

Since

1.1

Parameters

$datafield

No description

$refresh

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

removegroup()
removegroup($datafield) : \\Hazaar\\Widgets\\JavaScript

Removes a group.

Tags

Since

1.1

Parameters

$datafield

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

removegroupat()
removegroupat($index) : \\Hazaar\\Widgets\\JavaScript

Removes a group at specific index.

Tags

Since

1.1

Parameters

$indexstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

removesort()
removesort() : \\Hazaar\\Widgets\\JavaScript

Removes the sorting.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

render()
render() : \\Hazaar\\Widgets\\JavaScript

Renders the Grid contents. This method completely refreshes the Grid cells, columns, layout and repaints the view.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

renderaggregates()
renderaggregates() : \\Hazaar\\Widgets\\JavaScript

Renders the aggregates in the Grid’s status bar.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

rendered()
rendered($value) : \\Hazaar\\Widgets\\Grid

Callback function which is called when the jqxGrid’s render function is called either internally or not.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
rendergridrows()
rendergridrows($value) : \\Hazaar\\Widgets\\Grid

This is a function called when the grid is used in virtual mode. The function should return an array of rows which will be rendered by the Grid.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
renderstatusbar()
renderstatusbar($value) : \\Hazaar\\Widgets\\Grid

Callback function which allows you to customize the rendering of the Grid’s statusbar.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
rendertoolbar()
rendertoolbar($value) : \\Hazaar\\Widgets\\Grid

Callback function which allows you to customize the rendering of the Grid’s toolbar.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
rowdetails()
rowdetails($value) : \\Hazaar\\Widgets\\Grid

Enables or disables the row details. When this option is enabled, the Grid can show additional information below each grid row.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
rowdetailstemplate()
rowdetailstemplate($value) : \\Hazaar\\Widgets\\Grid

Determines the template of the row details. The rowdetails field specifies the HTML used for details. The rowdetailsheight specifies the height of the details.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
rowsheight()
rowsheight($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the height of the grid rows.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
savestate()
savestate() : \\Hazaar\\Widgets\\JavaScript

Saves the Grid’s current state. the savestate method saves the following information: ‘sort column, sort order, page number, page size, applied filters and filter row values, column widths and visibility, cells and rows selection and groups.

The method saves the Grid’s state, but also returns a JSON object with the state. In case of browsers that do not support localStorage, you can pass the state object to the ‘loadState’ method.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

scrollbarsize()
scrollbarsize($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the scrollbars size.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
scrollfeedback()
scrollfeedback($value) : \\Hazaar\\Widgets\\Grid

When the “scrollmode” is set to “deferred”, the “scrollfeedback” function may be used to display custom UI Tooltip next to the scrollbar.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
scrolling()
scrolling() : \\Hazaar\\Widgets\\JavaScript

Returns an object with two boolean fields – “vertical” and “horizontal”. If the user scrolls with the vertical scrollbar, “vertical” field’s value is true. If the user scrolls with the horizontal scrollbar, the “horizontal” field’s value is true.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

scrollmode()
scrollmode($value) : \\Hazaar\\Widgets\\Grid

Determines the scrolling mode.

Possible Values:

  • ‘default’
  • ‘logical’- the movement of the scrollbar thumb is by row, not by pixel
  • ‘deferred’-content is stationary when the user drags the Thumb of a ScrollBar

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Grid
scrolloffset()
scrolloffset($top, $left) : \\Hazaar\\Widgets\\JavaScript

Scrolls the grid contents.

Tags

Since

1.1

Parameters

$top

No description

$left

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

selectallrows()
selectallrows() : \\Hazaar\\Widgets\\JavaScript

The selection mode should be set to: ‘multiplerows’ or ‘multiplerowsextended’

Selects all Grid rows.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

selectcell()
selectcell($index, $column) : \\Hazaar\\Widgets\\JavaScript

The expected selection mode is ‘singlecell’, ‘multiplecells’ or ‘multiplecellsextended’

Selects a cell.

Tags

Since

1.1

Parameters

$index

No description

$columnstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

selectedrowindex()
selectedrowindex($value) : \\Hazaar\\Widgets\\Grid

Selects a row at a specified index.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
selectedrowindexes()
selectedrowindexes($value) : \\Hazaar\\Widgets\\Grid

Selects single or multiple rows.

Tags

Since

1.1

Parameters

$valuemixed

The value to set

Returns

\\Hazaar\\Widgets\\Grid
selectionmode()
selectionmode($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the selection mode.

Possible Values:

  • ‘none’-disables the selection
  • ‘singlerow’- full row selection
  • ‘multiplerows’ – each click selects a new row. Click on a selected row unselects it
  • ‘multiplerowsextended’ – multiple rows selection with drag and drop. The selection behavior resembles the selection of icons on your desktop
  • ‘singlecell’ – single cell selection
  • ‘multiplecells’ – each click selects a new cell. Click on a selected cell unselects it
  • ‘multiplecellsextended’ – in this mode, users can select multiple cells with a drag and drop. The selection behavior resembles the selection of icons on your desktop
  • ‘multiplecellsadvanced’ -this mode is the most advanced cells selection mode. In this mode, users can select multiple cells with a drag and drop. The selection behavior resembles the selection of cells in a spreadsheet

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Grid
selectrow()
selectrow($index) : \\Hazaar\\Widgets\\JavaScript

The expected selection mode is ‘singlerow’, ‘multiplerows’ or ‘multiplerowsextended’

Selects a row.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

setcellvalue()
setcellvalue($index, $cell, $value) : \\Hazaar\\Widgets\\JavaScript

Sets a new value to a cell.

Tags

Since

1.1

Parameters

$index

No description

$cell

No description

$value

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

setcolumnindex()
setcolumnindex($name, $value)

Sets the index of a column in the columns collection.

Parameters

$namestring

The column datafield member.

$value\Hazaar\View\Widgets\number

The column’s number.

setcolumnproperty()
setcolumnproperty($column, $property, $value) : \\Hazaar\\Widgets\\JavaScript

Sets a property of a column. Possible property names: ‘text’, ‘hidden’, ‘hideable’, ‘renderer’, ‘cellsrenderer’, ‘align’, ‘cellsalign’, ‘cellsformat’, ‘pinned’, ‘contenttype’, ‘resizable’, ‘filterable’, ‘editable’, ‘cellclassname’, ‘classname’, ‘width’, ‘minwidth’, ‘maxwidth’

Tags

Since

1.1

Parameters

$columnstring

No description

$property

No description

$value

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

setrowdetails()
setrowdetails($index, $details, $height, $state) : \\Hazaar\\Widgets\\JavaScript

Sets details to a row.

Tags

Since

1.1

Parameters

$indexint

The row index.

$detailsstring

Row details.

$heightint

Height or Row Details.

$state\Hazaar\View\Widgets\bool

Hidden state.

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

showaggregates()
showaggregates($value) : \\Hazaar\\Widgets\\Grid

Shows or hides the aggregates in the grid’s statusbar.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showcolumn()
showcolumn($column) : \\Hazaar\\Widgets\\JavaScript

Shows a column.

Tags

Since

1.1

Parameters

$columnstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

showdefaultloadelement()
showdefaultloadelement($value) : \\Hazaar\\Widgets\\Grid

Determines whether the Grid should display the built-in loading element or should use a DIV tag with class ‘jqx-grid-load’

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showemptyrow()
showemptyrow($value) : \\Hazaar\\Widgets\\Grid

Shows or hides the empty row label when the Grid has no records to display.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showfiltercolumnbackground()
showfiltercolumnbackground($value) : \\Hazaar\\Widgets\\Grid

When this property is true, the Grid adds an additional visual style to the grid cells in the filter column(s).

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showfiltermenuitems()
showfiltermenuitems($value) : \\Hazaar\\Widgets\\Grid

Determines whether to display the filtering items in the column’s menu.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showfilterrow()
showfilterrow($value) : \\Hazaar\\Widgets\\Grid

Shows or hides the filter row.

Possible Values:

  • ‘textbox’ – input field
  • ‘checkedlist’ – dropdownlist with checkboxes that specify which records should be visible and hidden
  • ‘list’ – dropdownlist which specifies the visible records depending on the selection
  • ‘number’ – numeric input field
  • ‘checkbox’ – filter for boolean data
  • ‘date’ – filter for dates

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showgroupmenuitems()
showgroupmenuitems($value) : \\Hazaar\\Widgets\\Grid

Determines whether to display the group menu items.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showgroupsheader()
showgroupsheader($value) : \\Hazaar\\Widgets\\Grid

Shows or hides the groups header area.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showheader()
showheader($value) : \\Hazaar\\Widgets\\Grid

Shows or hides the columns header.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showloadingelement()
showloadingelement() : \\Hazaar\\Widgets\\JavaScript

Shows the data loading image.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

showpinnedcolumnbackground()
showpinnedcolumnbackground($value) : \\Hazaar\\Widgets\\Grid

When this property is true, the Grid adds an additional visual style to the grid cells in the pinned column(s).

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showrowdetails()
showrowdetails($index) : \\Hazaar\\Widgets\\JavaScript

Shows the details of a row.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

showrowdetailscolumn()
showrowdetailscolumn($value) : \\Hazaar\\Widgets\\Grid

Shows an additional column with expand/collapse toggle buttons when the Row details feature is enabled.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showsortcolumnbackground()
showsortcolumnbackground($value) : \\Hazaar\\Widgets\\Grid

When this property is true, the Grid adds an additional visual style to the grid cells in the sort column.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showsortmenuitems()
showsortmenuitems($value) : \\Hazaar\\Widgets\\Grid

Determines whether to display the sort menu items.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showstatusbar()
showstatusbar($value) : \\Hazaar\\Widgets\\Grid

Shows or hides the grid’s statusbar.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showtoolbar()
showtoolbar($value) : \\Hazaar\\Widgets\\Grid

Shows or hides the grid’s toolbar.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
showvalidationpopup()
showvalidationpopup($index, $column, $value) : \\Hazaar\\Widgets\\JavaScript

Displays a validation popup below a Grid cell.

Tags

Since

1.1

Parameters

$index

No description

$columnstring

No description

$value

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

sortable()
sortable($value) : \\Hazaar\\Widgets\\Grid

The sortable property enables or disables the sorting feature.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid
sortby()
sortby($datafield, $order = null) : \\Hazaar\\Widgets\\JavaScript

Sorts the Grid data.

Tags

Since

1.1

Parameters

$datafield

No description

$order

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

sorttogglestates()
sorttogglestates($value) : \\Hazaar\\Widgets\\Grid

Sets the sort toggle states.

Possible Values:

  • ‘0’-disables toggling
  • ‘1’-enables togging. Click on a column toggles the sort direction
  • ‘2’-enables remove sorting option

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\Grid
source()
source($value) : \\Hazaar\\Widgets\\Grid

The source object represents a set of key/value pairs.

  • url: A string containing the URL to which the request is sent.
  • data: Data to be sent to the server.
  • localdata: data array or data string pointing to a local data source.
  • datatype: the data’s type. Possible values: ‘xml’, ‘json’, ‘jsonp’, ‘tsv’, ‘csv’, ‘local’, ‘array’, ‘observablearray’.
  • type: The type of request to make (“POST” or “GET”), default is “GET”.
  • id: A string containing the Id data field.
  • root: A string describing where the data begins and all other loops begin from this element.
  • record: A string describing the information for a particular record.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\DataAdapter

The value to set

Returns

\\Hazaar\\Widgets\\Grid
statusbarheight()
statusbarheight($value) : \\Hazaar\\Widgets\\Grid

Sets the statusbar’s height.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
toolbarheight()
toolbarheight($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the toolbar’s height.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
unpincolumn()
unpincolumn($column) : \\Hazaar\\Widgets\\JavaScript

Unpins the column.

Tags

Since

1.1

Parameters

$columnstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

unselectcell()
unselectcell($index, $column) : \\Hazaar\\Widgets\\JavaScript

The expected selection mode is ‘singlecell’, ‘multiplecells’ or ‘multiplecellsextended’

Unselects a cell.

Tags

Since

1.1

Parameters

$index

No description

$columnstring

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

unselectrow()
unselectrow($index) : \\Hazaar\\Widgets\\JavaScript

The expected selection mode is ‘singlerow’, ‘multiplerows’ or ‘multiplerowsextended’

Unselects a row.

Tags

Since

1.1

Parameters

$index

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

updatebounddata()
updatebounddata() : \\Hazaar\\Widgets\\JavaScript

Updates the bound data and refreshes the grid. You can pass ‘filter’ or ‘sort’ as parameter, if the update reason is change in ‘filtering’ or ‘sorting’. To update only the data without the columns, use the ‘data’ parameter. To make a quick update of the cells, pass “cells” as parameter. Passing “cells” will refresh only the cells values when the new rows count is equal to the previous rows count. To make a full update, do not pass any parameter.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

updatedelay()
updatedelay($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the rendering update delay. This could be used for deferred scrolling scenarios.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
updaterow()
updaterow($index, $data) : \\Hazaar\\Widgets\\JavaScript

Updates a row.

Tags

Since

1.1

Parameters

$index

No description

$dataArray

No description

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

updating()
updating() : \\Hazaar\\Widgets\\JavaScript

Gets the updating operation state. Returns a boolean value.

Tags

Since

1.1

Returns

\\Hazaar\\Widgets\\JavaScript

The JavaScript code to execute the method.

verticalscrollbarlargestep()
verticalscrollbarlargestep($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the scrollbar’s large step. This property specifies the step with which the vertical scrollbar’s value is changed when the user clicks the area above or below the thumb.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
verticalscrollbarstep()
verticalscrollbarstep($value) : \\Hazaar\\Widgets\\Grid

Sets or gets the scrollbar’s step when the user clicks the scroll arrows.

Tags

Since

1.1

Parameters

$valueint

The value to set

Returns

\\Hazaar\\Widgets\\Grid
virtualmode()
virtualmode($value) : \\Hazaar\\Widgets\\Grid

Enables or disables the virtual data mode.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\Grid