API Configuration

30 Nov 20172 minutes to read

It is possible to get and set the various properties available within the controls after its creation -

Getting API values

The API values can be accessed by using either of the following ways,

JAVASCRIPT

// First way
$("jquery-selector").ej-plugin-name("model.propertyName");
// Example
$("#myDate").ejDatePicker("model.buttonText");

// Second way
$("jquery-selector").ej-plugin-name("option", "propertyName");
// Example
$("#myDate").ejDatePicker("option", "buttonText");

Setting values to the API

It is possible to set new values to the properties of the Syncfusion widgets either during or after control initialization as described below,

During Initialization

JAVASCRIPT

$("jquery-selector").ej-plugin-name({
    propertyName1: value1,
    propertyName2: value2,
    …
});

// Example
$("#myDate").ejDatePicker({
    value: "01/01/2015",
    buttonText: "Hôm nay"
});

After initialization

JAVASCRIPT

// First way
var obj = $("jquery-selector").data("ej-plugin-name"); // [RECOMMENDED METHOD]
obj.option({
    propertyName: value
});
// Example
var dateObject = $("#myDate").data("ejDatePicker");
dateObject.option({
    buttonText: "Hôm nay"
});

// Second way
$("jquery-selector").ej-plugin-name("model.propertyName", "value");
//Example
$("#myDate").ejDatePicker("model.buttonText", "Hôm nay");

// Third way
$("jquery-selector").ej-plugin-name("option", "propertyName", "value");
//Example
$("#myDate").ejDatePicker("option", "buttonText", "Hôm nay");

// Fourth way
$("jquery-selector").ej-plugin-name({
    propertyName: "value"
});
// Example
$("#myDate").ejDatePicker({
    value: "01/01/2015"
});


// Fifth way
var obj = $("jquery-selector").data("ej-plugin-name");
obj.setModel({
    propertyName: value
});
// Example
var dateObject = $("#myDate").data("ejDatePicker");
dateObject.setModel({
    value: "01/01/2015"
});