var kendo = {
ui: {},
mobile: {ui: {}},
dataviz: {ui: {}},
data: {}
};
FX = function() { };
FX.prototype = {
kendoAnimate: function(duration,reverse,complete,show,hide) {
///
/// Applies the specified animation effect/s to all selected elements and triggers the callback on every element when it completes its animation.
/// Uses transitions and transformations where available and falls back to jQuery animate where not. kendoAnimate can be used to run one of the provided
/// animation effects or you can define one yourself, using the same format.
///
/// The effect duration (speed) in milliseconds.
/// Whether the effect should play backwards, useful when doing the same animation but with the opposite direction, like opening and closing.
/// Completion callback that should be called after animation completion. It gets fired for every animated element and is passed the said element as its only argument.
/// Whether the element should be shown before animating.
/// Whether the element should be hidden after the animation completes.
},
kendoStop: function(gotoEnd) {
///
/// Stops the animation effect running on the specified elements and optionally jumps to the end and clears the animation effect queue.
/// In browsers that don't support transitions falls back to jQuery stop().This functionality is useful to avoid chaining many effects, causing them to run longer than expected.
///
/// Whether to jump to the animation end position when stopping or just leave the element at its current position.
},
kendoAddClass: function(classes,options) {
///
/// Adds a CSS class to the element, while doing a transition to the new state. If the browser doesn't support transitions,
/// the method falls back to jQuery addClass();
///
/// A list of the classes that should be added to the element/s, separated by a space.
/// An object containing several additional options, like duration and exclusive.
},
kendoRemoveClass: function(classes,options) {
///
/// Removes a CSS class from the element, while doing a transition to the new state. If the browser doesn't support transitions,
/// the method falls back to jQuery removeClass();
///
/// A list of the classes that should be removed from the element/s, separated by a space.
/// An object containing several additional options, like duration and exclusive.
},
kendoToggleClass: function(classes,options,toggle) {
///
/// Toggle a CSS class on the element, based on a flag, while doing a transition to the new state. If the browser doesn't support transitions,
/// the method falls back to jQuery toggleClass();
///
/// A list of the classes that should be toggled on the element/s, separated by a space.
/// An object containing several additional options, like duration and exclusive.
/// A boolean flag to control the toggle - true to add or false to remove the CSS class. If omitted the method will assume the opposite state should be toggled.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoFX = function() {
///
/// Returns a reference to the FX widget, instantiated on the selector.
///
/// The FX instance (if present).
};
$.fn.kendoFX = function(options) {
///
/// Instantiates a FX widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
if (!kendo) {
kendo = {};
}
kendo.Class = function() { };
kendo.Class.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoClass = function() {
///
/// Returns a reference to the kendo.Class widget, instantiated on the selector.
///
/// The kendo.Class instance (if present).
};
$.fn.kendoClass = function(options) {
///
/// Instantiates a kendo.Class widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.Layout = function() { };
kendo.Layout.prototype = {
showIn: function(container,view) {
///
/// Renders the View element in the element specified by the selector
///
/// The selector of the container in which the view element will be appended.
/// The view instance that will be rendered.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoLayout = function() {
///
/// Returns a reference to the kendo.Layout widget, instantiated on the selector.
///
/// The kendo.Layout instance (if present).
};
$.fn.kendoLayout = function(options) {
///
/// Instantiates a kendo.Layout widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.Observable = function() { };
kendo.Observable.prototype = {
bind: function(eventName,handler) {
///
/// Attaches a handler to an event.
///
/// The name of the event.
/// A function to execute each time the event is triggered. That function should have a single parameter which will contain any event specific data.
},
one: function(eventName,handler) {
///
/// Attaches a handler to an event. The handler is executed only once.
///
/// The name of the event.
/// A function to execute each time the event is triggered. That function should have a single parameter which will contain any event specific data.
},
trigger: function(eventName,eventData) {
///
/// Executes all handlers attached to the given event.
///
/// The name of the event to trigger.
/// Optional event data which will be passed as an argument to the event handlers.
},
unbind: function(eventName,handler) {
///
/// Remove a previously attached event handler.
///
/// The name of the event. If not specified all handlers of all events will be removed.
/// The handler which should no loger be executed. If not specified all handlers listening to that event will be removed.
},
self: null
};
$.fn.getKendoObservable = function() {
///
/// Returns a reference to the kendo.Observable widget, instantiated on the selector.
///
/// The kendo.Observable instance (if present).
};
$.fn.kendoObservable = function(options) {
///
/// Instantiates a kendo.Observable widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.Router = function() { };
kendo.Router.prototype = {
start: function() {
///
/// Activates the router binding to the URL fragment part changes.
///
},
Example: function() {
///
///
///
},
route: function(route,callback) {
///
/// Specifies a callback for the given route. The route definition can contain bound parameters, optional segments, and route globbing.
/// The parsed parts of the URL are passed as parameters to the route callback.
///
/// The route definition.
/// The callback to be executed when the route is matched.
},
navigate: function(route,silent) {
///
/// Navigates to the given route.
///
/// The route to navigate to.
/// If set to true, the router callbacks will not be called.
},
destroy: function() {
///
/// Unbinds the router instance listeners from the URL fragment part changes.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoRouter = function() {
///
/// Returns a reference to the kendo.Router widget, instantiated on the selector.
///
/// The kendo.Router instance (if present).
};
$.fn.kendoRouter = function(options) {
///
/// Instantiates a kendo.Router widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.View = function() { };
kendo.View.prototype = {
destroy: function() {
///
/// Removes the View element from the DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
render: function(container) {
///
/// Renders the view contents. Accepts a jQuery selector (or jQuery object) to which the contents will be appended.
/// Alternatively, the render method can be called without parameters in order to retrieve the View element for manual insertion/further manipulation.
///
/// (Optional) the element in which the view element will be appended.
/// the view element.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoView = function() {
///
/// Returns a reference to the kendo.View widget, instantiated on the selector.
///
/// The kendo.View instance (if present).
};
$.fn.kendoView = function(options) {
///
/// Instantiates a kendo.View widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
tagName — String (default: "div")
///
The tag used for the root element of the view.
///
///
wrap — Boolean (default: true)
///
If set to false, the view will not wrap its contents in a root element. In that case, the view element will point to the root element in the template.
///
///
///
/// The widget configuration options
///
};
kendo.data.Binder = function() { };
kendo.data.Binder.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoBinder = function() {
///
/// Returns a reference to the kendo.data.Binder widget, instantiated on the selector.
///
/// The kendo.data.Binder instance (if present).
};
$.fn.kendoBinder = function(options) {
///
/// Instantiates a kendo.data.Binder widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.data.DataSource = function() { };
kendo.data.DataSource.prototype = {
add: function(model) {
///
/// Appends a data item to the data source.
///
/// Either a kendo.data.Model instance or JavaScript object containing the data item field values.
/// the data item which is inserted.
},
aggregate: function(value) {
///
/// Gets or sets the aggregate configuration.
///
/// The aggregate configuration. Accepts the same values as the aggregate option.
/// the current aggregate configuration.
},
aggregates: function() {
///
/// Returns the aggregate results.
///
/// the aggregate results. There is a key for every aggregated field.
},
at: function(index) {
///
/// Returns the data item at the specified index. The index is zero-based.
///
/// The zero-based index of the data item.
/// the data item at the specified index. Returns undefined if a data item is not found at the specified index.Returns a kendo.data.Model instance if the schema.model option is set.
},
cancelChanges: function(model) {
///
/// Cancels any pending changes in the data source. Deleted data items are restored, new data items are removed and updated data items are restored to their initial state.
///
/// The optional data item (model). If specified only the changes of this data item will be discarded. If omitted all changes will be discarded.
},
data: function(value) {
///
/// Gets or sets the data items of the data source.If the data source is bound to a remote service (via the transport option) the data method will return the service response.
/// Every item from the response is wrapped in a kendo.data.ObservableObject or kendo.data.Model (if the schema.model option is set).If the data source is bound to a JavaScript array (via the data option) the data method will return the items of that array.
/// Every item from the array is wrapped in a kendo.data.ObservableObject or kendo.data.Model (if the schema.model option is set).If the data source is grouped (via the group option or the group method) and the serverGrouping is set to true
/// the data method will return the group items.
///
/// The data items which will replace the current ones in the data source. If omitted the current data items will be returned.
/// the data items of the data source. Returns empty array if the data source hasn't been populated with data items via the read, fetch or query methods.
},
fetch: function(callback) {
///
/// Reads the data items from a remote service (if the transport option is set) or from a JavaScript array (if the data option is set).
///
/// The optional function which is executed when the remote request is finished. The function context (available via the this keyword) will be set to the data source instance.
},
filter: function(value) {
///
/// Gets or sets the filter configuration.
///
/// The filter configuration. Accepts the same values as the filter option.
/// the current filter configuration.
},
get: function(id) {
///
/// Gets the data item (model) with the specified id.
///
/// The id of the model to look for.
/// the model instance. Returns undefined if a model with the specified id is not found.
},
getByUid: function(uid) {
///
/// Gets the data item (model) with the specified uid.
///
/// The uid of the model to look for.
/// the model instance. Returns undefined if a model with the specified uid is not found.
},
group: function(value) {
///
/// Gets or sets the grouping configuration.
///
/// The grouping configuration. Accepts the same values as the group option.
/// the current grouping configuration.
},
hasChanges: function() {
///
/// Cheks if the data itams have changed.
///
/// returns true if the data items have changed. Otherwise, false.
},
indexOf: function(dataItem) {
///
/// Gets the index of the specified data item.
///
/// The target data item.
/// the index of the specified data item. Returns -1 if the data item is not found.
},
insert: function(index,model) {
///
/// Inserts a data item in the data source at the specified index.
///
/// The zero-based index at which the data item will be inserted.
/// Either a kendo.data.Model instance or JavaScript object containing the field values.
/// the data item which is inserted.
},
page: function(page) {
///
/// Gets or sets the current page.
///
/// The new page.
/// the current page.
},
pageSize: function(size) {
///
/// Gets or sets the current page size.
///
/// The new page size.
/// the current page size.
},
query: function(options) {
///
/// Executes the specified query over the data items. Makes a HTTP request if bound to a remote service.
///
/// The query options which should be applied.
},
read: function(data) {
///
/// Reads data items from a remote service (if the transport option is set) or from a JavaScript array (if the data option is set).
///
/// Optional data to pass to the remote service.
},
remove: function(model) {
///
/// Removes the specified data item from the data source.
///
/// The data item which should be removed.
},
sort: function(value) {
///
/// Gets or sets the sort order which will be applied over the data items.
///
/// The sort configuration. Accepts the same values as the sort option.
/// the current sort configuration.
},
sync: function() {
///
/// Saves any data item changes.The sync method will request the remote service if:
///
},
total: function() {
///
/// Gets the total number of data items. Uses schema.total if the transport.read option is set.
///
/// the total number of data items. Returns the length of the array returned by the data method if schema.total or transport.read are not set.Returns 0 if the data source hasn't been populated with data items via the read, fetch or query methods.
},
totalPages: function() {
///
/// Gets the number of available pages.
///
/// the available pages.
},
view: function() {
///
/// Returns the data items which correspond to the current page, filter, sort and group configuration.To ensure that data is available this method should be used within the change event handler or the fetch method.
///
/// the data items. Returns groups if the data items are grouped (via the group option or the group method).
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDataSource = function() {
///
/// Returns a reference to the kendo.data.DataSource widget, instantiated on the selector.
///
/// The kendo.data.DataSource instance (if present).
};
$.fn.kendoDataSource = function(options) {
///
/// Instantiates a kendo.data.DataSource widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
aggregate — Array
///
The aggregate(s) which are calculated when the data source populates with data. The supported aggregates are "average", "count", "max", "min" and "sum".
///
///
autoSync — Boolean (default: false)
///
If set to true the data source would automatically save any changed data items by calling the sync method. By default changes are not automatically saved.
///
///
batch — Boolean (default: false)
///
If set to true the data source will batch CRUD operation requests. For example updating two data items would cause one HTTP request instead of two. By default the data source
///
makes a HTTP request for every CRUD operation.
///
///
data — Array|String
///
The array of data items which the data source contains. The data source will wrap those items as kendo.data.ObservableObject or kendo.data.Model (if schema.model is set).Can be set to a string value if the schema.type option is set to "xml".
///
///
filter — Array|Object
///
The filter(s) which is (are) applied over the data items. By default no filter is applied.
///
///
group — Array|Object
///
The grouping configuration of the data source. If set the data items will be grouped when the data source is populated. By default grouping is not applied.
///
///
page — Number
///
The page of data which the data source will return when the view method is invoked or request from the remote service.
///
///
pageSize — Number
///
The number of data items per page.
///
///
schema — Object
///
The configuration used to parse the remote sevice response.
///
///
serverAggregates — Boolean (default: false)
///
If set to true the data source will leave the aggregate calculation to the remote service. By default the data source calculates aggregates client-side.
///
///
serverFiltering — Boolean (default: false)
///
If set to true the data source will leave the filtering implementation to the remote service. By default the data source performs filtering client-side.By default the filter is sent to the server following jQuery's conventions.For example the filter { logic: "and", filters: [ { field: "name", operator: "startswith", value: "Jane" } ] } is sent as:Use the parameterMap option to send the filter option in a different format.
///
///
serverGrouping — Boolean (default: false)
///
If set to true the data source will leave the grouping implementation to the remote service. By default the data source performs grouping client-side.By default the group is sent to the server following jQuery's conventions.For example the group { field: "category", dir: "desc" } is sent as:Use the parameterMap option to send the group option in a different format.
///
///
serverPaging — Boolean (default: false)
///
If set to true the data source will leave the data item paging implementation to the remote service. By default the data source performs paging client-side.The following options are sent to the server when server paging is enabled:Use the parameterMap option to send the paging options in a different format.
///
///
serverSorting — Boolean (default: false)
///
If set to true the data source will leave the data item sorting implementation to the remote service. By default the data source performs sorting client-side.By default the sort is sent to the server following jQuery's conventions.For example the sort { field: "age", dir: "desc" } is sent as:Use the parameterMap option to send the paging options in a different format.
///
///
sort — Array|Object
///
The sort order which will be applied over the data items. By default the data items are not sorted.
///
///
transport — Object
///
The configuration used to load and save the data items. A data source is remote or local based on the way of it retrieves data items.Remote data sources load and save data items from and to a remote end-point (a.k.a. remote service or server). The transport option describes the remote service configuration - URL, HTTP verb, HTTP headers etc.
///
The transport option can also be used to implement custom data loading and saving.Local data sources are bound to a JavaScript array via the data option.
///
///
type — String
///
If set the data source will use a predefined transport and/or schema. The only supported value is "odata" which supports the OData v.2 protocol.
///
///
///
/// The widget configuration options
///
};
kendo.data.HierarchicalDataSource = function() { };
kendo.data.HierarchicalDataSource.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoHierarchicalDataSource = function() {
///
/// Returns a reference to the kendo.data.HierarchicalDataSource widget, instantiated on the selector.
///
/// The kendo.data.HierarchicalDataSource instance (if present).
};
$.fn.kendoHierarchicalDataSource = function(options) {
///
/// Instantiates a kendo.data.HierarchicalDataSource widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
schema — Object
///
The schema configuration of the HierarchicalDataSource.
///
///
///
/// The widget configuration options
///
};
kendo.data.Model = function() { };
kendo.data.Model.prototype = {
bind: function() {
///
/// Attaches a handler to an event. More info can be found in the bind section of the Observable API reference.
///
},
editable: function(field) {
///
/// Determines if the specified field is editable or not.
///
/// The field to check.
},
get: function() {
///
/// Gets the value of the specified field. Inherited from ObservableObject. More info can be found in the get section of the
/// ObservableObject API reference.
///
},
isNew: function() {
///
/// Checks if the Model is new or not. The id field is used to determine if a model instance is new or existing one.
/// If the value of the field specified is equal to the default value (specifed through the fields configuration) the model is considered as new.
///
},
set: function() {
///
/// Sets the value of the specified field. Inherited from ObservableObject. More info can be found in the set section of the
/// ObservableObject API reference.
///
},
toJSON: function() {
///
/// Creates a plain JavaScript object which contains all fields of the Model. Inherited from ObservableObject. More info can be found in the toJSON section of the
/// ObservableObject API reference.
///
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoModel = function() {
///
/// Returns a reference to the kendo.data.Model widget, instantiated on the selector.
///
/// The kendo.data.Model instance (if present).
};
$.fn.kendoModel = function(options) {
///
/// Instantiates a kendo.data.Model widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.data.Node = function() { };
kendo.data.Node.prototype = {
append: function(model) {
///
/// Appends a new item to the children datasource, and initializes the datasource, if necessary.
///
/// The data for the new item
},
level: function() {
///
/// Gets the current nesting level of the Node within the HierarchicalDataSource.
///
},
load: function() {
///
/// Loads the child nodes in the child datasource, supplying the id of the Node to the request.
///
},
loaded: function() {
///
/// Gets or sets the loaded flag of the Node. Setting the loaded flag to false allows reloading of child items.
///
},
parentNode: function() {
///
/// Gets the parent node of the Node, if any.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoNode = function() {
///
/// Returns a reference to the kendo.data.Node widget, instantiated on the selector.
///
/// The kendo.data.Node instance (if present).
};
$.fn.kendoNode = function(options) {
///
/// Instantiates a kendo.data.Node widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.data.ObservableArray = function() { };
kendo.data.ObservableArray.prototype = {
bind: function(eventName,handler) {
///
/// Attaches an event handler for the specified event.
///
/// The name of the event.
/// The function which will be invoked when the event is raised.
},
join: function(separator) {
///
/// Joins all items of an ObservableArray into a string. Equivalent of
/// Array.prototype.join.
///
/// Specifies the string to separate each item of the array. If omitted the array items are separated with a comma (,)
},
parent: function() {
///
/// Returns the parent ObservableObject. If the current ObservableArray is not nested
/// returns undefined.
///
},
pop: function() {
///
/// Removes the last item from an array and returns that item. Equivalent of
/// Array.prototype.pop.
///
},
push: function() {
///
/// Appends the given items to the array and returns the new length of the array. Equivalent of
/// Array.prototype.push.
/// The new items are wrapped as ObservableObject if they are complex objects.
///
},
slice: function(begin,end) {
///
/// Returns a one-level deep copy of a portion of an array. Equivalent of
/// Array.prototype.slice.
/// The result of the slice method is not an instance of ObvservableArray. It is a regular JavaScript Array object.
/// > Important: The slice method does not modify the original ObservableArray.
///
/// Zero-based index at which to begin extraction.
/// Zero-based index at which to end extraction. If end is omitted, slice extracts to the end of the sequence.
},
splice: function(index,howMany) {
///
/// Changes an ObservableArray, by adding new items while removing old items. Equivalent of
/// Array.prototype.splice
///
/// Index at which to start changing the array. If negative, will begin that many elements from the end.
/// An integer indicating the number of items to remove. If howMany is 0, no items are removed. In this case, you should specify at least one new item.
/// An Array containing the removed items. The result of the splice method is not an instance of ObvservableArray.
},
shift: function() {
///
/// Removes the first item from an ObvservableArray and returns that item. Equivalent of
/// Array.prototype.shift.
///
},
toJSON: function() {
///
/// Returns a JavaScript Array which represents the contents of the ObservableArray.
///
},
unshift: function() {
///
/// Adds one or more items to the beginning of an ObservableArray and returns the new length.
/// Equivalent of Array.prototype.unshift.
///
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoObservableArray = function() {
///
/// Returns a reference to the kendo.data.ObservableArray widget, instantiated on the selector.
///
/// The kendo.data.ObservableArray instance (if present).
};
$.fn.kendoObservableArray = function(options) {
///
/// Instantiates a kendo.data.ObservableArray widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.data.ObservableObject = function() { };
kendo.data.ObservableObject.prototype = {
bind: function() {
///
/// Attaches a handler to an event. More info can be found in the bind section of the
/// kendo.Observable API reference.
///
},
get: function(name) {
///
/// Gets the value of the specified field.
///
/// The name of the field whose value is going to be returned.
/// The value of the specified field.
},
parent: function() {
///
/// Returns the parent ObservableObject. If the current ObservableObject is not
/// nested returns undefined;
///
},
set: function(name,value) {
///
/// Sets the value of the specified field.
///
/// The name of the field whose value is going to be returned.
/// The new value of the field.
},
toJSON: function() {
///
/// Creates a plain JavaScript object which contains all fields of the ObservableObject.
///
/// An Object which contains only the fields of the ObservableObject.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoObservableObject = function() {
///
/// Returns a reference to the kendo.data.ObservableObject widget, instantiated on the selector.
///
/// The kendo.data.ObservableObject instance (if present).
};
$.fn.kendoObservableObject = function(options) {
///
/// Instantiates a kendo.data.ObservableObject widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.dataviz.ui.Chart = function() { };
kendo.dataviz.ui.Chart.prototype = {
destroy: function() {
///
/// Prepares the widget for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
redraw: function() {
///
/// Repaints the chart using the currently loaded data.
///
},
refresh: function() {
///
/// Reloads the data and renders the chart.
///
},
setDataSource: function(dataSource) {
///
/// Sets the data source of the widget.
///
/// The data source to which the widget should be bound.
},
svg: function() {
///
/// Returns the SVG representation of the chart. The returned string is a self-contained SVG document that can be used as is or converted to other formats using tools like Inkscape and
/// ImageMagick. Both programs provide command-line interface suitable for server-side processing.
///
/// the SVG representation of the chart.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoChart = function() {
///
/// Returns a reference to the kendo.dataviz.ui.Chart widget, instantiated on the selector.
///
/// The kendo.dataviz.ui.Chart instance (if present).
};
$.fn.kendoChart = function(options) {
///
/// Instantiates a kendo.dataviz.ui.Chart widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
autoBind — Boolean (default: true)
///
If set to false the widget will not bind to the data source during initialization. In this case data binding will occur when the change event of the
///
data source is fired. By default the widget will bind to the data source specified in the configuration.
///
///
axisDefaults — Object
///
The default options for all chart axes. Accepts the options supported by categoryAxis, valueAxis, xAxis and yAxis.
///
///
categoryAxis — Array|Object
///
The category axis configuration options.
///
///
chartArea — Object
///
The chart area configuration options. Represents the entire visible area of the chart.
///
///
dataSource — Object|Array
///
The data source of the chart which is used to display the series. Can be a JavaScript object which represents a valid data source configuration, a JavaScript array or an existing kendo.data.DataSource
///
instance.If the dataSource option is set to a JavaScript object or array the widget will initialize a new kendo.data.DataSource instance using that value as data source configuration.If the dataSource option is an existing kendo.data.DataSource instance the widget will use that instance and will not initialize a new one.
///
///
legend — Object
///
The chart legend configuration options.
///
///
panes — Array
///
The chart panes configuration.Panes are used to split the chart in two or more parts. The panes are ordered from top to bottom.Each axis can be associated with a pane by setting its pane option to the name of the desired pane.
///
Axis that don't have specified pane are placed in the top (default) pane.Series are moved to the desired pane by associating them with an axis.
///
///
plotArea — Object
///
The plot area configuration options. The plot area is the area which displays the series.
///
///
series — Array
///
The configuration of the chart series.The series type is determined by the value of the type field.
///
If a type value is missing, the type is assumed to be the one specified in seriesDefaults.
///
///
seriesColors — Array
///
The default colors for the chart's series. When all colors are used, new colors are pulled from the start again.
///
///
seriesDefaults — Object
///
The default options for all series.
///
///
theme — String
///
The chart theme.The supported values are:
///
///
title — String
///
The chart title configuration options or text.
///
///
title — Object
///
The chart title configuration options or text.
///
///
tooltip — Object
///
The chart series tooltip configuration options.
///
///
transitions — Boolean (default: true)
///
If set to true the chart will play animations when displaying the series. By default animations are enabled.
///
///
valueAxis — Array
///
The value axis configuration options.
///
///
xAxis — Array
///
The X-axis configuration options of the scatter chart X-axis. Supports all valueAxis options.
///
///
yAxis — Array
///
The y axis configuration options of the scatter chart. Supports all valueAxis options.
///
///
///
/// The widget configuration options
///
};
kendo.dataviz.ui.LinearGauge = function() { };
kendo.dataviz.ui.LinearGauge.prototype = {
destroy: function() {
///
/// Prepares the Gauge for safe removal from the DOM.Detaches event handlers and removes data entries in order to avoid memory leaks.
///
},
redraw: function() {
///
/// Redraws the gauge.
///
},
svg: function() {
///
/// Returns the SVG representation of the current gauge.
/// The returned string is a self-contained SVG document
/// that can be used as is or converted to other formats
/// using tools like Inkscape and
/// ImageMagick.
/// Both programs provide command-line interface
/// suitable for backend processing.
///
},
value: function() {
///
/// Change the value of the gauge.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoLinearGauge = function() {
///
/// Returns a reference to the kendo.dataviz.ui.LinearGauge widget, instantiated on the selector.
///
/// The kendo.dataviz.ui.LinearGauge instance (if present).
};
$.fn.kendoLinearGauge = function(options) {
///
/// Instantiates a kendo.dataviz.ui.LinearGauge widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
gaugeArea — Object
///
The gauge area configuration options.
///
This is the entire visible area of the gauge.
///
///
pointer — Object
///
The pointer configuration options.
///
///
scale — Object
///
Configures the scale.
///
///
transitions — Boolean (default: true)
///
A value indicating if transition animations should be played.
///
///
///
/// The widget configuration options
///
};
kendo.dataviz.ui.RadialGauge = function() { };
kendo.dataviz.ui.RadialGauge.prototype = {
destroy: function() {
///
/// Prepares the Gauge for safe removal from the DOM.Detaches event handlers and removes data entries in order to avoid memory leaks.
///
},
redraw: function() {
///
/// Redraws the gauge.
///
},
svg: function() {
///
/// Returns the SVG representation of the current gauge.
/// The returned string is a self-contained SVG document
/// that can be used as is or converted to other formats
/// using tools like Inkscape and
/// ImageMagick.
/// Both programs provide command-line interface
/// suitable for backend processing.
///
},
value: function() {
///
/// Change the value of the gauge.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoRadialGauge = function() {
///
/// Returns a reference to the kendo.dataviz.ui.RadialGauge widget, instantiated on the selector.
///
/// The kendo.dataviz.ui.RadialGauge instance (if present).
};
$.fn.kendoRadialGauge = function(options) {
///
/// Instantiates a kendo.dataviz.ui.RadialGauge widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
gaugeArea — Object
///
The gauge area configuration options.
///
This is the entire visible area of the gauge.
///
///
pointer — Object
///
The pointer configuration options.
///
///
rangeSize — Number
///
The width of the range indicators.
///
///
rangeDistance — Number
///
The distance from the range indicators to the ticks.
///
///
scale — Object
///
Configures the scale.
///
///
transitions — Boolean (default: true)
///
A value indicating if transition animations should be played.
///
///
///
/// The widget configuration options
///
};
kendo.dataviz.ui.Sparkline = function() { };
kendo.dataviz.ui.Sparkline.prototype = {
destroy: function() {
///
/// Prepares the Sparkline for safe removal from the DOM.Detaches event handlers and removes data entries in order to avoid memory leaks.
///
},
refresh: function() {
///
/// Reloads the data and repaints the chart.
///
},
setDataSource: function(dataSource) {
///
/// Sets the dataSource of an existing Chart and rebinds it.
///
///
},
svg: function() {
///
/// Returns the SVG representation of the current chart.
/// The returned string is a self-contained SVG document
/// that can be used as is or converted to other formats
/// using tools like Inkscape and
/// ImageMagick.
/// Both programs provide command-line interface
/// suitable for backend processing.
///
/// the SVG representation of the sparkline.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoSparkline = function() {
///
/// Returns a reference to the kendo.dataviz.ui.Sparkline widget, instantiated on the selector.
///
/// The kendo.dataviz.ui.Sparkline instance (if present).
};
$.fn.kendoSparkline = function(options) {
///
/// Instantiates a kendo.dataviz.ui.Sparkline widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
axisDefaults — Object
///
Default options for all chart axes.
///
///
categoryAxis — Array
///
The category axis configuration options.
///
///
chartArea — Object
///
The chart area configuration options.
///
This is the entire visible area of the chart.
///
///
data — Array
///
The data for the default sparkline series.Will be discareded if series are supplied.
///
///
dataSource — Object
///
DataSource configuration or instance.
///
///
autoBind — Boolean (default: true)
///
Indicates whether the chart will call read on the data source initially.
///
///
plotArea — Object
///
The plot area configuration options. This is the area containing the plotted series.
///
///
pointWidth — Number (default: 5)
///
The width to allocate for each data point.
///
///
series — Array
///
Array of series definitions.The series type is determined by the value of the type field.
///
If a type value is missing, the type is assumed to be the one specified in seriesDefaults.Each series type has a different set of options.
///
///
seriesColors — Array
///
The default colors for the chart's series. When all colors are used, new colors are pulled from the start again.
///
///
seriesDefaults — Object
///
Default values for each series.
///
///
theme — String
///
Sets Chart theme. Available themes: default, blueOpal, black.
///
///
tooltip — Object
///
The data point tooltip configuration options.
///
///
transitions — Boolean (default: false)
///
A value indicating if transition animations should be played.
///
///
type — String (default: "line")
///
The default series type.
///
///
valueAxis — Array
///
The value axis configuration options.
///
///
///
/// The widget configuration options
///
};
kendo.dataviz.ui.StockChart = function() { };
kendo.dataviz.ui.StockChart.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoStockChart = function() {
///
/// Returns a reference to the kendo.dataviz.ui.StockChart widget, instantiated on the selector.
///
/// The kendo.dataviz.ui.StockChart instance (if present).
};
$.fn.kendoStockChart = function(options) {
///
/// Instantiates a kendo.dataviz.ui.StockChart widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
dateField — String (default: "date")
///
The field containing the point date.
///
It is used as a default field for all date axes, including the navigator pane.The data item field value must be either:
///
///
navigator — Object
///
The data navigator configuration options.
///
///
axisDefaults — Object
///
Default options for all chart axes.
///
///
categoryAxis — Array
///
The category axis configuration options.
///
///
chartArea — Object
///
The chart area configuration options.
///
This is the entire visible area of the chart.
///
///
dataSource — Object
///
DataSource configuration or instance.
///
///
autoBind — Boolean (default: true)
///
Indicates whether the chart will call read on the data source initially.
///
///
legend — Object
///
The chart legend configuration options.
///
///
panes — Array
///
The chart panes configuration.Panes are used to split the chart in two or more parts. The panes are ordered from top to bottom.Each axis can be associated with a pane by setting its pane option to the name of the desired pane.
///
Axis that don't have specified pane are placed in the top (default) pane.Series are moved to the desired pane by associating them with an axis.
///
///
plotArea — Object
///
The plot area configuration options. This is the area containing the plotted series.
///
///
series — Array
///
Array of series definitions.The series type is determined by the value of the type field.
///
If a type value is missing, the type is assumed to be the one specified in seriesDefaults.Each series type has a different set of options.
///
///
seriesColors — Array
///
The default colors for the chart's series. When all colors are used, new colors are pulled from the start again.
///
///
seriesDefaults — Object
///
Default values for each series.
///
///
theme — String
///
Sets Chart theme. Available themes: default, blueOpal, black.
///
///
title — Object
///
The chart title configuration options or text.
///
///
tooltip — Object
///
The data point tooltip configuration options.
///
///
transitions — Boolean (default: true)
///
A value indicating if transition animations should be played.
///
///
valueAxis — Array
///
The value axis configuration options.
///
///
xAxis — Array
///
Scatter charts X-axis configuration options.
///
Includes all valueAxis options in addition to:
///
///
yAxis — Array
///
Scatter charts Y-axis configuration options.
///
Includes all valueAxis options in addition to:
///
///
///
/// The widget configuration options
///
};
kendo.mobile.Application = function() { };
kendo.mobile.Application.prototype = {
hideLoading: function() {
///
/// Hide the loading animation.
///
},
navigate: function(url,transition) {
///
/// Navigate to local or to remote view.
///
/// The id or url of the view.
/// The transition to apply when navigating. See View Transitions section for more information.
},
scroller: function() {
///
/// Get a reference to the current view's scroller widget instance.
///
/// the scroller widget instance.
},
showLoading: function() {
///
/// Show the loading animation.
///
},
view: function() {
///
/// Get a reference to the current view.
///
/// the view instance.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoApplication = function() {
///
/// Returns a reference to the kendo.mobile.Application widget, instantiated on the selector.
///
/// The kendo.mobile.Application instance (if present).
};
$.fn.kendoApplication = function(options) {
///
/// Instantiates a kendo.mobile.Application widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
hideAddressBar — Boolean (default: true)
///
Whether to hide the browser address bar. Supported only in iPhone and iPod. Doesn't affect standalone mode as there the address bar is always hidden.
///
///
updateDocumentTitle — Boolean (default: true)
///
Whether to update the document title.
///
///
initial — String
///
The id of the initial mobile View to display.
///
///
layout — String
///
The id of the default Application Layout.
///
///
loading — String (default: ")
///
The text displayed in the loading popup. Setting this value to false will disable the loading popup.Note: The text should be wrapped inside tag.
///
///
platform — String
///
Which platform look to force on the application. Can be one of "ios", "android", "blackberry".
///
///
serverNavigation — Boolean
///
If set to true, the application will not use ajax to load remote views.
///
///
transition — String
///
The default View transition.
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.ActionSheet = function() { };
kendo.mobile.ui.ActionSheet.prototype = {
close: function() {
///
/// Close the ActionSheet.
///
},
destroy: function() {
///
/// Prepares the ActionSheet for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
open: function(target,context) {
///
/// Open the ActionSheet.
///
/// (optional) The target element of the ActionSheet, available in the callback methods.Notice The target element is mandatory on tablets, as the ActionSheet widget positions itself relative to opening element when a tablet is detected.
/// (optional) The context of the ActionSheet, available in the callback methods.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoActionSheet = function() {
///
/// Returns a reference to the kendo.mobile.ui.ActionSheet widget, instantiated on the selector.
///
/// The kendo.mobile.ui.ActionSheet instance (if present).
};
$.fn.kendoActionSheet = function(options) {
///
/// Instantiates a kendo.mobile.ui.ActionSheet widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
cancel — String (default: "Cancel")
///
The text of the cancel button.
///
///
popup — Object
///
The popup configuration options (tablet only).
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.BackButton = function() { };
kendo.mobile.ui.BackButton.prototype = {
destroy: function() {
///
/// Prepares the BackButton for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoBackButton = function() {
///
/// Returns a reference to the kendo.mobile.ui.BackButton widget, instantiated on the selector.
///
/// The kendo.mobile.ui.BackButton instance (if present).
};
$.fn.kendoBackButton = function(options) {
///
/// Instantiates a kendo.mobile.ui.BackButton widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.Button = function() { };
kendo.mobile.ui.Button.prototype = {
badge: function(value) {
///
/// Introduced in Q1 2013 SP Sets a badge on the Button with the specified value. If invoked without parameters, returns the current badge value. Set the value to false to remove the badge.
///
/// The target value to be set or false to be removed.
/// Returns the badge value if invoked without parameters, otherwise returns the Button object.
},
destroy: function() {
///
/// Prepares the Button for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoButton = function() {
///
/// Returns a reference to the kendo.mobile.ui.Button widget, instantiated on the selector.
///
/// The kendo.mobile.ui.Button instance (if present).
};
$.fn.kendoButton = function(options) {
///
/// Instantiates a kendo.mobile.ui.Button widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
icon — String
///
The icon of the button. It can be either one of the built-in icons, or a custom one.
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.ButtonGroup = function() { };
kendo.mobile.ui.ButtonGroup.prototype = {
badge: function(button,value) {
///
/// Introduced in Q1 2013 SP Sets a badge on one of the ButtonGroup buttons with the specified value. If invoked without parameters, returns the button's current badge value. Set the value to false to remove the badge.
///
/// The target button specified either as a jQuery selector/object or as an button index.
/// The target value to be set or false to be removed.
/// Returns the badge value if invoked without parameters, otherwise returns the ButtonGroup object.
},
current: function() {
///
/// Get the currently selected Button.
///
/// the jQuery object representing the currently selected button.
},
destroy: function() {
///
/// Prepares the ButtonGroup for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
select: function(li) {
///
/// Select a Button.
///
/// LI element or index of the Button.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoButtonGroup = function() {
///
/// Returns a reference to the kendo.mobile.ui.ButtonGroup widget, instantiated on the selector.
///
/// The kendo.mobile.ui.ButtonGroup instance (if present).
};
$.fn.kendoButtonGroup = function(options) {
///
/// Instantiates a kendo.mobile.ui.ButtonGroup widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
index — Number
///
Defines the initially selected Button.
///
///
selectOn — String (default: default "down")
///
Sets the DOM event used to select the button. Accepts "up" as an alias for touchend, mouseup and MSPointerUp vendor specific events.By default, buttons are selected immediately after the user presses the button (on touchstart or mousedown or MSPointerDown, depending on the mobile device).
///
However, if the widget is placed in a scrollable view, the user may accidentally press the button when scrolling. In such cases, it is recommended to set this option to "up".
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.DetailButton = function() { };
kendo.mobile.ui.DetailButton.prototype = {
destroy: function() {
///
/// Prepares the DetailButton for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDetailButton = function() {
///
/// Returns a reference to the kendo.mobile.ui.DetailButton widget, instantiated on the selector.
///
/// The kendo.mobile.ui.DetailButton instance (if present).
};
$.fn.kendoDetailButton = function(options) {
///
/// Instantiates a kendo.mobile.ui.DetailButton widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.Layout = function() { };
kendo.mobile.ui.Layout.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoLayout = function() {
///
/// Returns a reference to the kendo.mobile.ui.Layout widget, instantiated on the selector.
///
/// The kendo.mobile.ui.Layout instance (if present).
};
$.fn.kendoLayout = function(options) {
///
/// Instantiates a kendo.mobile.ui.Layout widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
id — String (default: null)
///
The id of the layout. Required.
///
///
platform — String
///
The specific platform this layout targets. By default, layouts are displayed
///
on all platforms.
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.ListView = function() { };
kendo.mobile.ui.ListView.prototype = {
destroy: function() {
///
/// Prepares the ListView for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
items: function() {
///
/// Get the listview DOM element items
///
/// The listview DOM element items
},
refresh: function() {
///
/// repaints the listview (works only in databound mode).
///
},
setDataSource: function(dataSource) {
///
/// Sets the dataSource of an existing ListView and rebinds it.
///
///
},
stopEndlessScrolling: function() {
///
/// Stops the 'endless scroll' of the ListView.
///
},
stopLoadMore: function() {
///
/// Stops the 'load more' functionality of the ListView.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoListView = function() {
///
/// Returns a reference to the kendo.mobile.ui.ListView widget, instantiated on the selector.
///
/// The kendo.mobile.ui.ListView instance (if present).
};
$.fn.kendoListView = function(options) {
///
/// Instantiates a kendo.mobile.ui.ListView widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
appendOnRefresh — Boolean (default: false)
///
Used in combination with pullToRefresh. If set to true, newly loaded data will be appended on top when refershing.
///
///
autoBind — Boolean (default: true)
///
Indicates whether the listview will call read on the DataSource initially.
///
///
dataSource — Object
///
Instance of DataSource or the data that the mobile ListView will be bound to.
///
///
endlessScroll — Boolean (default: false)
///
If set to true, the listview gets the next page of data when the user scrolls near the bottom of the view.
///
///
endlessScrollParameters — Function
///
A callback function used when the 'endlessScroll' option is enabled. The result of the function will be send as additional parameters to the DataSource's next method.
///
///
fixedHeaders — Boolean (default: false)
///
If set to true, the group headers will persist their position when the user scrolls through the listview. Applicable only when the type is set to group, or when binding to grouped datasource.
///
///
headerTemplate — String|Function (default: "#:value#")
///
The header item template (applicable when the type is set to group).
///
///
loadMore — Boolean (default: false)
///
If set to true, a button is rendered at the bottom of the listview, which fetch the next page of data when tapped.
///
///
loadMoreText — String (default: "Press to load more")
///
The text of the rendered load-more button (applies only if loadMore is set to true).
///
///
loadMoreParameters — Function
///
Check the 'endlessScrollParameters' option.
///
///
pullTemplate — String|Function (default: "Pull to refresh")
///
The message template displayed when the user pulls the listView. Applicable only when pullToRefresh is set to true.
///
///
pullToRefresh — Boolean (default: false)
///
If set to true, the listview will reload its data when the user pulls the view over the top limit.
///
///
pullParameters — Function
///
A callback function used when the 'pullToRefresh' option is enabled. The result of the function will be send as additional parameters to the DataSource's next method.
///
///
refreshTemplate — String|Function (default: "Refreshing")
///
The message template displayed during the refresh. Applicable only when pullToRefresh is set to true.
///
///
releaseTemplate — String|Function (default: "Release to refresh")
///
The message template indicating that pullToRefresh will occur. Applicable only when pullToRefresh is set to true.
///
///
scrollTreshold — String (default: 30)
///
The distance to the bottom in pixels, after which the listview will start fetching the next page. Applicable only when endlessScroll is set to true.
///
///
style — String
///
The style of the control. Can be either empty string(""), or inset.
///
///
template — String|Function (default: "#:data#")
///
The item template.
///
///
type — String
///
The type of the control. Can be either flat (default) or group. Determined automatically in databound mode.
///
///
filterable — Boolean (default: false)
///
Indicates whether the filter input must be visible or not.
///
///
filterable — Object
///
Indicates whether the filter input must be visible or not.
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.Loader = function() { };
kendo.mobile.ui.Loader.prototype = {
hide: function() {
///
/// Hide the loading animation.
///
},
show: function() {
///
/// Show the loading animation.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoLoader = function() {
///
/// Returns a reference to the kendo.mobile.ui.Loader widget, instantiated on the selector.
///
/// The kendo.mobile.ui.Loader instance (if present).
};
$.fn.kendoLoader = function(options) {
///
/// Instantiates a kendo.mobile.ui.Loader widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.ModalView = function() { };
kendo.mobile.ui.ModalView.prototype = {
close: function() {
///
/// Close the ModalView
///
},
destroy: function() {
///
/// Prepares the ModalView for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
open: function(target) {
///
/// Open the ModalView
///
/// (optional) The target of the ModalView
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoModalView = function() {
///
/// Returns a reference to the kendo.mobile.ui.ModalView widget, instantiated on the selector.
///
/// The kendo.mobile.ui.ModalView instance (if present).
};
$.fn.kendoModalView = function(options) {
///
/// Instantiates a kendo.mobile.ui.ModalView widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
height — Number
///
The height of the ModalView container in pixels. If not set, the element style is used.
///
///
modal — Boolean (default: true)
///
When set to false, the ModalView will close when the user taps outside of its element.
///
///
width — Number
///
The width of the ModalView container in pixels. If not set, the element style is used.
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.NavBar = function() { };
kendo.mobile.ui.NavBar.prototype = {
destroy: function() {
///
/// Prepares the NavBar for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
title: function(value) {
///
/// Update the title element text. The title element is specified by setting the role data attribute to view-title.
///
/// The text of title
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoNavBar = function() {
///
/// Returns a reference to the kendo.mobile.ui.NavBar widget, instantiated on the selector.
///
/// The kendo.mobile.ui.NavBar instance (if present).
};
$.fn.kendoNavBar = function(options) {
///
/// Instantiates a kendo.mobile.ui.NavBar widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.Pane = function() { };
kendo.mobile.ui.Pane.prototype = {
destroy: function() {
///
/// Prepares the Pane for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
hideLoading: function() {
///
/// Hide the loading animation.
///
},
navigate: function(url,transition) {
///
/// Navigate the local or remote view.
///
/// The id or URL of the view.
/// The transition to apply when navigating. See View Transitions section for more information.
},
showLoading: function() {
///
/// Show the loading animation.
///
},
view: function() {
///
/// Get a reference to the current view.
///
/// the view instance.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoPane = function() {
///
/// Returns a reference to the kendo.mobile.ui.Pane widget, instantiated on the selector.
///
/// The kendo.mobile.ui.Pane instance (if present).
};
$.fn.kendoPane = function(options) {
///
/// Instantiates a kendo.mobile.ui.Pane widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
initial — String
///
The id of the initial mobile View to display.
///
///
layout — String
///
The id of the default Pane Layout.
///
///
loading — String (default: "Loading...")
///
The text displayed in the loading popup. Setting this value to false will disable the loading popup.
///
///
transition — String
///
The default View transition.
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.PopOver = function() { };
kendo.mobile.ui.PopOver.prototype = {
close: function() {
///
/// Close the popover.
///
},
destroy: function() {
///
/// Prepares the PopOver for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
open: function(target) {
///
/// Open the PopOver.
///
/// The target of the Popover, to which the visual arrow will point to. This parameter is required for a tablet OS.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoPopOver = function() {
///
/// Returns a reference to the kendo.mobile.ui.PopOver widget, instantiated on the selector.
///
/// The kendo.mobile.ui.PopOver instance (if present).
};
$.fn.kendoPopOver = function(options) {
///
/// Instantiates a kendo.mobile.ui.PopOver widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
pane — Object
///
The pane configuration options.
///
///
popup — Object
///
The popup configuration options.
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.ScrollView = function() { };
kendo.mobile.ui.ScrollView.prototype = {
content: function(content) {
///
/// Update the scrollview HTML content
///
/// the new scrollView content.
},
destroy: function() {
///
/// Prepares the ScrollView for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
refresh: function() {
///
/// Redraw the mobile ScrollView pager. Called automatically on device orientation change event.
///
},
scrollTo: function(page,instant) {
///
/// Scroll to the given page. Pages are zero-based indexed.
///
/// The page to scroll to.
/// If set to true, the scrollview will jump instantly to the given page without any animation effects.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoScrollView = function() {
///
/// Returns a reference to the kendo.mobile.ui.ScrollView widget, instantiated on the selector.
///
/// The kendo.mobile.ui.ScrollView instance (if present).
};
$.fn.kendoScrollView = function(options) {
///
/// Instantiates a kendo.mobile.ui.ScrollView widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
bounceVelocityThreshold — Number (default: 1.6)
///
The velocity threshold after which a swipe will result in a bounce effect.
///
///
duration — Number (default: 300)
///
The milliseconds that take the ScrollView to snap to the current page after released.
///
///
page — Number (default: 0)
///
The initial page to display.
///
///
pageSize — Number (default: 1)
///
Multiplier applied to the snap amount of the ScrollView. By default, the widget scrolls to the next screen when swipe. If the pageSize property is set to 0.5, the ScrollView will scroll by half of the widget width.
///
///
velocityThreshold — Number (default: 0.8)
///
The velocity threshold after which a swipe will navigate to the next page (as opposed to snapping back to the current page).
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.Scroller = function() { };
kendo.mobile.ui.Scroller.prototype = {
destroy: function() {
///
/// Prepares the Scroller for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
pullHandled: function() {
///
/// Indicate that the pull event is handled (i.e. data from the server has been retrieved).
///
},
reset: function() {
///
/// Scrolls the container to the top.
///
},
scrollHeight: function() {
///
/// Returns the height in pixels of the scroller content.
///
},
scrollTo: function(x,y) {
///
/// Scrolls the container to the specified location. The arguments should be negative numbers.
///
/// The horizontal offset in pixels to scroll to.
/// The vertical offset in pixels to scroll to.
},
scrollWidth: function() {
///
/// Returns the width in pixels of the scroller content.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoScroller = function() {
///
/// Returns a reference to the kendo.mobile.ui.Scroller widget, instantiated on the selector.
///
/// The kendo.mobile.ui.Scroller instance (if present).
};
$.fn.kendoScroller = function(options) {
///
/// Instantiates a kendo.mobile.ui.Scroller widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
zoom — Boolean (default: false)
///
If set to true, the user can zoom in/out the contents of the widget using the pinch/zoom gesture.
///
///
elastic — Boolean (default: true)
///
Weather or not to allow out of bounds dragging and easing.
///
///
pullOffset — Number (default: 140)
///
The threshold below which a releasing the scroller will trigger the pull event.
///
Has effect only when the pullToRefresh option is set to true.
///
///
pullTemplate — String (default: "Pull to refresh")
///
The message template displayed when the user pulls the scroller.
///
Has effect only when the pullToRefresh option is set to true.
///
///
pullToRefresh — Boolean (default: false)
///
If set to true, the scroller will display a hint when the user pulls the container beyond its top limit.
///
If a pull beyond the specified pullOffset occurs, a pull event will be triggered.
///
///
refreshTemplate — String (default: "Refreshing")
///
The message template displayed during the refresh.
///
Has effect only when the pullToRefresh option is set to true.
///
///
releaseTemplate — String (default: "Release to refresh")
///
The message template displayed when the user pulls the scroller below the
///
pullOffset, indicating that pullToRefresh will occur.
///
Has effect only when the pullToRefresh option is set to true.
///
///
useNative — Boolean (default: false)
///
(available since Q1 2013)
///
If set to true, the scroller will use the native scrolling available in the current platform. This should help with form issues on some platforms (namely Android and WP8).
///
Native scrolling is only enabled on platforms that support it: iOS > 4, Android > 2, WP8. BlackBerry devices do support it, but the native scroller is flaky.
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.SplitView = function() { };
kendo.mobile.ui.SplitView.prototype = {
destroy: function() {
///
/// Prepares the SplitView for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoSplitView = function() {
///
/// Returns a reference to the kendo.mobile.ui.SplitView widget, instantiated on the selector.
///
/// The kendo.mobile.ui.SplitView instance (if present).
};
$.fn.kendoSplitView = function(options) {
///
/// Instantiates a kendo.mobile.ui.SplitView widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
style — String (default: "horizontal")
///
Defines the SplitView style - horizontal or vertical.
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.Swipe = function() { };
kendo.mobile.ui.Swipe.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoSwipe = function() {
///
/// Returns a reference to the kendo.mobile.ui.Swipe widget, instantiated on the selector.
///
/// The kendo.mobile.ui.Swipe instance (if present).
};
$.fn.kendoSwipe = function(options) {
///
/// Instantiates a kendo.mobile.ui.Swipe widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.Switch = function() { };
kendo.mobile.ui.Switch.prototype = {
check: function(check) {
///
/// Get/Set the checked state of the widget.
///
/// Whether to turn the widget on or off.
/// The checked state of the widget.
},
destroy: function() {
///
/// Prepares the Switch for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
toggle: function() {
///
/// Toggle the checked state of the widget.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoSwitch = function() {
///
/// Returns a reference to the kendo.mobile.ui.Switch widget, instantiated on the selector.
///
/// The kendo.mobile.ui.Switch instance (if present).
};
$.fn.kendoSwitch = function(options) {
///
/// Instantiates a kendo.mobile.ui.Switch widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
checked — Boolean (default: false)
///
The checked state of the widget.
///
///
offLabel — String (default: "OFF")
///
The OFF label.
///
///
onLabel — String (default: "ON")
///
The ON label.
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.TabStrip = function() { };
kendo.mobile.ui.TabStrip.prototype = {
badge: function(tab,value) {
///
/// Introduced in Q1 2013 SP Sets a badge on one of the tabs with the specified value. If invoked without second parameter, returns the tab's current badge value. Set the value to false to remove the badge.
///
/// The target tab specified either as a jQuery selector/object or as an item index.
/// The target value to be set or false to be removed.
/// Returns the badge value if invoked without parameters, otherwise returns the TabStrip object.
},
currentItem: function() {
///
/// Get the currently selected tab DOM element.
///
/// the currently selected tab DOM element.
},
destroy: function() {
///
/// Prepares the TabStrip for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
switchTo: function(url) {
///
/// Set the mobile TabStrip active tab to the tab with the specified url. This method doesn't change the current View. To change the View, use Application's navigate method instead.
///
/// The url of the tab.
},
clear: function() {
///
/// Clear the currently selected tab.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoTabStrip = function() {
///
/// Returns a reference to the kendo.mobile.ui.TabStrip widget, instantiated on the selector.
///
/// The kendo.mobile.ui.TabStrip instance (if present).
};
$.fn.kendoTabStrip = function(options) {
///
/// Instantiates a kendo.mobile.ui.TabStrip widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
selectedIndex — Number (default: 0)
///
The index of the initially selected tab.
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.View = function() { };
kendo.mobile.ui.View.prototype = {
destroy: function() {
///
/// Prepares the View for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
contentElement: function() {
///
/// Retrieves the current content holder of the View - this is the content element if the View is stretched or the scroll container otherwise.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoView = function() {
///
/// Returns a reference to the kendo.mobile.ui.View widget, instantiated on the selector.
///
/// The kendo.mobile.ui.View instance (if present).
};
$.fn.kendoView = function(options) {
///
/// Instantiates a kendo.mobile.ui.View widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
model — String (default: null)
///
The MVVM model to bind to. If a string is passed, The view will try to resolve a reference to the view model variable in the global scope.
///
///
reload — Boolean (default: null)
///
Applicable to remote views only. If set to true, the remote view contents will be reloaded from the server (using Ajax) each time the view is navigated to.
///
///
stretch — Boolean (default: false)
///
If set to true, the view will stretch its child contents to occupy the entire view, while disabling kinetic scrolling.
///
Useful if the view contains an image or a map.
///
///
title — String
///
The text to display in the navbar title (if present) and the browser title.
///
///
useNativeScrolling — Boolean (default: false)
///
(available since Q1 2013)
///
If set to true, the view will use the native scrolling available in the current platform. This should help with form issues on some platforms (namely Android and WP8).
///
Native scrolling is only enabled on platforms that support it: iOS > 4, Android > 2, WP8. BlackBerry devices do support it, but the native scroller is flaky.
///
///
zoom — Boolean (default: false)
///
If set to true, the user can zoom in/out the contents of the view using the pinch/zoom gesture.
///
///
///
/// The widget configuration options
///
};
kendo.mobile.ui.Widget = function() { };
kendo.mobile.ui.Widget.prototype = {
view: function() {
///
/// Returns the kendo.mobile.ui.View which contains the widget.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoWidget = function() {
///
/// Returns a reference to the kendo.mobile.ui.Widget widget, instantiated on the selector.
///
/// The kendo.mobile.ui.Widget instance (if present).
};
$.fn.kendoWidget = function(options) {
///
/// Instantiates a kendo.mobile.ui.Widget widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
if (!ui) {
ui = {};
}
kendo.ui.AutoComplete = function() { };
kendo.ui.AutoComplete.prototype = {
close: function() {
///
/// Closes the widget suggestion popup.
///
},
dataItem: function(index) {
///
/// Returns the data item at the specified index.
///
/// The zero-based index of of the data item.
/// the data item at the specified index. Returns undefined if the index is not within bounds.
},
destroy: function() {
///
/// Prepares the widget for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enables or disables the widget.
///
/// If set to true the widget will be enabled. If set to false the widget will be disabled.
},
readonly: function(readonly) {
///
/// Toggles the readonly state of the widget. When the widget is readonly it doesn't allow user input.
///
/// If set to true the widget will not allow user input. If set to false the widget will allow user input.
},
focus: function() {
///
/// Focuses the widget.
///
},
refresh: function() {
///
/// Refresh the suggestion popup by rendering all items again.
///
},
search: function(word) {
///
/// Searches the data source for the provided value and displays any matches as suggestions.
///
/// The value to search for. All matches are displayed in the suggestion popup.
},
select: function(item) {
///
/// Selects the item provided as an argument and updates the value of the widget.
///
/// A string, DOM element or jQuery object which represents the item to be selected. A string is treated as a jQuery selector.
},
setDataSource: function(dataSource) {
///
/// Sets the data source of the widget.
///
/// The data source to which the widget should be bound.
},
suggest: function(value) {
///
/// Sets the value of the widget to the specified argument and visually selects the text.
///
/// The value to set.
},
value: function(value) {
///
/// Gets or sets the value of the widget.
///
/// The value to set.
/// the value of the widget.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoAutoComplete = function() {
///
/// Returns a reference to the kendo.ui.AutoComplete widget, instantiated on the selector.
///
/// The kendo.ui.AutoComplete instance (if present).
};
$.fn.kendoAutoComplete = function(options) {
///
/// Instantiates a kendo.ui.AutoComplete widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation — Object
///
Configures the opening and closing animations of the suggestion popup. Setting the animation option to false will disable the opening and closing animations. As a result the suggestion popup will open and close instantly.
///
///
dataSource — Object|Array
///
The data source of the widget which is used to display suggestions for the current value. Can be a JavaScript object which represents a valid data source configuration, a JavaScript array or an existing kendo.data.DataSource
///
instance.If the dataSource option is set to a JavaScript object or array the widget will initialize a new kendo.data.DataSource instance using that value as data source configuration.If the dataSource option is an existing kendo.data.DataSource instance the widget will use that instance and will not initialize a new one.
///
///
dataTextField — String (default: null)
///
The field of the data item used when searching for suggestions. This is the text that will be displayed in the list of matched results.
///
///
delay — Number (default: 200)
///
The delay in milliseconds between a keystroke and when the widget displays the suggestion popup.
///
///
enable — Boolean (default: true)
///
If set to false the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input.
///
///
filter — String (default: "startswith")
///
The filtering method used to determine the suggestions for the current value. The default filter is "startswith" -
///
all data items which begin with the current widget value are displayed in the suggestion popup. The supported filter values are startswith, endswith and contains.
///
///
height — Number (default: 200)
///
The height of the suggestion popup in pixels. The default value is 200 pixels.
///
///
highlightFirst — Boolean (default: true)
///
If set to true the first suggestion will be automatically highlighted.
///
///
ignoreCase — Boolean (default: true)
///
If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default.
///
///
minLength — Number (default: 1)
///
The minimum number of characters the user must type before a search is performed. Set to higher value than 1 if the search could match a lot of items.
///
///
placeholder — String (default: "")
///
The hint displayed by the widget when it is empty. Not set by default.
///
///
separator — String (default: "")
///
The character used to separate multiple values. Empty by default.
///
///
suggest — Boolean (default: false)
///
If set to true the widget will automatically use the first suggestion as its value.
///
///
template — String|Function
///
The template used to render the suggestions. By default the widget displays only the text of the suggestion (configured via dataTextField).
///
///
///
/// The widget configuration options
///
};
kendo.ui.Calendar = function() { };
kendo.ui.Calendar.prototype = {
destroy: function() {
///
/// Prepares the Calendar for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
max: function(value) {
///
/// Gets/Sets the max value of the calendar.
///
/// The max date to set.
/// The max value of the calendar.
},
min: function(value) {
///
/// Gets/Sets the min value of the calendar.
///
/// The min date to set.
/// The min value of the calendar.
},
navigate: function(value,view) {
///
/// Navigates to view
///
/// Desired date
/// Desired view
},
navigateDown: function(value) {
///
/// Navigates to the lower view
///
/// Desired date
},
navigateToFuture: function() {
///
/// Navigates to the future
///
},
navigateToPast: function() {
///
/// Navigates to the past
///
},
navigateUp: function() {
///
/// Navigates to the upper view
///
},
value: function(value) {
///
/// Gets/Sets the value of the calendar.
///
/// The date to set.
/// The value of the calendar.
},
current: function() {
///
/// Gets currently focused date.
///
/// The current focused date shown in the calendar.
},
view: function() {
///
/// Gets an instance of the current view used by the calendar.
///
/// The instance of the current view used by the calendar.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoCalendar = function() {
///
/// Returns a reference to the kendo.ui.Calendar widget, instantiated on the selector.
///
/// The kendo.ui.Calendar instance (if present).
};
$.fn.kendoCalendar = function(options) {
///
/// Instantiates a kendo.ui.Calendar widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
culture — String (default: "en-US")
///
Specifies the culture info used by the widget.
///
///
dates — Array
///
Specifies a list of dates, which will be passed to the month template.
///
///
depth — String
///
Specifies the navigation depth.
///
///
footer — String
///
Template to be used for rendering the footer. If false, the footer will not be rendered.
///
///
format — String (default: "MM/dd/yyyy")
///
Specifies the format, which is used to parse value set with value() method.
///
///
max — Date (default: Date(2099, 11, 31))
///
Specifies the maximum date, which the calendar can show.
///
///
min — Date (default: Date(1900, 0, 1))
///
Specifies the minimum date, which the calendar can show.
///
///
month — Object
///
Templates for the cells rendered in the "month" view.
///
///
start — String (default: "month")
///
Specifies the start view.
///
///
value — Date (default: null)
///
Specifies the selected date.
///
///
///
/// The widget configuration options
///
};
kendo.ui.ColorPalette = function() { };
kendo.ui.ColorPalette.prototype = {
value: function(color) {
///
/// Get or set the selected color. If no argument is given, this returns the
/// currently selected color as a string in format #FFFFFF when the opacity
/// option is off, or rgba(255, 255, 255, 1) when opacity is requested.If one argument is given, it selects the new color and updates the UI. The
/// argument can be a string in hex, rgb or rgba format, or a Color object.
/// This does not trigger the "change" event.
///
///
/// the string representation of the current color.
},
color: function() {
///
/// Like value(), but it returns a Color object.
///
},
enable: function() {
///
/// Enables or disables the widget. It will enable it with no arguments
/// or with a true argument, or disable with a false argument.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoColorPalette = function() {
///
/// Returns a reference to the kendo.ui.ColorPalette widget, instantiated on the selector.
///
/// The kendo.ui.ColorPalette instance (if present).
};
$.fn.kendoColorPalette = function(options) {
///
/// Instantiates a kendo.ui.ColorPalette widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
palette — String|Array (default: "basic")
///
Specifies the color palette to display. It can be a string with
///
comma-separated colors in hex representation, an array of Color
///
objects or of strings that parseColor understands. As a shortcut,
///
you can pass "basic" to get the simple palette (this is the default)
///
or "websafe" to get the Web-safe palette.
///
///
columns — Number (default: 10)
///
The number of columns to display. When you pass "websafe" this will
///
automatically default to 18.
///
///
tileSize — Number (default: 14)
///
The size of a color cell.
///
///
tileSize — Object
///
The size of a color cell.
///
///
value — String (default: null)
///
Specifies the initially selected color.
///
///
///
/// The widget configuration options
///
};
kendo.ui.ColorPicker = function() { };
kendo.ui.ColorPicker.prototype = {
close: function() {
///
/// Closes the popup.
///
},
open: function() {
///
/// Opens the popup element with the color selector.
///
},
toggle: function() {
///
/// Toggles the popup.
///
},
value: function(color) {
///
/// Get or set the selected color. If no argument is given, this returns the
/// currently selected color as a string in format #FFFFFF when the opacity
/// option is off, or rgba(255, 255, 255, 1) when opacity is requested.If one argument is given, it selects the new color and updates the UI. The
/// argument can be a string in hex, rgb or rgba format, or a Color object.
/// This does not trigger the "change" event.
///
///
/// the string representation of the current color.
},
color: function() {
///
/// Like value(), but it returns a Color object.
///
},
enable: function(color) {
///
/// Set the widget's enabled state. Called with no arguments, this
/// method will ensure that the widget gets enabled. Pass a false
/// argument to disable it.
///
/// The color should be either a Color object or a string that parseColor can understand (the CSS hex, rgb or rgba notations).
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoColorPicker = function() {
///
/// Returns a reference to the kendo.ui.ColorPicker widget, instantiated on the selector.
///
/// The kendo.ui.ColorPicker instance (if present).
};
$.fn.kendoColorPicker = function(options) {
///
/// Instantiates a kendo.ui.ColorPicker widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
buttons — Boolean (default: true)
///
Applicable only for the HSV selector (that is, when pallete is
///
null). This specifies whether the "Apply" / "Cancel" buttons are to
///
be displayed in the drop-down HSV picker.
///
///
columns — Number
///
The number of columns to show in the simple color dropdown. For the
///
"basic" and "websafe" palettes this is automatically initialized; if
///
you pass a custom palette then you can set this to some value that
///
makes sense for your colors.
///
///
tileSize — Number (default: 14)
///
The size of a color cell.
///
///
tileSize — Object
///
The size of a color cell.
///
///
messages — Object
///
Allows customization of "Apply" / "Cancel" labels.
///
///
palette — String|Array (default: null)
///
When a non-null palette argument is supplied, the drop-down will be
///
a simple color picker. The following are supported:If palette is missing or null, the widget will display the HSV
///
selector.
///
///
opacity — Boolean (default: false)
///
Only for the HSV selector. If true, the widget will display the
///
opacity slider. Note that currently in HTML5 the does not support opacity.
///
///
preview — Boolean (default: true)
///
Only for the HSV selector. Displays the color preview element, along
///
with an input field where the end user can paste a color in a
///
CSS-supported notation.
///
///
toolIcon — String (default: null)
///
A CSS class name to display an icon in the color picker button. If
///
specified, the HTML for the element will look like this:
///
///
value — String (default: null)
///
The initially selected color. This can be a string supported by
///
parseColor or a Color object. Note that when initializing the
///
widget from an element, the initial color will be decided by the
///
field instead.
///
///
///
/// The widget configuration options
///
};
kendo.ui.ComboBox = function() { };
kendo.ui.ComboBox.prototype = {
close: function() {
///
/// Closes the drop-down list.
///
},
dataItem: function(index) {
///
/// Returns the raw data record at the specified index. If the index is not specified, the selected index will be used.
///
/// The zero-based index of the data record
/// The raw data record. Returns undefined if no data.
},
destroy: function() {
///
/// Prepares the ComboBox for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enables/disables the combobox widget
///
/// Desired state
},
readonly: function(readonly) {
///
/// Controls whether the widget is editable or readonly.
///
/// The argument, which defines whether the combobox should be readonly or editable.
},
focus: function() {
///
/// Focuses the widget.
///
},
open: function() {
///
/// Opens the drop-down list.
///
},
refresh: function() {
///
/// Re-render the items of the drop-down list.
///
},
search: function(word) {
///
/// Filters dataSource using the provided parameter and rebinds drop-down list.
///
/// The filter value.
},
select: function(li) {
///
/// Selects drop-down list item and sets the value and the text of the combobox.
///
/// LI element or index of the item or predicate function, which defines the item that should be selected.
/// The index of the selected LI element.
},
setDataSource: function(dataSource) {
///
/// Sets the dataSource of an existing ComboBox and rebinds it.
///
///
},
suggest: function(value) {
///
/// Forces a suggestion onto the text of the ComboBox.
///
/// Characters to force a suggestion.
},
text: function(text) {
///
/// Gets/Sets the text of the ComboBox.
///
/// The text to set.
/// The text of the combobox.
},
toggle: function(toggle) {
///
/// Toggles the drop-down list between opened and closed state.
///
/// Defines the whether to open/close the drop-down list.
},
value: function(value) {
///
/// Gets/Sets the value of the combobox. If the value is undefined, text of the data item will be used.
///
/// The value to set.
/// The value of the combobox.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoComboBox = function() {
///
/// Returns a reference to the kendo.ui.ComboBox widget, instantiated on the selector.
///
/// The kendo.ui.ComboBox instance (if present).
};
$.fn.kendoComboBox = function(options) {
///
/// Instantiates a kendo.ui.ComboBox widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation — Object
///
Animations to be used for opening/closing the popup. Setting to false will turn off the animation.
///
///
autoBind — Boolean (default: true)
///
Controls whether to bind the widget to the DataSource on initialization.
///
///
cascadeFrom — String
///
Use it to set the Id of the parent DropDownList.
///
///
dataSource — Object
///
A local JavaScript object or instance of DataSource or the data that the ComboBox will be bound to.
///
///
dataTextField — String (default: "")
///
Sets the field of the data item that provides the text content of the list items.
///
///
dataValueField — String (default: "")
///
Sets the field of the data item that provides the value content of the list items.
///
///
delay — Number (default: 200)
///
Specifies the delay in ms after which the ComboBox will start filtering dataSource.
///
///
enable — Boolean (default: true)
///
Controls whether the ComboBox should be initially enabled.
///
///
filter — String (default: "none")
///
Defines the type of filtration. If "none" the ComboBox will not filter the items.
///
///
height — Number (default: 200)
///
Define the height of the drop-down list in pixels.
///
///
highlightFirst — Boolean (default: true)
///
Controls whether the first item will be automatically highlighted.
///
///
ignoreCase — String (default: true)
///
Defines whether the filtration should be case sensitive.
///
///
index — Number (default: -1)
///
Defines the initial selected item.
///
///
minLength — Number (default: 1)
///
Specifies the minimum characters that should be typed before the ComboBox activates
///
///
placeholder — String (default: "")
///
A string that appears in the textbox when the combobox has no value.
///
///
suggest — Boolean (default: false)
///
Controls whether the ComboBox should automatically auto-type the rest of text.
///
///
template — String
///
Template to be used for rendering the items in the list.
///
///
text — String (default: "")
///
Define the text of the widget, when the autoBind is set to false.
///
///
value — String (default: "")
///
Define the value of the widget
///
///
///
/// The widget configuration options
///
};
kendo.ui.DatePicker = function() { };
kendo.ui.DatePicker.prototype = {
close: function() {
///
/// Closes the calendar.
///
},
destroy: function() {
///
/// Prepares the DatePicker for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enable/Disable the datePicker widget.
///
/// The argument, which defines whether to enable/disable the datePicker.
},
readonly: function(readonly) {
///
/// Controls whether the widget is editable or readonly.
///
/// The argument, which defines whether the datepicker should be readonly or editable.
},
max: function(value) {
///
/// Gets/Sets the max value of the datePicker.
///
/// The max date to set.
/// The max value of the datePicker.
},
min: function(value) {
///
/// Gets/Sets the min value of the datePicker.
///
/// The min date to set.
/// The min value of the datePicker.
},
open: function() {
///
/// Opens the calendar.
///
},
value: function(value) {
///
/// Gets/Sets the value of the datePicker.
///
/// The value to set.
/// The value of the datePicker.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDatePicker = function() {
///
/// Returns a reference to the kendo.ui.DatePicker widget, instantiated on the selector.
///
/// The kendo.ui.DatePicker instance (if present).
};
$.fn.kendoDatePicker = function(options) {
///
/// Instantiates a kendo.ui.DatePicker widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation — Object
///
The animation(s) used for opening and/or closing the pop-up. Setting this value to false
///
will disable the animation(s).
///
///
culture — String (default: "en-US")
///
Specifies the culture info used by the widget.
///
///
dates — Array
///
Specifies a list of dates, which will be passed to the month template.
///
///
depth — String
///
Specifies the navigation depth. The following
///
settings are available for the depth value:
///
///
footer — String
///
Template to be used for rendering the footer of the calendar.
///
///
format — String (default: "MM/dd/yyyy")
///
Specifies the format, which is used to format the value of the DatePicker displayed in the input. The format also will be used to parse the input.
///
///
max — Date (default: Date(2099, 11, 31))
///
Specifies the maximum date, which the calendar can show.
///
///
min — Date (default: Date(1900, 0, 1))
///
Specifies the minimum date that the calendar can show.
///
///
month — Object
///
Templates for the cells rendered in the calendar "month" view.
///
///
parseFormats — Array
///
Specifies the formats, which are used to parse the value set with value() method or by direct input. If not set the value of the format will be used. Note that value of the format option is always used.
///
///
start — String (default: "month")
///
Specifies the start view.
///
The following settings are available for the start value:
///
///
value — Date (default: null)
///
Specifies the selected date.
///
///
///
/// The widget configuration options
///
};
kendo.ui.DateTimePicker = function() { };
kendo.ui.DateTimePicker.prototype = {
close: function(view) {
///
/// Closes the calendar or the time drop-down list.
///
/// The view of the DateTimePicker, expressed as a string. Available views are "time" and "date".
},
destroy: function() {
///
/// Prepares the DateTimePicker for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enables or disables a DateTimePicker.
///
/// Enables (true or undefined) or disables (false) a DateTimePicker.
},
readonly: function(readonly) {
///
/// Controls whether the widget is editable or readonly.
///
/// The argument, which defines whether the datetimepicker should be readonly or editable.
},
max: function(value) {
///
/// Gets or sets the maximum value of the DateTimePicker.
///
/// The maximum time value to set for a DateTimePicker, expressed as a Date object or as a string.
/// The maximum time value of a DateTimePicker.
},
min: function(value) {
///
/// Gets or sets the minimum value of the DateTimePicker.
///
/// The minimum time value to set for a DateTimePicker, expressed as a Date object or as a string.
/// The minimum time value of a DateTimePicker.
},
open: function(view) {
///
/// Opens the calendar or the time drop-down list.
///
/// The view of the DateTimePicker, expressed as a string. Available views are "time" and "date".
},
toggle: function(view) {
///
/// Toggles the calendar or the time drop-down list.
///
/// The view of the DateTimePicker, expressed as a string. Available views are "time" and "date".
},
value: function(value) {
///
/// Gets or sets the value of the DateTimePicker.
///
/// The time value to set for a DateTimePicker, expressed as a Date object or as a string.
/// The time value of a DateTimePicker.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDateTimePicker = function() {
///
/// Returns a reference to the kendo.ui.DateTimePicker widget, instantiated on the selector.
///
/// The kendo.ui.DateTimePicker instance (if present).
};
$.fn.kendoDateTimePicker = function(options) {
///
/// Instantiates a kendo.ui.DateTimePicker widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation — Object
///
The animation(s) used for opening and/or closing the pop-ups. Setting this value to false
///
will disable the animation(s).
///
///
culture — String (default: "en-US")
///
Specifies the culture info used by the widget.
///
///
dates — Array
///
Specifies a list of dates, which will be passed to the month template of the DateView. All dates, which match the date portion of the selected date will be used to re-bind the TimeView.
///
///
depth — String
///
Specifies the navigation depth of the calendar. The following
///
settings are available for the depth value:
///
///
footer — String
///
Template to be used for rendering the footer of the calendar.
///
///
format — String (default: "MM/dd/yyyy h:mm tt")
///
Specifies the format, which is used to format the value of the DateTimePicker displayed in the input. The format also will be used to parse the input.
///
///
interval — Number (default: 30)
///
Specifies the interval, between values in the popup list, in minutes.
///
///
max — Date (default: Date(2099, 11, 31))
///
Specifies the maximum date, which the calendar can show.
///
///
min — Date (default: Date(1900, 0, 1))
///
Specifies the minimum date that the calendar can show.
///
///
month — Object
///
Templates for the cells rendered in the calendar "month" view.
///
///
parseFormats — Array
///
Specifies the formats, which are used to parse the value set with value() method or by direct input. If not set the value of the options.format and options.timeFormat will be used. Note that value of the format option is always used.
///
///
start — String (default: "month")
///
Specifies the start view of the calendar.
///
The following settings are available for the start value:
///
///
timeFormat — String (default: "h:mm tt")
///
Specifies the format, which is used to format the values in the time drop-down list.
///
///
value — Date (default: null)
///
Specifies the selected value.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Draggable = function() { };
kendo.ui.Draggable.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDraggable = function() {
///
/// Returns a reference to the kendo.ui.Draggable widget, instantiated on the selector.
///
/// The kendo.ui.Draggable instance (if present).
};
$.fn.kendoDraggable = function(options) {
///
/// Instantiates a kendo.ui.Draggable widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
axis — String (default: null)
///
Constrains the hint movement to either the horizontal (x) or vertical (y) axis. Can be set to either "x" or "y".
///
///
cursorOffset — Object (default: null)
///
If set, specifies the offset of the hint relative to the mouse cursor/finger.
///
By default, the hint is initially positioned on top of the draggable source offset. The option accepts an object with two keys: top and left.
///
///
distance — Number (default: 5)
///
The required distance that the mouse should travel in order to initiate a drag.
///
///
group — String (default: "default")
///
Used to group sets of draggable and drop targets. A draggable with the same group value as a drop target will be accepted by the drop target.
///
///
hint — Function
///
Provides a way for customization of the drag indicator. If a function is supplied, it receives one argument - the draggable element's jQuery object.
///
///
///
/// The widget configuration options
///
};
kendo.ui.DropDownList = function() { };
kendo.ui.DropDownList.prototype = {
close: function() {
///
/// Closes the drop-down list.
///
},
dataItem: function(index) {
///
/// Returns the raw data record at the specified index. If the index is not specified, the selected index will be used.
///
/// The zero-based index of the data record
/// The raw data record. Returns undefined if no data.
},
destroy: function() {
///
/// Prepares the DropDownList for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enables/disables the dropdownlist widget
///
/// Desired state
},
readonly: function(readonly) {
///
/// Controls whether the widget is editable or readonly.
///
/// The argument, which defines whether the timepicker should be readonly or editable.
},
focus: function() {
///
/// Focuses the widget.
///
},
open: function() {
///
/// Opens the drop-down list.
///
},
refresh: function() {
///
/// Re-render the items in drop-down list.
///
},
search: function(word) {
///
/// Selects item, which starts with the provided parameter.
///
/// The search value.
},
select: function(li) {
///
/// Selects drop-down list item and sets the value and the text of the dropdownlist.
///
/// LI element or index of the item or predicate function, which defines the item that should be selected.
/// The index of the selected LI element.
},
setDataSource: function(dataSource) {
///
/// Sets the dataSource of an existing DropDownList and rebinds it.
///
///
},
text: function(text) {
///
/// Gets/Sets the text of the dropdownlist.
///
/// The text to set.
/// The text of the dropdownlist.
},
toggle: function(toggle) {
///
/// Toggles the drop-down list between opened and closed state.
///
/// Defines the whether to open/close the drop-down list.
},
value: function(value) {
///
/// Gets/Sets the value of the dropdownlist. The value will not be set if there is no item with such value. If value is undefined, text of the data item is used.
///
/// The value to set.
/// The value of the dropdownlist.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDropDownList = function() {
///
/// Returns a reference to the kendo.ui.DropDownList widget, instantiated on the selector.
///
/// The kendo.ui.DropDownList instance (if present).
};
$.fn.kendoDropDownList = function(options) {
///
/// Instantiates a kendo.ui.DropDownList widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation — Object
///
Animations to be used for opening/closing the popup. Setting to false will turn of the animation.
///
///
autoBind — Boolean (default: true)
///
Controls whether to bind the widget on initialization.
///
///
cascadeFrom — String
///
Use it to set the Id of the parent DropDownList.
///
///
dataSource — Object
///
Instance of DataSource or the data that the DropDownList will be bound to.
///
///
dataTextField — String (default: "")
///
Sets the field of the data item that provides the text content of the list items.
///
///
dataValueField — String (default: "")
///
Sets the field of the data item that provides the value content of the list items.
///
///
delay — Number (default: 500)
///
Specifies the delay in ms before the search text typed by the end user is cleared.
///
///
enable — Boolean (default: true)
///
Controls whether the DropDownList should be initially enabled.
///
///
height — Number (default: 200)
///
Define the height of the drop-down list in pixels.
///
///
ignoreCase — String (default: true)
///
Controls whether the search should be case sensitive.
///
///
index — Number (default: 0)
///
Defines the initial selected item.
///
///
optionLabel — String|Object (default: "")
///
Define the text of the default empty item. If the value is an object, then the widget will use it directly.
///
Note that object should have atleast the dataValueField and dataTextField properties. Otherwise, widget will show undefined.
///
///
template — String
///
Template to be used for rendering the items in the list.
///
///
text — String (default: "")
///
Define the text of the widget, when the autoBind is set to false.
///
///
value — String (default: "")
///
Define the value of the widget
///
///
///
/// The widget configuration options
///
};
kendo.ui.DropTarget = function() { };
kendo.ui.DropTarget.prototype = {
destroyGroup: function() {
///
/// Destroys all DropTarget instances from the group with the given name.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDropTarget = function() {
///
/// Returns a reference to the kendo.ui.DropTarget widget, instantiated on the selector.
///
/// The kendo.ui.DropTarget instance (if present).
};
$.fn.kendoDropTarget = function(options) {
///
/// Instantiates a kendo.ui.DropTarget widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
group — String (default: "default")
///
Used to group sets of draggable and drop targets. A draggable with the same group value as a drop target will be accepted by the drop target.
///
///
///
/// The widget configuration options
///
};
kendo.ui.DropTargetArea = function() { };
kendo.ui.DropTargetArea.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDropTargetArea = function() {
///
/// Returns a reference to the kendo.ui.DropTargetArea widget, instantiated on the selector.
///
/// The kendo.ui.DropTargetArea instance (if present).
};
$.fn.kendoDropTargetArea = function(options) {
///
/// Instantiates a kendo.ui.DropTargetArea widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
group — String (default: "default")
///
Used to group sets of draggable and drop targets. A draggable with the same group value as a drop target will be accepted by the drop target.
///
///
filter — String (default: ")
///
Selector to filter the drop targets in the area. Every matched element acts as a drop target and fires events on the DropTargetArea.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Editor = function() { };
kendo.ui.Editor.prototype = {
createRange: function(document) {
///
/// Creates a W3C-compatible Range object.
///
/// The document that the range is associated with. If ommited, the document of the editor editing area will be used.
/// The created Range object.
},
destroy: function() {
///
/// Prepares the Editor for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
encodedValue: function() {
///
/// Gets the HTML encoded value of the editor.
///
},
exec: function(name,params) {
///
/// Executes an editor command on the currently selected text.
///
/// The name of the command to be executed.
/// The parameters for the executed command.
},
focus: function() {
///
/// Focuses the editable area.
///
},
getRange: function() {
///
/// Gets a Range object form the editable area.
///
/// A W3C-compatible Range object that represents the currently selected text in the editor area.
},
getSelection: function() {
///
/// Gets a W3C-compatible Selection object form the editable area.
///
/// a W3C-compatible Selection object form the editable area.
},
paste: function(html) {
///
/// Pastes HTML into the editable area.
///
/// The HTML to be pasted.
},
selectedHtml: function() {
///
/// Serializes the currently selected text to a XHTML string.
///
/// The selectied text as valid XHTML.
},
refresh: function() {
///
/// Reinitializes the editing area iframe. Should be used after moving the editor in the DOM.
///
},
selectRange: function(range) {
///
/// Focuses the editable area and selects the range described by the range parameter.
///
/// The Range object that describes the new selection.
},
update: function() {
///
/// Serializes the current state of the editable area to the
},
value: function(value) {
///
/// Gets or sets the editor value.
///
/// The value to set.
/// The value of the Editor as HTML string.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoEditor = function() {
///
/// Returns a reference to the kendo.ui.Editor widget, instantiated on the selector.
///
/// The kendo.ui.Editor instance (if present).
};
$.fn.kendoEditor = function(options) {
///
/// Instantiates a kendo.ui.Editor widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
encoded — Boolean (default: true)
///
Indicates whether the Editor should submit encoded HTML tags.
///
///
messages — Object
///
Defines the text of the labels that are shown within the editor. Used primarily for localization.
///
///
stylesheets — Array
///
Allows custom stylesheets to be included within the editing area.
///
///
tools — Array
///
A collection of tools that should render a button, combobox, etc, to interact with the Editor. Custom tools are defined
///
as a collection of required properties, while the insertHtml tool requires a collection of text-value pairs. A separator may be included multiple times.
///
///
imageBrowser — Object
///
Configuration for image browser dialog.
///
///
///
/// The widget configuration options
///
};
kendo.ui.FlatColorPicker = function() { };
kendo.ui.FlatColorPicker.prototype = {
focus: function() {
///
/// Focuses the widget.
///
},
value: function(color) {
///
/// Get or set the selected color. If no argument is given, this returns the
/// currently selected color as a string in format #FFFFFF when the opacity
/// option is off, or rgba(255, 255, 255, 1) when opacity is requested.If one argument is given, it selects the new color and updates the UI. The
/// argument can be a string in hex, rgb or rgba format, or a Color object.
/// This does not trigger the "change" event.
///
///
/// the string representation of the current color.
},
color: function() {
///
/// Like value(), but it returns a Color object.
///
},
enable: function() {
///
/// Enables or disables the widget. It will enable it with no arguments
/// or with a true argument, or disable with a false argument.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoFlatColorPicker = function() {
///
/// Returns a reference to the kendo.ui.FlatColorPicker widget, instantiated on the selector.
///
/// The kendo.ui.FlatColorPicker instance (if present).
};
$.fn.kendoFlatColorPicker = function(options) {
///
/// Instantiates a kendo.ui.FlatColorPicker widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
opacity — Boolean (default: false)
///
Specifies whether we should display the opacity slider to allow
///
selection of transparency.
///
///
buttons — Boolean (default: true)
///
Specifies whether we should display the Apply / Cancel buttons.
///
///
value — String (default: null)
///
Specifies the initially selected color.
///
///
preview — Boolean (default: true)
///
Specifies whether we should display the preview bar which displays the
///
current color and the input field.
///
///
messages — Object
///
Allows customization of "Apply" / "Cancel" labels.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Grid = function() { };
kendo.ui.Grid.prototype = {
addRow: function() {
///
/// Adds an empty data item to the grid. In "incell" and "inline" editing mode a table row will be appended. Popup window will be displayed in "popup" editing mode.Fires the edit event.
///
},
cancelChanges: function() {
///
/// Cancels any pending changes in the data source. Deleted data items are restored, new data items are removed and updated data items are restored to their initial state.
///
},
cancelRow: function() {
///
/// Cancels editing for the table row which is in edit mode. Reverts any changes made.
///
},
cellIndex: function(cell) {
///
/// Returns the index of the specified table cell. Skips group and detail table cells.
///
/// A string, DOM element or jQuery object which represents the table cell. A string is treated as a jQuery selector.
/// the index of the specified table cell.
},
clearSelection: function() {
///
/// Clears the currently selected table rows or cells (depending on the current selection mode).
///
},
closeCell: function() {
///
/// Stops editing the table cell which is in edit mode. Requires "incell" edit mode.
///
},
collapseGroup: function(row) {
///
/// Collapses the specified group. This hides the group items.
///
/// A string, DOM element or jQuery object which represents the group table row. A string is treated as a jQuery selector.
},
collapseRow: function(row) {
///
/// Collapses the specified master table row. This hides its detail table row.
///
/// A string, DOM element or jQuery object which represents the master table row. A string is treated as a jQuery selector.
},
dataItem: function(row) {
///
/// Returns the data item to which the specified table row is bound.
///
/// A string, DOM element or jQuery object which represents the table row. A string is treated as a jQuery selector.
/// the data item to which the specified table row is bound.
},
destroy: function() {
///
/// Prepares the widget for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
editCell: function(cell) {
///
/// Switches the specified table cell in edit mode. Requires "incell" edit mode.Fires the edit event.
///
/// The jQuery object which represents the table cell.
},
editRow: function(row) {
///
/// Switches the specified table cell in edit mode. Requires "inline" or "popup" edit mode.Fires the edit event.
///
/// The jQuery object which represents the table row.
},
expandGroup: function(row) {
///
/// Expands the specified group. This shows the group items.
///
/// A string, DOM element or jQuery object which represents the group table row. A string is treated as a jQuery selector. Expands specified group.
},
expandRow: function(row) {
///
/// Expands the specified master table row. This shows its detail table row.
///
/// A string, DOM element or jQuery object which represents the master table row. A string is treated as a jQuery selector. Expands specified master row.
},
hideColumn: function(column) {
///
/// Hides the specified grid column.
///
/// The index of the column or the field to which the columns is bound.
},
refresh: function() {
///
/// Renders all table rows using the current data items.
///
},
removeRow: function(row) {
///
/// Removes the specified table row from the grid. Also removes the corresponding data item from the data source.Fires the remove event.
///
/// A string, DOM element or jQuery object which represents the table row. A string is treated as a jQuery selector.
},
reorderColumn: function(destIndex,column) {
///
/// Changes the position of the specified column.
///
/// The new position of the column.
/// The column whose position should be changed.
},
saveChanges: function() {
///
/// Saves any pending changes by calling the sync method.Fires the saveChanges event.
///
},
saveRow: function() {
///
/// Switches the table row which is in edit mode and saves any changes made by the user.
///
},
select: function(rows) {
///
/// Gets or sets the table rows (or cells) which are selected.
///
/// A string, DOM element or jQuery object which represents the table row(s) or cell(s). A string is treated as a jQuery selector.
/// the selected table rows or cells.
},
setDataSource: function(dataSource) {
///
/// Sets the data source of the widget.
///
/// The data source to which the widget should be bound.
},
showColumn: function(column) {
///
/// Shows the specified column.
///
/// The index of the column or the field to which the columns is bound.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoGrid = function() {
///
/// Returns a reference to the kendo.ui.Grid widget, instantiated on the selector.
///
/// The kendo.ui.Grid instance (if present).
};
$.fn.kendoGrid = function(options) {
///
/// Instantiates a kendo.ui.Grid widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
altRowTemplate — String|Function
///
The template which renders the alternating table rows. Be default the grid renders a table row () for every data source item.
///
///
autoBind — Boolean (default: true)
///
If set to false the widget will not bind to the data source during initialization. In this case data binding will occur when the change event of the
///
data source is fired. By default the widget will bind to the data source specified in the configuration.
///
///
columns — Array
///
The configuration of the grid columns. An array of JavaScript objects or strings. A JavaScript objects are interpreted as column configurations. Strings are interpreted as the
///
field to which the column is bound. The grid will create a column for every item of the array.
///
///
columnMenu — Boolean (default: false)
///
If set to true the grid will display the column menu when the user clicks the chevron icon in the column headers. The column menu allows the user to show and hide columns, filter and sort (if filtering and sorting are enabled).
///
By default the column menu is not enabled.Can be set to a JavaScript object which represents the column menu configuration.
///
///
columnMenu — Object
///
If set to true the grid will display the column menu when the user clicks the chevron icon in the column headers. The column menu allows the user to show and hide columns, filter and sort (if filtering and sorting are enabled).
///
By default the column menu is not enabled.Can be set to a JavaScript object which represents the column menu configuration.
///
///
dataSource — Object|Array
///
The data source of the widget which is used render table rows. Can be a JavaScript object which represents a valid data source configuration, a JavaScript array or an existing kendo.data.DataSource
///
instance.If the dataSource option is set to a JavaScript object or array the widget will initialize a new kendo.data.DataSource instance using that value as data source configuration.If the dataSource option is an existing kendo.data.DataSource instance the widget will use that instance and will not initialize a new one.
///
///
detailTemplate — String|Function
///
The template which renders the detail rows.
///
///
editable — Boolean (default: false)
///
If set to true the user would be able to edit the data to which the grid is bound to. By default editing is disabled.Can be set to a string ("inline", "incell" or "popup") to specify the editing mode. The default editing mode is "incell".Can be set to a JavaScript object which represents the editing configuration.
///
///
editable — Object
///
If set to true the user would be able to edit the data to which the grid is bound to. By default editing is disabled.Can be set to a string ("inline", "incell" or "popup") to specify the editing mode. The default editing mode is "incell".Can be set to a JavaScript object which represents the editing configuration.
///
///
filterable — Boolean (default: false)
///
If set to true the user can filter the data source using the grid filter menu. Filtering is disabled by default.Can be set to a JavaScript object which represents the filter menu configuration.
///
///
filterable — Object
///
If set to true the user can filter the data source using the grid filter menu. Filtering is disabled by default.Can be set to a JavaScript object which represents the filter menu configuration.
///
///
groupable — Boolean (default: false)
///
If set to true the user could group the grid by dragging the column header cells. By default grouping is disabled.Can be set to a JavaScript object which represents the grouping configuration.
///
///
groupable — Object
///
If set to true the user could group the grid by dragging the column header cells. By default grouping is disabled.Can be set to a JavaScript object which represents the grouping configuration.
///
///
height — Number|String
///
The height of the grid. Numeric values are treated as pixels.
///
///
navigatable — Boolean (default: false)
///
If set to true the use could navigate the widget using the keyboard navigation. By default keyboard navigation is disabled.
///
///
pageable — Boolean (default: false)
///
If set to true the grid will display a pager. By default paging is disabled.Can be set to a JavaScript object which represents the pager configuration.
///
///
pageable — Object
///
If set to true the grid will display a pager. By default paging is disabled.Can be set to a JavaScript object which represents the pager configuration.
///
///
reorderable — Boolean (default: false)
///
If set to true the user could reorder the columns by dragging their header cells. By default reordering is disabled.
///
///
resizable — Boolean (default: false)
///
If set to true the user could resize the columns by dragging the edges of their header cells. By default resizing is disabled.
///
///
rowTemplate — String|Function
///
The template which renders rows. Be default renders a table row () for every data source item.
///
///
scrollable — Boolean (default: true)
///
If set to true the grid will display a scrollbar when the total row height (or width) exceeds the grid height (or width). By default scrolling is enabled.Can be set to a JavaScript object which represents the scrolling configuration.
///
///
scrollable — Object
///
If set to true the grid will display a scrollbar when the total row height (or width) exceeds the grid height (or width). By default scrolling is enabled.Can be set to a JavaScript object which represents the scrolling configuration.
///
///
selectable — Boolean|String (default: false)
///
If set to true the user would be able to select grid rows. By default selection is disabled.Can also be set to the following string values:
///
///
sortable — Boolean (default: false)
///
If set to true the user could sort the grid by clicking the column header cells. By default sorting is disabled.Can be set to a JavaScript object which represents the sorting configuration.
///
///
sortable — Object
///
If set to true the user could sort the grid by clicking the column header cells. By default sorting is disabled.Can be set to a JavaScript object which represents the sorting configuration.
///
///
toolbar — Array
///
The list of commands displayed in the grid toolbar. Commands can be custom or built-in ("cancel", "create", "save").The "cancel" built-in command reverts any data changes done by the end user.The "create" command adds an empty data item to the grid.The "save" command persists any data changes done by the end user.
///
///
///
/// The widget configuration options
///
};
kendo.ui.ListView = function() { };
kendo.ui.ListView.prototype = {
add: function() {
///
/// Inserts empty item as first item on the current view and prepare it for editing.
///
},
cancel: function() {
///
/// Cancels changes in currently edited item.
///
},
clearSelection: function() {
///
/// Clears ListView selected items and triggers change event.
///
},
destroy: function() {
///
/// Prepares the ListView for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
edit: function(item) {
///
/// Edit specified ListView item. Triggers edit event.
///
/// jQuery object containing the item to be edited.
},
refresh: function() {
///
/// Reloads the data and repaints the list view.
///
},
remove: function(item) {
///
/// Removes specified ListView item. Triggers remove event and if not prevented calls DataSource sync method.
///
/// jQuery object containing the item to be removed.
},
save: function() {
///
/// Saves edited ListView item. If validation succeeds will call DataSource sync method.
///
},
select: function(items) {
///
/// Get/set the selected listview item(s).
///
/// Items to select.
/// the selected items if called without arguments.
},
setDataSource: function(dataSource) {
///
/// Sets the dataSource of an existing ListView and rebinds it.
///
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoListView = function() {
///
/// Returns a reference to the kendo.ui.ListView widget, instantiated on the selector.
///
/// The kendo.ui.ListView instance (if present).
};
$.fn.kendoListView = function(options) {
///
/// Instantiates a kendo.ui.ListView widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
autoBind — Boolean (default: true)
///
Indicates whether the list view will call read on the DataSource initially.
///
///
dataSource — Object
///
Instance of DataSource or Object with DataSource configuration.
///
///
editTemplate — Function
///
Specifies ListView item template in edit mode.
///
///
navigatable — Boolean (default: false)
///
Indicates whether keyboard navigation is enabled/disabled.
///
///
selectable — Boolean|String (default: false)
///
Indicates whether selection is enabled/disabled. Possible values:
///
///
template — Function
///
Specifies ListView item template.
///
///
altTemplate — Function
///
Template to be used for rendering the alternate items in the listview.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Menu = function() { };
kendo.ui.Menu.prototype = {
append: function(item,referenceItem) {
///
/// Appends an item to a Menu in the specified referenceItem's sub menu.
///
/// Target item, specified as a JSON object. Can also handle an array of such objects.
/// A reference item to append the new item in.
/// Returns the Menu object to support chaining.
},
close: function(element) {
///
/// Closes a sub-menu of a specified item(s) in a Menu.
///
/// Target item selector.
/// Returns the Menu object to support chaining.
},
destroy: function() {
///
/// Prepares the Menu for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(element,enable) {
///
/// Enables or disables an item of a Menu. This can optionally be accomplished on
/// initialization by setting the disabled="disabled" on the desired menu item html element.
///
/// Target element
/// Desired state
/// Returns the Menu object to support chaining.
},
insertAfter: function(item,referenceItem) {
///
/// Inserts an item into a Menu after the specified referenceItem.
///
/// Target item, specified as a JSON object. Can also handle an array of such objects.
/// A reference item to insert the new item after.
/// Returns the Menu object to support chaining.
},
insertBefore: function(item,referenceItem) {
///
/// Inserts an item into a Menu before the specified referenceItem.
///
/// Target item, specified as a JSON object. Can also handle an array of such objects.
/// A reference item to insert the new item before
/// Returns the Menu object to support chaining.
},
open: function(element) {
///
/// Opens a sub-menu of a specified item(s) in a Menu.
///
/// Target item selector.
/// Returns the Menu object to support chaining.
},
remove: function(element) {
///
/// Removes a specified item(s) from a Menu.
///
/// Target item selector.
/// Returns the Menu object to support chaining.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoMenu = function() {
///
/// Returns a reference to the kendo.ui.Menu widget, instantiated on the selector.
///
/// The kendo.ui.Menu instance (if present).
};
$.fn.kendoMenu = function(options) {
///
/// Instantiates a kendo.ui.Menu widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation — Object
///
A collection of Animation objects, used to change default animations. A value of false will disable all animations in the widget.Available animations for the Menu are listed below. Each animation has a reverse options which is used for the close effect by default, but can be over-ridden
///
by setting the close animation. Each animation also has a direction which can be set off the animation (i.e. slideIn:Down).
///
///
closeOnClick — Boolean (default: true)
///
Specifies that sub menus should close after item selection (provided they won't navigate).
///
///
direction — String (default: "default")
///
Specifies Menu opening direction. Can be "top", "bottom", "left", "right".
///
You can also specify different direction for root and sub menu items, separating them with space. The example below will initialize the root menu to open upwards and
///
its sub menus to the left.
///
///
hoverDelay — Number (default: 100)
///
Specifies the delay in ms before the menu is opened/closed - used to avoid accidental closure on leaving.
///
///
openOnClick — Boolean (default: false)
///
Specifies that the root sub menus will be opened on item click.
///
///
orientation — String (default: "horizontal")
///
Root menu orientation. Could be horizontal or vertical.
///
///
popupCollision — String
///
Specifies how Menu should adjust to screen boundaries. By default the strategy is "fit" for a sub menu with a horizontal parent,
///
meaning it will move to fit in screen boundaries in all directions, and "fit flip" for a sub menu with vertical parent, meaning it will fit vertically and flip over
///
its parent horizontally. You can also switch off the screen boundary detection completely if you set the popupCollision to false.
///
///
///
/// The widget configuration options
///
};
kendo.ui.MultiSelect = function() { };
kendo.ui.MultiSelect.prototype = {
close: function() {
///
/// Closes the drop-down list.
///
},
dataItems: function() {
///
/// Returns list of raw data records corresponding to the selected items.
///
/// The raw data records. Returns empty array ([]) if no selected options
},
destroy: function() {
///
/// Prepares the multiselect for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enables/disables the multiselect widget
///
/// Desired state
},
readonly: function(readonly) {
///
/// Controls whether the widget is editable or readonly.
///
/// The argument, which defines whether the multiselect should be readonly or editable.
},
focus: function() {
///
/// Focuses the widget.
///
},
open: function() {
///
/// Opens the drop-down list.
///
},
refresh: function() {
///
/// Re-render the items of the drop-down list.
///
},
search: function(word) {
///
/// Filters dataSource using the provided parameter and rebinds drop-down list.
///
/// The filter value.
},
setDataSource: function(dataSource) {
///
/// Sets the dataSource of an existing multiselect and rebinds it.
///
///
},
toggle: function(toggle) {
///
/// Toggles the drop-down list between opened and closed state.
///
/// Defines the whether to open/close the drop-down list.
},
value: function(value) {
///
/// Gets/Sets the value of the multiselect. Accepts string value or Array of strings.
///
/// The value to set.
/// The value of the multiselect.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoMultiSelect = function() {
///
/// Returns a reference to the kendo.ui.MultiSelect widget, instantiated on the selector.
///
/// The kendo.ui.MultiSelect instance (if present).
};
$.fn.kendoMultiSelect = function(options) {
///
/// Instantiates a kendo.ui.MultiSelect widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation — Object
///
Animations to be used for opening/closing the popup. Setting to false will turn off the animation.
///
///
autoBind — Boolean (default: true)
///
Controls whether to bind the widget to the DataSource on initialization.
///
///
dataSource — Object
///
A local JavaScript object or instance of DataSource or the data that the multiselect will be bound to.
///
///
dataTextField — String (default: "")
///
Sets the field of the data item that provides the text content of the list items.
///
///
dataValueField — String (default: "")
///
Sets the field of the data item that provides the value content of the list items.
///
///
delay — Number (default: 200)
///
Specifies the delay in ms after which the multiselect will start filtering dataSource.
///
///
enable — Boolean (default: true)
///
Controls whether the multiselect should be initially enabled.
///
///
filter — String (default: "none")
///
Defines the type of filtration.
///
///
height — Number (default: 200)
///
Define the height of the drop-down list in pixels.
///
///
highlightFirst — Boolean (default: true)
///
Controls whether the first item will be automatically highlighted.
///
///
ignoreCase — String (default: true)
///
Defines whether the filtration should be case sensitive.
///
///
minLength — Number (default: 1)
///
Specifies the minimum characters that should be typed before the multiselect activates
///
///
maxSelectedItems — Number (default: null)
///
Defines the limit of the selected items. If set to null widget will not limit number of the selected items.
///
///
placeholder — String (default: "")
///
A string that appears in the textbox when the multiselect has no value.
///
///
itemTemplate — String
///
Template to be used for rendering the items in the list.
///
///
tagTemplate — String
///
Template to be used for rendering the tags of the selected items.
///
///
value — Array (default: [])
///
Define the value of the widget
///
///
///
/// The widget configuration options
///
};
kendo.ui.NumericTextBox = function() { };
kendo.ui.NumericTextBox.prototype = {
destroy: function() {
///
/// Prepares the NumericTextBox for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enable/Disable the numerictextbox widget.
///
/// The argument, which defines whether to enable/disable tha numerictextbox.
},
readonly: function(readonly) {
///
/// Controls whether the widget is editable or readonly.
///
/// The argument, which defines whether the numerictextbox should be readonly or editable.
},
focus: function() {
///
/// Focuses the numerictextbox widget.
///
},
max: function(value) {
///
/// Gets/Sets the max value of the NumericTextBox.
///
/// The max value to set.
/// The max value of the NumericTextBox.
},
min: function(value) {
///
/// Gets/Sets the min value of the NumericTextBox.
///
/// The min value to set.
/// The min value of the NumericTextBox.
},
step: function(value) {
///
/// Gets/Sets the step value of the NumericTextBox.
///
/// The step value to set.
/// The step value of the NumericTextBox.
},
value: function(value) {
///
/// Gets/Sets the value of the numerictextbox.
///
/// The value to set.
/// The value of the numerictextbox.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoNumericTextBox = function() {
///
/// Returns a reference to the kendo.ui.NumericTextBox widget, instantiated on the selector.
///
/// The kendo.ui.NumericTextBox instance (if present).
};
$.fn.kendoNumericTextBox = function(options) {
///
/// Instantiates a kendo.ui.NumericTextBox widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
culture — String (default: "en-US")
///
Specifies the culture info used by the NumericTextBox widget.
///
///
decimals — Number (default: null)
///
Specifies the number precision. If not set precision defined by current culture is used.
///
///
downArrowText — String (default: "Decrease value")
///
Specifies the text of the tooltip on the down arrow.
///
///
format — String (default: "n")
///
Specifies the format of the number. Any valid number format is allowed.
///
///
max — Number (default: null)
///
Specifies the largest value the user can enter.
///
///
min — Number (default: null)
///
Specifies the smallest value the user can enter.
///
///
placeholder — String (default: "")
///
Specifies the text displayed when the input is empty.
///
///
spinners — Boolean (default: true)
///
Specifies whether the up/down spin buttons should be rendered
///
///
step — Number (default: 1)
///
Specifies the increment/decrement step.
///
///
upArrowText — String (default: "Increase value")
///
Specifies the text of the tooltip on the up arrow.
///
///
value — Number (default: null)
///
Specifies the value of the NumericTextBox widget.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Pager = function() { };
kendo.ui.Pager.prototype = {
totalPages: function() {
///
/// Returns the number of pages.
///
},
pageSize: function() {
///
/// Returns the page size - maximum number of items allowed on one page.
///
},
page: function() {
///
/// Set the specified page as a current page. If called without arguments - returns the current page.
///
},
refresh: function() {
///
/// Updates all values of pager elements so that these values fit the values of DataSource. This method is automaticaly called after DataSource change event is fired.
///
},
destroy: function() {
///
/// Unbinds all callbacks created within pager initialization. This method doesn't remove pager element from DOM.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoPager = function() {
///
/// Returns a reference to the kendo.ui.Pager widget, instantiated on the selector.
///
/// The kendo.ui.Pager instance (if present).
};
$.fn.kendoPager = function(options) {
///
/// Instantiates a kendo.ui.Pager widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
autoBind — Boolean (default: true)
///
Indicates whether the pager refresh method will be called within its initialization.
///
///
buttonCount — Number (default: 10)
///
Defines the number of buttons displayed in the numeric pager.
///
///
dataSource — Object
///
Instance of kendo DataSource. See the kendo.data.DataSource.This option is mandatory because the Pager is tightly connected with DataSource. The pager is UI widget for managing paging over the DataSource. The Pager gets values like page size or total count of items from DataSource.
///
///
selectTemplate — String
///
The template for selectbox with predefined page sizes.
///
///
linkTemplate — String
///
The template for page number links.
///
///
info — Boolean (default: true)
///
Defines if a label showing current paging information will be displayed.
///
///
input — Boolean (default: false)
///
Defines if an input element which allows the user to navigate to given page will be displayed.
///
///
numeric — Boolean (default: true)
///
Defines if numeric portion of the pager will be shown.
///
///
pageSizes — Boolean|Array (default: false)
///
Displays a list with predefined page sizes. An array of values to be displayed can be provided. If pageSize option is provided for DataSource then this pageSize value will be automaticaly selected in created selectbox.
///
///
previousNext — Boolean (default: true)
///
Defines if buttons for navigating to the first, last, previous and next pages will be shown.
///
///
refresh — Boolean (default: false)
///
Defines if a refresh button will be displayed. Click on that button will call DataSource read() method to get actual data.
///
///
messages — Object
///
Defines texts shown within the pager.
///
///
///
/// The widget configuration options
///
};
kendo.ui.PanelBar = function() { };
kendo.ui.PanelBar.prototype = {
append: function(item,referenceItem) {
///
/// Appends an item to the PanelBar.
///
/// Target item, specified as the JSON representation of an object. You can pass item text, content or contentUrl here. Can handle an HTML string or array of such strings or JSON.
/// A reference item to append the new item in
/// Returns the PanelBar object to support chaining.
},
collapse: function(element,useAnimation) {
///
/// Collapses the specified item(s) of a PanelBar.
///
/// The PanelBar item(s) to be collapsed, expressed as a string containing a selector expression or represented by a jQuery selector.
/// _optional, default: _Temporarily enables (true) or disables (false) any visual animation(s) when collapsing items.
/// Returns the PanelBar object to support chaining.
},
destroy: function() {
///
/// Prepares the PanelBar for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(element,enable) {
///
/// Enables (true) or disables (false) the specified item(s) of the
/// PanelBar.
///
/// The PanelBar item(s) to be enabled (true) or disabled (false), expressed as a string containing a selector expression or represented by a jQuery selector.
/// The desired state - enabled (true) or disabled (false) - of the target element(s).
},
expand: function(element,useAnimation) {
///
/// Expands the specified item(s) of a PanelBar.
///
/// The PanelBar item(s) to be expanded, expressed as a selector.
/// _optional, default: _Temporariliy enables (true) or disables (false) any visual animation(s) when expanding items.
/// Returns the PanelBar object to support chaining.
},
insertAfter: function(item,referenceItem) {
///
/// Inserts a PanelBar item after the specified referenceItem
///
/// Target item, specified as a JSON object. You can pass item text, content or contentUrl here. Can handle an HTML string or array of such strings or JSON.
/// A reference item to insert the new item after
},
insertBefore: function(item,referenceItem) {
///
/// Inserts a PanelBar item before the specified referenceItem
///
/// Target item, specified as a JSON object. You can pass item text, content or contentUrl here. Can handle an TML string or array of such strings or JSON.
/// A reference item to insert the new item before.
/// Returns the PanelBar object to support chaining.
},
reload: function(element) {
///
/// Reloads the content of a PanelBar from an AJAX request.
///
/// Target element
},
remove: function(element) {
///
/// Removes the specified PanelBar item(s).
///
/// The PanelBar item(s) to be removed, expressed as a selector string, DOM element or a jQuery object.
},
select: function(element) {
///
/// Selects the specified item of the PanelBar. If this method is invoked without arguments, it
/// returns the currently selected item.
///
/// The PanelBar item to be selected, expressed as a string containing a selector expression or represented by a jQuery selector.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoPanelBar = function() {
///
/// Returns a reference to the kendo.ui.PanelBar widget, instantiated on the selector.
///
/// The kendo.ui.PanelBar instance (if present).
};
$.fn.kendoPanelBar = function(options) {
///
/// Instantiates a kendo.ui.PanelBar widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation — Boolean
///
A collection of visual animations used when PanelBar items are exapnd or collapsed through
///
user interactions. Setting this option to false will disable all animations.
///
///
animation — Object
///
A collection of visual animations used when PanelBar items are exapnd or collapsed through
///
user interactions. Setting this option to false will disable all animations.
///
///
expandMode — String (default: "multiple")
///
Specifies how the PanelBar items are displayed when opened and closed. The following values
///
are available:
///
///
///
/// The widget configuration options
///
};
kendo.ui.RangeSlider = function() { };
kendo.ui.RangeSlider.prototype = {
destroy: function() {
///
/// Prepares the RangeSlider for safe removal from the DOM.Detaches event handlers and removes data entries in order to avoid memory leaks.
///
},
enable: function(enable) {
///
/// Enable/Disable the RangeSlider widget.
///
/// The argument, which defines whether to enable/disable the RangeSlider.
},
value: function(value) {
///
/// The value method gets or sets the start and end values of the RangeSlider. It
/// accepts an array as parameter, and returns an object array with the start and end
/// selection values.
///
/// The new value of the RangeSlider.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoRangeSlider = function() {
///
/// Returns a reference to the kendo.ui.RangeSlider widget, instantiated on the selector.
///
/// The kendo.ui.RangeSlider instance (if present).
};
$.fn.kendoRangeSlider = function(options) {
///
/// Instantiates a kendo.ui.RangeSlider widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
largeStep — Number (default: 5)
///
The delta with which the value will change when the user presses the Page Up or Page Down key (the drag
///
handle must be focused). Note: The allied largeStep will also set large tick for every large step.
///
///
max — Number (default: 10)
///
The maximum value of the RangeSlider.
///
///
min — Number (default: 0)
///
The minimum value of the RangeSlider.
///
///
orientation — String (default: "horizontal")
///
F
///
The orientation of a RangeSlider; "horizontal" or
///
"vertical".
///
///
selectionEnd — Number
///
The selection end value of the RangeSlider.
///
///
selectionStart — Number
///
The selection start value of the RangeSlider.
///
///
smallStep — Number (default: 1)
///
The small step value of the RangeSlider. The underlying value will be changed when the end
///
user (1) clicks on the increase or decrease buttons of the RangeSlider, (2) presses the
///
arrow keys (the drag handle must be focused), or (3) drags the drag handle.
///
///
tickPlacement — String (default: "both")
///
Denotes the location of the tick marks in the RangeSlider. The available options are:
///
///
tooltip — Object
///
Configuration of the RangeSlider tooltip.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Slider = function() { };
kendo.ui.Slider.prototype = {
destroy: function() {
///
/// Prepares the Slider for safe removal from the DOM.Detaches event handlers and removes data entries in order to avoid memory leaks.
///
},
enable: function(enable) {
///
/// Enable/Disable the Slider widget.
///
/// The argument, which defines whether to enable/disable the Slider.
},
value: function(value) {
///
/// Gets or sets the value of a Slider. It accepts a string or number as parameters and returns
/// a number representing the underlying value.
///
/// _optional, default: _The value to be set for a Slider.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoSlider = function() {
///
/// Returns a reference to the kendo.ui.Slider widget, instantiated on the selector.
///
/// The kendo.ui.Slider instance (if present).
};
$.fn.kendoSlider = function(options) {
///
/// Instantiates a kendo.ui.Slider widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
decreaseButtonTitle — String (default: "Decrease")
///
The title of the decrease button of the Slider.
///
///
increaseButtonTitle — String (default: "Increase")
///
The title of the increase button of the Slider.
///
///
largeStep — Number (default: 5)
///
The delta with which the value will change when the user presses the Page Up or Page Down key (the drag
///
handle must be focused). Note: The allied largeStep will also set large tick for every large step.
///
///
max — Number (default: 10)
///
The maximum value of the Slider.
///
///
min — Number (default: 0)
///
The minimum value of the Slider.
///
///
orientation — String (default: "horizontal")
///
The orientation of a Slider: "horizontal" or "vertical".
///
///
showButtons — Boolean (default: true)
///
Can be used to show (true) or hide (false) the
///
increase and decrease buttons of a Slider.
///
///
smallStep — Number (default: 1)
///
The small step value of the Slider. The underlying value will be changed when the end user
///
(1) clicks on the increase or decrease buttons of the Slider, (2) presses the arrow keys
///
(the drag handle must be focused), or (3) drags the drag handle.
///
///
tickPlacement — String (default: "both")
///
Denotes the location of the tick marks in the Slider. The available options are:
///
///
tooltip — Object
///
Configuration of the Slider tooltip.
///
///
value — Number
///
The underlying value of the Slider.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Splitter = function() { };
kendo.ui.Splitter.prototype = {
ajaxRequest: function(pane,url,data) {
///
/// Loads the content of a pane from a local or remote URL.
///
/// The targetted pane whose content is to be loaded via a URL.
/// A local or remote URL from which the content of the pane is to be loaded.
/// Any data that is necessary to be sent to the server.
},
collapse: function(pane) {
///
/// Collapses a specified pane. Invoking this method will force the Splitter to redraw and it
/// will trigger layoutChange and resize events. Note: Invoking the method will not trigger a collapse event.
///
/// The pane to be collapsed.
},
destroy: function() {
///
/// Prepares the Splitter for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
expand: function(pane) {
///
/// Expands a specified pane. Invoking this method will force the Splitter to redraw and it
/// will trigger layoutChange and resize events. Note: Invoking the method will not trigger an expand event.
///
/// The pane to be expanded.
},
max: function(pane,value) {
///
/// Sets the maximum size of a pane. Setting this value will not cause the Splitter to
/// redraw, nor will it trigger any events.
///
/// The pane being targetted for a new minimum size configuration value.
/// The maximum size value of the pane defined as pixels (i.e. "200px") or as a percentage (i.e. "50%").
},
min: function(pane,value) {
///
/// Sets the minimum size of a pane. Setting this value will not cause the Splitter to
/// redraw, nor will it trigger any events.
///
/// The pane being targetted for a new minimum size configuration value.
/// The minimum size value of the pane defined as pixels (i.e. "200px") or as a percentage (i.e. "50%").
},
size: function(pane,value) {
///
/// Set the size of the pane. Setting this value will cause the Splitter to redraw and it will
/// trigger layoutChange and resize events.
///
/// The pane to be resized.
/// The new size of the pane defined as pixels (i.e. "200px") or as a percentage (i.e. "50%"). Note: This value must not exceed panes.max or be less then panes.min.
},
toggle: function(pane,expand) {
///
/// Toggles the state of a specified pane (i.e. collapsed or expanded). Invoking this method will force the
/// Splitter to redraw and it will trigger layoutChange and resize events. Note: Invoking the
/// method will not trigger collapse or expand events.
///
/// The pane to be collapsed.
/// (Optional) Represents the desired state of the specified pane; to be expanded (true) or collapsed (false). If undefined, toggle() will collapse the pane if it is expanded or will expand the pane if it is collapsed.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoSplitter = function() {
///
/// Returns a reference to the kendo.ui.Splitter widget, instantiated on the selector.
///
/// The kendo.ui.Splitter instance (if present).
};
$.fn.kendoSplitter = function(options) {
///
/// Instantiates a kendo.ui.Splitter widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
orientation — String (default: "horizontal")
///
Specifies the orientation of the Splitter.
///
///
panes — Array
///
An array of pane definitions.
///
///
///
/// The widget configuration options
///
};
kendo.ui.TabStrip = function() { };
kendo.ui.TabStrip.prototype = {
activateTab: function(item) {
///
/// Activates a tab specified as a selector. Note: Invoking this method will not trigger any events.
///
/// The target tab, specified as a selector, to be activated.
/// Returns true if successful; otherwise, false.
},
append: function(tab) {
///
/// Appends a tab to the collection of tabs in a TabStrip.
///
/// Target tab, specified as a JSON object. You can pass tab text, content or contentUrl here. Can handle an HTML string or array of such strings or JSON.
/// Returns the TabStrip object to support chaining.
},
contentElement: function(itemIndex) {
///
/// Obtains the DOM element that encloses tab content by its tab index in the TabStrip.
///
/// The index of the tab in the TabStrip.
/// The DOM element enclosing tab content by its tab index in the TabStrip.
},
contentHolder: function(itemIndex) {
///
/// Obtains the DOM element that holds tab content by its tab index in the TabStrip.
/// The difference between contentElement and contentHolder is that contentHolder returns the DOM element that really holds the content, which on mobile is the scroll container.
///
/// The index of the tab in the TabStrip.
/// The DOM element holding tab content by its tab index in the TabStrip.
},
deactivateTab: function(item) {
///
/// Deactivates a tab specified as a selector. Note: Invoking this method will not trigger any events.
///
/// The target tab, specified as a selector, to be deactivated.
},
destroy: function() {
///
/// Prepares the TabStrip for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
disable: function(element) {
///
/// Disables a tab(s) of a TabStrip.
///
/// The target tab(s), specified as a selector, to be disabled.
/// Returns the TabStrip object to support chaining.
},
enable: function(element,enable) {
///
/// Disables (false) or enables (true) a tab(s) of a TabStrip.
///
/// The target tab(s), specified as a selector, to be enabled (true) or disabled (false).
/// Desired state of the tab(s) specified by the selector; enabled (true) or disabled (false).
/// Returns the TabStrip object to support chaining.
},
insertAfter: function(item,referenceTab) {
///
/// Inserts a newly-created tab after a specified tab.
///
/// Target tab, specified as a JSON object. You can pass tab text, content or contentUrl here. Can handle an HTML string or array of such strings or JSON.
/// A reference tab to insert the new item after.
/// Returns the TabStrip object to support chaining.
},
insertBefore: function(item,referenceTab) {
///
/// Inserts a newly-created tab before a specified tab.
///
/// Target tab, specified as a JSON object. You can pass tab text, content or contentUrl here. Can handle an HTML string or array of such strings or JSON.
/// A reference tab to insert the new item before
/// Returns the TabStrip object to support chaining.
},
reload: function(element) {
///
/// Reloads TabStrip tab(s) via AJAX.
///
/// The target tab(s), specified as a selector or jQuery object, to be reloaded via AJAX.
/// Returns the TabStrip object to support chaining.
},
remove: function(element) {
///
/// Removes a specified tab from a TabStrip.
///
/// The target tab(s), specified as a selector or jQuery object, to be removed.
/// Returns the TabStrip object to support chaining.
},
select: function(element) {
///
/// Get/set the selected tab. If called without arguments, it returns the
/// currently selected tab.
///
/// The target tab(s), specified as a selector, jQuery object or index in the tab group.
/// the selected tab if called without arguments. kendo.ui.TabStrip if called with arguments.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoTabStrip = function() {
///
/// Returns a reference to the kendo.ui.TabStrip widget, instantiated on the selector.
///
/// The kendo.ui.TabStrip instance (if present).
};
$.fn.kendoTabStrip = function(options) {
///
/// Instantiates a kendo.ui.TabStrip widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation — Object
///
A collection of visual animations used when TabStrip tab are selected through
///
user interactions. Setting this option to false will disable all animations.
///
///
collapsible — Boolean (default: false)
///
Specifies whether the TabStrip should be able to collapse completely when clicking an expanded tab.
///
///
dataContentField — String (default: "")
///
Sets the field of the data item that provides the text content of
///
the tab content element.
///
///
dataContentUrlField — String (default: "")
///
Sets the field of the data item that provides the URL for
///
the ajax loaded tab content.
///
///
dataImageUrlField — String (default: "")
///
Sets the field of the data item that provides the image URL of
///
the tab.
///
///
dataSpriteCssClass — String (default: "")
///
Sets the field of the data item that provides the CSS class of
///
the tab.
///
///
dataTextField — String (default: "")
///
Sets the field of the data item that provides the text name of the tab.
///
///
dataUrlField — String (default: "")
///
Sets the field of the data item that provides the link URL for the
///
tab.
///
///
///
/// The widget configuration options
///
};
kendo.ui.TimePicker = function() { };
kendo.ui.TimePicker.prototype = {
close: function() {
///
/// Closes the drop-down list of a TimePicker.
///
},
destroy: function() {
///
/// Prepares the TimePicker for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enables or disables a TimePicker.
///
/// Enables (true or undefined) or disables (false) a TimePicker.
},
readonly: function(readonly) {
///
/// Controls whether the widget is editable or readonly.
///
/// The argument, which defines whether the timepicker should be readonly or editable.
},
max: function(value) {
///
/// Gets or sets the maximum value of the TimePicker.
///
/// The maximum time value to set for a TimePicker, expressed as a Date object or as a string.
/// The maximum time value of a TimePicker.
},
min: function(value) {
///
/// Gets or sets the minimum value of the TimePicker.
///
/// The minimum time value to set for a TimePicker, expressed as a Date object or as a string.
/// The minimum time value of a TimePicker.
},
open: function() {
///
/// Opens the drop-down list of a TimePicker.
///
},
value: function(value) {
///
/// Gets or sets the value of the TimePicker.
///
/// The time value to set for a TimePicker, expressed as a Date object or as a string.
/// The time value of a TimePicker.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoTimePicker = function() {
///
/// Returns a reference to the kendo.ui.TimePicker widget, instantiated on the selector.
///
/// The kendo.ui.TimePicker instance (if present).
};
$.fn.kendoTimePicker = function(options) {
///
/// Instantiates a kendo.ui.TimePicker widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation — Object
///
Animations to be used for opening/closing the popup. Setting to false will turn of the animation.
///
///
culture — String (default: "en-US")
///
Specifies the culture info used by the widget.
///
///
dates — Array
///
Specifies a list of dates, which are shown in the time drop-down list. If not set, the DateTimePicker will auto-generate the available times.
///
///
format — String (default: "h:mm tt")
///
Specifies the format, which is used to format the value of the TimePicker displayed in the input. The format also will be used to parse the input.
///
///
interval — Number (default: "30")
///
Specifies the interval, between values in the popup list, in minutes.
///
///
max — Date (default: "00:00")
///
Specifies the end value in the popup list.
///
///
min — Date (default: "00:00")
///
Specifies the start value in the popup list.
///
///
parseFormats — Array
///
Specifies the formats, which are used to parse the value set with the value method or by direct input. If not set the value of the options.format will be used. Note that value of the format option is always used.
///
///
value — Date (default: null)
///
Specifies the selected time.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Tooltip = function() { };
kendo.ui.Tooltip.prototype = {
show: function(element) {
///
/// Shows the tooltip for given target.
///
/// The target element for which the tooltip should be shown.
},
hide: function() {
///
/// Hides the tooltip.
///
},
target: function() {
///
/// Gets the tooltip current target.
///
/// The target element or null.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoTooltip = function() {
///
/// Returns a reference to the kendo.ui.Tooltip widget, instantiated on the selector.
///
/// The kendo.ui.Tooltip instance (if present).
};
$.fn.kendoTooltip = function(options) {
///
/// Instantiates a kendo.ui.Tooltip widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
autoHide — Boolean (default: true)
///
Specifies if the tooltip will be hidden when mouse leaves the target element. If set to false a close button will be shown within tooltip.
///
///
animation — Object
///
A collection of {Animation} objects, used to change default animations. A value of false
///
will disable all animations in the widget.
///
///
content — String|Function
///
The text or a function which result will be shown within the tooltip.
///
By default the tooltip will display the target element title attribute content.
///
///
content — Object
///
The text or a function which result will be shown within the tooltip.
///
By default the tooltip will display the target element title attribute content.
///
///
callout — Boolean (default: true)
///
Specifies if the tooltip callout will be displayed.
///
///
filter — String
///
Specifies a selector for elements, within the container, for which the tooltip will be displayed.
///
///
iframe — Boolean
///
Explicitly states whether content iframe should be created.
///
///
height — Number (default: Infinity)
///
The height (in pixels) of the tooltip.
///
///
width — Number (default: Infinity)
///
The width (in pixels) of the tooltip.
///
///
position — String (default: "bottom")
///
The position relative to the target element, at which the tooltip will be shown. Predefined values are "bottom", "top", "left", "right", "center".
///
///
showAfter — Number (default: 100)
///
Specify the delay in milliseconds before the tooltip is shown. This option is ignored if showOn is set to "click" or "focus".
///
///
showOn — String (default: "mouseenter")
///
The event on which the tooltip will be shown. Predefined values are "mouseenter", "click" and "focus".
///
///
///
/// The widget configuration options
///
};
kendo.ui.Touch = function() { };
kendo.ui.Touch.prototype = {
destroy: function() {
///
/// Prepares the Touch for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoTouch = function() {
///
/// Returns a reference to the kendo.ui.Touch widget, instantiated on the selector.
///
/// The kendo.ui.Touch instance (if present).
};
$.fn.kendoTouch = function(options) {
///
/// Instantiates a kendo.ui.Touch widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
global — Boolean (default: false)
///
If set to true, the document element will be used a s surface for the user drags.
///
///
multiTouch — Boolean (default: false)
///
If set to true, the widget will capture and trigger the gesturestart, gesturechange, and gestureend events when the user touches the element with two fingers.
///
///
enableSwipe — Boolean (default: false)
///
If set to true, the Touch widget will recognize horizontal swipes and trigger the swipe event.Notice: if the enableSwipe option is set to true, the dragstart, drag and dragend events will not be triggered.
///
///
minXDelta — Number (default: 30)
///
The minimum horizontal distance in pixels the user should swipe before the swipe event is triggered.
///
///
maxYDelta — Number (default: 20)
///
The maximum vertical deviation in pixels of the swipe event. Swipes with higher deviation are discarded.
///
///
maxDuration — Number (default: 1000)
///
The maximum amount of time in milliseconds the swipe event can last. Slower swipes are discarded.
///
///
minHold — Number (default: 800)
///
The timeout in milliseconds before the hold event is fired.Notice: the hold event will be triggered after the time passes, not after the user lifts his/hers finger.
///
///
doubleTapTimeout — Number (default: 400)
///
The maximum period (in milliseconds) between two consecutive taps which will trigger the doubletap event.
///
///
///
/// The widget configuration options
///
};
kendo.ui.TreeView = function() { };
kendo.ui.TreeView.prototype = {
append: function(nodeData,parentNode) {
///
/// Appends a node to a group of a TreeView. This method may also be used to reorder the nodes of a
/// TreeView.
///
/// A JSON-formatted string or selector that specifies the node to be appended.
/// The node that will contain the newly appended node. If not specified, the new node will be appended to the root group of the TreeView.
},
collapse: function(nodes) {
///
/// Collapses nodes.
///
/// The nodes that are to be collapsed.
},
dataItem: function(node) {
///
/// Returns the model dataItem that corresponds to a TreeView node
///
/// The element or selector that specifies a node.
/// The model of the item that was passed as a parameter.
},
destroy: function() {
///
/// Prepares the TreeView for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
detach: function(node) {
///
/// Removes a node from a TreeView, but keeps its jQuery.data() objects.
///
/// The node that is to be detached.
/// The node that has been detached.
},
enable: function(nodes,enable) {
///
/// Enables or disables nodes.
///
/// The nodes that are to be enabled/disabled.
/// Whether the nodes should be enabled or disabled.
},
expand: function(nodes) {
///
/// Expands nodes.
///
/// The nodes that are to be collapsed.
},
findByText: function(text) {
///
/// Searches a TreeView for a node that has specific text.
///
/// The text that is being searched for.
/// All nodes that have the text.
},
findByUid: function(text) {
///
/// Searches a TreeView for a node with the given unique identifier.
/// Applicable when the widget is bound to a HierarchicalDataSource.
///
/// The text that is being searched for.
/// All nodes that have the text.
},
insertAfter: function(nodeData,referenceNode) {
///
/// Inserts a node after a specified node in a TreeView. This method may also be used to reorder the nodes of a
/// TreeView.
///
/// A JSON-formatted string or selector that specifies the node to be inserted.
/// The node that will be preceed the newly-appended node.
},
insertBefore: function(nodeData,referenceNode) {
///
/// Inserts a node before another node. This method may also be used to reorder the nodes of a
/// TreeView.
///
/// A JSON-formatted string or selector that specifies the node to be inserted.
/// The node that follows the inserted node.
},
parent: function(node) {
///
/// Gets the parent node of the item
///
/// The child node whose parent will be returned.
/// The parent node of the given parameter node.
},
remove: function(node) {
///
/// Removes a node from a TreeView.
///
/// The node that is to be removed.
},
select: function(node) {
///
/// Gets or sets the selected node of a TreeView.
///
/// If provided, the node of a TreeView that should be selected.
/// The selected node of a TreeView.
},
setDataSource: function(dataSource) {
///
/// Sets the dataSource of an existing TreeView and rebinds it.
///
///
},
text: function(node,newText) {
///
/// Gets or sets the text of a node in a TreeView.
///
/// The node of which the text is being retrieved.
/// Optional. When passed, sets the node text to the specified string
/// The text of a node.
},
toggle: function(node) {
///
/// Toggles the node of a TreeView between its expanded and collapsed states.
///
/// The node that should be toggled.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoTreeView = function() {
///
/// Returns a reference to the kendo.ui.TreeView widget, instantiated on the selector.
///
/// The kendo.ui.TreeView instance (if present).
};
$.fn.kendoTreeView = function(options) {
///
/// Instantiates a kendo.ui.TreeView widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation — Object
///
A collection of visual animations used when items are expanded or collapsed through user interaction.
///
Setting this option to false will disable all animations.
///
///
checkboxes — Boolean
///
If true or an object, renders checkboxes within each treeview item.
///
///
checkboxes — Object
///
If true or an object, renders checkboxes within each treeview item.
///
///
dataImageUrlField — String (default: null)
///
Sets the field of the data item that provides
///
the image URL of the treeview nodes.
///
///
dataSource — Array
///
The data that the TreeView will be bound to.
///
///
dataSpriteCssClassField — String (default: null)
///
Sets the field of the data item that provides
///
the sprite CSS class of the treeview nodes.
///
///
dataTextField — String|Array (default: null)
///
Sets the field of the data item that provides the text content of the treeview nodes.
///
If an array, each level uses the field that is at the same index in the array, or the last item in the array.
///
///
dataUrlField — String (default: null)
///
Sets the field of the data item that provides
///
the link URL of the treeview nodes.
///
///
dragAndDrop — Boolean (default: false)
///
Disables (false) or enables (true) drag-and-drop on the nodes of a
///
TreeView.
///
///
loadOnDemand — Boolean (default: true)
///
Indicates whether the child datasources should be fetched
///
lazily, when parent groups get expanded. Setting this to false causes all child dataSources to
///
be loaded at initialization time. Note: when initializing a TreeView from array (rather than from a
///
HierarchicalDataSource instance), the default value of this option is false.
///
///
template — String|Function
///
Template for rendering of the nodes of the treeview.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Upload = function() { };
kendo.ui.Upload.prototype = {
destroy: function() {
///
/// Prepares the Upload for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
disable: function() {
///
/// Disables the upload.
///
},
enable: function(enable) {
///
/// Enables the upload.
///
/// The argument, which defines whether to enable/disable the upload.
},
toggle: function(enable) {
///
/// Toggles the upload enabled state.
///
/// (Optional) The new enabled state.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoUpload = function() {
///
/// Returns a reference to the kendo.ui.Upload widget, instantiated on the selector.
///
/// The kendo.ui.Upload instance (if present).
};
$.fn.kendoUpload = function(options) {
///
/// Instantiates a kendo.ui.Upload widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
async — Object
///
Configures the ability to upload a file(s) in an asynchronous manner. Please refer to the
///
async mode help topic
///
for more details.
///
///
enabled — Boolean (default: true)
///
Enables (true) or disables (false) an Upload. A disabled
///
Upload may be re-enabled via enable().
///
///
localization — Object
///
Sets the strings rendered by the Upload.
///
///
multiple — Boolean (default: true)
///
Enables (true) or disables (false) the ability to select multiple files.
///
If false, users will be able to select only one file at a time. Note: This option does not
///
limit the total number of uploaded files in an asynchronous configuration.
///
///
showFileList — Boolean (default: true)
///
Enables (true) or disables (false) the ability to display a file listing
///
for uploading a file(s). Disabling a file listing may be useful you wish to customize the UI; use the
///
client-side events to build your own UI.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Validator = function() { };
kendo.ui.Validator.prototype = {
errors: function() {
///
/// Get the error messages if any.
///
/// Messages for the failed validation rules.
},
hideMessages: function() {
///
/// Hides the validation messages.
///
},
validate: function() {
///
/// Validates the input element(s) against the declared validation rules.
///
/// true if all validation rules passed successfully.Note that if a HTML form element is set as validation container, the form submits will be automatically prevented if validation fails.
},
validateInput: function(input) {
///
/// Validates the input element against the declared validation rules.
///
/// Input element to be validated.
/// true if all validation rules passed successfully.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoValidator = function() {
///
/// Returns a reference to the kendo.ui.Validator widget, instantiated on the selector.
///
/// The kendo.ui.Validator instance (if present).
};
$.fn.kendoValidator = function(options) {
///
/// Instantiates a kendo.ui.Validator widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
messages — Object
///
Set of messages (either strings or functions) which will be shown when given validation rule fails.
///
By setting already existing key the appropriate built-in message will be overridden.
///
///
rules — Object
///
Set of custom validation rules. Those rules will extend the built-in ones.
///
///
validateOnBlur — Boolean
///
Determines if validation will be triggered when element loses focus. Default value is true.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Widget = function() { };
kendo.ui.Widget.prototype = {
bind: function() {
///
/// Attaches a handler to an event. More info can be found in the bind section of the
/// kendo.Observable API reference.
///
},
destroy: function() {
///
/// Prepares the widget for safe removal from the DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
one: function() {
///
/// Attaches a handler to an event. The handler is executed only once. More info can be found in the one section of the
/// kendo.Observable API reference.
///
},
trigger: function() {
///
/// Executes all handlers attached to the given event. More info can be found in the trigger section of the
/// kendo.Observable API reference.
///
},
unbind: function() {
///
/// Remove a previously attached event handler. More info can be found in the unbind section of the
/// kendo.Observable API reference.
///
},
self: null
};
$.fn.getKendoWidget = function() {
///
/// Returns a reference to the kendo.ui.Widget widget, instantiated on the selector.
///
/// The kendo.ui.Widget instance (if present).
};
$.fn.kendoWidget = function(options) {
///
/// Instantiates a kendo.ui.Widget widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.ui.Window = function() { };
kendo.ui.Window.prototype = {
center: function() {
///
/// Centers a Window within the viewport.
///
/// Returns the (Kendo UI) Window object to support chaining.
},
close: function() {
///
/// Closes a Window.
///
/// Returns the (Kendo UI) Window object to support chaining.
},
content: function(content) {
///
/// Gets or set the content of a Window.
///
/// _optional, default: _The content of the Window.
/// If content is provided, this method will return the (Kendo UI) Window object to support chaining. Otherwise,it will return the current content of the (Kendo UI) Window.
},
destroy: function() {
///
/// Destroys the window and its modal overlay, if necessary. Removes the Window HTML elements from the DOM.
///
},
maximize: function() {
///
/// Maximizes a Window to the entire viewing area of the user agent. Triggers the resize event.
///
/// Returns the (Kendo UI) Window object to support chaining.
},
minimize: function() {
///
/// Maximizes a Window to its title bar.
///
/// Returns the (Kendo UI) Window object to support chaining.
},
open: function() {
///
/// Opens a Window.
///
/// Returns the (Kendo UI) Window object to support chaining.
},
refresh: function(options) {
///
/// Refreshes the content of a Window from a remote URL.
///
/// Options for requesting data from the server. If omitted, the window uses the content property that was supplied when the window was created. Any options specified here are passed to jQuery.ajax().
/// Returns the (Kendo UI) Window object to support chaining.
},
restore: function() {
///
/// Restores a maximized or minimized Window to its previous state. Triggers the resize event.
///
/// Returns the (Kendo UI) Window object to support chaining.
},
setOptions: function() {
///
/// Allows the window to be configured with new options.
///
},
title: function(text) {
///
/// Gets or set the title of a Window.
///
/// _optional, default: _The title of the Window.
/// If a title is provided, this method will return the (Kendo UI) Window object to support chaining. Otherwise,it will return the current title of the (Kendo UI) Window.
},
toFront: function() {
///
/// Brings forward a Window to the top of the z-index.
///
/// Returns the (Kendo UI) Window object to support chaining.
},
toggleMaximization: function() {
///
/// Toggles a Window between a maximized and restored state. Triggers the resize event.
///
/// Returns the (Kendo UI) Window object to support chaining.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoWindow = function() {
///
/// Returns a reference to the kendo.ui.Window widget, instantiated on the selector.
///
/// The kendo.ui.Window instance (if present).
};
$.fn.kendoWindow = function(options) {
///
/// Instantiates a kendo.ui.Window widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
actions — Array (default: ["Close"])
///
The buttons for interacting with the window. Predefined array values are "Close", "Refresh", "Minimize",
///
and "Maximize".
///
///
animation — Object
///
A collection of {Animation} objects, used to change default animations. A value of false
///
will disable all animations in the widget.
///
///
appendTo — Object|String (default: document.body)
///
The element that the Window will be appended to.
///
Note that this does not constrain the window dragging within the given element.
///
///
content — String
///
Specifies a URL or request options that the window should load its content from.Note: For URLs starting with a protocol (e.g. http://),
///
a container iframe element is automatically created. This behavior may change in future
///
versions, so it is advisable to always use the iframe configuration option.
///
///
content — Object
///
Specifies a URL or request options that the window should load its content from.Note: For URLs starting with a protocol (e.g. http://),
///
a container iframe element is automatically created. This behavior may change in future
///
versions, so it is advisable to always use the iframe configuration option.
///
///
draggable — Boolean (default: true)
///
Enables (true) or disables (false) the ability for users to move/drag a
///
Window.
///
///
iframe — Boolean
///
Explicitly states whether content iframe should be created.
///
///
maxHeight — Number (default: Infinity)
///
The maximum height (in pixels) that may be achieved by resizing the window.
///
///
maxWidth — Number (default: Infinity)
///
The maximum width (in pixels) that may be achieved by resizing the window.
///
///
minHeight — Number (default: 50)
///
The minimum height (in pixels) that may be achieved by resizing the window.
///
///
minWidth — Number (default: 50)
///
The minimum width (in pixels) that may be achieved by resizing the window.
///
///
modal — Boolean (default: false)
///
Specifies whether the window should show a modal overlay over the page.
///
///
resizable — Boolean (default: true)
///
Enables (true) or disables (false) the ability for users to resize a
///
Window.
///
///
title — String|Boolean (default: "")
///
The text in the window title bar. If false, the window will be displayed without a title bar. Note that this will prevent the window from being dragged, and the window titlebar buttons will not be shown.
///
///
visible — Boolean (default: true)
///
Specifies whether the window will be initially visible.
///
///
width — Number
///
Specifies width of the window.
///
///
height — Number
///
Specifies height of the window.
///
///
///
/// The widget configuration options
///
};