Skip to content

Latest commit

 

History

History
145 lines (125 loc) · 10.8 KB

api_overview.md

File metadata and controls

145 lines (125 loc) · 10.8 KB
sidebar_label API overview
title API Overview
description Overview of the DHTMLX Spreadsheet API, covering the constructor, methods, events, properties, and the sheet manager, selection, event bus and export modules.

API overview

Constructor

const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {
    rowsCount: 20,
    colsCount: 20
});

Parameters:

  • an HTML container (or the ID of an HTML container)
  • a hash of config options (check below)

Spreadsheet methods

Name Description
@getshort(api/spreadsheet_addcolumn_method.md)
@getshort(api/spreadsheet_addformula_method.md)
@getshort(api/spreadsheet_addrow_method.md)
@getshort(api/spreadsheet_announce_method.md)
@getshort(api/spreadsheet_clear_method.md)
@getshort(api/spreadsheet_deletecolumn_method.md)
@getshort(api/spreadsheet_deleterow_method.md)
@getshort(api/spreadsheet_eachcell_method.md)
@getshort(api/spreadsheet_endedit_method.md)
@getshort(api/spreadsheet_fitcolumn_method.md)
@getshort(api/spreadsheet_freezecols_method.md)
@getshort(api/spreadsheet_freezerows_method.md)
@getshort(api/spreadsheet_getfilter_method.md)
@getshort(api/spreadsheet_getformat_method.md)
@getshort(api/spreadsheet_getformula_method.md)
@getshort(api/spreadsheet_getstyle_method.md)
@getshort(api/spreadsheet_getvalue_method.md)
@getshort(api/spreadsheet_hidecols_method.md)
@getshort(api/spreadsheet_hiderows_method.md)
@getshort(api/spreadsheet_hidesearch_method.md)
@getshort(api/spreadsheet_insertlink_method.md)
@getshort(api/spreadsheet_islocked_method.md)
@getshort(api/spreadsheet_load_method.md)
@getshort(api/spreadsheet_lock_method.md)
@getshort(api/spreadsheet_mergecells_method.md)
@getshort(api/spreadsheet_parse_method.md)
@getshort(api/spreadsheet_redo_method.md)
@getshort(api/spreadsheet_serialize_method.md)
@getshort(api/spreadsheet_search_method.md)
@getshort(api/spreadsheet_setfilter_method.md)
@getshort(api/spreadsheet_setformat_method.md)
@getshort(api/spreadsheet_setstyle_method.md)
@getshort(api/spreadsheet_setvalidation_method.md)
@getshort(api/spreadsheet_setvalue_method.md)
@getshort(api/spreadsheet_showcols_method.md)
@getshort(api/spreadsheet_showrows_method.md)
@getshort(api/spreadsheet_startedit_method.md)
@getshort(api/spreadsheet_undo_method.md)
@getshort(api/spreadsheet_unfreezecols_method.md)
@getshort(api/spreadsheet_unfreezerows_method.md)
@getshort(api/spreadsheet_unlock_method.md)

Spreadsheet events

Name Description
@getshort(api/spreadsheet_afteraction_event.md)
@getshort(api/spreadsheet_afterclear_event.md)
@getshort(api/spreadsheet_afterdataloaded_event.md)
@getshort(api/spreadsheet_aftereditend_event.md)
@getshort(api/spreadsheet_aftereditstart_event.md)
@getshort(api/spreadsheet_afterfocusset_event.md)
@getshort(api/spreadsheet_afterselectionset_event.md)
@getshort(api/spreadsheet_aftersheetchange_event.md)
@getshort(api/spreadsheet_beforeaction_event.md)
@getshort(api/spreadsheet_beforeclear_event.md)
@getshort(api/spreadsheet_beforeeditend_event.md)
@getshort(api/spreadsheet_beforeeditstart_event.md)
@getshort(api/spreadsheet_beforefocusset_event.md)
@getshort(api/spreadsheet_beforeselectionset_event.md)
@getshort(api/spreadsheet_beforesheetchange_event.md)

Spreadsheet properties

Name Description
@getshort(api/spreadsheet_colscount_config.md)
@getshort(api/spreadsheet_editline_config.md)
@getshort(api/spreadsheet_exportmodulepath_config.md)
@getshort(api/spreadsheet_formats_config.md)
@getshort(api/spreadsheet_importmodulepath_config.md)
@getshort(api/spreadsheet_localization_config.md)
@getshort(api/spreadsheet_menu_config.md)
@getshort(api/spreadsheet_multisheets_config.md)
@getshort(api/spreadsheet_readonly_config.md)
@getshort(api/spreadsheet_rowscount_config.md)
@getshort(api/spreadsheet_selection_config.md)
@getshort(api/spreadsheet_toolbarblocks_config.md)

Sheet Manager methods

Name Description
@getshort(api/sheetmanager_add_method.md)
@getshort(api/sheetmanager_clear_method.md)
@getshort(api/sheetmanager_get_method.md)
@getshort(api/sheetmanager_getactive_method.md)
@getshort(api/sheetmanager_getall_method.md)
@getshort(api/sheetmanager_remove_method.md)
@getshort(api/sheetmanager_setactive_method.md)

Selection methods

Name Description
@getshort(api/selection_disable_method.md)
@getshort(api/selection_enable_method.md)
@getshort(api/selection_getfocusedcell_method.md)
@getshort(api/selection_getselectedcell_method.md)
@getshort(api/selection_isdisabled_method.md)
@getshort(api/selection_removeselectedcell_method.md)
@getshort(api/selection_setfocusedcell_method.md)
@getshort(api/selection_setselectedcell_method.md)

Events Bus methods

Name Description
@getshort(api/eventsbus_detach_method.md)
@getshort(api/eventsbus_fire_method.md)
@getshort(api/eventsbus_on_method.md)

Export methods

Name Description
@getshort(api/export_json_method.md)
@getshort(api/export_xlsx_method.md)