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.Color = function() { };
kendo.Color.prototype = {
diff: function() {
///
/// Computes the relative luminance between two colors.
///
/// The relative luminance.
},
equals: function() {
///
/// Compares two color objects for equality.
///
/// returns true if the two colors are the same. Otherwise, false
},
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.getKendoColor = function() {
///
/// Returns a reference to the kendo.Color widget, instantiated on the selector.
///
/// The kendo.Color instance (if present).
};
$.fn.kendoColor = function(options) {
///
/// Instantiates a kendo.Color 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 longer 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.
///
},
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. Query string parameters are parsed and passed as last argument of the callback function.
///
/// 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 = {
refresh: function() {
///
/// Invoked by the Kendo UI MVVM framework when the bound view model value is changed. The binder should update the UI (HTML element or Kendo UI widget) to reflect the view model change.
///
},
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 service 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. See the DataSource.schema configuration for all available options.
///
///
///
/// The widget configuration options
///
};
kendo.data.Model = function() { };
kendo.data.Model.prototype = {
bind: function() {
///
/// Attaches a handler to an event. Examples and more info can be found in the bind section of the kendo.Observable API reference.
///
},
editable: function(field) {
///
/// Determines if the specified field is editable or not.
///
/// The field to check.
/// true if the field is editable; false otherwise.
},
get: function() {
///
/// Gets the value of the specified field. Inherited from kendo.data.ObservableObject. Examples and 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 (specified through the fields configuration) the model is considered as new.
///
/// true if the model is new; false otherwise.
},
set: function() {
///
/// Sets the value of the specified field. Inherited from kendo.data.ObservableObject. Examples and 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 kendo.data.ObservableObject. Examples and 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 data source, and initializes it if necessary.
///
/// The data for the new item
},
level: function() {
///
/// Gets the current nesting level of the node within the data source.
///
/// the zero based level of the node.
},
load: function() {
///
/// Loads the child nodes in the child data source, 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.
///
/// the parent of the node; null if the node is a root node or doesn't have a parent.
},
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() {
///
/// Gets the parent of the array if such parent exists.
///
/// the parent of the array; undefined if the array is not nested and doesn't have a parent.
},
pop: function() {
///
/// Removes the last item from an array and returns that item. Equivalent of Array.prototype.pop.
///
/// the item which was removed.
},
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.
///
/// the new length of the array.
},
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.
///
/// 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 set to 0, no items are removed. In this case, you should specify at least one new item.
/// 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.
///
/// the item which was removed.
},
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.
///
/// the new length of the array.
},
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. Examples and 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() {
///
/// Gets the parent of the object if such parent exists.
///
/// the parent of the object; undefined if the object is not nested and doesn't have a parent.
},
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.
///
/// 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.data.SchedulerDataSource = function() { };
kendo.data.SchedulerDataSource.prototype = {
expand: function(start,end) {
///
/// Expands all recurring events in the data and returns a list of events for a specific period.
///
/// The start date of the period.
/// The end date of the period.
/// the expanded list of scheduler events filtered by the specified start/end period.
},
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.getKendoSchedulerDataSource = function() {
///
/// Returns a reference to the kendo.data.SchedulerDataSource widget, instantiated on the selector.
///
/// The kendo.data.SchedulerDataSource instance (if present).
};
$.fn.kendoSchedulerDataSource = function(options) {
///
/// Instantiates a kendo.data.SchedulerDataSource widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
schema — Object
///
The schema configuration of the SchedulerDataSource.
///
///
///
/// The widget configuration options
///
};
kendo.data.SchedulerEvent = function() { };
kendo.data.SchedulerEvent.prototype = {
clone: function(options) {
///
/// Clones the scheduler event.
///
/// Additional options passed to the SchedulerEvent constructor.
/// the cloned scheduler event.
},
duration: function() {
///
/// Returns the scheduler event length in milliseconds.
///
/// the length of the event.
},
expand: function(start,end,timeZoneId) {
///
/// Expands the event for a specific period based on the recurrenceRule option.
///
/// The start date of the occurrence period.
/// The end date of the occurrence period.
/// The time zone ID used to convert the recurrence rule dates.
/// the list of the occurrences.
},
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.getKendoSchedulerEvent = function() {
///
/// Returns a reference to the kendo.data.SchedulerEvent widget, instantiated on the selector.
///
/// The kendo.data.SchedulerEvent instance (if present).
};
$.fn.kendoSchedulerEvent = function(options) {
///
/// Instantiates a kendo.data.SchedulerEvent widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
description — string (default: "")
///
The optional event description.
///
///
end — Date
///
The date at which the scheduler event ends. The end date is mandatory.
///
///
endTimezone — string (default: undefined)
///
The timezone of the end date. If not specified the timezone will be used.The complete list of the supported timezones is available in the List of IANA time zones Wikipedia page.
///
///
id — string|Number|Object
///
The mandatory unique identifier of the event.
///
///
isAllDay — Boolean (default: false)
///
If set to true the event is "all day". By default events are not all day.
///
///
recurrenceException — string (default: undefined)
///
The recurrence exceptions. A list of semicolon separated dates formatted using the yyyyMMddTHHmmssZ format string.
///
///
recurrenceId — string|Number|Object (default: undefined)
///
The id of the recurrence parent event. Required for events that are recurrence exceptions.
///
///
recurrenceRule — string (default: undefined)
///
The recurrence rule describing the recurring pattern of the event. The format follows the iCal specification.
///
///
start — Date
///
The date at which the scheduler event starts. The start date is mandatory.
///
///
startTimezone — string (default: undefined)
///
The timezone of the start date. If not specified the timezone will be used.The complete list of the supported timezones is available in the List of IANA time zones Wikipedia page.
///
///
title — string (default: "")
///
The title of the event which is displayed by the scheduler widget.
///
///
///
/// 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. If the widget is contained in a splitview, modalview, or drawer, the respective widget instance is returned.
///
},
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.
},
focus: function() {
///
/// Focuses the widget.
///
},
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.
},
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.
///
///
headerTemplate — string|Function
///
Specifies a static HTML content, which will be rendered as a header of the popup element.
///
///
template — string|Function
///
The template used to render the suggestions. By default the widget displays only the text of the suggestion (configured via dataTextField).
///
///
valuePrimitive — Boolean (default: false)
///
Spcifies the value binding behavior for the widget when the initial model value is null. If set to true, the View-Model field will be updated with the selected item text field. If set to false, the View-Model field will be updated with the selected item.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Button = function() { };
kendo.ui.Button.prototype = {
enable: function(toggle) {
///
/// Enables or disables the Button.
///
/// Indicates whether the Button should be enabled or disabled. Truthy and falsy arguments are accepted. If no argument is supplied, the Button will assume true and will be enabled.
},
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.ui.Button widget, instantiated on the selector.
///
/// The kendo.ui.Button instance (if present).
};
$.fn.kendoButton = function(options) {
///
/// Instantiates a kendo.ui.Button widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
enable — Boolean (default: true)
///
Indicates whether the Button should be enabled or disabled. By default, it is enabled, unless a disabled="disabled" attribute is detected.
///
///
icon — string
///
Defines a name of an existing icon in the Kendo UI theme sprite. The icon will be applied as background image of a span element inside the Button.
///
The span element can be added automatically by the widget, or an existing element can be used, if it has a k-icon CSS class applied.
///
For a list of available icon names, please refer to the Icons demo.
///
///
imageUrl — string
///
Defines a URL, which will be used for an img element inside the Button. The URL can be relative or absolute. In case it is relative, it will be evaluated with relation to the web page URL.The img element can be added automatically by the widget, or an existing element can be used, if it has a k-image CSS class applied.
///
///
spriteCssClass — string
///
Defines a CSS class (or multiple classes separated by spaces), which will be used for applying a background image to a span element inside the Button.
///
In case you want to use an icon from the Kendo UI theme sprite background image, it is easier to use the icon property.The span element can be added automatically by the widget, or an existing element can be used, if it has a k-sprite CSS class applied.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Calendar = function() { };
kendo.ui.Calendar.prototype = {
current: function() {
///
/// Gets currently focused date.
///
/// The current focused date shown in the calendar.
},
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.
},
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. The following
///
settings are available for the depth value:
///
///
footer — string|Function
///
The template which renders 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 "month" view.
///
///
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.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.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 kendo.Color object object.
///
///
/// the string representation of the current color.
},
color: function(color) {
///
/// Get or set the selected color. If no argument is given, this returns the currently selected color as a kendo.Color object.
///
/// The color that should be set as the current value
/// the current value
},
enable: function(enable) {
///
/// Enables or disables the widget.
///
/// Whether the widget should be enabled (true) or disabled (false). If not specified, the method will enable 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.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 kendo.Color object 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 use the "websafe" palette, 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(color) {
///
/// Get or set the selected color. If no argument is given, this returns the currently selected color as a kendo.Color object.
///
/// The color that should be set as the current value
/// the current value
},
enable: function(enable) {
///
/// Enables or disables the widget.
///
/// Whether the widget should be enabled (true) or disabled (false). If not specified, the method will enable 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.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)
///
Specifies whether the widget should display the Apply / Cancel buttons.Applicable only for the HSV selector, when a pallete is not specified.
///
///
columns — Number
///
The number of columns to show in the color dropdown when a pallete is specified.
///
This is automatically initialized for the "basic" and "websafe" palettes.
///
If you use 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 that lists the colors. 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 applicable 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.
///
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 widget popup.
///
},
dataItem: function(index) {
///
/// Returns the data item 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 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.
///
},
open: function() {
///
/// Opens the popup.
///
},
refresh: function() {
///
/// Refresh the popup by rendering all items again.
///
},
search: function(word) {
///
/// Searches the data source for the provided value and displays any matches as suggestions.
///
/// The filter value.
},
select: function(li) {
///
/// Selects the item provided as an argument and updates the value and text 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. A number representing the index of the item or function predicate which returns the correct data item.
/// The index of the selected item, if called with no parameters. If a custom value is entered, the returned selected index is -1. If called with a parameter as a setter.
},
setDataSource: function(dataSource) {
///
/// Sets the dataSource of an existing ComboBox and rebinds it.
///
///
},
suggest: function(value) {
///
/// Sets the value of the widget to the specified argument and visually selects the text.
///
/// Characters to force a suggestion.
},
text: function(text) {
///
/// Gets or sets the text of the ComboBox. Widget will select the item with same text. If
/// there are no matches then the text will be considered as a custom value of the widget.
///
/// The text to set.
/// The text of the combobox.
},
toggle: function(toggle) {
///
/// Opens or closes the widget popup.
///
/// Defines the whether to open/close the drop-down list.
},
value: function(value) {
///
/// Gets or sets the value of the combobox.
///
/// 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
///
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.
///
///
autoBind — Boolean (default: true)
///
Controls whether to bind the widget to the data source on initialization.
///
///
cascadeFrom — string
///
Use it to set the Id of the parent ComboBox widget.
///
Help topic showing how cascading functionality works
///
///
cascadeFromField — string
///
Defines the field to be used to filter the data source. If not defiend the parent's dataValueField option will be used.
///
Help topic showing how cascading functionality works
///
///
dataSource — Object|Array
///
The data source of the widget which is used to display a list of values. 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: "")
///
The field of the data item that provides the text content of the list items. The widget will filter the data source based on this field.
///
///
dataValueField — string (default: "")
///
The field of the data item that provides the value of the widget.
///
///
delay — Number (default: 200)
///
The delay in milliseconds between a keystroke and when the widget displays the 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: "none")
///
The filtering method used to determine the suggestions for the current value. Filtration is turned of by default.
///
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 — string (default: true)
///
If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default.
///
///
index — Number (default: -1)
///
The index of the initially selected item. The index is 0 based.
///
///
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.
///
///
suggest — Boolean (default: false)
///
If set to true the widget will automatically use the first suggestion as its value.
///
///
headerTemplate — string|Function
///
Specifies a static HTML content, which will be rendered as a header of the popup element.
///
///
template — string|Function
///
The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
///
///
text — string (default: "")
///
The text of the widget used when the autoBind is set to false.
///
///
value — string (default: "")
///
The value of the widget.
///
///
valuePrimitive — Boolean (default: false)
///
Specifies the value binding behavior for the widget when the initial model value is null. If set to true, the View-Model field will be updated with the selected item value field. If set to false, the View-Model field will be updated with the selected item.
///
///
///
/// 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) {
///
/// Toggles the readonly state of the widget. When the widget is readonly it doesn't allow user input.
///
/// 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
///
Configures the opening and closing animations of the calendar popup. Setting the animation option to false will disable the opening and closing animations. As a result the calendar popup will open and close instantly.
///
///
ARIATemplate — string (default: "Current focused date is #=kendo.toString(data.current, 'D'#"))
///
Specifies a template used to populate value of the aria-label attribute.
///
///
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|Function
///
The template which renders the footer of the calendar. If false, the footer will not be rendered.
///
///
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 a lis of date formats used to parse the value set with value() method or by direct user input. If not set the value of the format will be used.
///
Note that format option is always used parsing process.
///
///
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) {
///
/// Toggles the readonly state of the widget. When the widget is readonly it doesn't allow user input.
///
/// 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
///
Configures the opening and closing animations of the popups. Setting the animation option to false will disable the opening and closing animations. As a result the popup will open and close instantly.
///
///
ARIATemplate — string (default: "Current focused date is #=kendo.toString(data.current, 'G'#"))
///
Specifies a template used to populate value of the aria-label attribute.
///
///
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
///
The template which renders the footer of the calendar. If false, the footer will not be rendered.
///
///
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 = {
cancelHold: function() {
///
/// Has effect only when holdToDrag is set to true. Cancels the activated state of the widget, caused by pressing and holding.
///
},
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.
///
///
holdToDrag — Boolean (default: false)
///
Suitable for touch oriented user interface, in order to avoid collision with the touch scrolling gesture. When set to true, the widget will be activated after the user taps and holds the finger on the element for a short amount of time.The draggable will also be activated by pressing, holding and lifting the finger without any movement. Dragging it afterwards will initiate the drag immediately. The activated mode can be canceled by calling cancelHold.
///
///
///
/// The widget configuration options
///
};
kendo.ui.DropDownList = function() { };
kendo.ui.DropDownList.prototype = {
close: function() {
///
/// Closes the widget popup.
///
},
dataItem: function(index) {
///
/// Returns the data item 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.
///
},
focus: function() {
///
/// Focuses the widget.
///
},
open: function() {
///
/// Opens the popup.
///
},
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) {
///
/// Controls whether the widget is editable or readonly.
///
/// The argument, which defines whether the datepicker should be readonly or editable.
},
refresh: function() {
///
/// Refresh the popup by rendering all items again.
///
},
search: function(word) {
///
/// Selects an item, which starts with the provided value.
///
/// The search value.
},
select: function(li) {
///
/// Gets or sets the selected item. Selects the item provided as an argument and updates the value and text 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. A number representing the index of the item or function predicate which returns the correct data item.
/// The index of the selected item, if called with no parameters. If a custom value is entered, the returned selected index is -1. If called with a parameter as a setter.
},
setDataSource: function(dataSource) {
///
/// Sets the dataSource of an existing DropDownList and rebinds it.
///
///
},
text: function(text) {
///
/// Gets or sets the text of the dropdownlist.
///
/// The text to set.
/// The text of the dropdownlist.
},
toggle: function(toggle) {
///
/// Opens or closes the widget popup.
///
/// Defines the whether to open/close the drop-down list.
},
value: function(value) {
///
/// Gets or 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
///
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.
///
///
autoBind — Boolean (default: true)
///
Controls whether to bind the widget to the data source on initialization.
///
///
cascadeFrom — string
///
Use it to set the Id of the parent dropdownlist widget.
///
Help topic showing how cascading functionality works
///
///
cascadeFromField — string
///
Defines the field to be used to filter the data source. If not defiend the parent's dataValueField option will be used.
///
Help topic showing how cascading functionality works
///
///
dataSource — Object|Array
///
The data source of the widget which is used to display a list of values. 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: "")
///
The field of the data item that provides the text content of the list items. The widget will filter the data source based on this field.
///
///
dataValueField — string (default: "")
///
The field of the data item that provides the value of the widget.
///
///
delay — Number (default: 500)
///
Specifies the delay in milliseconds before the search-text typed by the end user is cleared.
///
///
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.
///
///
height — Number (default: 200)
///
The height of the suggestion popup in pixels. The default value is 200 pixels.
///
///
ignoreCase — string (default: true)
///
If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default.
///
///
index — Number (default: 0)
///
The index of the initially selected item. The index is 0 based.
///
///
optionLabel — string|Object (default: "")
///
Define the text of the default empty item. If the value is an object, then the widget will use it a valid data item.
///
Note that the optionLabel will not be available if the widget is empty.
///
///
headerTemplate — string|Function
///
Specifies a static HTML content, which will be rendered as a header of the popup element.
///
///
template — string|Function
///
The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
///
///
valueTemplate — string|Function
///
The valueTemplate used to render the selected value. By default the widget displays only the text of the data item (configured via dataTextField).
///
///
text — string (default: "")
///
The text of the widget used when the autoBind is set to false.
///
///
value — string (default: "")
///
The value of the widget.
///
///
valuePrimitive — Boolean (default: false)
///
Spcifies the value binding behavior for the widget when the initial model value is null. If set to true, the View-Model field will be updated with the selected item value field. If set to false, the View-Model field will be updated with the selected item.
///
///
///
/// 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: null)
///
Selector to filter the drop targets in the area. Every matched element acts as a drop target and fires events on the DropTargetArea. Specifying the filter is mandatory.
///
///
///
/// 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 omitted, the document of the editor editing area will be used.
/// The created Range object.
},
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.
///
},
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. Cleans up MS Word formatting.
///
/// 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