w2utils.settings

Global settings for w2ui

Object

There is a number of default settings used across w2ui library. The setting object is a map with the following structure:

settings : {
    locale            : "en-us",
    dateFormat        : "mm/dd/yyyy",
    timeFormat        : "hh:mi pm",
    currencyPrefix    : "$",
    currencySuffix    : "",
    currencyPrecision : 2,
    groupSymbol       : ",",
    decimalSymbol     : ".",
    shortmonths       : ["Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],
    fullmonths        : ["January", "February", "March", "April", "May", "June", "July", "August",
                         "September", "October", "November", "December"],
    shortdays         : ["M", "T", "W", "T", "F", "S","S"],
    fulldays          : ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"],
    weekStarts        : "M",        // can be "M" for Monday or "S" for Sunday
    dataType          : 'HTTPJSON', // can be HTTP, HTTPJSON, RESTFULL, RESTFULLJSON, JSON
    phrases           : {}          // empty object for phrases
    warnNoPhrase      : true,       // warns if a phrase translation is missing
    dateStartYear     : 1950,       // start year for date-picker
    dateEndYear       : 2020        // end year for date picker
}

​x
 
settings : {
    locale            : "en-us",
    dateFormat        : "mm/dd/yyyy",
    timeFormat        : "hh:mi pm",
    currencyPrefix    : "$",
    currencySuffix    : "",
    currencyPrecision : 2,
    groupSymbol       : ",",
    decimalSymbol     : ".",
    shortmonths       : ["Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],
    fullmonths        : ["January", "February", "March", "April", "May", "June", "July", "August",
                         "September", "October", "November", "December"],
    shortdays         : ["M", "T", "W", "T", "F", "S","S"],
    fulldays          : ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"],
    weekStarts        : "M",        // can be "M" for Monday or "S" for Sunday
    dataType          : 'HTTPJSON', // can be HTTP, HTTPJSON, RESTFULL, RESTFULLJSON, JSON
    phrases           : {}          // empty object for phrases
    warnNoPhrase      : true,       // warns if a phrase translation is missing
    dateStartYear     : 1950,       // start year for date-picker
    dateEndYear       : 2020        // end year for date picker
}
​

You can define and load settings based on your locale. See .locale() method for more information. All locale specific files are located in the /src/locale folder on github.com

Data Types

w2utils.settings.dataType can be one of the following.

HTTPJSON (default) - will encode params as a JSON string and will submit GET request

xxxxxxxxxx
 
request: {
    "limit":100,
    "offset":0,
    "searchLogic":"AND",
    "search":[
        {"field":"age", "type":"int", "operator":"between", "value":[10,20]},
        {"field":"fname", "type":"text", "operator":"begins", "value":"vitali"}
    ],
    "sort":[
        {"field":"fname", "direction":"asc"},
        {"field":"lname", "direction":"asc"}
    ]
}
​

HTTP - will encode params as HTTP string and will submit GET request

xxxxxxxxxx
 
limit: 100
&offset: 0
&searchLogic: AND
&search[0][field]: age
&search[0][type]: int
&search[0][operator]: between
&search[0][value][]: 10
&search[0][value][]: 20
&search[1][field]: fname
&search[1][type]: text
&search[1][operator]: begins
&search[1][value]: vitali
&sort[0][field]: fname
&sort[0][direction]: asc
&sort[1][field]: lname
&sort[1][direction]: asc
​

RESTFULL - will encode params as HTTP string and will submit GET for list, PUT for save, DELETE for delete, POST for update actions in w2grid and w2forms. For w2grid the request will look like this:

xxxxxxxxxx
 
limit: 100
&offset: 0
&searchLogic: AND
&search[0][field]: age
&search[0][type]: int
&search[0][operator]: between
&search[0][value][]: 10
&search[0][value][]: 20
&search[1][field]: fname
&search[1][type]: text
&search[1][operator]: begins
&search[1][value]: vitali
&sort[0][field]: fname
&sort[0][direction]: asc
&sort[1][field]: lname
&sort[1][direction]: asc
​

RESTFULLJSON - will encode params as JSON and will submit GET for list, PUT for save, DELETE for delete, POST for update actions in w2grid and w2forms. Note that often PUT and DELETE are disabled by various hosting services. For w2grid the request will look like this:

xxxxxxxxxx
 
{
    "limit":100,
    "offset":0,
    "searchLogic":"AND",
    "search":[
        {"field":"age", "type":"int", "operator":"between", "value":[10,20]},
        {"field":"fname", "type":"text", "operator":"begins", "value":"vitali"}
    ],
    "sort":[
        {"field":"fname", "direction":"asc"},
        {"field":"lname", "direction":"asc"}
    ]
}
​

JSON - will encode params as JSON and submit POST request. The parameters will be submitted as HTTP payload (not HTTP POST), on the server it needs to be parsed differently.

xxxxxxxxxx
 
{
    "limit":100,
    "offset":0,
    "searchLogic":"AND",
    "search":[
        {"field":"age", "type":"int", "operator":"between", "value":[10,20]},
        {"field":"fname", "type":"text", "operator":"begins", "value":"vitali"}
    ],
    "sort":[
        {"field":"fname", "direction":"asc"},
        {"field":"lname", "direction":"asc"}
    ]
}
​

w2utils.settings

Data Types

User Comments