Check documentation for the latest version 6.0 of dhtmlxSuite load DHTMLX Docs

load

loads data to the component via XML or JSON, usually data-values pairs

promise load(string|object data, [function doOnLoad] );

Parameters

datastring|objectXML|JSON URL|string|object
doOnLoadfunction(optional) calls user-defined handler after data is loaded and rendered

Returns

promisea "promise" object

Example

var myComponent = new dhtmlXComponent();
 
// local json/xml object
myComponent.load({data:[{id:"a1",..},{id:"a2",..}]});
 
// local json/xml string
myComponent.load('<data><node id="a1".../></data>');
 
// json/xml from server
myComponent.load("server/data.xml");
 
// local json/xml with callback
myComponent.load({data:[{id:"a1",..},{id:"a2",..}]}, function(){
    // data loaded and rendered
    // your code here
});
 
// local json/xml string with callback
myComponent.load('<data><node id="a1".../></data>', function(){
    // data loaded and rendered
    // your code here
});
 
// json/xml from server with callback
myComponent.load("server/data.xml", function(){
    // data loaded and rendered
    // your code here
});
 
// returns a "promise" object, see details
myComponent.load(url).then(function(text){
    // text - a server side response
});

Details

The type of incoming data will be detected automatically, so you can use this method for loading both XML and JSON in different formats:string, URL from server, object itself.

In the case of loading config from server:

  • async POST request will be performed (that's why you need callback)
    (to use GET instead of POST set dhx.ajax.method = "get", please check details here)
  • to prevent caching in some browsers extra param like "dhxr0123456789" will be added
    (to disable the extra param set dhx.ajax.cache = true, please check details here)
  • callback order: onXLS event => [request] => onXLE event => doOnLoad()
  • make sure the response has the header "Content-Type: text/xml" for the XML mode

DHTMLX is integrated with Promiz.js library to treat the result of asynchronous operations (like data loading) without callbacks. Read more about integration of DHTMLX with Promiz.js.

Change log
  • added in 4.0
  • integration with Promiz.js is added in version 5.1
Back to top