dhx.ui.grouplist

Methods

  • add - adds a new item into a certain branch
  • add - adds a new item into a certain branch
  • adjust - adjusts the component to the size of the outer parent HTML container
  • attachEvent - attaches custom handler to inner event
  • bind - binds components
  • blockEvent - blocks event triggering
  • branchIndex - gets position of the item in the parent branch
  • callEvent - calls inner event
  • clearAll - removes all data
  • clearAll - removes all data
  • customize - applies new type settings
  • dataCount - gets count of items
  • define - sets configuration property or a hash of properties
  • destructor - destructs an object
  • detachEvent - detaches custom code from handler
  • exists - checks if the item with such ID exists
  • filter - filters data
  • first - gets the ID of the first item
  • firstChild - gets the id of the first child in a certain branch
  • getNode - returns main html container of view
  • getOpenState - returns an object containing 2 arrays: parents - an array of the parents of the currently open group; branch - an array of subgroups of the currently open group
  • getParent - returns parent object of current view
  • getSelected - returns ID of selected item(s)
  • hasChild - checks whether an item exists in a certain branch (at any level)
  • hasEvent - checks whether a component has an event
  • hide - hides view
  • idByIndex - gets the id of an item with taken index
  • indexById - the index of the item in question
  • isSelected - checks if item is selected or not
  • isVisible - returns true if current view is visible
  • item - gets the object of a data item
  • last - gets the id of the last item
  • load - loads values from external datasource
  • loadNext - sends request to load N records to the end or to the specified position
  • locate - gets the ID of item which is affected by HTML event
  • mapEvent - routes events from one object to another
  • next - gets ID of the next element which is positioned in defined step
  • nextSibling - gets the id of the next item
  • parent - gets the id of the parent branch
  • parse - addes data from a datasource
  • prevSibling - gets the id of the previous item
  • previous - gets ID of the previous element which is positioned in defined step
  • refresh - repaint the whole view or a certain item
  • remove - removes an item
  • remove - removes an item
  • render - renders a current state of an item or the whole component
  • resize - adjusts view to the new size
  • scrollState - returns scroll position ({x:scrollLeft,y:scrollTop})
  • scrollTo - scrolls data container to a certain position
  • select - selects item
  • selectAll - selects all items
  • serialize - serializes branch or the whole dataset to a json object
  • serialize - serializes branch or the whole dataset to a json object
  • show - makes view visible
  • showItem - shows the specified item
  • sort - sorts datastore
  • sync - allows to sync two copy all, or part of data from one DataCollection to another
  • unblockEvent - enables event triggering
  • unselect - unselects item
  • unselectAll - unselects all items
  • update - sets properties of the data item

Events

Properties

  • animate - enables/disables animation
  • container - html container or its id where view needs initializing
  • css - class name for view container
  • dataFeed - path to php file that will get data. Used to reload data from server.
  • data - loaded data
  • datastore - custom DataStore object
  • datatype - type of loaded data
  • gravity - view gravity (1 by default)
  • height - view height
  • hidden - sets whether a view will be hidden initially
  • id - view id
  • on - allows to attach custom handlers to inner events of the component
  • scheme - defines a default scheme for data records of the component. So, in cases when you add an empty record to the component, the record will be populated with the values set by the scheme.
  • scroll - enables/disables scroll
  • select - enables/disables item selection or multiselection in grouplist
  • templateBack - an html template that defines data that will be presented in group header in the expanded state
  • templateGroup - an html template that defines data that will be presented in group header in the collapsed state
  • templateItem - an html template that defines data that will be presented in grouplist
  • template - item template
  • type - object that specifies items list presentation
  • url - data url
  • width - view width