2905 lines
102 KiB
JavaScript
2905 lines
102 KiB
JavaScript
var kendo = {
|
|
ui: {},
|
|
mobile: {ui: {}},
|
|
dataviz: {ui: {}},
|
|
data: {}
|
|
};
|
|
|
|
|
|
FX = function() { };
|
|
|
|
FX.prototype = {
|
|
|
|
|
|
|
|
|
|
kendoAnimate: function(duration,reverse,complete,show,hide) {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <param name="duration" type="Number" >The effect duration (speed) in milliseconds.</param>
|
|
/// <param name="reverse" type="Boolean" >Whether the effect should play backwards, useful when doing the same animation but with the opposite direction, like opening and closing.</param>
|
|
/// <param name="complete" type="Function" >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.</param>
|
|
/// <param name="show" type="Boolean" >Whether the element should be shown before animating.</param>
|
|
/// <param name="hide" type="Boolean" >Whether the element should be hidden after the animation completes.</param>
|
|
|
|
},
|
|
|
|
|
|
kendoStop: function(gotoEnd) {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <param name="gotoEnd" type="Boolean" >Whether to jump to the animation end position when stopping or just leave the element at its current position.</param>
|
|
|
|
},
|
|
|
|
|
|
kendoAddClass: function(classes,options) {
|
|
/// <summary>
|
|
/// 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();
|
|
/// </summary>
|
|
/// <param name="classes" type="String" >A list of the classes that should be added to the element/s, separated by a space.</param>
|
|
/// <param name="options" type="" >An object containing several additional options, like duration and exclusive.</param>
|
|
|
|
},
|
|
|
|
|
|
kendoRemoveClass: function(classes,options) {
|
|
/// <summary>
|
|
/// 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();
|
|
/// </summary>
|
|
/// <param name="classes" type="String" >A list of the classes that should be removed from the element/s, separated by a space.</param>
|
|
/// <param name="options" type="" >An object containing several additional options, like duration and exclusive.</param>
|
|
|
|
},
|
|
|
|
|
|
kendoToggleClass: function(classes,options,toggle) {
|
|
/// <summary>
|
|
/// 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();
|
|
/// </summary>
|
|
/// <param name="classes" type="String" >A list of the classes that should be toggled on the element/s, separated by a space.</param>
|
|
/// <param name="options" type="" >An object containing several additional options, like duration and exclusive.</param>
|
|
/// <param name="toggle" type="Boolean" >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.</param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoFX = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the FX widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="FX">The FX instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoFX = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a FX widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
if (!kendo) {
|
|
kendo = {};
|
|
}
|
|
|
|
kendo.Class = function() { };
|
|
|
|
kendo.Class.prototype = {
|
|
|
|
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoClass = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.Class widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.Class">The kendo.Class instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoClass = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.Class widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.Color = function() { };
|
|
|
|
kendo.Color.prototype = {
|
|
|
|
|
|
|
|
|
|
diff: function() {
|
|
/// <summary>
|
|
/// Computes the relative luminance between two colors.
|
|
/// </summary>
|
|
/// <returns type="Number">The relative luminance.</returns>
|
|
|
|
},
|
|
|
|
|
|
equals: function() {
|
|
/// <summary>
|
|
/// Compares two color objects for equality.
|
|
/// </summary>
|
|
/// <returns type="Boolean">returns true if the two colors are the same. Otherwise, false</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoColor = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.Color widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.Color">The kendo.Color instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoColor = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.Color widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.Layout = function() { };
|
|
|
|
kendo.Layout.prototype = {
|
|
|
|
|
|
|
|
|
|
showIn: function(container,view) {
|
|
/// <summary>
|
|
/// Renders the View element in the element specified by the selector
|
|
/// </summary>
|
|
/// <param name="container" type="String" >The selector of the container in which the view element will be appended.</param>
|
|
/// <param name="view" type="kendo.View" >The view instance that will be rendered.</param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoLayout = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.Layout widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.Layout">The kendo.Layout instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoLayout = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.Layout widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.Observable = function() { };
|
|
|
|
kendo.Observable.prototype = {
|
|
|
|
|
|
|
|
|
|
bind: function(eventName,handler) {
|
|
/// <summary>
|
|
/// Attaches a handler to an event.
|
|
/// </summary>
|
|
/// <param name="eventName" type="String" >The name of the event.</param>
|
|
/// <param name="handler" type="Function" >A function to execute each time the event is triggered. That function should have a single parameter which will contain any event specific data.</param>
|
|
|
|
},
|
|
|
|
|
|
one: function(eventName,handler) {
|
|
/// <summary>
|
|
/// Attaches a handler to an event. The handler is executed only once.
|
|
/// </summary>
|
|
/// <param name="eventName" type="String" >The name of the event.</param>
|
|
/// <param name="handler" type="Function" >A function to execute each time the event is triggered. That function should have a single parameter which will contain any event specific data.</param>
|
|
|
|
},
|
|
|
|
|
|
trigger: function(eventName,eventData) {
|
|
/// <summary>
|
|
/// Executes all handlers attached to the given event.
|
|
/// </summary>
|
|
/// <param name="eventName" type="String" >The name of the event to trigger.</param>
|
|
/// <param name="eventData" type="Object" >Optional event data which will be passed as an argument to the event handlers.</param>
|
|
|
|
},
|
|
|
|
|
|
unbind: function(eventName,handler) {
|
|
/// <summary>
|
|
/// Remove a previously attached event handler.
|
|
/// </summary>
|
|
/// <param name="eventName" type="String" >The name of the event. If not specified all handlers of all events will be removed.</param>
|
|
/// <param name="handler" type="Function" >The handler which should no longer be executed. If not specified all handlers listening to that event will be removed.</param>
|
|
|
|
},
|
|
|
|
|
|
self: null
|
|
|
|
};
|
|
|
|
$.fn.getKendoObservable = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.Observable widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.Observable">The kendo.Observable instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoObservable = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.Observable widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.Router = function() { };
|
|
|
|
kendo.Router.prototype = {
|
|
|
|
|
|
|
|
|
|
start: function() {
|
|
/// <summary>
|
|
/// Activates the router binding to the URL fragment part changes.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
route: function(route,callback) {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <param name="route" type="String" >The route definition.</param>
|
|
/// <param name="callback" type="Function" >The callback to be executed when the route is matched.</param>
|
|
|
|
},
|
|
|
|
|
|
navigate: function(route,silent) {
|
|
/// <summary>
|
|
/// Navigates to the given route.
|
|
/// </summary>
|
|
/// <param name="route" type="String" >The route to navigate to.</param>
|
|
/// <param name="silent" type="Boolean" >If set to true, the router callbacks will not be called.</param>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Unbinds the router instance listeners from the URL fragment part changes.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoRouter = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.Router widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.Router">The kendo.Router instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoRouter = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.Router widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.View = function() { };
|
|
|
|
kendo.View.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
render: function(container) {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <param name="container" type="jQuery" >(optional) the element in which the view element will be appended.</param>
|
|
/// <returns type="jQuery">the view element.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoView = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.View widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.View">The kendo.View instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoView = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.Binder = function() { };
|
|
|
|
kendo.data.Binder.prototype = {
|
|
|
|
|
|
|
|
|
|
refresh: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoBinder = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.Binder widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.Binder">The kendo.data.Binder instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoBinder = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.Binder widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.DataSource = function() { };
|
|
|
|
kendo.data.DataSource.prototype = {
|
|
|
|
|
|
|
|
|
|
add: function(model) {
|
|
/// <summary>
|
|
/// Appends a data item to the data source.
|
|
/// </summary>
|
|
/// <param name="model" type="Object" >Either a kendo.data.Model instance or JavaScript object containing the data item field values.</param>
|
|
/// <returns type="kendo.data.Model">the data item which is inserted.</returns>
|
|
|
|
},
|
|
|
|
|
|
aggregate: function(value) {
|
|
/// <summary>
|
|
/// Gets or sets the aggregate configuration.
|
|
/// </summary>
|
|
/// <param name="value" type="Object" >The aggregate configuration. Accepts the same values as the aggregate option.</param>
|
|
/// <returns type="Array">the current aggregate configuration.</returns>
|
|
|
|
},
|
|
|
|
|
|
aggregates: function() {
|
|
/// <summary>
|
|
/// Returns the aggregate results.
|
|
/// </summary>
|
|
/// <returns type="Object">the aggregate results. There is a key for every aggregated field.</returns>
|
|
|
|
},
|
|
|
|
|
|
at: function(index) {
|
|
/// <summary>
|
|
/// Returns the data item at the specified index. The index is zero-based.
|
|
/// </summary>
|
|
/// <param name="index" type="Number" >The zero-based index of the data item.</param>
|
|
/// <returns type="kendo.data.ObservableObject">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.</returns>
|
|
|
|
},
|
|
|
|
|
|
cancelChanges: function(model) {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <param name="model" type="kendo.data.Model" >The optional data item (model). If specified only the changes of this data item will be discarded. If omitted all changes will be discarded.</param>
|
|
|
|
},
|
|
|
|
|
|
data: function(value) {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <param name="value" type="Object" >The data items which will replace the current ones in the data source. If omitted the current data items will be returned.</param>
|
|
/// <returns type="kendo.data.ObservableArray">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.</returns>
|
|
|
|
},
|
|
|
|
|
|
fetch: function(callback) {
|
|
/// <summary>
|
|
/// 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).
|
|
/// </summary>
|
|
/// <param name="callback" type="Function" >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.</param>
|
|
|
|
},
|
|
|
|
|
|
filter: function(value) {
|
|
/// <summary>
|
|
/// Gets or sets the filter configuration.
|
|
/// </summary>
|
|
/// <param name="value" type="Object" >The filter configuration. Accepts the same values as the filter option.</param>
|
|
/// <returns type="Object">the current filter configuration.</returns>
|
|
|
|
},
|
|
|
|
|
|
get: function(id) {
|
|
/// <summary>
|
|
/// Gets the data item (model) with the specified id.
|
|
/// </summary>
|
|
/// <param name="id" type="Object" >The id of the model to look for.</param>
|
|
/// <returns type="kendo.data.Model">the model instance. Returns undefined if a model with the specified id is not found.</returns>
|
|
|
|
},
|
|
|
|
|
|
getByUid: function(uid) {
|
|
/// <summary>
|
|
/// Gets the data item (model) with the specified uid.
|
|
/// </summary>
|
|
/// <param name="uid" type="String" >The uid of the model to look for.</param>
|
|
/// <returns type="kendo.data.ObservableObject">the model instance. Returns undefined if a model with the specified uid is not found.</returns>
|
|
|
|
},
|
|
|
|
|
|
group: function(value) {
|
|
/// <summary>
|
|
/// Gets or sets the grouping configuration.
|
|
/// </summary>
|
|
/// <param name="value" type="Object" >The grouping configuration. Accepts the same values as the group option.</param>
|
|
/// <returns type="Array">the current grouping configuration.</returns>
|
|
|
|
},
|
|
|
|
|
|
hasChanges: function() {
|
|
/// <summary>
|
|
/// Cheks if the data itams have changed.
|
|
/// </summary>
|
|
/// <returns type="Boolean">returns true if the data items have changed. Otherwise, false.</returns>
|
|
|
|
},
|
|
|
|
|
|
indexOf: function(dataItem) {
|
|
/// <summary>
|
|
/// Gets the index of the specified data item.
|
|
/// </summary>
|
|
/// <param name="dataItem" type="kendo.data.ObservableObject" >The target data item.</param>
|
|
/// <returns type="Number">the index of the specified data item. Returns -1 if the data item is not found.</returns>
|
|
|
|
},
|
|
|
|
|
|
insert: function(index,model) {
|
|
/// <summary>
|
|
/// Inserts a data item in the data source at the specified index.
|
|
/// </summary>
|
|
/// <param name="index" type="Number" >The zero-based index at which the data item will be inserted.</param>
|
|
/// <param name="model" type="Object" >Either a kendo.data.Model instance or JavaScript object containing the field values.</param>
|
|
/// <returns type="kendo.data.Model">the data item which is inserted.</returns>
|
|
|
|
},
|
|
|
|
|
|
page: function(page) {
|
|
/// <summary>
|
|
/// Gets or sets the current page.
|
|
/// </summary>
|
|
/// <param name="page" type="Number" >The new page.</param>
|
|
/// <returns type="Number">the current page.</returns>
|
|
|
|
},
|
|
|
|
|
|
pageSize: function(size) {
|
|
/// <summary>
|
|
/// Gets or sets the current page size.
|
|
/// </summary>
|
|
/// <param name="size" type="Number" >The new page size.</param>
|
|
/// <returns type="Number">the current page size.</returns>
|
|
|
|
},
|
|
|
|
|
|
query: function(options) {
|
|
/// <summary>
|
|
/// Executes the specified query over the data items. Makes a HTTP request if bound to a remote service.
|
|
/// </summary>
|
|
/// <param name="options" type="" >The query options which should be applied.</param>
|
|
|
|
},
|
|
|
|
|
|
read: function(data) {
|
|
/// <summary>
|
|
/// Reads data items from a remote service (if the transport option is set) or from a JavaScript array (if the data option is set).
|
|
/// </summary>
|
|
/// <param name="data" type="Object" >Optional data to pass to the remote service.</param>
|
|
|
|
},
|
|
|
|
|
|
remove: function(model) {
|
|
/// <summary>
|
|
/// Removes the specified data item from the data source.
|
|
/// </summary>
|
|
/// <param name="model" type="kendo.data.Model" >The data item which should be removed.</param>
|
|
|
|
},
|
|
|
|
|
|
sort: function(value) {
|
|
/// <summary>
|
|
/// Gets or sets the sort order which will be applied over the data items.
|
|
/// </summary>
|
|
/// <param name="value" type="Object" >The sort configuration. Accepts the same values as the sort option.</param>
|
|
/// <returns type="Array">the current sort configuration.</returns>
|
|
|
|
},
|
|
|
|
|
|
sync: function() {
|
|
/// <summary>
|
|
/// Saves any data item changes.The sync method will request the remote service if:
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
total: function() {
|
|
/// <summary>
|
|
/// Gets the total number of data items. Uses schema.total if the transport.read option is set.
|
|
/// </summary>
|
|
/// <returns type="Number">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.</returns>
|
|
|
|
},
|
|
|
|
|
|
totalPages: function() {
|
|
/// <summary>
|
|
/// Gets the number of available pages.
|
|
/// </summary>
|
|
/// <returns type="Number">the available pages.</returns>
|
|
|
|
},
|
|
|
|
|
|
view: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.ObservableArray">the data items. Returns groups if the data items are grouped (via the group option or the group method).</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoDataSource = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.DataSource widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.DataSource">The kendo.data.DataSource instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoDataSource = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.HierarchicalDataSource = function() { };
|
|
|
|
kendo.data.HierarchicalDataSource.prototype = {
|
|
|
|
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoHierarchicalDataSource = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.HierarchicalDataSource widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.HierarchicalDataSource">The kendo.data.HierarchicalDataSource instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoHierarchicalDataSource = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.Model = function() { };
|
|
|
|
kendo.data.Model.prototype = {
|
|
|
|
|
|
|
|
|
|
bind: function() {
|
|
/// <summary>
|
|
/// Attaches a handler to an event. Examples and more info can be found in the bind section of the kendo.Observable API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
editable: function(field) {
|
|
/// <summary>
|
|
/// Determines if the specified field is editable or not.
|
|
/// </summary>
|
|
/// <param name="field" type="String" >The field to check.</param>
|
|
/// <returns type="Boolean">true if the field is editable; false otherwise.</returns>
|
|
|
|
},
|
|
|
|
|
|
get: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
isNew: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <returns type="Boolean">true if the model is new; false otherwise.</returns>
|
|
|
|
},
|
|
|
|
|
|
set: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
toJSON: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoModel = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.Model widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.Model">The kendo.data.Model instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoModel = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.Model widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.Node = function() { };
|
|
|
|
kendo.data.Node.prototype = {
|
|
|
|
|
|
|
|
|
|
append: function(model) {
|
|
/// <summary>
|
|
/// Appends a new item to the children data source, and initializes it if necessary.
|
|
/// </summary>
|
|
/// <param name="model" type="Object" >The data for the new item</param>
|
|
|
|
},
|
|
|
|
|
|
level: function() {
|
|
/// <summary>
|
|
/// Gets the current nesting level of the node within the data source.
|
|
/// </summary>
|
|
/// <returns type="Number">the zero based level of the node.</returns>
|
|
|
|
},
|
|
|
|
|
|
load: function() {
|
|
/// <summary>
|
|
/// Loads the child nodes in the child data source, supplying the id of the Node to the request.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
loaded: function() {
|
|
/// <summary>
|
|
/// Gets or sets the loaded flag of the Node. Setting the loaded flag to false allows reloading of child items.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
parentNode: function() {
|
|
/// <summary>
|
|
/// Gets the parent node.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.Node">the parent of the node; null if the node is a root node or doesn't have a parent.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoNode = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.Node widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.Node">The kendo.data.Node instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoNode = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.Node widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.ObservableArray = function() { };
|
|
|
|
kendo.data.ObservableArray.prototype = {
|
|
|
|
|
|
|
|
|
|
bind: function(eventName,handler) {
|
|
/// <summary>
|
|
/// Attaches an event handler for the specified event.
|
|
/// </summary>
|
|
/// <param name="eventName" type="String" >The name of the event.</param>
|
|
/// <param name="handler" type="Function" >The function which will be invoked when the event is raised.</param>
|
|
|
|
},
|
|
|
|
|
|
join: function(separator) {
|
|
/// <summary>
|
|
/// Joins all items of an ObservableArray into a string. Equivalent of
|
|
/// Array.prototype.join.
|
|
/// </summary>
|
|
/// <param name="separator" type="String" >Specifies the string to separate each item of the array. If omitted the array items are separated with a comma (,)</param>
|
|
|
|
},
|
|
|
|
|
|
parent: function() {
|
|
/// <summary>
|
|
/// Gets the parent of the array if such parent exists.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.ObservableObject">the parent of the array; undefined if the array is not nested and doesn't have a parent.</returns>
|
|
|
|
},
|
|
|
|
|
|
pop: function() {
|
|
/// <summary>
|
|
/// Removes the last item from an array and returns that item. Equivalent of Array.prototype.pop.
|
|
/// </summary>
|
|
/// <returns type="Object">the item which was removed.</returns>
|
|
|
|
},
|
|
|
|
|
|
push: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <returns type="Number">the new length of the array.</returns>
|
|
|
|
},
|
|
|
|
|
|
slice: function(begin,end) {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <param name="begin" type="Number" >Zero-based index at which to begin extraction.</param>
|
|
/// <param name="end" type="Number" >Zero-based index at which to end extraction. If end is omitted, slice extracts to the end of the sequence.</param>
|
|
|
|
},
|
|
|
|
|
|
splice: function(index,howMany) {
|
|
/// <summary>
|
|
/// Changes an ObservableArray, by adding new items while removing old items. Equivalent of
|
|
/// Array.prototype.splice
|
|
/// </summary>
|
|
/// <param name="index" type="Number" >Index at which to start changing the array. If negative, will begin that many elements from the end.</param>
|
|
/// <param name="howMany" type="Number" >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.</param>
|
|
/// <returns type="Array">containing the removed items. The result of the splice method is not an instance of ObvservableArray.</returns>
|
|
|
|
},
|
|
|
|
|
|
shift: function() {
|
|
/// <summary>
|
|
/// Removes the first item from an ObvservableArray and returns that item. Equivalent of Array.prototype.shift.
|
|
/// </summary>
|
|
/// <returns type="Object">the item which was removed.</returns>
|
|
|
|
},
|
|
|
|
|
|
toJSON: function() {
|
|
/// <summary>
|
|
/// Returns a JavaScript Array which represents the contents of the ObservableArray.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
unshift: function() {
|
|
/// <summary>
|
|
/// Adds one or more items to the beginning of an ObservableArray and returns the new length. Equivalent of Array.prototype.unshift.
|
|
/// </summary>
|
|
/// <returns type="Number">the new length of the array.</returns>
|
|
|
|
},
|
|
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoObservableArray = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.ObservableArray widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.ObservableArray">The kendo.data.ObservableArray instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoObservableArray = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.ObservableArray widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.ObservableObject = function() { };
|
|
|
|
kendo.data.ObservableObject.prototype = {
|
|
|
|
|
|
|
|
|
|
bind: function() {
|
|
/// <summary>
|
|
/// Attaches a handler to an event. Examples and more info can be found in the bind section of the
|
|
/// kendo.Observable API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
get: function(name) {
|
|
/// <summary>
|
|
/// Gets the value of the specified field.
|
|
/// </summary>
|
|
/// <param name="name" type="String" >The name of the field whose value is going to be returned.</param>
|
|
/// <returns type="Object">the value of the specified field.</returns>
|
|
|
|
},
|
|
|
|
|
|
parent: function() {
|
|
/// <summary>
|
|
/// Gets the parent of the object if such parent exists.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.ObservableObject">the parent of the object; undefined if the object is not nested and doesn't have a parent.</returns>
|
|
|
|
},
|
|
|
|
|
|
set: function(name,value) {
|
|
/// <summary>
|
|
/// Sets the value of the specified field.
|
|
/// </summary>
|
|
/// <param name="name" type="String" >The name of the field whose value is going to be returned.</param>
|
|
/// <param name="value" type="Object" >The new value of the field.</param>
|
|
|
|
},
|
|
|
|
|
|
toJSON: function() {
|
|
/// <summary>
|
|
/// Creates a plain JavaScript object which contains all fields of the ObservableObject.
|
|
/// </summary>
|
|
/// <returns type="Object">which contains only the fields of the ObservableObject.</returns>
|
|
|
|
},
|
|
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoObservableObject = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.ObservableObject widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.ObservableObject">The kendo.data.ObservableObject instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoObservableObject = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.data.ObservableObject widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.SchedulerDataSource = function() { };
|
|
|
|
kendo.data.SchedulerDataSource.prototype = {
|
|
|
|
|
|
|
|
|
|
expand: function(start,end) {
|
|
/// <summary>
|
|
/// Expands all recurring events in the data and returns a list of events for a specific period.
|
|
/// </summary>
|
|
/// <param name="start" type="Date" >The start date of the period.</param>
|
|
/// <param name="end" type="Date" >The end date of the period.</param>
|
|
/// <returns type="Array">the expanded list of scheduler events filtered by the specified start/end period.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoSchedulerDataSource = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.SchedulerDataSource widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.SchedulerDataSource">The kendo.data.SchedulerDataSource instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoSchedulerDataSource = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.data.SchedulerEvent = function() { };
|
|
|
|
kendo.data.SchedulerEvent.prototype = {
|
|
|
|
|
|
|
|
|
|
clone: function(options) {
|
|
/// <summary>
|
|
/// Clones the scheduler event.
|
|
/// </summary>
|
|
/// <param name="options" type="Object" >Additional options passed to the SchedulerEvent constructor.</param>
|
|
/// <returns type="kendo.data.Scheduler">the cloned scheduler event.</returns>
|
|
|
|
},
|
|
|
|
|
|
duration: function() {
|
|
/// <summary>
|
|
/// Returns the scheduler event length in milliseconds.
|
|
/// </summary>
|
|
/// <returns type="Number">the length of the event.</returns>
|
|
|
|
},
|
|
|
|
|
|
expand: function(start,end,timeZoneId) {
|
|
/// <summary>
|
|
/// Expands the event for a specific period based on the recurrenceRule option.
|
|
/// </summary>
|
|
/// <param name="start" type="Date" >The start date of the occurrence period.</param>
|
|
/// <param name="end" type="Date" >The end date of the occurrence period.</param>
|
|
/// <param name="timeZoneId" type="String" >The time zone ID used to convert the recurrence rule dates.</param>
|
|
/// <returns type="Array">the list of the occurrences.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoSchedulerEvent = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.data.SchedulerEvent widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.data.SchedulerEvent">The kendo.data.SchedulerEvent instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoSchedulerEvent = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.dataviz.ui.Barcode = function() { };
|
|
|
|
kendo.dataviz.ui.Barcode.prototype = {
|
|
|
|
|
|
|
|
|
|
imageDataURL: function() {
|
|
/// <summary>
|
|
/// Returns a PNG image of the barcode encoded as a Data URL.
|
|
/// </summary>
|
|
/// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
|
|
|
|
},
|
|
|
|
|
|
redraw: function() {
|
|
/// <summary>
|
|
/// Redraws the barcode.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
svg: function() {
|
|
/// <summary>
|
|
/// Returns the SVG representation of the barcode. 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.
|
|
/// </summary>
|
|
/// <returns type="String">the SVG representation of the barcode.</returns>
|
|
|
|
},
|
|
|
|
|
|
value: function(value) {
|
|
/// <summary>
|
|
/// Gets/Sets the value of the barcode.
|
|
/// </summary>
|
|
/// <param name="value" type="Object" >The value to set.</param>
|
|
/// <returns type="String">The value of the barcode.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoBarcode = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.dataviz.ui.Barcode widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.dataviz.ui.Barcode">The kendo.dataviz.ui.Barcode instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoBarcode = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.dataviz.ui.Barcode widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// renderAs — String (default: "canvas")
|
|
/// Sets the preferred rendering engine.
|
|
/// If it is not supported by the browser, the Barcode will switch to the first available mode.The supported values are:
|
|
///
|
|
/// background — String (default: "white")
|
|
/// The background of the barcode area.
|
|
/// Any valid CSS color string will work here, including hex and rgb.
|
|
///
|
|
/// border — Object
|
|
/// The border of the barcode area.
|
|
///
|
|
/// checksum — Boolean (default: false)
|
|
/// If set to true the barcode will not display the checksum digit next to the value in the text area.
|
|
///
|
|
/// color — String (default: "black")
|
|
/// The color of the bar elements.
|
|
/// Any valid CSS color string will work here, including hex and rgb.
|
|
///
|
|
/// height — Number (default: 100)
|
|
/// The height of the barcode in pixels. By default the height is 100.
|
|
///
|
|
/// padding — Object
|
|
/// The padding of the barcode.
|
|
///
|
|
/// text — Object
|
|
/// Can be set to a JavaScript object which represents the text configuration.
|
|
///
|
|
/// type — String (default: "code39")
|
|
/// The symbology (encoding) the barcode will use.The supported values are:
|
|
///
|
|
/// value — String
|
|
/// The initial value of the Barcode
|
|
///
|
|
/// width — Number (default: 300)
|
|
/// The width of the barcode in pixels. By default the width is 300.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.dataviz.ui.Chart = function() { };
|
|
|
|
kendo.dataviz.ui.Chart.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
redraw: function() {
|
|
/// <summary>
|
|
/// Repaints the chart using the currently loaded data.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
refresh: function() {
|
|
/// <summary>
|
|
/// Reloads the data and renders the chart.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
setDataSource: function(dataSource) {
|
|
/// <summary>
|
|
/// Sets the data source of the widget.
|
|
/// </summary>
|
|
/// <param name="dataSource" type="kendo.data.DataSource" >The data source to which the widget should be bound.</param>
|
|
|
|
},
|
|
|
|
|
|
setOptions: function(options) {
|
|
/// <summary>
|
|
/// Sets the widget options. Changes are cumulative.
|
|
/// </summary>
|
|
/// <param name="options" type="Object" >The chart settings to update.</param>
|
|
|
|
},
|
|
|
|
|
|
svg: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <returns type="String">the SVG representation of the chart.</returns>
|
|
|
|
},
|
|
|
|
|
|
imageDataURL: function() {
|
|
/// <summary>
|
|
/// Returns a PNG image of the chart encoded as a Data URL.
|
|
/// </summary>
|
|
/// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoChart = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.dataviz.ui.Chart widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.dataviz.ui.Chart">The kendo.dataviz.ui.Chart instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoChart = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// renderAs — String
|
|
/// Sets the preferred rendering engine.
|
|
/// If it is not supported by the browser, the Chart will switch to the first available mode.The supported values are:
|
|
///
|
|
/// 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.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.dataviz.ui.LinearGauge = function() { };
|
|
|
|
kendo.dataviz.ui.LinearGauge.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the Gauge for safe removal from the DOM.Detaches event handlers and removes data entries in order to avoid memory leaks.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
redraw: function() {
|
|
/// <summary>
|
|
/// Redraws the gauge.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
svg: function() {
|
|
/// <summary>
|
|
/// Returns the SVG representation of the 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 server-side processing.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
imageDataURL: function() {
|
|
/// <summary>
|
|
/// Returns a PNG image of the gauge encoded as a Data URL.
|
|
/// </summary>
|
|
/// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
|
|
|
|
},
|
|
|
|
|
|
value: function() {
|
|
/// <summary>
|
|
/// Change the value of the gauge.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoLinearGauge = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.dataviz.ui.LinearGauge widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.dataviz.ui.LinearGauge">The kendo.dataviz.ui.LinearGauge instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoLinearGauge = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// renderAs — String
|
|
/// Sets the preferred rendering engine.
|
|
/// If it is not supported by the browser, the Gauge will switch to the first available mode.The supported values are:
|
|
///
|
|
/// scale — Object
|
|
/// Configures the scale.
|
|
///
|
|
/// transitions — Boolean (default: true)
|
|
/// A value indicating if transition animations should be played.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.dataviz.ui.Map = function() { };
|
|
|
|
kendo.dataviz.ui.Map.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoMap = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.dataviz.ui.Map widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.dataviz.ui.Map">The kendo.dataviz.ui.Map instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoMap = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.dataviz.ui.Map widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// center — Array
|
|
/// The map center. Coordinates are listed as [Latitude, Longitude].
|
|
///
|
|
/// controls — Object
|
|
/// The configuration of built-in map controls.
|
|
///
|
|
/// layerDefaults — Object
|
|
/// The default configuration for map layers by type.
|
|
///
|
|
/// layers — Array
|
|
/// The configuration of the map layers.
|
|
/// The layer type is determined by the value of the type field.
|
|
///
|
|
/// markerDefaults — Object
|
|
/// The default options for all markers.
|
|
///
|
|
/// markers — Array
|
|
/// Static markers to display on the map.
|
|
///
|
|
/// minZoom — Number (default: 2)
|
|
/// The minimum zoom level.
|
|
///
|
|
/// maxZoom — Number (default: 19)
|
|
/// The maximum zoom level.
|
|
///
|
|
/// minSize — Number (default: 256)
|
|
/// The size of the map in pixels at zoom level 0.
|
|
///
|
|
/// wraparound — Boolean (default: true)
|
|
/// Specifies whether the map should wrap around the east-west edges.
|
|
///
|
|
/// zoom — Number (default: 3)
|
|
/// The initial zoom level.Typical web maps use zoom levels from 0 (whole world) to 19 (sub-meter features).The map size is derived from the zoom level and minScale options: size = (2 ^ zoom) * minSize
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.dataviz.ui.QRCode = function() { };
|
|
|
|
kendo.dataviz.ui.QRCode.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the QRCode for safe removal from the DOM.Removes data entries in order to avoid memory leaks.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
imageDataURL: function() {
|
|
/// <summary>
|
|
/// Returns a PNG image of the qrcode encoded as a Data URL.
|
|
/// </summary>
|
|
/// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
|
|
|
|
},
|
|
|
|
|
|
redraw: function() {
|
|
/// <summary>
|
|
/// Redraws the QR code using the current value and options.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
setOptions: function(options) {
|
|
/// <summary>
|
|
/// Sets new options to the QRCode and redraws it.
|
|
/// </summary>
|
|
/// <param name="options" type="Object" >An object with the new options. All configuration options can be set.</param>
|
|
|
|
},
|
|
|
|
|
|
svg: function() {
|
|
/// <summary>
|
|
/// Returns the SVG representation of the qrcode. 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.
|
|
/// </summary>
|
|
/// <returns type="String">the SVG representation of the qrcode.</returns>
|
|
|
|
},
|
|
|
|
|
|
value: function(options) {
|
|
/// <summary>
|
|
/// Change the value of the QR code.
|
|
/// </summary>
|
|
/// <param name="options" type="Object" >The new value to be set.</param>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoQRCode = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.dataviz.ui.QRCode widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.dataviz.ui.QRCode">The kendo.dataviz.ui.QRCode instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoQRCode = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.dataviz.ui.QRCode widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// background — String (default: "#fff")
|
|
/// The background color of the QR code. Accepts a valid CSS color string, including hex and rgb.
|
|
///
|
|
/// border — Object
|
|
/// The border of the QR code.
|
|
///
|
|
/// color — String (default: "#000")
|
|
/// The color of the QR code. Accepts a valid CSS color string, including hex and rgb.
|
|
///
|
|
/// encoding — String (default: "ISO_8859_1")
|
|
/// The encoding mode used to encode the value.The possible values are:
|
|
///
|
|
/// errorCorrection — String (default: "L")
|
|
/// The error correction level used to encode the value.The possible values are:
|
|
///
|
|
/// renderAs — String (default: "canvas")
|
|
/// Sets the preferred rendering engine.
|
|
/// If it is not supported by the browser, the QRCode will switch to the first available mode.The supported values are:
|
|
///
|
|
/// size — Number|String
|
|
/// Specifies the size of a QR code in pixels (i.e. "200px"). Numeric values are treated as pixels. If no size is specified, it will be determined from the element width and height. In case the element does not have width or height bigger than zero, a default value of 200 pixels will be used.
|
|
///
|
|
/// value — Number|String
|
|
/// The value of the QRCode.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.dataviz.ui.RadialGauge = function() { };
|
|
|
|
kendo.dataviz.ui.RadialGauge.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the Gauge for safe removal from the DOM.Detaches event handlers and removes data entries in order to avoid memory leaks.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
redraw: function() {
|
|
/// <summary>
|
|
/// Redraws the gauge.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
svg: function() {
|
|
/// <summary>
|
|
/// Returns the SVG representation of the 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 server-side processing.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
imageDataURL: function() {
|
|
/// <summary>
|
|
/// Returns a PNG image of the gauge encoded as a Data URL.
|
|
/// </summary>
|
|
/// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
|
|
|
|
},
|
|
|
|
|
|
value: function() {
|
|
/// <summary>
|
|
/// Change the value of the gauge.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoRadialGauge = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.dataviz.ui.RadialGauge widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.dataviz.ui.RadialGauge">The kendo.dataviz.ui.RadialGauge instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoRadialGauge = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// renderAs — String
|
|
/// Sets the preferred rendering engine.
|
|
/// If it is not supported by the browser, the Gauge will switch to the first available mode.The supported values are:
|
|
///
|
|
/// scale — Object
|
|
/// Configures the scale.
|
|
///
|
|
/// transitions — Boolean (default: true)
|
|
/// A value indicating if transition animations should be played.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.dataviz.ui.Sparkline = function() { };
|
|
|
|
kendo.dataviz.ui.Sparkline.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// Prepares the Sparkline for safe removal from the DOM.Detaches event handlers and removes data entries in order to avoid memory leaks.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
refresh: function() {
|
|
/// <summary>
|
|
/// Reloads the data and repaints the chart.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
setDataSource: function(dataSource) {
|
|
/// <summary>
|
|
/// Sets the dataSource of an existing Chart and rebinds it.
|
|
/// </summary>
|
|
/// <param name="dataSource" type="kendo.data.DataSource" ></param>
|
|
|
|
},
|
|
|
|
|
|
setOptions: function(options) {
|
|
/// <summary>
|
|
/// Sets the widget options. Changes are cumulative.
|
|
/// </summary>
|
|
/// <param name="options" type="Object" >The chart settings to update.</param>
|
|
|
|
},
|
|
|
|
|
|
svg: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <returns type="String">the SVG representation of the sparkline.</returns>
|
|
|
|
},
|
|
|
|
|
|
imageDataURL: function() {
|
|
/// <summary>
|
|
/// Returns a PNG image of the sparkline encoded as a Data URL.
|
|
/// </summary>
|
|
/// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoSparkline = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.dataviz.ui.Sparkline widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.dataviz.ui.Sparkline">The kendo.dataviz.ui.Sparkline instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoSparkline = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// renderAs — String
|
|
/// Sets the preferred rendering engine.
|
|
/// If it is not supported by the browser, the Sparkline will switch to the first available mode.The supported values are:
|
|
///
|
|
/// 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.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.dataviz.ui.StockChart = function() { };
|
|
|
|
kendo.dataviz.ui.StockChart.prototype = {
|
|
|
|
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
redraw: function() {
|
|
/// <summary>
|
|
/// Repaints the chart using the currently loaded data.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
refresh: function() {
|
|
/// <summary>
|
|
/// Reloads the data and renders the chart.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
setDataSource: function(dataSource) {
|
|
/// <summary>
|
|
/// Sets the data source of the widget.
|
|
/// </summary>
|
|
/// <param name="dataSource" type="kendo.data.DataSource" >The data source to which the widget should be bound.</param>
|
|
|
|
},
|
|
|
|
|
|
svg: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <returns type="String">the SVG representation of the chart.</returns>
|
|
|
|
},
|
|
|
|
|
|
imageDataURL: function() {
|
|
/// <summary>
|
|
/// Returns a PNG image of the chart encoded as a Data URL.
|
|
/// </summary>
|
|
/// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoStockChart = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.dataviz.ui.StockChart widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.dataviz.ui.StockChart">The kendo.dataviz.ui.StockChart instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoStockChart = function(options) {
|
|
/// <summary>
|
|
/// 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 categoryField for all series.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.
|
|
///
|
|
/// renderAs — String
|
|
/// Sets the preferred rendering engine.
|
|
/// If it is not supported by the browser, the Chart will switch to the first available mode.The supported values are:
|
|
///
|
|
/// 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.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.mobile.ui.Widget = function() { };
|
|
|
|
kendo.mobile.ui.Widget.prototype = {
|
|
|
|
|
|
|
|
|
|
view: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoWidget = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.mobile.ui.Widget widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.mobile.ui.Widget">The kendo.mobile.ui.Widget instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoWidget = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.mobile.ui.Widget widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.ui.Draggable = function() { };
|
|
|
|
kendo.ui.Draggable.prototype = {
|
|
|
|
|
|
|
|
|
|
cancelHold: function() {
|
|
/// <summary>
|
|
/// Has effect only when holdToDrag is set to true. Cancels the activated state of the widget, caused by pressing and holding.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoDraggable = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.ui.Draggable widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.ui.Draggable">The kendo.ui.Draggable instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoDraggable = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.ui.DropTarget = function() { };
|
|
|
|
kendo.ui.DropTarget.prototype = {
|
|
|
|
|
|
|
|
|
|
destroyGroup: function() {
|
|
/// <summary>
|
|
/// Destroys all DropTarget instances from the group with the given name.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoDropTarget = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.ui.DropTarget widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.ui.DropTarget">The kendo.ui.DropTarget instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoDropTarget = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.ui.DropTargetArea = function() { };
|
|
|
|
kendo.ui.DropTargetArea.prototype = {
|
|
|
|
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoDropTargetArea = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.ui.DropTargetArea widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.ui.DropTargetArea">The kendo.ui.DropTargetArea instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoDropTargetArea = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.ui.Validator = function() { };
|
|
|
|
kendo.ui.Validator.prototype = {
|
|
|
|
|
|
|
|
|
|
errors: function() {
|
|
/// <summary>
|
|
/// Get the error messages if any.
|
|
/// </summary>
|
|
/// <returns type="Array">Messages for the failed validation rules.</returns>
|
|
|
|
},
|
|
|
|
|
|
hideMessages: function() {
|
|
/// <summary>
|
|
/// Hides the validation messages.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
validate: function() {
|
|
/// <summary>
|
|
/// Validates the input element(s) against the declared validation rules.
|
|
/// </summary>
|
|
/// <returns type="Boolean">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.</returns>
|
|
|
|
},
|
|
|
|
|
|
validateInput: function(input) {
|
|
/// <summary>
|
|
/// Validates the input element against the declared validation rules.
|
|
/// </summary>
|
|
/// <param name="input" type="Object" >Input element to be validated.</param>
|
|
/// <returns type="Boolean">true if all validation rules passed successfully.</returns>
|
|
|
|
},
|
|
|
|
bind: function(event, callback) {
|
|
/// <summary>
|
|
/// Binds to a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
|
|
},
|
|
|
|
unbind: function(event, callback) {
|
|
/// <summary>
|
|
/// Unbinds a callback from a widget event.
|
|
/// </summary>
|
|
/// <param name="event" type="String">The event name</param>
|
|
/// <param name="callback" type="Function">The callback to be removed.</param>
|
|
}
|
|
|
|
};
|
|
|
|
$.fn.getKendoValidator = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.ui.Validator widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.ui.Validator">The kendo.ui.Validator instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoValidator = function(options) {
|
|
/// <summary>
|
|
/// 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.
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|
|
|
|
kendo.ui.Widget = function() { };
|
|
|
|
kendo.ui.Widget.prototype = {
|
|
|
|
|
|
|
|
|
|
bind: function() {
|
|
/// <summary>
|
|
/// Attaches a handler to an event. Examples and more info can be found in the bind section of the kendo.Observable API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
destroy: function() {
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
one: function() {
|
|
/// <summary>
|
|
/// Attaches a handler to an event. The handler is executed only once. Examples and more info can be found in the one section of the
|
|
/// kendo.Observable API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
trigger: function() {
|
|
/// <summary>
|
|
/// Executes all handlers attached to the given event. More info can be found in the trigger section of the
|
|
/// kendo.Observable API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
unbind: function() {
|
|
/// <summary>
|
|
/// Remove a previously attached event handler. More info can be found in the unbind section of the
|
|
/// kendo.Observable API reference.
|
|
/// </summary>
|
|
|
|
},
|
|
|
|
|
|
self: null
|
|
|
|
};
|
|
|
|
$.fn.getKendoWidget = function() {
|
|
/// <summary>
|
|
/// Returns a reference to the kendo.ui.Widget widget, instantiated on the selector.
|
|
/// </summary>
|
|
/// <returns type="kendo.ui.Widget">The kendo.ui.Widget instance (if present).</returns>
|
|
};
|
|
|
|
$.fn.kendoWidget = function(options) {
|
|
/// <summary>
|
|
/// Instantiates a kendo.ui.Widget widget based the DOM elements that match the selector.
|
|
|
|
/// Accepts an object with the following configuration options:
|
|
///
|
|
/// </summary>
|
|
/// <param name="options" type="Object">
|
|
/// The widget configuration options
|
|
/// </param>
|
|
};
|
|
|