Skip to content

Latest commit

 

History

History
382 lines (317 loc) · 30.1 KB

File metadata and controls

382 lines (317 loc) · 30.1 KB
sidebar_label API overview
title JavaScript Grid - API Overview
description You can explore the API of Grid in the documentation of the DHTMLX JavaScript UI library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Suite.

Grid API overview

Grid methods

Name Description
@getshort(grid/api/grid_addcellcss_method.md)
@getshort(grid/api/grid_addrowcss_method.md)
@getshort(grid/api/grid_addspan_method.md)
@getshort(grid/api/grid_adjustcolumnwidth_method.md)
@getshort(grid/api/grid_collapse_method.md)
@getshort(grid/api/grid_collapseall_method.md)
@getshort(grid/api/grid_destructor_method.md)
@getshort(grid/api/grid_editcell_method.md)
@getshort(grid/api/grid_editend_method.md)
@getshort(grid/api/grid_expand_method.md)
@getshort(grid/api/grid_expandall_method.md)
@getshort(grid/api/grid_getcellrect_method.md)
@getshort(grid/api/grid_getcolumn_method.md)
@getshort(grid/api/grid_getheaderfilter_method.md)
@getshort(grid/api/grid_getscrollstate_method.md)
@getshort(grid/api/grid_getspan_method.md)
@getshort(grid/api/grid_getsummary_method.md)
@getshort(grid/api/grid_hidecolumn_method.md)
@getshort(grid/api/grid_hiderow_method.md)
@getshort(grid/api/grid_iscolumnhidden_method.md)
@getshort(grid/api/grid_isrowhidden_method.md)
@getshort(grid/api/grid_paint_method.md)
@getshort(grid/api/grid_removecellcss_method.md)
@getshort(grid/api/grid_removerowcss_method.md)
@getshort(grid/api/grid_removespan_method.md)
@getshort(grid/api/grid_scroll_method.md)
@getshort(grid/api/grid_scrollto_method.md)
@getshort(grid/api/grid_setcolumns_method.md)
@getshort(grid/api/grid_showcolumn_method.md)
@getshort(grid/api/grid_showrow_method.md)

:::info important

Grid events

Editing

Name Description
@getshort(grid/api/grid_aftercollapse_event.md)
@getshort(grid/api/grid_aftereditend_event.md)
@getshort(grid/api/grid_aftereditstart_event.md)
@getshort(grid/api/grid_afterexpand_event.md)
@getshort(grid/api/grid_beforecollapse_event.md)
@getshort(grid/api/grid_beforeeditend_event.md)
@getshort(grid/api/grid_beforeeditstart_event.md)
@getshort(grid/api/grid_beforeexpand_event.md)

Mouse

Name Description
@getshort(grid/api/grid_cellclick_event.md)
@getshort(grid/api/grid_celldblclick_event.md)
@getshort(grid/api/grid_cellmousedown_event.md)
@getshort(grid/api/grid_cellmouseover_event.md)
@getshort(grid/api/grid_cellrightclick_event.md)
@getshort(grid/api/grid_footercellclick_event.md)
@getshort(grid/api/grid_footercelldblclick_event.md)
@getshort(grid/api/grid_footercellmousedown_event.md)
@getshort(grid/api/grid_footercellmouseover_event.md)
@getshort(grid/api/grid_footercellrightclick_event.md)
@getshort(grid/api/grid_grouppanelitemclick_event.md)
@getshort(grid/api/grid_grouppanelitemmousedown_event.md)
@getshort(grid/api/grid_headercellclick_event.md)
@getshort(grid/api/grid_headercelldblclick_event.md)
@getshort(grid/api/grid_headercellmousedown_event.md)
@getshort(grid/api/grid_headercellmouseover_event.md)
@getshort(grid/api/grid_headercellrightclick_event.md)

Key Navigation and Scroll

Name Description
@getshort(grid/api/grid_afterkeydown_event.md)
@getshort(grid/api/grid_beforekeydown_event.md)
@getshort(grid/api/grid_scroll_event.md)

Sort and Filter

Name Description
@getshort(grid/api/grid_aftersort_event.md)
@getshort(grid/api/grid_beforefilter_event.md)
@getshort(grid/api/grid_beforesort_event.md)
@getshort(grid/api/grid_filterchange_event.md)

Column Drag and Drop

Name Description
@getshort(grid/api/grid_aftercolumndrag_event.md)
@getshort(grid/api/grid_aftercolumndrop_event.md)
@getshort(grid/api/grid_beforecolumndrag_event.md)
@getshort(grid/api/grid_beforecolumndrop_event.md)
@getshort(grid/api/grid_cancelcolumndrop_event.md)
@getshort(grid/api/grid_cancolumndrop_event.md)
@getshort(grid/api/grid_dragcolumnin_event.md)
@getshort(grid/api/grid_dragcolumnout_event.md)
@getshort(grid/api/grid_dragcolumnstart_event.md)

Column Hide and Show

Name Description
@getshort(grid/api/grid_aftercolumnhide_event.md)
@getshort(grid/api/grid_aftercolumnshow_event.md)
@getshort(grid/api/grid_beforecolumnhide_event.md)
@getshort(grid/api/grid_beforecolumnshow_event.md)

Column Resize

Name Description
@getshort(grid/api/grid_afterresizeend_event.md)
@getshort(grid/api/grid_beforeresizestart_event.md)
@getshort(grid/api/grid_resize_event.md)

Row Drag and Drop

Name Description
@getshort(grid/api/grid_afterrowdrag_event)
@getshort(grid/api/grid_afterrowdrop_event)
@getshort(grid/api/grid_beforerowdrag_event.md)
@getshort(grid/api/grid_beforerowdrop_event.md)
@getshort(grid/api/grid_cancelrowdrop_event.md)
@getshort(grid/api/grid_canrowdrop_event.md)
@getshort(grid/api/grid_dragrowin_event.md)
@getshort(grid/api/grid_dragrowout_event.md)
@getshort(grid/api/grid_dragrowstart_event.md)

Row Hide and Show

Name Description
@getshort(grid/api/grid_afterrowhide_event.md)
@getshort(grid/api/grid_afterrowshow_event.md)
@getshort(grid/api/grid_beforerowhide_event.md)
@getshort(grid/api/grid_beforerowshow_event.md)

Row Resize

Name Description
@getshort(grid/api/grid_afterrowresize_event.md)
@getshort(grid/api/grid_beforerowresize_event.md)

:::info important

Grid properties

Name Description
@getshort(grid/api/grid_adjust_config.md)
@getshort(grid/api/grid_autoemptyrow_config.md)
@getshort(grid/api/grid_autoheight_config.md)
@getshort(grid/api/grid_autowidth_config.md)
@getshort(grid/api/grid_blockselection_config.md)
@getshort(grid/api/grid_bottomsplit_config.md)
@getshort(grid/api/grid_clipboard_config.md)
@getshort(grid/api/grid_closable_config.md)
@getshort(grid/api/grid_collapsed_config.md)
@getshort(grid/api/grid_columns_config.md)
@getshort(grid/api/grid_css_config.md)
@getshort(grid/api/grid_data_config.md)
@getshort(grid/api/grid_dragcopy_config.md)
@getshort(grid/api/grid_dragexpand_config.md)
@getshort(grid/api/grid_dragitem_config.md)
@getshort(grid/api/grid_dragmode_config.md)
@getshort(grid/api/grid_dragpanel_config.md)
@getshort(grid/api/grid_dropbehaviour_config.md)
@getshort(grid/api/grid_editable_config.md)
@getshort(grid/api/grid_eventhandlers_config.md)
@getshort(grid/api/grid_exportconfig_config.md)
@getshort(grid/api/grid_exportstyles_config.md)
@getshort(grid/api/grid_footerautoheight_config.md)
@getshort(grid/api/grid_footerposition_config.md)
@getshort(grid/api/grid_footerrowheight_config.md)
@getshort(grid/api/grid_footertooltip_config.md)
@getshort(grid/api/grid_group_config.md)
@getshort(grid/api/grid_groupable_config.md)
@getshort(grid/api/grid_headerautoheight_config.md)
@getshort(grid/api/grid_headerrowheight_config.md)
@getshort(grid/api/grid_headertooltip_config.md)
@getshort(grid/api/grid_height_config.md)
@getshort(grid/api/grid_history_config.md)
@getshort(grid/api/grid_htmlenable_config.md)
@getshort(grid/api/grid_keynavigation_config.md)
@getshort(grid/api/grid_leftsplit_config.md)
@getshort(grid/api/grid_multiselection_config.md)
@getshort(grid/api/grid_multisort_config.md)
@getshort(grid/api/grid_rangeselection_config.md)
@getshort(grid/api/grid_resizable_config.md)
@getshort(grid/api/grid_rightsplit_config.md)
@getshort(grid/api/grid_rootparent_config.md)
@getshort(grid/api/grid_rowcss_config.md)
@getshort(grid/api/grid_rowheight_config.md)
@getshort(grid/api/grid_selection_config.md)
@getshort(grid/api/grid_sortable_config.md)
@getshort(grid/api/grid_spans_config.md)
@getshort(grid/api/grid_subrow_config.md)
@getshort(grid/api/grid_subrowconfig_config.md)
@getshort(grid/api/grid_summary_config.md)
@getshort(grid/api/grid_tooltip_config.md)
@getshort(grid/api/grid_topsplit_config.md)
@getshort(grid/api/grid_type_config.md)
@getshort(grid/api/grid_width_config.md)

Column properties

You will find the list of all the available configuration properties of a Grid column here.

Selection API

Selection methods

Name Description
@getshort(grid/api/selection/selection_disable_method.md)
@getshort(grid/api/selection/selection_enable_method.md)
@getshort(grid/api/selection/selection_getcell_method.md)
@getshort(grid/api/selection/selection_getcells_method.md)
@getshort(grid/api/selection/selection_isselectedcell_method.md)
@getshort(grid/api/selection/selection_removecell_method.md)
@getshort(grid/api/selection/selection_setcell_method.md)

Selection events

Name Description
@getshort(grid/api/selection/selection_afterselect_event.md)
@getshort(grid/api/selection/selection_afterunselect_event.md)
@getshort(grid/api/selection/selection_beforeselect_event.md)
@getshort(grid/api/selection/selection_beforeunselect_event.md)

RangeSelection API

RangeSelection methods

Name Description
@getshort(grid/api/rangeselection/disable_method.md)
@getshort(grid/api/rangeselection/enable_method.md)
@getshort(grid/api/rangeselection/getrange_method.md)
@getshort(grid/api/rangeselection/getrangedcells_method.md)
@getshort(grid/api/rangeselection/isdisabled_method.md)
@getshort(grid/api/rangeselection/isranged_method.md)
@getshort(grid/api/rangeselection/resetrange_method.md)
@getshort(grid/api/rangeselection/setrange_method.md)

RangeSelection events

Name Description
@getshort(grid/api/rangeselection/afterresetrange_event.md)
@getshort(grid/api/rangeselection/aftersetrange_event.md)
@getshort(grid/api/rangeselection/beforeresetrange_event.md)
@getshort(grid/api/rangeselection/beforesetrange_event.md)

BlockSelection API

BlockSelection methods

Name Description
@getshort(grid/api/blockselection/disable_method.md)
@getshort(grid/api/blockselection/enable_method.md)
@getshort(grid/api/blockselection/isdisabled_method.md)

BlockSelection events

Name Description
@getshort(grid/api/blockselection/afterblockhandleapply_event.md)
@getshort(grid/api/blockselection/afterblockselectionapply_event.md)
@getshort(grid/api/blockselection/afterblockselectionmove_event.md)
@getshort(grid/api/blockselection/beforeblockhandleapply_event.md)
@getshort(grid/api/blockselection/beforeblockselectionapply_event.md)
@getshort(grid/api/blockselection/beforeblockselectionmove_event.md)
@getshort(grid/api/blockselection/blockhandlemousedown_event.md)
@getshort(grid/api/blockselection/blockselectionend_event.md)
@getshort(grid/api/blockselection/blockselectionstart_event.md)
@getshort(grid/api/blockselection/blockselectionvalidate_event.md)

Export API

Export methods

Name Description
@getshort(grid/api/export/grid_csv_method.md)
@getshort(grid/api/export/grid_pdf_method.md)
@getshort(grid/api/export/grid_png_method.md)
@getshort(grid/api/export/grid_xlsx_method.md)

Clipboard API

Clipboard events

Name Description
@getshort(grid/api/clipboard/aftercopy_event.md)
@getshort(grid/api/clipboard/afterpaste_event.md)
@getshort(grid/api/clipboard/beforecopy_event.md)
@getshort(grid/api/clipboard/beforepaste_event.md)
@getshort(grid/api/clipboard/copyerror_event.md)
@getshort(grid/api/clipboard/pasteerror_event.md)

DragPanel API

DragPanel events

Name Description
@getshort(grid/api/dragpanel/dragpanelitemclick_event.md)
@getshort(grid/api/dragpanel/dragpanelitemmousedown_event.md)

History API

History methods

Name Description
@getshort(grid/api/history/add_method.md)
@getshort(grid/api/history/canredo_method.md)
@getshort(grid/api/history/canundo_method.md)
@getshort(grid/api/history/disable_method.md)
@getshort(grid/api/history/enable_method.md)
@getshort(grid/api/history/gethistory_method.md)
@getshort(grid/api/history/isdisabled_method.md)
@getshort(grid/api/history/redo_method.md)
@getshort(grid/api/history/remove_method.md)
@getshort(grid/api/history/removeall_method.md)
@getshort(grid/api/history/undo_method.md)

History events

Name Description
@getshort(grid/api/history/afteradd_event.md)
@getshort(grid/api/history/afterredo_event.md)
@getshort(grid/api/history/afterundo_event.md)
@getshort(grid/api/history/beforeadd_event.md)
@getshort(grid/api/history/beforeredo_event.md)
@getshort(grid/api/history/beforeundo_event.md)
@getshort(grid/api/history/error_event.md)