DHTMLX Docs & Samples Explorer

API

Configuration

  • define - switches configuration property to positive value
  • attachEvent - attaches handler for the custom event
  • detachEvent - detaches handler from the custom event

Data manipulation

  • exists - checks if item with defined id exists
  • idByIndex - returns items ID by index
  • indexById - returns items index by ID
  • get - returns hash of data associated with ID
  • set - associates hash of data with ID
  • refresh - forces data repainting
  • dataCount - returns size of dataset
  • sort - sorts dataset
  • filter - filters dataset
  • next - gets next ID
  • previous - gets previous Id
  • clearAll - clears dataset
  • first - gets ID of first item
  • last - gets ID of last item

Data binding

  • bind - binds components

Data edit

  • edit - switches selected item to the edit state
  • stopEdit - switches items in the edit state, backs to normal

Data loading

  • parse - adds data from string or object
  • load - adds data from external URL

Data moving

  • copy - creates a copy of item
  • move - moves an item to the different position
  • moveUp - moves an item to the upper position
  • moveDown - moves an item to the down
  • moveTop - moves an item to the first position
  • moveBottom - moves item to the last position

Templates

  • locate - locates item by DOM event
  • show - shows item ( adjusts scrolls to make item visible )
  • customize - updates settings of active template

Selection