-
Notifications
You must be signed in to change notification settings - Fork 2
Documentation
Eagan Martin edited this page Mar 25, 2019
·
4 revisions
- query
/**
* * Sample Usage:
* * Kony.component.query('button[property = value]');
*
* @param {string} queryString
*/
Kony.component.query(queryString);- reference
/**
* * Sample Usage:
* * Kony.component.reference('button', 'button-reference-value');
*
* @param {string} component
* @param {string} reference
*/
Kony.component.reference(component, reference);- create
/**
* * Sample Usage:
* * Kony.store.create('url', { key: value }, component, true, 25);
*
* @param {string} url
* @param {object} extraParams
* @param {string} component
* @param {boolean} autoLoad
* @param {number} pageSize
*/
Kony.store.create(url, extraParams, component, autoLoad, pageSize);- tree
/**
* * Sample Usage:
* * Kony.store.tree('url', { key: value }, component, true, true);
*
* @param {string} url
* @param {object} extraParams
* @param {string} component
* @param {boolean} autoLoad
* @param {boolean} folderSort
*/
Kony.store.tree(url, extraParams, component, autoLoad, folderSort);- local
/**
* * Sample Usage:
* * Kony.store.local([]);
*
* @param {array} records
*/
Kony.store.local(records);- render
/**
* * Sample Usage:
* * renderer: Kony.grid.render.default();
*/
Kony.grid.render.default();
/**
* * Sample Usage:
* * renderer: Kony.grid.render.qTip();
*/
Kony.grid.render.qTip();
/**
* * Sample Usage:
* * renderer: Kony.grid.render.checkColumn();
*/
Kony.grid.render.checkColumn();
/**
* * Sample Usage:
* * renderer: Kony.grid.render.yesNo();
*/
Kony.grid.render.yesNo();
/**
* * Sample Usage:
* * renderer: Kony.grid.render.currency();
*/
Kony.grid.render.currency();
/**
* * Sample Usage:
* * renderer: Kony.grid.render.accurate();
*/
Kony.grid.render.accurate();
/**
* * Sample Usage:
* * renderer: Kony.grid.render.fullDate();
*/
Kony.grid.render.fullDate();
/**
* * Sample Usage:
* * renderer: Kony.grid.render.ymdDate();
*/
Kony.grid.render.ymdDate();
/**
* * Sample Usage:
* * renderer: Kony.grid.render.dmyDate();
*/
Kony.grid.render.dmyDate();
/**
* * Sample Usage:
* * renderer: Kony.grid.render.mdyDate();
*/
Kony.grid.render.mdyDate();- get
/**
* * Sample Usage:
* * Kony.grid.get('grid-reference-value');
*
* @param {string} reference
*/
Kony.grid.get(reference);- setup
/**
* * Sample Usage:
* * Kony.grid.setup('reference', 'url', { key: value });
*
* @param {string} reference
* @param {string} storeUrl
* @param {object} filters
*/
Kony.grid.setup(reference, storeUrl, filters);- clear
/**
* * Sample Usage:
* * Kony.grid.clear('reference');
*
* @param {string} reference
*/
Kony.grid.clear(reference);- getSelection
/**
* * Sample Usage:
* * Kony.grid.getSelection('reference');
*
* @param {string} reference
*/
Kony.grid.getSelection(reference);- clearSelection
/**
* * Sample Usage:
* * Kony.grid.clearSelection('reference');
*
* @param {string} reference
*/
Kony.grid.clearSelection(reference);- getStore
/**
* * Sample Usage:
* * Kony.grid.getStore('reference');
*
* @param {string} reference
*/
Kony.grid.getStore(reference);- reload
/**
* * Sample Usage:
* * Kony.grid.reload('reference');
*
* @param {string} reference
*/
Kony.grid.reload(reference);- get
/**
* * Sample Usage:
* * Kony.combobox.get('reference');
*
* @param {string} reference
*/
Kony.combobox.get(reference);- setup
/**
* * Sample Usage:
* * Kony.combobox.setup('reference', 'url', { key: value });
*
* @param {string} reference
* @param {string} storeUrl
* @param {object} filters
*/
Kony.combobox.setup(reference, storeUrl, filters);- getRecordById
/**
* * Sample Usage: Kony.combobox.getRecordById('reference', 2);
*
* @param {string} reference
* @param {number} id
*/
Kony.combobox.getRecordById(reference, id);- get
/**
* * Sample Usage:
* * Kony.form.get('reference');
*
* @param {string} reference
*/
Kony.form.get(reference);- getValues
/**
* * Sample Usage:
* * Kony.form.getValues('reference');
*
* @param {string} reference
*/
Kony.form.getValues(reference);- loadRecord
/**
* * Sample Usage:
* * Kony.form.loadRecord('reference', []);
*
* @param {string} reference
* @param {array} record
*/
Kony.form.loadRecord(reference, record);- setReadOnly
/**
* * Sample Usage:
* * Kony.form.setReadOnly('reference', true);
*
* @param {string} reference
* @param {boolean} isReadOnly
*/
Kony.form.setReadOnly(reference, isReadOnly);- clear
/**
* * Sample Usage:
* * Kony.form.clear('reference');
*
* @param {string} reference
*/
Kony.form.clear(reference);- isValid
/**
* * Sample Usage:
* * Kony.form.isValid('reference');
*
* @param {string} reference
*/
Kony.form.isValid(reference);- getInvalidFields
/**
* * Sample Usage:
* * Kony.form.getInvalidFields('reference');
*
* @param {string} reference
*/
Kony.form.getInvalidFields(reference);- get
/**
* * Sample Usage:
* * Kony.button.get('reference');
*
* @param {string} reference
*/
Kony.button.get(reference);- disable
/**
* * Sample Usage:
* * Kony.button.disable('reference');
*
* @param {string} reference
*/
Kony.button.disable(reference);- enable
/**
* * Sample Usage:
* * Kony.button.enable('reference');
*
* @param {string} reference
*/
Kony.button.enable(reference);- default
/**
* * Sample Usage:
* * renderer: Kony.render.default(value);
*
* @param {*} value
*/
Kony.render.default(value);- yesNo
/**
* * Sample Usage:
* * renderer: Kony.render.yesNo(value);
*
* @param {number} value
*/
Kony.render.yesNo(value);- currency
/**
* * Sample Usage:
* * renderer: Kony.render.currency(value);
*
* @param {number} value
*/
Kony.render.currency(value);- accurate
/**
* * Sample Usage:
* * renderer: Kony.render.accurate(value);
*
* @param {number} value
*/
Kony.render.accurate(value);- fullDate
/**
* * Sample Usage:
* * renderer: Kony.render.fullDate(value);
*
* @param {string|date} value
*/
Kony.render.fullDate(value);- ymdDate
/**
* * Sample Usage:
* * renderer: Kony.render.ymdDate(value);
*
* @param {string|date} value
*/
Kony.render.ymdDate(value);- dmyDate
/**
* * Sample Usage:
* * renderer: Kony.render.dmyDate(value);
*
* @param {string|date} value
*/
Kony.render.dmyDate(value);- mdyDate
/**
* * Sample Usage:
* * renderer: Kony.render.mdyDate(value);
*
* @param {string|date} value
*/
Kony.render.mdyDate(value);- formatDate
/**
* * Sample Usage:
* * renderer: Kony.render.formatDate(value, 'YYYY');
*
* @param {string|date} value
* @param {string} format
*/
Kony.render.formatDate(value, format);- request
/**
* * Sample Usage:
* * Kony.ajax.request('url', 'GET', { key: value }, function (){}, function (){}, false);
*
* @param {string} url
* @param {string} method
* @param {object} params
* @param {function} sucessCallback
* @param {function} failureCallback
* @param {boolean} async
*/
Kony.ajax.request(url, method, params, sucessCallback, failureCallback, async);- convertObjectToQuery
/**
* * Sample Usage:
* * Kony.url.convertObjectToQuery({ key: value });
*
* @param {object} params
*/
Kony.url.convertObjectToQuery(params);- create
/**
* * Sample Usage:
* * Kony.task.create(function (){});
*
* @param {function} callback
*/
Kony.task.create(callback);- getHeight
/**
* * Sample Usage:
* * Kony.window.getHeight();
*/
Kony.window.getHeight();- getWidth
/**
* * Sample Usage:
* * Kony.window.getWidth();
*/
Kony.window.getWidth();- custom
/**
* * Sample Usage:
* * Kony.message.custom('Test', 'test', Ext.Msg.YESNO, Ext.Msg.QUESTION, function (){});
*
* @param {string} title
* @param {string} message
* @param {class} btn
* @param {class} icon
* @param {function} callback
*/
Kony.message.custom(title, message, btn, icon, callback);- alert
/**
* * Sample Usage:
* * Kony.message.alert('test');
*
* @param {string} message
*/
Kony.message.alert(message);- confirm
/**
* * Sample Usage:
* * Kony.message.confirm('test', function (){});
*
* @param {string} message
* @param {function} callback
*/
Kony.message.confirm(message, callback);- error
/**
* * Sample Usage:
* * Kony.message.error('test');
*
* @param {string} message
*/
Kony.message.error(message);- info
/**
* * Sample Usage:
* * Kony.message.info('test');
*
* @param {string} message
*/
Kony.message.info(message);- *ask
/**
* * Sample Usage:
* * Kony.message.ask('test', function (){});
*
* @param {string} message
* @param {function} callback
*/
Kony.message.ask(message, callback);- warn
/**
* * Sample Usage:
* * Kony.message.warn('test');
*
* @param {string} message
*/
Kony.message.warn(message);