// jshint unused: false
var kendo = {
ui: {},
mobile: {ui: {}},
dataviz: {ui: {}},
data: {}
};
if (!kendo.kendo) {
kendo.kendo = {};
}
kendo.Class = function() { };
kendo.Class.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoClass = function() {
///
/// Returns a reference to the kendo.Class widget, instantiated on the selector.
///
/// The kendo.Class instance (if present).
};
$.fn.kendoClass = function(options) {
///
/// Instantiates a kendo.Class widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.Color = function() { };
kendo.Color.prototype = {
diff: function() {
///
/// Computes the relative luminance between two colors.
///
/// The relative luminance.
},
equals: function() {
///
/// Compares two color objects for equality.
///
/// returns true if the two colors are the same. Otherwise, false
},
toHSV: function() {
///
/// Returns the color in HSV representation. As HSV object, it has the following properties: h -- hue, an integer between 0 and 360; s -- saturation, floating point between 0 and 1; v -- value, floating point between 0 and 1 or a -- alpha, floating point between 0 and 1. This does not modify the current object, it creates a new one instead.
///
/// An object with h, s, v and a fields.
},
toRGB: function() {
///
/// Returns the color in RGB representation. The result has the following properties: r -- red component as floating point between 0 and 1; g -- green component; b -- blue component or a -- alpha. This does not modify the current object, it creates a new one instead.
///
/// An object with r, g, b and a fields.
},
toBytes: function() {
///
/// Returns the color in "Bytes" representation. It has the same properties as RGB, but r, g and b are integers between 0 and 255 instead of floats.This does not modify the current object, it creates a new one instead.
///
/// An object with r, g and b fields.
},
toHex: function() {
///
/// Returns a string in "FF0000" form (without a leading #).
///
/// The color in hex notation.
},
toCss: function() {
///
/// Like toHex, but includes a leading #.
///
/// The color in CSS notation.
},
toCssRgba: function() {
///
/// Returns the color in RGBA notation (includes the opacity).
///
/// The color in RGBA notation.
},
toDisplay: function() {
///
/// Returns the color in the best notation supported by the current browser. In IE < 9 this returns the #FF0000 form; in all other browsers it returns the RGBA form.
///
/// The color in the best notation supported by the current browser.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoColor = function() {
///
/// Returns a reference to the kendo.Color widget, instantiated on the selector.
///
/// The kendo.Color instance (if present).
};
$.fn.kendoColor = function(options) {
///
/// Instantiates a kendo.Color widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.Layout = function() { };
kendo.Layout.prototype = {
showIn: function(container,view,transitionClass) {
///
/// Renders the View element in the element specified by the selector
///
/// The selector of the container in which the view element will be appended.
/// The view instance that will be rendered.
/// Optional. If provided, the new view will replace the current one with a replace effect.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoLayout = function() {
///
/// Returns a reference to the kendo.Layout widget, instantiated on the selector.
///
/// The kendo.Layout instance (if present).
};
$.fn.kendoLayout = function(options) {
///
/// Instantiates a kendo.Layout widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.Observable = function() { };
kendo.Observable.prototype = {
bind: function(eventName,handler) {
///
/// Attaches a handler to an event.
///
/// The name of the event.
/// A function to execute each time the event is triggered. That function should have a single parameter which will contain any event specific data.
},
one: function(eventName,handler) {
///
/// Attaches a handler to an event. The handler is executed only once.
///
/// The name of the event.
/// A function to execute each time the event is triggered. That function should have a single parameter which will contain any event specific data.
},
trigger: function(eventName,eventData) {
///
/// Executes all handlers attached to the given event.
///
/// The name of the event to trigger.
/// Optional event data which will be passed as an argument to the event handlers.
},
unbind: function(eventName,handler) {
///
/// Remove a previously attached event handler.
///
/// The name of the event. If not specified all handlers of all events will be removed.
/// The handler which should no longer be executed. If not specified all handlers listening to that event will be removed.
},
self: null
};
$.fn.getKendoObservable = function() {
///
/// Returns a reference to the kendo.Observable widget, instantiated on the selector.
///
/// The kendo.Observable instance (if present).
};
$.fn.kendoObservable = function(options) {
///
/// Instantiates a kendo.Observable widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.Router = function() { };
kendo.Router.prototype = {
start: function() {
///
/// Activates the router binding to the URL changes.
///
},
route: function(route,callback) {
///
///
///
/// The route definition.
/// The callback to be executed when the route is matched.
},
navigate: function(route,silent) {
///
/// Navigates to the given route.
///
/// The route to navigate to.
/// If set to true, the router callbacks will not be called.
},
replace: function(route,silent) {
///
/// Navigates to the given route, replacing the current view in the history stack (like window.history.replaceState or location.replace work).
///
/// The route to navigate to.
/// If set to true, the router callbacks will not be called.
},
destroy: function() {
///
/// Unbinds the router instance listeners from the URL fragment part changes.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoRouter = function() {
///
/// Returns a reference to the kendo.Router widget, instantiated on the selector.
///
/// The kendo.Router instance (if present).
};
$.fn.kendoRouter = function(options) {
///
/// Instantiates a kendo.Router widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
ignoreCase - Boolean (default: true)
///
Introduced with Q3 2014. If set to false, the router instance will perform case sensitive match of the url against the defined routes.
///
///
pushState - Boolean (default: false)
///
If set to true, the router will use the history pushState API.
///
///
root - String (default: "/")
///
Applicable if pushState is used and the application is deployed to a path different than /. If the application start page is hosted on http://foo.com/myapp/, the root option should be set to /myapp/.
///
///
hashBang - Boolean (default: false)
///
Introduced in the 2014 Q1 Service Pack 1 release. If set to true, the hash based navigation will parse and prefix the fragment value with !, which should be SEO friendly, and allows non-prefixed anchor links to work as expected.
///
///
///
/// The widget configuration options
///
};
kendo.View = function() { };
kendo.View.prototype = {
destroy: function() {
///
/// Removes the View element from the DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
render: function(container) {
///
/// Renders the view contents. Accepts a jQuery selector (or jQuery object) to which the contents will be appended. Alternatively, the render method can be called without parameters in order to retrieve the View element for manual insertion/further manipulation.
///
/// (optional) the element in which the view element will be appended.
/// the view element.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoView = function() {
///
/// Returns a reference to the kendo.View widget, instantiated on the selector.
///
/// The kendo.View instance (if present).
};
$.fn.kendoView = function(options) {
///
/// Instantiates a kendo.View widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
evalTemplate - Boolean (default: false)
///
If set to true, the view template will be treated as kendo template and evaluated against the provided model instance.
///
///
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. If false, the view template should have a single root element.
///
///
///
/// The widget configuration options
///
};
kendo.data.Binder = function() { };
kendo.data.Binder.prototype = {
refresh: function() {
///
/// Invoked by the Kendo UI MVVM framework when the bound view-model value is changed. The Binder should update the UI (the HTML element or the Kendo UI widget) to reflect the view-model change.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoBinder = function() {
///
/// Returns a reference to the kendo.data.Binder widget, instantiated on the selector.
///
/// The kendo.data.Binder instance (if present).
};
$.fn.kendoBinder = function(options) {
///
/// Instantiates a kendo.data.Binder widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.data.DataSource = function() { };
kendo.data.DataSource.prototype = {
add: function(model) {
///
/// Appends a data item to the data source.
///
/// Either a kendo.data.Model instance or JavaScript object containing the data item field values.
/// —The data item which is inserted.
},
aggregate: function(value) {
///
/// Gets or sets the aggregate configuration.
///
/// The aggregate configuration. Accepts the same values as the aggregate option.
/// —The current aggregate configuration.
},
aggregates: function() {
///
/// Returns the aggregate results.
///
/// —The aggregate results. There is a key for every aggregated field.
},
at: function(index) {
///
/// Returns the data item at the specified index. The index is zero-based.
///
/// The zero-based index of the data item.
/// —The data item at the specified index. Returns undefined if a data item is not found at the specified index. Returns a kendo.data.Model instance if the schema.model option is set.
},
cancelChanges: function(model) {
///
/// Cancels any pending changes in the data source. Deleted data items are restored, new data items are removed, and updated data items are restored to their initial state. Every data item uid will be reset.
///
/// The optional data item (model). If specified, only the changes of this data item will be discarded. If omitted, all changes will be discarded.
},
data: function(value) {
///
/// Gets or sets the data items of the data source.If the data source is bound to a remote service (via the transport option), the data method will return the service response. Every item from the response is wrapped in a kendo.data.ObservableObject or kendo.data.Model (if the schema.model option is set).If the data source is bound to a JavaScript array (via the data option), the data method will return the items of that array. Every item from the array is wrapped in a kendo.data.ObservableObject or kendo.data.Model (if the schema.model option is set).If the data source is grouped (via the group option or the group method) and the serverGrouping is set to true, the data method will return the group items.Compare with the view method, which will return the data items that correspond to the current page, filter, sort and group configuration.
///
/// The data items which will replace the current ones in the data source. If omitted the current data items will be returned.
/// —The data items of the data source. Returns an empty array if the data source was not populated with data items via the read, fetch, or query methods.
},
fetch: function(callback) {
///
/// Reads the data items from a remote service (if the transport option is set) or from a JavaScript array (if the data option is set).
///
/// The optional function which is executed when the remote request is finished. The function context (available via the this keyword) will be set to the data source instance.
/// —A promise that will be resolved when the data has been loaded, or rejected if an HTTP error occurs.
},
filter: function(value) {
///
/// Gets or sets the filter configuration.
///
/// The filter configuration. Accepts the same values as the filter option (check there for more examples).
/// —The current filter configuration. Returns null if no filter criteria are currently applied. Returns undefined if the DataSource instance has not performed filtering so far.
},
get: function(id) {
///
/// Gets the data item (model) with the specified id.
///
/// The id of the model to look for.
/// —The model instance. Returns undefined if a model with the specified id is not found.
},
getByUid: function(uid) {
///
/// Gets the data item (model) with the specified uid.
///
/// The uid of the model to look for.
/// —The model instance. Returns undefined if a model with the specified uid is not found.
},
group: function(value) {
///
/// Gets or sets the grouping configuration.
///
/// The grouping configuration. Accepts the same values as the group option.
/// —The current grouping configuration.
},
hasChanges: function() {
///
/// Checks if the data items have changed.
///
/// —Returns true if the data items have changed. Otherwise, returns false.
},
indexOf: function(dataItem) {
///
/// Gets the index of the specified data item.
///
/// The target data item.
/// —The index of the specified data item. Returns -1 if the data item is not found.
},
insert: function(index,model) {
///
/// Inserts a data item in the data source at the specified index.
///
/// The zero-based index at which the data item will be inserted.
/// Either a kendo.data.Model instance or a JavaScript object containing the field values.
/// —The data item which is inserted.
},
online: function(value) {
///
/// Gets or sets the online state of the data source.
///
/// The online state - true for online, false for offline.
/// —The current online state - true if online. Otherwise, false.
},
offlineData: function(data) {
///
/// Gets or sets the offline state of the data source.
///
/// The array of data items that replace the current offline state of the data source.
/// —An array of JavaScript objects that represent the data items. Changed data items have a __state__ field attached. That field indicates the type of change: "create", "update", or "destroy". Unmodified data items do not have a __state__ field.
},
page: function(page) {
///
/// Gets or sets the current page.
///
/// The new page.
/// —The current page.
},
pageSize: function(size) {
///
/// Gets or sets the current page size.
///
/// The new page size.
/// —The current page size.
},
pushCreate: function(items) {
///
/// Appends the specified data items to the data source without marking them as "new". The data source will not sync data items appended via pushCreate.
///
/// The data item or data items to append to the data source.
},
pushDestroy: function(items) {
///
/// Removes the specified data items from the data source without marking them as "removed". The data source will not sync data items appended via pushDestroy.
///
/// The data item or data items to remove from the data source.
},
pushInsert: function(index,items) {
///
/// Appends the specified data items to the data source without marking them as "new". The data source will not sync data items appended via pushInsert.
///
/// The zero-based index at which the data item will be inserted.
/// The data item or data items to append to the data source.
},
pushUpdate: function(items) {
///
/// Updates the specified data items without marking them as "dirty". The data source will not sync data items appended via pushUpdate. If the data items are not found (using schema.model.id), they will be appended.
///
/// The data item or data items to update.
},
query: function(options) {
///
/// Executes the specified query over the data items. Makes an HTTP request if bound to a remote service.This method is useful when you need to modify several parameters of the data request at the same time (e.g. filtering and sorting). If you execute filter() and then sort(), the DataSource will make two separate requests. With query(), it will make one request.
///
/// The query options which should be applied.
/// —A promise that will be resolved when the data has been loaded or rejected if an HTTP error occurs.
},
read: function(data) {
///
/// Reads data items from a remote/custom transport (if the transport option is set) or from a JavaScript array (if the data option is set).
///
/// Optional data to pass to the remote service. If you need to filter, it is better to use the filter() method or the query() method with a filter parameter.
/// —A promise that will be resolved when the data has been loaded or rejected if an HTTP error occurs.
},
remove: function(model) {
///
/// Removes the specified data item from the data source.
///
/// The data item which should be removed.
},
skip: function() {
///
/// Gets the current skip parameter of the dataSource. The skip parameter indicates the number of data items that should be skipped when a new page is formed.
///
/// —The current skip parameter.
},
sort: function(value) {
///
/// Gets or sets the sort order which will be applied over the data items.
///
/// The sort configuration. Accepts the same values as the sort option.
/// —The current sort configuration. Returns undefined instead of an empty array if the DataSource instance has not performed any sorting so far.
},
sync: function() {
///
/// Saves any data item changes.The sync method will request the remote service if: The transport.create option is set and the data source contains new data items.; The transport.destroy option is set and data items have been removed from the data source. or The transport.update option is set and the data source contains updated data items..
///
/// —A promise that will be resolved when all sync requests have finished successfully, or rejected if any single request fails.
},
total: function() {
///
/// Gets the total number of data items. Uses schema.total if the transport.read option is set.
///
/// —The total number of data items. Returns the length of the array returned by the data method if schema.total or transport.read are not set. Returns 0 if the data source was not populated with data items via the read, fetch, or query methods.
},
totalPages: function() {
///
/// Gets the number of available pages.
///
/// —The available pages.
},
view: function() {
///
/// Returns the data items which correspond to the current page, filter, sort, and group configuration. Compare with the data method, which will return data items from all pages, if local data binding and paging are used.To ensure that data is available this method should be used within the change event handler or the fetch method.
///
/// —The data items. Returns groups if the data items are grouped (via the group option or the group method).
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDataSource = function() {
///
/// Returns a reference to the kendo.data.DataSource widget, instantiated on the selector.
///
/// The kendo.data.DataSource instance (if present).
};
$.fn.kendoDataSource = function(options) {
///
/// Instantiates a kendo.data.DataSource widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
accentFoldingFiltering - String
///
It allows the filtering operation to be performed considering the diacritic characters for specific language.Introduced in the Kendo UI 2019 R1 SP1 (2019.1.220) release.
///
///
aggregate - Array
///
The aggregates which are calculated when the data source populates with data.The supported aggregates are: "average" - Only for Number.; "count" - String, Number and Date.; "max" - Number and Date.; "min" - Number and Date. or "sum" - Only for Number..
///
///
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 an 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 filters which 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.
///
///
inPlaceSort - Boolean (default: false)
///
If set to true, the original Array used as data will be sorted when sorting operation is performed. This setting supported only with local data, bound to a JavaScript array via the data option.
///
///
offlineStorage - String|Object
///
The offline storage key or custom offline storage implementation.
///
///
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. The property has no default value. Therefore, to use paging, make sure some pageSize value is set.
///
///
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.For more information and tips about client and server data operations, refer to the introductory article on the DataSource.
///
///
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 conventions.For example, the filter { logic: "and", filters: [ { field: "name", operator: "startswith", value: "Jane" } ] } is sent as: filter[logic]: and; filter[filters][0][field]: name; filter[filters][0][operator]: startswith or filter[filters][0][value]: Jane. Use the parameterMap option to send the filter option in a different format.For more information and tips about client and server data operations, refer to the introductory article on the DataSource.
///
///
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 conventions.For example, the group { field: "category", dir: "desc" } is sent as: group[0][field]: category or group[0][dir]: desc. Use the parameterMap option to send the group option in a different format.For more information and tips about client and server data operations, refer to the introductory article on the DataSource.
///
///
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: page - The page of data item to return (1 means the first page).; pageSize - The number of items to return.; skip - The number of data items to skip. or take - The number of data items to return (the same as pageSize).. Use the parameterMap option to send the paging options in a different format.For more information and tips about client and server data operations, refer to the introductory article on the DataSource.
///
///
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 conventions.For example, the sort { field: "age", dir: "desc" } is sent as: sort[0][field]: age or sort[0][dir]: desc. Use the parameterMap option to send the paging options in a different format.For more information and tips about client and server data operations, refer to the introductory article on the DataSource.
///
///
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 it retrieves data items.Remote data sources load and save data items from and to a remote end-point (also known as remote service or server). The transport option describes the remote service configuration - URL, HTTP verb, HTTP headers, and others. 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 supported values are: "odata" which supports the OData v.2 protocol; "odata-v4" which partially supports odata version 4 or "signalr".
///
///
///
/// The widget configuration options
///
};
kendo.data.GanttDataSource = function() { };
kendo.data.GanttDataSource.prototype = {
taskAllChildren: function(task) {
///
/// Returns a list of all child tasks. The search is recursive.
///
/// The parent task. If this parameter is not specified, all Gantt tasks will be returned.
/// —The list of all child tasks.
},
taskChildren: function(task) {
///
/// Returns a list of all direct child tasks.
///
/// The parent task. If this parameter is not specified, all root-level tasks will be returned.
/// —The list of all direct child tasks.
},
taskLevel: function(task) {
///
/// Returns the level of the task in the hierarchy. 0 for root-level tasks.
///
/// The reference task.
/// —The level of the task in the hierarchy.
},
taskParent: function(task) {
///
/// Returns the parent task of a certain task.
///
/// The reference task.
/// —The parent task.
},
taskSiblings: function(task) {
///
/// Returns a list of all tasks that have the same parent.
///
/// The reference task.
/// —The list of all tasks with the same parent as the parameter task. If the parameter task is a root-level task, all root-level tasks are returned.
},
taskTree: function(task) {
///
/// Returns a list of all child Gantt tasks, ordered by their hierarchical index (Depth-First). a parent is collapsed, it's children are not returned.
///
/// The reference task. If this parameter is specified, the result will be all child tasks of this task, ordered by their hierarchical index.
/// —The list of all child Gantt tasks, ordered by their hierarchical index (Depth-First).
},
update: function(task,taskInfo) {
///
/// Updates a Gantt task.
///
/// The task to be updated.
/// The new values which will be used to update the task.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoGanttDataSource = function() {
///
/// Returns a reference to the kendo.data.GanttDataSource widget, instantiated on the selector.
///
/// The kendo.data.GanttDataSource instance (if present).
};
$.fn.kendoGanttDataSource = function(options) {
///
/// Instantiates a kendo.data.GanttDataSource widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
schema - Object
///
The schema configuration of the GanttDataSource.
///
///
///
/// The widget configuration options
///
};
kendo.data.GanttDependency = function() { };
kendo.data.GanttDependency.prototype = {
define: function(options) {
///
/// Defines a new GanttDependency type using the provided options.
///
/// Describes the configuration options of the new Gantt dependency class.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoGanttDependency = function() {
///
/// Returns a reference to the kendo.data.GanttDependency widget, instantiated on the selector.
///
/// The kendo.data.GanttDependency instance (if present).
};
$.fn.kendoGanttDependency = function(options) {
///
/// Instantiates a kendo.data.GanttDependency widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
id - String|Number|Object
///
The mandatory unique identifier of the dependency.
///
///
predecessorId - String|Number|Object
///
The mandatory id of the predecessor task.
///
///
successorId - String|Number|Object
///
The mandatory id of the successor task.
///
///
type - String|Number|Object
///
The type of the dependency. The type is a value between 0 and 3, representing the four different dependency types: 0 - Finish-Finish; 1 - Finish-Start; 2 - Start-Finish or 3 - Start-Start.
///
///
///
/// The widget configuration options
///
};
kendo.data.GanttDependencyDataSource = function() { };
kendo.data.GanttDependencyDataSource.prototype = {
dependencies: function(id) {
///
/// Returns a list of all dependencies for a certain task.
///
/// The id of the Gantt task based on which the dependencies are filtered.
/// —The list of all task dependencies.
},
predecessors: function(id) {
///
/// Returns a list of all predecessor dependencies for a certain task.
///
/// The id of the Gantt task based on which the dependencies are filtered.
/// —The list of all task predecessors.
},
successors: function(id) {
///
/// Returns a list of all successor dependencies for a certain task.
///
/// The id of the Gantt task, based on which the dependencies are filtered.
/// —The list of all task successors.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoGanttDependencyDataSource = function() {
///
/// Returns a reference to the kendo.data.GanttDependencyDataSource widget, instantiated on the selector.
///
/// The kendo.data.GanttDependencyDataSource instance (if present).
};
$.fn.kendoGanttDependencyDataSource = function(options) {
///
/// Instantiates a kendo.data.GanttDependencyDataSource widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
schema - Object
///
The schema configuration of the GanttDependencyDataSource.
///
///
///
/// The widget configuration options
///
};
kendo.data.GanttTask = function() { };
kendo.data.GanttTask.prototype = {
define: function(options) {
///
/// Defines a new GanttTask type using the provided options.
///
/// Describes the configuration options of the new Gantt task class.
},
duration: function() {
///
/// Returns the Gantt task length in milliseconds.
///
/// —The length of the task.
},
isMilestone: function() {
///
/// Checks whether the event has zero duration.
///
/// —Returns true if the task start is equal to the task end.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoGanttTask = function() {
///
/// Returns a reference to the kendo.data.GanttTask widget, instantiated on the selector.
///
/// The kendo.data.GanttTask instance (if present).
};
$.fn.kendoGanttTask = function(options) {
///
/// Instantiates a kendo.data.GanttTask widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
end - Date
///
The date at which the Gantt task ends. The end date is mandatory.
///
///
expanded - Boolean (default: true)
///
If set to true, the task is expanded and the tasks of its child are visible.
///
///
id - String|Number|Object
///
The mandatory unique identifier of the task.
///
///
orderId - String|Number|Object (default: 0)
///
The position of the task relative to its sibling tasks.
///
///
parentId - String|Number|Object (default: null)
///
The id of the parent task. Required for child tasks.
///
///
percentComplete - String|Number|Object (default: 0)
///
The completion percentage of the task. A value between 0 and 1 representing how much of a task is completed.
///
///
start - Date
///
The date at which the Gantt task starts. The start date is mandatory.
///
///
summary - Boolean (default: true)
///
If set to true, the task has child tasks.
///
///
title - String (default: "")
///
The title of the task which is displayed by the Gantt widget.
///
///
///
/// The widget configuration options
///
};
kendo.data.HierarchicalDataSource = function() { };
kendo.data.HierarchicalDataSource.prototype = {
filter: function(value) {
///
/// Gets or sets the filter configuration. It applies the filter to all loaded nodes and creates views from the nodes that match the filter and their parent nodes up to the root of the hierarchy. Currently, nodes that are not loaded are not filtered.
///
/// The filter configuration. Accepts the same values as the filter option.
/// —The current filter configuration. Returns undefined if the DataSource instance has not performed filtering so far.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoHierarchicalDataSource = function() {
///
/// Returns a reference to the kendo.data.HierarchicalDataSource widget, instantiated on the selector.
///
/// The kendo.data.HierarchicalDataSource instance (if present).
};
$.fn.kendoHierarchicalDataSource = function(options) {
///
/// Instantiates a kendo.data.HierarchicalDataSource widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
filter - Array|Object
///
The filters which are applied over the data items. It applies the filter to all loaded nodes and creates views from the nodes that match the filter and their parent nodes up to the root of the hierarchy. Currently, nodes that are not loaded are not filtered. By default, no filter is applied.
///
///
schema - Object
///
The schema configuration. See the DataSource.schema configuration for all available options.
///
///
///
/// The widget configuration options
///
};
kendo.data.Model = function() { };
kendo.data.Model.prototype = {
bind: function() {
///
/// Attaches a handler to an event. For more information and examples, refer to the bind API reference.
///
},
define: function(options) {
///
/// Defines a new Model type by using the provided options. The returned value inherits from the kendo.data.Model class.
///
/// Describes the configuration options of the new model type.
},
editable: function(field) {
///
/// Determines if the specified field is editable or not.
///
/// The field that will be checked.
/// —Returns true if the field is editable. Otherwise, returns false.
},
get: function() {
///
/// Gets the value of the specified field. Inherited from kendo.data.ObservableObject. For more information and examples, refer to the get API reference.
///
},
isNew: function() {
///
/// Checks if the Model is new or not. The id field is used to determine if a model instance is new or existing. If the value of the specified field is equal to the default value that is specified through the fields configuration, the model is considered new.
///
/// —Returns true if the field is editable. Otherwise, returns false.
},
set: function() {
///
/// Sets the value of the specified field. Inherited from kendo.data.ObservableObject. For more information and examples, refer to the set API reference.
///
},
toJSON: function() {
///
/// Creates a plain JavaScript object which contains all fields of the Model. Inherited from kendo.data.ObservableObject. For more information and examples, refer to the toJSON API reference.
///
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoModel = function() {
///
/// Returns a reference to the kendo.data.Model widget, instantiated on the selector.
///
/// The kendo.data.Model instance (if present).
};
$.fn.kendoModel = function(options) {
///
/// Instantiates a kendo.data.Model widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.data.Node = function() { };
kendo.data.Node.prototype = {
append: function(model) {
///
/// Appends a new item to the children data source and initializes it if necessary.
///
/// The data for the new item.
},
level: function() {
///
/// Gets the current nesting level of the node within the data source.
///
/// —The zero-based level of the node.
},
load: function() {
///
/// Loads the child nodes in the child data source and supplies the id of the Node to the request.
///
},
loaded: function() {
///
/// Gets or sets the loaded flag of the Node. Setting the loaded flag to false allows the reloading of child items.
///
},
parentNode: function() {
///
/// Gets the parent node.
///
/// —The parent of the node. Returns null if the node is a root node or does not have a parent.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoNode = function() {
///
/// Returns a reference to the kendo.data.Node widget, instantiated on the selector.
///
/// The kendo.data.Node instance (if present).
};
$.fn.kendoNode = function(options) {
///
/// Instantiates a kendo.data.Node widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.data.ObservableArray = function() { };
kendo.data.ObservableArray.prototype = {
bind: function(eventName,handler) {
///
/// Attaches an event handler for the specified event.
///
/// The name of the event.
/// The function which will be invoked when the event is fired.
},
join: function(separator) {
///
/// Joins all items of an ObservableArray into a string. An equivalent of Array.prototype.join.
///
/// Specifies the string to separate each item of the array. If omitted, the array items are separated with a comma (,).
},
parent: function() {
///
/// Gets the parent of the array if such a parent exists.
///
/// —The parent of the array. Returns undefined if the array is not nested and does not have a parent.
},
pop: function() {
///
/// Removes the last item from an array and returns that item. An equivalent of Array.prototype.pop.
///
/// —The item which was removed.
},
push: function() {
///
/// Appends the given items to the array and returns the new length of the array. An equivalent of Array.prototype.push. The new items are wrapped as an ObservableObject if they are complex objects.
///
/// —The new length of the array.
},
slice: function(begin,end) {
///
/// Returns a single-level deep copy of a portion of an array. An equivalent of Array.prototype.slice. The result of the slice method is not an instance of ObvservableArray—it is a regular JavaScript Array object.
///
/// A zero-based index at which the extraction will start.
/// A zero-based index at which the extraction will end. If end is omitted, slice extracts to the end of the sequence.
},
splice: function(index,howMany) {
///
/// Changes an ObservableArray by adding new items while removing old items. An equivalent of Array.prototype.splice.
///
/// An index at which the changing of the array will start.
/// An integer which indicates the number of the items for removal. If set to 0, no items will be removed. In this case, you have to specify at least one new item.
/// —Contains the removed items. The result of the splice method is not an instance of ObvservableArray.
},
shift: function() {
///
/// Removes the first item from an ObvservableArray and returns that item. An equivalent of Array.prototype.shift.
///
/// —The item which was removed.
},
toJSON: function() {
///
/// Returns a JavaScript Array object which represents the contents of the ObservableArray.
///
},
unshift: function() {
///
/// Adds one or more items to the beginning of an ObservableArray and returns the new length. An equivalent of Array.prototype.unshift.
///
/// —The new length of the array.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoObservableArray = function() {
///
/// Returns a reference to the kendo.data.ObservableArray widget, instantiated on the selector.
///
/// The kendo.data.ObservableArray instance (if present).
};
$.fn.kendoObservableArray = function(options) {
///
/// Instantiates a kendo.data.ObservableArray widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.data.ObservableObject = function() { };
kendo.data.ObservableObject.prototype = {
bind: function() {
///
/// Attaches a handler to an event. For more information and examples, refer to the bind API reference.
///
},
get: function(name) {
///
/// Gets the value of the specified field.
///
/// The name of the field whose value will be returned.
/// —The value of the specified field.
},
parent: function() {
///
/// Gets the parent of the object if such a parent exists.
///
/// —The parent of the object. Returns undefined if the object is not nested and does not have a parent.
},
set: function(name,value) {
///
/// Sets the value of the specified field.
///
/// The name of the field whose value will be returned.
/// The new value of the field.
},
toJSON: function() {
///
/// Creates a plain JavaScript object which contains all fields of the ObservableObject.
///
/// —Contains only the fields of the ObservableObject.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoObservableObject = function() {
///
/// Returns a reference to the kendo.data.ObservableObject widget, instantiated on the selector.
///
/// The kendo.data.ObservableObject instance (if present).
};
$.fn.kendoObservableObject = function(options) {
///
/// Instantiates a kendo.data.ObservableObject widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.data.PivotDataSource = function() { };
kendo.data.PivotDataSource.prototype = {
axes: function() {
///
/// Gets the parsed axes data.
///
/// —The parsed axes data.
},
catalog: function(name) {
///
/// Gets or sets the current catalog name.
///
/// The name of the catalog.
/// —The current catalog name.
},
columns: function(val) {
///
/// Gets or sets the columns configuration.
///
/// The columns configuration. Accepts the same values as the columns option.
/// —The current columns configuration.
},
cube: function(name) {
///
/// Gets or sets the current cube name.
///
/// The name of the cube.
/// —The current cube name.
},
discover: function(options) {
///
/// Starts the discover request with the specified options.
///
/// The options of the discover request.
/// —The deferred object.
},
expandColumn: function(path) {
///
/// Expands a column tuple member that has children.
///
/// The path that uniquely specifies the tuple member that needs to be expanded.
},
expandRow: function(path) {
///
/// Expands a row tuple member that has children.
///
/// The path which uniquely specifies the tuple member that needs to be expanded.
},
measures: function(val) {
///
/// Gets or sets the measures configuration.
///
/// The measures configuration. Accepts the same values as the measures option.
/// —The current measures configuration.
},
measuresAxis: function() {
///
/// Gets the name of the axis on which the measures are displayed.
///
/// —The axis name.
},
rows: function(val) {
///
/// Gets or sets the rows configuration.
///
/// The rows configuration. Accepts the same values as the row option.
/// —The current rows configuration.
},
schemaCatalogs: function() {
///
/// Requests the catalogs information.
///
/// —The deferred object.
},
schemaCubes: function() {
///
/// Requests the cubes schema information.
///
/// —The deferred object.
},
schemaDimensions: function() {
///
/// Requests the dimensions schema information.
///
/// —The deferred object.
},
schemaHierarchies: function(dimensionName) {
///
/// Requests the hierarchies schema information.
///
/// The name of the dimensions which is the "owner" of the hierarchy.
/// —The deferred object.
},
schemaLevels: function(hierarchyName) {
///
/// Requests the levels schema information.
///
/// The name of the hierarchy which is the "owner" of the level.
/// —The deferred object.
},
schemaMeasures: function() {
///
/// Requests the measures schema information.
///
/// —The deferred object.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoPivotDataSource = function() {
///
/// Returns a reference to the kendo.data.PivotDataSource widget, instantiated on the selector.
///
/// The kendo.data.PivotDataSource instance (if present).
};
$.fn.kendoPivotDataSource = function(options) {
///
/// Instantiates a kendo.data.PivotDataSource widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
columns - Array
///
The configuration of the column axis members. An array of JavaScript objects or strings. A JavaScript objects are interpreted as column descriptors. Strings are interpreted as the hierarchical name of the member.
///
///
measures - Array|Object
///
The configuration of measures. A string array whose values are interpreted as the name of the measures that will be loaded. Measures can be defined as a list of objects with the name and type fields.
///
///
rows - Array
///
The configuration of the row axis members. An array of JavaScript objects or strings. A JavaScript objects are interpreted as rows descriptors. Strings are interpreted as the hierarchical name of the member.
///
///
transport - Object
///
The configuration used to load data items and discover schema information.
///
///
schema - Object
///
The schema configuration of the PivotDataSource.
///
///
///
/// The widget configuration options
///
};
kendo.data.Query = function() { };
kendo.data.Query.prototype = {
toArray: function() {
///
/// Returns the internal data collection
///
/// Returns plain JavaScript array which represents the internal data collection
},
skip: function(count) {
///
/// Skip a given amount it items
///
/// The number of items that should be skipped
/// Returns a new instance of kendo.data.Query with the first count elements of the list skipped
},
take: function(count) {
///
/// Take a given amount it items
///
/// The number of items that should be taken
/// Returns a new instance of kendo.data.Query containing only the first count elements of the list
},
select: function(selector) {
///
/// Maps over the data items
///
/// A function that is applied to each of the items
/// Returns a new instance of kendo.data.Query containing the mapped collection
},
order: function(selector) {
///
/// Returns a copy of the list sorted according to the direction
///
/// The current sort configuration.
/// Returns a new instance of kendo.data.Query containing the sorted collection
},
filter: function(expression) {
///
/// Returns a copy of the list filtered according to the expression
///
/// The filter configuration. Accepts the same values as the filter option (check there for more examples).
/// Returns a new instance of kendo.data.Query containing the filtered collection
},
groupBy: function(descriptor) {
///
/// Returns a copy of the list grouped according to the descriptor
///
/// The grouping configuration. Accepts the same values as the group option.
/// Returns a new instance of kendo.data.Query containing the grouped collection
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoQuery = function() {
///
/// Returns a reference to the kendo.data.Query widget, instantiated on the selector.
///
/// The kendo.data.Query instance (if present).
};
$.fn.kendoQuery = function(options) {
///
/// Instantiates a kendo.data.Query widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.data.SchedulerDataSource = function() { };
kendo.data.SchedulerDataSource.prototype = {
expand: function(start,end) {
///
/// Expands all recurring events in the data and returns a list of events for a specific period.
///
/// The start date of the period.
/// The end date of the period.
/// the expanded list of scheduler events filtered by the specified start/end period.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoSchedulerDataSource = function() {
///
/// Returns a reference to the kendo.data.SchedulerDataSource widget, instantiated on the selector.
///
/// The kendo.data.SchedulerDataSource instance (if present).
};
$.fn.kendoSchedulerDataSource = function(options) {
///
/// Instantiates a kendo.data.SchedulerDataSource widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
schema - Object
///
The schema configuration of the SchedulerDataSource.
///
///
///
/// The widget configuration options
///
};
kendo.data.SchedulerEvent = function() { };
kendo.data.SchedulerEvent.prototype = {
define: function(options) {
///
/// Defines a new SchedulerEvent type using the provided options.
///
/// Describes the configuration options of the new scheduler event class.
},
clone: function(options,updateUid) {
///
/// Clones the scheduler event.
///
/// Additional options passed to the SchedulerEvent constructor.
/// If you pass true the uid of the event will be updated.
/// the cloned scheduler event.
},
duration: function() {
///
/// Returns the scheduler event length in milliseconds.
///
/// the length of the event.
},
expand: function(start,end,timeZoneId) {
///
/// Expands the event for a specific period based on the recurrenceRule option.
///
/// The start date of the occurrence period.
/// The end date of the occurrence period.
/// The time zone ID used to convert the recurrence rule dates.
/// list of occurrences.
},
update: function(eventInfo) {
///
/// Updates the scheduler event.
///
/// The new values, which will be used to update the event.
},
isMultiDay: function() {
///
/// Checks whether the event is equal to or longer then twenty four hours.
///
/// return true if event is equal to or longer then 24 hours.
},
isException: function() {
///
/// Checks whether the event is a recurrence exception.
///
/// return true if event is a recurrence exception.
},
isOccurrence: function() {
///
/// Checks whether the event is an occurrence part of a recurring series.
///
/// return true if event is an occurrence.
},
isRecurring: function() {
///
/// Checks whether the event is part of a recurring series.
///
/// return true if event is recurring.
},
isRecurrenceHead: function() {
///
/// Checks whether the event is the head of a recurring series.
///
/// return true if event is a recurrence head.
},
toOccurrence: function(options) {
///
/// Converts the scheduler event to a event occurrence. Method will remove recurrenceRule, recurrenceException options, will add a recurrenceId field and will set id to the default one.
///
/// Additional options passed to the SchedulerEvent constructor.
/// the occurrence.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoSchedulerEvent = function() {
///
/// Returns a reference to the kendo.data.SchedulerEvent widget, instantiated on the selector.
///
/// The kendo.data.SchedulerEvent instance (if present).
};
$.fn.kendoSchedulerEvent = function(options) {
///
/// Instantiates a kendo.data.SchedulerEvent widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
description - String (default: "")
///
The optional event description.
///
///
end - Date
///
The date at which the scheduler event ends. The end date is mandatory.
///
///
endTimezone - String (default: undefined)
///
The timezone of the end date. If not specified the timezone will be used.The complete list of the supported timezones is available in the List of IANA time zones Wikipedia page.
///
///
id - String|Number|Object
///
The mandatory unique identifier of the event.
///
///
isAllDay - Boolean (default: false)
///
If set to true the event is "all day". By default events are not all day.
///
///
recurrenceException - String (default: undefined)
///
The recurrence exceptions. A list of comma separated dates formatted using the yyyyMMddTHHmmssZ format string.
///
///
recurrenceId - String|Number|Object (default: undefined)
///
The id of the recurrence parent event. Required for events that are recurrence exceptions.
///
///
recurrenceRule - String (default: undefined)
///
The recurrence rule describing the recurring pattern of the event. The format follows the iCal specification.
///
///
start - Date
///
The date at which the scheduler event starts. The start date is mandatory.
///
///
startTimezone - String (default: undefined)
///
The timezone of the start date. If not specified the timezone will be used.The complete list of the supported timezones is available in the List of IANA time zones Wikipedia page.
///
///
title - String (default: "")
///
The title of the event which is displayed by the scheduler widget.
///
///
///
/// The widget configuration options
///
};
kendo.data.TreeListDataSource = function() { };
kendo.data.TreeListDataSource.prototype = {
load: function(model) {
///
/// Loads the child nodes of a model.
///
/// The model that must be loaded.
/// A promise that will be resolved when the child nodes have been loaded, or rejected if an HTTP error occurs.
},
childNodes: function(model) {
///
/// Child nodes for model.
///
/// The model whose children must be returned.
/// of the child items.
},
rootNodes: function() {
///
/// Return all root nodes.
///
/// of the root items.
},
parentNode: function(model) {
///
/// The parent of given node.
///
/// The model whose parent must be returned.
/// parent of the node.
},
level: function(model) {
///
/// The hierarchical level of the node.
///
/// The model whose level must be calculated.
/// the hierarchy level of the node.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoTreeListDataSource = function() {
///
/// Returns a reference to the kendo.data.TreeListDataSource widget, instantiated on the selector.
///
/// The kendo.data.TreeListDataSource instance (if present).
};
$.fn.kendoTreeListDataSource = function(options) {
///
/// Instantiates a kendo.data.TreeListDataSource widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
schema - Object
///
The schema configuration of the TreeListDataSource.
///
///
///
/// The widget configuration options
///
};
kendo.data.TreeListModel = function() { };
kendo.data.TreeListModel.prototype = {
loaded: function() {
///
/// Gets or sets the loaded flag of the TreeList. Setting the loaded flag to false allows reloading of child items.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoTreeListModel = function() {
///
/// Returns a reference to the kendo.data.TreeListModel widget, instantiated on the selector.
///
/// The kendo.data.TreeListModel instance (if present).
};
$.fn.kendoTreeListModel = function(options) {
///
/// Instantiates a kendo.data.TreeListModel widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
if (!kendo.date) {
kendo.date = {};
}
if (!kendo.drawing) {
kendo.drawing = {};
}
kendo.drawing.Arc = function() { };
kendo.drawing.Arc.prototype = {
bbox: function() {
///
/// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
///
/// The bounding box of the element with transformations applied.
},
clip: function(clip) {
///
/// Gets or sets the element clipping path. Inherited from Element.clip
///
/// The element clipping path.
/// The current element clipping path.
},
clippedBBox: function() {
///
/// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
///
/// The bounding box of the element with clipping transformations applied.
},
containsPoint: function(point) {
///
/// Returns true if the shape contains the specified point.
///
/// The point that should be checked.
/// value indicating if the shape contains the point.
},
geometry: function(value) {
///
/// Gets or sets the arc geometry.
///
/// The new geometry to use.
/// The current arc geometry.
},
fill: function(color,opacity) {
///
/// Sets the shape fill.
///
/// The fill color to set.
/// The fill opacity to set.
/// The current instance to allow chaining.
},
opacity: function(opacity) {
///
/// Gets or sets the element opacity. Inherited from Element.opacityIf set, the stroke and fill opacity will be multiplied by the element opacity.
///
/// The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
/// The current element opacity.
},
stroke: function(color,width,opacity) {
///
/// Sets the shape stroke.
///
/// The stroke color to set.
/// The stroke width to set.
/// The stroke opacity to set.
/// The current instance to allow chaining.
},
transform: function(transform) {
///
/// Gets or sets the transformation of the element. Inherited from Element.transform
///
/// The transformation to apply to the element.
/// The current transformation on the element.
},
visible: function(visible) {
///
/// Gets or sets the visibility of the element. Inherited from Element.visible
///
/// A flag indicating if the element should be visible.
/// true if the element is visible; false otherwise.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoArc = function() {
///
/// Returns a reference to the kendo.drawing.Arc widget, instantiated on the selector.
///
/// The kendo.drawing.Arc instance (if present).
};
$.fn.kendoArc = function(options) {
///
/// Instantiates a kendo.drawing.Arc widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
clip - kendo.drawing.Path
///
The element clipping path. Inherited from Element.clip
///
///
cursor - String
///
The element cursor. Inherited from Element.cursor
///
///
fill - kendo.drawing.FillOptions
///
The fill options of the shape.
///
///
opacity - Number
///
The element opacity. Inherited from Element.opacity
///
///
stroke - kendo.drawing.StrokeOptions
///
The stroke options of the shape.
///
///
tooltip - kendo.drawing.TooltipOptions
///
The tooltip options of the shape.
///
///
transform - kendo.geometry.Transformation
///
The transformation to apply to this element. Inherited from Element.transform
///
///
visible - Boolean
///
A flag, indicating if the element is visible. Inherited from Element.visible
///
///
///
/// The widget configuration options
///
};
kendo.drawing.Circle = function() { };
kendo.drawing.Circle.prototype = {
bbox: function() {
///
/// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
///
/// The bounding box of the element with transformations applied.
},
clip: function(clip) {
///
/// Gets or sets the element clipping path. Inherited from Element.clip
///
/// The element clipping path.
/// The current element clipping path.
},
clippedBBox: function() {
///
/// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
///
/// The bounding box of the element with clipping transformations applied.
},
containsPoint: function(point) {
///
/// Returns true if the shape contains the specified point.
///
/// The point that should be checked.
/// value indicating if the shape contains the point.
},
geometry: function(value) {
///
/// Gets or sets the circle geometry.
///
/// The new geometry to use.
/// The current circle geometry.
},
fill: function(color,opacity) {
///
/// Sets the shape fill.
///
/// The fill color to set.
/// The fill opacity to set.
/// The current instance to allow chaining.
},
opacity: function(opacity) {
///
/// Gets or sets the element opacity. Inherited from Element.opacityIf set, the stroke and fill opacity will be multiplied by the element opacity.
///
/// The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
/// The current element opacity.
},
stroke: function(color,width,opacity) {
///
/// Sets the shape stroke.
///
/// The stroke color to set.
/// The stroke width to set.
/// The stroke opacity to set.
/// The current instance to allow chaining.
},
transform: function(transform) {
///
/// Gets or sets the transformation of the element. Inherited from Element.transform
///
/// The transformation to apply to the element.
/// The current transformation on the element.
},
visible: function(visible) {
///
/// Gets or sets the visibility of the element. Inherited from Element.visible
///
/// A flag indicating if the element should be visible.
/// true if the element is visible; false otherwise.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoCircle = function() {
///
/// Returns a reference to the kendo.drawing.Circle widget, instantiated on the selector.
///
/// The kendo.drawing.Circle instance (if present).
};
$.fn.kendoCircle = function(options) {
///
/// Instantiates a kendo.drawing.Circle widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
clip - kendo.drawing.Path
///
The element clipping path. Inherited from Element.clip
///
///
cursor - String
///
The element cursor. Inherited from Element.cursor
///
///
fill - kendo.drawing.FillOptions
///
The fill options of the shape.
///
///
opacity - Number
///
The element opacity. Inherited from Element.opacity
///
///
stroke - kendo.drawing.StrokeOptions
///
The stroke options of the shape.
///
///
tooltip - kendo.drawing.TooltipOptions
///
The tooltip options of the shape.
///
///
transform - kendo.geometry.Transformation
///
The transformation to apply to this element. Inherited from Element.transform
///
///
visible - Boolean
///
A flag, indicating if the element is visible. Inherited from Element.visible
///
///
///
/// The widget configuration options
///
};
kendo.drawing.Element = function() { };
kendo.drawing.Element.prototype = {
bbox: function() {
///
/// Returns the bounding box of the element with transformations applied.
///
/// The bounding box of the element with transformations applied.
},
clip: function(clip) {
///
/// Gets or sets the element clipping path.
///
/// The element clipping path.
/// The current element clipping path.
},
clippedBBox: function() {
///
/// Returns the bounding box of the element with clipping and transformations applied.This is the rectangle that will fit around the actual rendered element.
///
/// The bounding box of the element with clipping and transformations applied.
},
containsPoint: function(point) {
///
/// Returns true if the shape contains the specified point.
///
/// The point that should be checked.
/// value indicating if the shape contains the point.
},
opacity: function(opacity) {
///
/// Gets or sets the element opacity.
///
/// The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
/// The current element opacity.
},
transform: function(transform) {
///
/// Gets or sets the transformation of the element.
///
/// The transformation to apply to the element.
/// The current transformation on the element.
},
visible: function(visible) {
///
/// Gets or sets the visibility of the element.
///
/// A flag indicating if the element should be visible.
/// true if the element is visible; false otherwise.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoElement = function() {
///
/// Returns a reference to the kendo.drawing.Element widget, instantiated on the selector.
///
/// The kendo.drawing.Element instance (if present).
};
$.fn.kendoElement = function(options) {
///
/// Instantiates a kendo.drawing.Element widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
clip - kendo.drawing.Path
///
The clipping path for this element.The path instance will be monitored for changes. It can be replaced by calling the clip method.
///
///
cursor - String
///
The element CSS cursor.Applicable to an SVG output.
///
///
opacity - Number
///
The element opacity.
///
///
transform - kendo.geometry.Transformation
///
The transformation to apply to this element.
///
///
visible - Boolean
///
A flag, indicating if the element is visible.
///
///
///
/// The widget configuration options
///
};
kendo.drawing.FillOptions = function() { };
kendo.drawing.FillOptions.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoFillOptions = function() {
///
/// Returns a reference to the kendo.drawing.FillOptions widget, instantiated on the selector.
///
/// The kendo.drawing.FillOptions instance (if present).
};
$.fn.kendoFillOptions = function(options) {
///
/// Instantiates a kendo.drawing.FillOptions widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.drawing.Gradient = function() { };
kendo.drawing.Gradient.prototype = {
addStop: function(offset,color,opacity) {
///
/// Adds a color stop to the gradient.
///
/// The stop offset from the start of the element. Ranges from 0 (start of gradient) to 1 (end of gradient).
/// The color in any of the following formats.| Format | Description | --- | --- | --- | red | Basic or Extended CSS Color name | #ff0000 | Hex RGB value | rgb(255, 0, 0) | RGB valueSpecifying 'none', 'transparent' or '' (empty string) will clear the fill.
/// The fill opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
/// The new gradient color stop.
},
removeStop: function(stop) {
///
/// Removes a color stop from the gradient.
///
/// The gradient color stop to remove.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoGradient = function() {
///
/// Returns a reference to the kendo.drawing.Gradient widget, instantiated on the selector.
///
/// The kendo.drawing.Gradient instance (if present).
};
$.fn.kendoGradient = function(options) {
///
/// Instantiates a kendo.drawing.Gradient widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
stops - Array
///
The color stops of the gradient. Can contain either plain objects or GradientStop instances.
///
///
///
/// The widget configuration options
///
};
kendo.drawing.GradientStop = function() { };
kendo.drawing.GradientStop.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoGradientStop = function() {
///
/// Returns a reference to the kendo.drawing.GradientStop widget, instantiated on the selector.
///
/// The kendo.drawing.GradientStop instance (if present).
};
$.fn.kendoGradientStop = function(options) {
///
/// Instantiates a kendo.drawing.GradientStop widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
offset - Number
///
The stop offset from the start of the element. Ranges from 0 (start of gradient) to 1 (end of gradient).
///
///
color - String
///
The color in any of the following formats.| Format | Description | --- | --- | --- | red | Basic or Extended CSS Color name | #ff0000 | Hex RGB value | rgb(255, 0, 0) | RGB valueSpecifying 'none', 'transparent' or '' (empty string) will clear the fill.
///
///
opacity - Number
///
The fill opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
///
///
///
/// The widget configuration options
///
};
kendo.drawing.Group = function() { };
kendo.drawing.Group.prototype = {
append: function(element) {
///
/// Appends the specified element as a last child of the group.
///
/// The element to append. Multiple parameters are accepted.
},
clear: function() {
///
/// Removes all child elements from the group.
///
},
clip: function(clip) {
///
/// Gets or sets the group clipping path. Inherited from Element.clip
///
/// The group clipping path.
/// The current group clipping path.
},
clippedBBox: function() {
///
/// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
///
/// The bounding box of the element with clipping transformations applied.
},
containsPoint: function(point) {
///
/// Returns true if the shape contains the specified point.
///
/// The point that should be checked.
/// value indicating if the shape contains the point.
},
insert: function(position,element) {
///
/// Inserts an element at the specified position.
///
/// The position to insert the element at. Existing children beyond this position will be shifted right.
/// The element to insert.
},
opacity: function(opacity) {
///
/// Gets or sets the group opacity. Inherited from Element.opacityThe opacity of any child groups and elements will be multiplied by this value.
///
/// The group opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
/// The current group opacity.
},
remove: function(element) {
///
/// Removes the specified element from the group.
///
/// The element to remove.
},
removeAt: function(index) {
///
/// Removes the child element at the specified position.
///
/// The index at which the element currently resides.
},
visible: function(visible) {
///
/// Gets or sets the visibility of the element.
///
/// A flag indicating if the element should be visible.
/// true if the element is visible; false otherwise.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoGroup = function() {
///
/// Returns a reference to the kendo.drawing.Group widget, instantiated on the selector.
///
/// The kendo.drawing.Group instance (if present).
};
$.fn.kendoGroup = function(options) {
///
/// Instantiates a kendo.drawing.Group widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
clip - kendo.drawing.Path
///
The group clipping path. Inherited from Element.clip
///
///
cursor - String
///
The group cursor. Inherited from Element.cursor
///
///
opacity - Number
///
The group opacity. Inherited from Element.opacityThe opacity of any child groups and elements will be multiplied by this value.
///
///
pdf - kendo.drawing.PDFOptions
///
Page options to apply during PDF export.
///
///
tooltip - kendo.drawing.TooltipOptions
///
The tooltip options of the shape.
///
///
transform - kendo.geometry.Transformation
///
The transformation to apply to this group and its children. Inherited from Element.transform
///
///
visible - Boolean
///
A flag, indicating if the group and its children are visible. Inherited from Element.visible
///
///
///
/// The widget configuration options
///
};
kendo.drawing.Image = function() { };
kendo.drawing.Image.prototype = {
bbox: function() {
///
/// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
///
/// The bounding box of the element with transformations applied.
},
clip: function(clip) {
///
/// Gets or sets the element clipping path. Inherited from Element.clip
///
/// The element clipping path.
/// The current element clipping path.
},
clippedBBox: function() {
///
/// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
///
/// The bounding box of the element with clipping transformations applied.
},
containsPoint: function(point) {
///
/// Returns true if the shape contains the specified point.
///
/// The point that should be checked.
/// value indicating if the shape contains the point.
},
opacity: function(opacity) {
///
/// Gets or sets the element opacity. Inherited from Element.opacity
///
/// The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
/// The current element opacity.
},
src: function(value) {
///
/// Gets or sets the image source URL.
///
/// The new source URL.
/// The current image source URL.
},
rect: function(value) {
///
/// Gets or sets the rectangle defines the image position and size.
///
/// The new image rectangle.
/// The current image rectangle.
},
transform: function(transform) {
///
/// Gets or sets the transformation of the element. Inherited from Element.transform
///
/// The transformation to apply to the element.
/// The current transformation on the element.
},
visible: function(visible) {
///
/// Gets or sets the visibility of the element. Inherited from Element.visible
///
/// A flag indicating if the element should be visible.
/// true if the element is visible; false otherwise.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoImage = function() {
///
/// Returns a reference to the kendo.drawing.Image widget, instantiated on the selector.
///
/// The kendo.drawing.Image instance (if present).
};
$.fn.kendoImage = function(options) {
///
/// Instantiates a kendo.drawing.Image widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
clip - kendo.drawing.Path
///
The element clipping path. Inherited from Element.clip
///
///
cursor - String
///
The element cursor. Inherited from Element.cursor
///
///
opacity - Number
///
The element opacity. Inherited from Element.opacity
///
///
tooltip - kendo.drawing.TooltipOptions
///
The tooltip options of the shape.
///
///
transform - kendo.geometry.Transformation
///
The transformation to apply to this element. Inherited from Element.transform
///
///
visible - Boolean
///
A flag, indicating if the element is visible. Inherited from Element.visible
///
///
///
/// The widget configuration options
///
};
kendo.drawing.Layout = function() { };
kendo.drawing.Layout.prototype = {
rect: function(rect) {
///
/// Gets or sets the layout rectangle.
///
/// The layout rectangle.
/// The current rectangle.
},
reflow: function() {
///
/// Arranges the elements based on the current options.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoLayout = function() {
///
/// Returns a reference to the kendo.drawing.Layout widget, instantiated on the selector.
///
/// The kendo.drawing.Layout instance (if present).
};
$.fn.kendoLayout = function(options) {
///
/// Instantiates a kendo.drawing.Layout widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
alignContent - String (default: "start")
///
Specifies the alignment of the content. The supported values are: "start" - aligns the content to the rectangle origin.; "center" - aligns the content to the rectangle center. or "end" - aligns the content to the rectangle end..
///
///
alignItems - String (default: "start")
///
Specifies the alignment of the items based on the largest one. The supported values are: "start" - aligns the items to the start of the largest element.; "center" - aligns the items to the center of the largest element. or "end" - aligns the items to the end of the largest element..
///
///
justifyContent - String (default: "start")
///
Specifies how should the content be justified. The supported values are: "start" - aligns the items to the rectangle origin.; "center" - aligns the items to the rectangle center. or "end" - aligns the items to the rectangle end..
///
///
lineSpacing - Number (default: 0)
///
Specifies the distance between the lines for wrapped layout.
///
///
spacing - Number (default: 0)
///
Specifies the distance between the elements.
///
///
orientation - String (default: "horizontal")
///
Specifies layout orientation. The supported values are: "horizontal" - the elements are arranged horizontally. or "vertical" - the elements are arranged vertically..
///
///
wrap - Boolean (default: true)
///
Specifies the behavior when the elements size exceeds the rectangle size. If set to true, the elements will be moved to the next "line". If set to false, the layout will be scaled so that the elements fit in the rectangle.
///
///
///
/// The widget configuration options
///
};
kendo.drawing.LinearGradient = function() { };
kendo.drawing.LinearGradient.prototype = {
addStop: function(offset,color,opacity) {
///
/// Adds a color stop to the gradient. Inherited from Gradient.addStop
///
///
/// The color of the stop.
/// The fill opacity.
/// The new gradient color stop.
},
end: function(end) {
///
/// Gets or sets the end point of the gradient.
///
/// The end point of the gradient.Coordinates are relative to the shape bounding box. For example [0, 0] is top left and [1, 1] is bottom right.
/// The current end point of the gradient.
},
start: function(start) {
///
/// Gets or sets the start point of the gradient.
///
/// The start point of the gradient.Coordinates are relative to the shape bounding box. For example [0, 0] is top left and [1, 1] is bottom right.
/// The current start point of the gradient.
},
removeStop: function(stop) {
///
/// Removes a color stop from the gradient. Inherited from Gradient.removeStop
///
/// The gradient color stop to remove.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoLinearGradient = function() {
///
/// Returns a reference to the kendo.drawing.LinearGradient widget, instantiated on the selector.
///
/// The kendo.drawing.LinearGradient instance (if present).
};
$.fn.kendoLinearGradient = function(options) {
///
/// Instantiates a kendo.drawing.LinearGradient widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
stops - Array
///
The color stops of the gradient. Can contain either plain objects or GradientStop instances.
///
///
///
/// The widget configuration options
///
};
kendo.drawing.MultiPath = function() { };
kendo.drawing.MultiPath.prototype = {
bbox: function() {
///
/// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
///
/// The bounding box of the element with transformations applied.
},
clip: function(clip) {
///
/// Gets or sets the element clipping path. Inherited from Element.clip
///
/// The element clipping path.
/// The current element clipping path.
},
clippedBBox: function() {
///
/// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
///
/// The bounding box of the element with clipping transformations applied.
},
close: function() {
///
/// Closes the current sub-path by linking its current end point with its start point.
///
/// The current instance to allow chaining.
},
containsPoint: function(point) {
///
/// Returns true if the shape contains the specified point.
///
/// The point that should be checked.
/// value indicating if the shape contains the point.
},
curveTo: function(controlOut,controlIn,endPoint) {
///
/// Draws a cubic Bézier curve (with two control points).A quadratic Bézier curve (with one control point) can be plotted by making the control point equal.
///
/// The first control point for the curve.
/// The second control point for the curve.
/// The curve end point.
/// The current instance to allow chaining.
},
fill: function(color,opacity) {
///
/// Sets the shape fill.
///
/// The fill color to set.
/// The fill opacity to set.
/// The current instance to allow chaining.
},
lineTo: function(x,y) {
///
/// Draws a straight line to the specified absolute coordinates.
///
/// The line end X coordinate or a Point/Array with X and Y coordinates.
/// The line end Y coordinate.Optional if the first parameter is a Point/Array.
/// The current instance to allow chaining.
},
moveTo: function(x,y) {
///
/// Creates a new sub-path or clears all segments and moves the starting point to the specified absolute coordinates.
///
/// The starting X coordinate or a Point/Array with X and Y coordinates.
/// The starting Y coordinate.Optional if the first parameter is a Point/Array.
/// The current instance to allow chaining.
},
opacity: function(opacity) {
///
/// Gets or sets the element opacity. Inherited from Element.opacityIf set, the stroke and fill opacity will be multiplied by the element opacity.
///
/// The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
/// The current element opacity.
},
stroke: function(color,width,opacity) {
///
/// Sets the shape stroke.
///
/// The stroke color to set.
/// The stroke width to set.
/// The stroke opacity to set.
/// The current instance to allow chaining.
},
transform: function(transform) {
///
/// Gets or sets the transformation of the element. Inherited from Element.transform
///
/// The transformation to apply to the element.
/// The current transformation on the element.
},
visible: function(visible) {
///
/// Gets or sets the visibility of the element. Inherited from Element.visible
///
/// A flag indicating if the element should be visible.
/// true if the element is visible; false otherwise.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoMultiPath = function() {
///
/// Returns a reference to the kendo.drawing.MultiPath widget, instantiated on the selector.
///
/// The kendo.drawing.MultiPath instance (if present).
};
$.fn.kendoMultiPath = function(options) {
///
/// Instantiates a kendo.drawing.MultiPath widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
clip - kendo.drawing.Path
///
The element clipping path. Inherited from Element.clip
///
///
cursor - String
///
The element cursor. Inherited from Element.cursor
///
///
fill - kendo.drawing.FillOptions
///
The fill options of the shape.
///
///
opacity - Number
///
The element opacity. Inherited from Element.opacity
///
///
stroke - kendo.drawing.StrokeOptions
///
The stroke options of the shape.
///
///
tooltip - kendo.drawing.TooltipOptions
///
The tooltip options of the shape.
///
///
transform - kendo.geometry.Transformation
///
The transformation to apply to this element. Inherited from Element.transform
///
///
visible - Boolean
///
A flag, indicating if the element is visible. Inherited from Element.visible
///
///
///
/// The widget configuration options
///
};
kendo.drawing.OptionsStore = function() { };
kendo.drawing.OptionsStore.prototype = {
get: function(field) {
///
/// Gets the value of the specified option.
///
/// The field name to retrieve. Must be a fully qualified name (e.g. "foo.bar") for nested options.
/// The current option value.
},
set: function(field,value) {
///
/// Sets the value of the specified option.
///
/// The name of the option to set. Must be a fully qualified name (e.g. "foo.bar") for nested options.
/// The new option value.If the new value is exactly the same as the new value the operation will not trigger options change on the observer (if any).
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoOptionsStore = function() {
///
/// Returns a reference to the kendo.drawing.OptionsStore widget, instantiated on the selector.
///
/// The kendo.drawing.OptionsStore instance (if present).
};
$.fn.kendoOptionsStore = function(options) {
///
/// Instantiates a kendo.drawing.OptionsStore widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.drawing.PDFOptions = function() { };
kendo.drawing.PDFOptions.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoPDFOptions = function() {
///
/// Returns a reference to the kendo.drawing.PDFOptions widget, instantiated on the selector.
///
/// The kendo.drawing.PDFOptions instance (if present).
};
$.fn.kendoPDFOptions = function(options) {
///
/// Instantiates a kendo.drawing.PDFOptions widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.drawing.Path = function() { };
kendo.drawing.Path.prototype = {
bbox: function() {
///
/// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
///
/// The bounding box of the element with transformations applied.
},
clip: function(clip) {
///
/// Gets or sets the element clipping path. Inherited from Element.clip
///
/// The element clipping path.
/// The current element clipping path.
},
clippedBBox: function() {
///
/// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
///
/// The bounding box of the element with clipping transformations applied.
},
close: function() {
///
/// Closes the path by linking the current end point with the start point.
///
/// The current instance to allow chaining.
},
containsPoint: function(point) {
///
/// Returns true if the shape contains the specified point.
///
/// The point that should be checked.
/// value indicating if the shape contains the point.
},
curveTo: function(controlOut,controlIn,endPoint) {
///
/// Draws a cubic Bézier curve (with two control points).A quadratic Bézier curve (with one control point) can be plotted by making the control point equal.
///
/// The first control point for the curve.
/// The second control point for the curve.
/// The curve end point.
/// The current instance to allow chaining.
},
fill: function(color,opacity) {
///
/// Sets the shape fill.
///
/// The fill color to set.
/// The fill opacity to set.
/// The current instance to allow chaining.
},
lineTo: function(x,y) {
///
/// Draws a straight line to the specified absolute coordinates.
///
/// The line end X coordinate or a Point/Array with X and Y coordinates.
/// The line end Y coordinate.Optional if the first parameter is a Point/Array.
/// The current instance to allow chaining.
},
moveTo: function(x,y) {
///
/// Clears all existing segments and moves the starting point to the specified absolute coordinates.
///
/// The starting X coordinate or a Point/Array with X and Y coordinates.
/// The starting Y coordinate.Optional if the first parameter is a Point/Array.
/// The current instance to allow chaining.
},
opacity: function(opacity) {
///
/// Gets or sets the element opacity. Inherited from Element.opacityIf set, the stroke and fill opacity will be multiplied by the element opacity.
///
/// The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
/// The current element opacity.
},
stroke: function(color,width,opacity) {
///
/// Sets the shape stroke.
///
/// The stroke color to set.
/// The stroke width to set.
/// The stroke opacity to set.
/// The current instance to allow chaining.
},
transform: function(transform) {
///
/// Gets or sets the transformation of the element. Inherited from Element.transform
///
/// The transformation to apply to the element.
/// The current transformation on the element.
},
visible: function(visible) {
///
/// Gets or sets the visibility of the element. Inherited from Element.visible
///
/// A flag indicating if the element should be visible.
/// true if the element is visible; false otherwise.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoPath = function() {
///
/// Returns a reference to the kendo.drawing.Path widget, instantiated on the selector.
///
/// The kendo.drawing.Path instance (if present).
};
$.fn.kendoPath = function(options) {
///
/// Instantiates a kendo.drawing.Path widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
clip - kendo.drawing.Path
///
The element clipping path. Inherited from Element.clip
///
///
cursor - String
///
The element cursor. Inherited from Element.cursor
///
///
fill - kendo.drawing.FillOptions
///
The fill options of the shape.
///
///
opacity - Number
///
The element opacity. Inherited from Element.opacity
///
///
stroke - kendo.drawing.StrokeOptions
///
The stroke options of the shape.
///
///
tooltip - kendo.drawing.TooltipOptions
///
The tooltip options of the shape.
///
///
transform - kendo.geometry.Transformation
///
The transformation to apply to this element. Inherited from Element.transform
///
///
visible - Boolean
///
A flag, indicating if the element is visible. Inherited from Element.visible
///
///
///
/// The widget configuration options
///
};
kendo.drawing.RadialGradient = function() { };
kendo.drawing.RadialGradient.prototype = {
addStop: function(offset,color,opacity) {
///
/// Adds a color stop to the gradient. Inherited from Gradient.addStop
///
///
/// The color of the stop.
/// The fill opacity.
/// The new gradient color stop.
},
center: function(center) {
///
/// Gets or sets the center point of the gradient.
///
/// The center point of the gradient.Coordinates are relative to the shape bounding box. For example [0, 0] is top left and [1, 1] is bottom right.
/// The current radius of the gradient.
},
radius: function(value) {
///
/// Gets or sets the radius of the gradient.
///
/// The new radius of the gradient.
/// The current radius of the gradient.
},
removeStop: function(stop) {
///
/// Removes a color stop from the gradient. Inherited from Gradient.removeStop
///
/// The gradient color stop to remove.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoRadialGradient = function() {
///
/// Returns a reference to the kendo.drawing.RadialGradient widget, instantiated on the selector.
///
/// The kendo.drawing.RadialGradient instance (if present).
};
$.fn.kendoRadialGradient = function(options) {
///
/// Instantiates a kendo.drawing.RadialGradient widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
center - Array|kendo.geometry.Point
///
The center of the gradient.Coordinates are relative to the shape bounding box. For example [0, 0] is top left and [1, 1] is bottom right.
///
///
radius - Number (default: 1)
///
The radius of the radial gradient relative to the shape bounding box.
///
///
stops - Array
///
The color stops of the gradient. Can contain either plain objects or GradientStop instances.
///
///
///
/// The widget configuration options
///
};
kendo.drawing.Rect = function() { };
kendo.drawing.Rect.prototype = {
bbox: function() {
///
/// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
///
/// The bounding box of the element with transformations applied.
},
clip: function(clip) {
///
/// Gets or sets the element clipping path. Inherited from Element.clip
///
/// The element clipping path.
/// The current element clipping path.
},
clippedBBox: function() {
///
/// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
///
/// The bounding box of the element with clipping transformations applied.
},
containsPoint: function(point) {
///
/// Returns true if the shape contains the specified point.
///
/// The point that should be checked.
/// value indicating if the shape contains the point.
},
geometry: function(value) {
///
/// Gets or sets the rectangle geometry.
///
/// The new geometry to use.
/// The current rectangle geometry.
},
fill: function(color,opacity) {
///
/// Sets the shape fill.
///
/// The fill color to set.
/// The fill opacity to set.
/// The current instance to allow chaining.
},
opacity: function(opacity) {
///
/// Gets or sets the element opacity. Inherited from Element.opacityIf set, the stroke and fill opacity will be multiplied by the element opacity.
///
/// The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
/// The current element opacity.
},
stroke: function(color,width,opacity) {
///
/// Sets the shape stroke.
///
/// The stroke color to set.
/// The stroke width to set.
/// The stroke opacity to set.
/// The current instance to allow chaining.
},
transform: function(transform) {
///
/// Gets or sets the transformation of the element. Inherited from Element.transform
///
/// The transformation to apply to the element.
/// The current transformation on the element.
},
visible: function(visible) {
///
/// Gets or sets the visibility of the element. Inherited from Element.visible
///
/// A flag indicating if the element should be visible.
/// true if the element is visible; false otherwise.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoRect = function() {
///
/// Returns a reference to the kendo.drawing.Rect widget, instantiated on the selector.
///
/// The kendo.drawing.Rect instance (if present).
};
$.fn.kendoRect = function(options) {
///
/// Instantiates a kendo.drawing.Rect widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
clip - kendo.drawing.Path
///
The element clipping path. Inherited from Element.clip
///
///
cursor - String
///
The element cursor. Inherited from Element.cursor
///
///
fill - kendo.drawing.FillOptions
///
The fill options of the shape.
///
///
opacity - Number
///
The element opacity. Inherited from Element.opacity
///
///
stroke - kendo.drawing.StrokeOptions
///
The stroke options of the shape.
///
///
tooltip - kendo.drawing.TooltipOptions
///
The tooltip options of the shape.
///
///
transform - kendo.geometry.Transformation
///
The transformation to apply to this element. Inherited from Element.transform
///
///
visible - Boolean
///
A flag, indicating if the element is visible. Inherited from Element.visible
///
///
///
/// The widget configuration options
///
};
kendo.drawing.Segment = function() { };
kendo.drawing.Segment.prototype = {
anchor: function(value) {
///
/// Gets or sets the segment anchor point.The setter returns the current Segment to allow chaining.
///
/// The new anchor point.
/// The current anchor point.
},
controlIn: function(value) {
///
/// Gets or sets the first curve control point of this segment.The setter returns the current Segment to allow chaining.
///
/// The new control point.
/// The current control point.
},
controlOut: function(value) {
///
/// Gets or sets the second curve control point of this segment.The setter returns the current Segment to allow chaining.
///
/// The new control point.
/// The current control point.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoSegment = function() {
///
/// Returns a reference to the kendo.drawing.Segment widget, instantiated on the selector.
///
/// The kendo.drawing.Segment instance (if present).
};
$.fn.kendoSegment = function(options) {
///
/// Instantiates a kendo.drawing.Segment widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.drawing.StrokeOptions = function() { };
kendo.drawing.StrokeOptions.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoStrokeOptions = function() {
///
/// Returns a reference to the kendo.drawing.StrokeOptions widget, instantiated on the selector.
///
/// The kendo.drawing.StrokeOptions instance (if present).
};
$.fn.kendoStrokeOptions = function(options) {
///
/// Instantiates a kendo.drawing.StrokeOptions widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.drawing.Surface = function() { };
kendo.drawing.Surface.prototype = {
clear: function() {
///
/// Clears the drawing surface.
///
},
draw: function(element) {
///
/// Draws the element and its children on the surface. Existing elements will remain visible.
///
/// The element to draw.
},
eventTarget: function(e) {
///
/// Returns the target drawing element of a DOM event.
///
/// The original DOM or jQuery event object.
/// The target drawing element, if any.
},
hideTooltip: function() {
///
/// Hides the surface tooltip.
///
},
resize: function(force) {
///
/// Resizes the surface to match the size of the container.
///
/// Whether to proceed with resizing even if the container dimensions have not changed.
},
showTooltip: function(element,options) {
///
/// Shows the surface tooltip for the passed shape.
///
/// The element for which the tooltip should be shown.
/// Options for the tooltip.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoSurface = function() {
///
/// Returns a reference to the kendo.drawing.Surface widget, instantiated on the selector.
///
/// The kendo.drawing.Surface instance (if present).
};
$.fn.kendoSurface = function(options) {
///
/// Instantiates a kendo.drawing.Surface widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
type - String
///
The preferred type of surface to create. Supported types (case insensitive): - svg - canvasThis option will be ignored if not supported by the browser. See Supported Browsers.
///
///
height - String (default: "100%")
///
The height of the surface element. By default the surface will expand to fill the height of the first positioned container.
///
///
width - String (default: "100%")
///
The width of the surface element. By default the surface will expand to fill the width of the first positioned container.
///
///
tooltip - Object
///
Specifies general options for the shapes tooltip.
///
///
///
/// The widget configuration options
///
};
kendo.drawing.Text = function() { };
kendo.drawing.Text.prototype = {
bbox: function() {
///
/// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
///
/// The bounding box of the element with transformations applied.
},
clip: function(clip) {
///
/// Gets or sets the element clipping path. Inherited from Element.clip
///
/// The element clipping path.
/// The current element clipping path.
},
clippedBBox: function() {
///
/// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
///
/// The bounding box of the element with clipping transformations applied.
},
containsPoint: function(point) {
///
/// Returns true if the shape contains the specified point.
///
/// The point that should be checked.
/// value indicating if the shape contains the point.
},
content: function(value) {
///
/// Gets or sets the text content.
///
/// The new text content to set.
/// The current content of the text.
},
fill: function(color,opacity) {
///
/// Sets the text fill.
///
/// The fill color to set.
/// The fill opacity to set.
/// The current instance to allow chaining.
},
opacity: function(opacity) {
///
/// Gets or sets the element opacity. Inherited from Element.opacityIf set, the stroke and fill opacity will be multiplied by the element opacity.
///
/// The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
/// The current element opacity.
},
position: function(value) {
///
/// Gets or sets the position of the text upper left corner.
///
/// The new position of the text upper left corner.
/// The current position of the text upper left corner.
},
stroke: function(color,width,opacity) {
///
/// Sets the text stroke.
///
/// The stroke color to set.
/// The stroke width to set.
/// The stroke opacity to set.
/// The current instance to allow chaining.
},
transform: function(transform) {
///
/// Gets or sets the transformation of the element. Inherited from Element.transform
///
/// The transformation to apply to the element.
/// The current transformation on the element.
},
visible: function(visible) {
///
/// Gets or sets the visibility of the element. Inherited from Element.visible
///
/// A flag indicating if the element should be visible.
/// true if the element is visible; false otherwise.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoText = function() {
///
/// Returns a reference to the kendo.drawing.Text widget, instantiated on the selector.
///
/// The kendo.drawing.Text instance (if present).
};
$.fn.kendoText = function(options) {
///
/// Instantiates a kendo.drawing.Text widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
clip - kendo.drawing.Path
///
The element clipping path. Inherited from Element.clip
///
///
cursor - String
///
The element cursor. Inherited from Element.cursor
///
///
fill - kendo.drawing.FillOptions
///
The fill options of the text.
///
///
font - String
///
The font to use for rendering the text. Accepts the standard CSS font syntax.Examples of valid font values: * Size and family: "2em 'Open Sans', sans-serif" * Style, size and family: "italic 2em 'Open Sans', sans-serif"
///
///
opacity - Number
///
The element opacity. Inherited from Element.opacity
///
///
stroke - kendo.drawing.StrokeOptions
///
The stroke options of the text.
///
///
tooltip - kendo.drawing.TooltipOptions
///
The tooltip options of the shape.
///
///
transform - kendo.geometry.Transformation
///
The transformation to apply to this element. Inherited from Element.transform
///
///
visible - Boolean
///
A flag, indicating if the element is visible. Inherited from Element.visible
///
///
///
/// The widget configuration options
///
};
kendo.drawing.TooltipOptions = function() { };
kendo.drawing.TooltipOptions.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoTooltipOptions = function() {
///
/// Returns a reference to the kendo.drawing.TooltipOptions widget, instantiated on the selector.
///
/// The kendo.drawing.TooltipOptions instance (if present).
};
$.fn.kendoTooltipOptions = function(options) {
///
/// Instantiates a kendo.drawing.TooltipOptions widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
if (!kendo.effects) {
kendo.effects = {};
}
kendo.geometry.Arc = function() { };
kendo.geometry.Arc.prototype = {
bbox: function(matrix) {
///
/// Returns the bounding box of this arc after applying the specified transformation matrix.
///
/// Transformation matrix to apply.
/// The bounding box after applying the transformation matrix.
},
getAnticlockwise: function() {
///
/// Gets the arc anticlockwise flag.
///
/// The anticlockwise flag of the arc.
},
getCenter: function() {
///
/// Gets the arc center location.
///
/// The location of the arc center.
},
getEndAngle: function() {
///
/// Gets the end angle of the arc in decimal degrees. Measured in clockwise direction with 0 pointing "right".
///
/// The end angle of the arc.
},
getRadiusX: function() {
///
/// Gets the x radius of the arc.
///
/// The x radius of the arc.
},
getRadiusY: function() {
///
/// Gets the y radius of the arc.
///
/// The y radius of the arc.
},
getStartAngle: function() {
///
/// Gets the start angle of the arc in decimal degrees. Measured in clockwise direction with 0 pointing "right".
///
/// The start angle of the arc.
},
pointAt: function(angle) {
///
/// Gets the location of a point on the arc's circumference at a given angle.
///
/// Angle in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.
/// The point on the arc's circumference.
},
setAnticlockwise: function(value) {
///
/// Sets the arc anticlockwise flag.
///
/// The new anticlockwise value.
/// The current arc instance.
},
setCenter: function(value) {
///
/// Sets the arc center location.
///
/// The new arc center.
/// The current arc instance.
},
setEndAngle: function(value) {
///
/// Sets the end angle of the arc in decimal degrees. Measured in clockwise direction with 0 pointing "right".
///
/// The new arc end angle.
/// The current arc instance.
},
setRadiusX: function(value) {
///
/// Sets the x radius of the arc.
///
/// The new arc x radius.
/// The current arc instance.
},
setRadiusY: function(value) {
///
/// Sets the y radius of the arc.
///
/// The new arc y radius.
/// The current arc instance.
},
setStartAngle: function(value) {
///
/// Sets the start angle of the arc in decimal degrees. Measured in clockwise direction with 0 pointing "right".
///
/// The new arc start angle.
/// The current arc instance.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoArc = function() {
///
/// Returns a reference to the kendo.geometry.Arc widget, instantiated on the selector.
///
/// The kendo.geometry.Arc instance (if present).
};
$.fn.kendoArc = function(options) {
///
/// Instantiates a kendo.geometry.Arc widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.geometry.Circle = function() { };
kendo.geometry.Circle.prototype = {
bbox: function(matrix) {
///
/// Returns the bounding box of this circle after applying the specified transformation matrix.
///
/// Transformation matrix to apply.
/// The bounding box after applying the transformation matrix.
},
clone: function() {
///
/// Creates a new instance with the same center and radius.
///
/// A new Circle instance with the same center and radius.
},
equals: function(other) {
///
/// Compares this circle with another instance.
///
/// The circle to compare with.
/// true if the point coordinates match; false otherwise.
},
getCenter: function() {
///
/// Gets the circle center location.
///
/// The location of the circle center.
},
getRadius: function() {
///
/// Gets the circle radius.
///
/// The radius of the circle.
},
pointAt: function(angle) {
///
/// Gets the location of a point on the circle's circumference at a given angle.
///
/// Angle in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.
/// The point on the circle's circumference.
},
setCenter: function(value) {
///
/// Sets the location of the circle center.
///
/// The new center Point or equivalent [x, y] array.
/// The location of the circle center.
},
setRadius: function(value) {
///
/// Sets the circle radius.
///
/// The new circle radius.
/// The current circle instance.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoCircle = function() {
///
/// Returns a reference to the kendo.geometry.Circle widget, instantiated on the selector.
///
/// The kendo.geometry.Circle instance (if present).
};
$.fn.kendoCircle = function(options) {
///
/// Instantiates a kendo.geometry.Circle widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.geometry.Matrix = function() { };
kendo.geometry.Matrix.prototype = {
clone: function() {
///
/// Creates a new instance with the same element values.
///
/// A new Matrix instance with the same element values.
},
equals: function(other) {
///
/// Compares this matrix with another instance.
///
/// The matrix instance to compare with.
/// true if the matrix elements match; false otherwise.
},
round: function(digits) {
///
/// Rounds the matrix elements to the specified number of fractional digits.
///
/// Number of fractional digits.
/// The current matrix instance.
},
multiplyCopy: function(matrix) {
///
/// Multiplies the matrix with another one and returns the result as new instance. The current instance elements are not altered.
///
/// The matrix to multiply by.
/// The result of the multiplication.
},
toArray: function(digits) {
///
/// Returns the matrix elements as an [a, b, c, d, e, f] array.
///
/// (Optional) Number of fractional digits.
/// An array representation of the matrix.
},
toString: function(digits,separator) {
///
/// Formats the matrix elements as a string.
///
/// (Optional) Number of fractional digits.
/// The separator to place between elements.
/// A string representation of the matrix, e.g. "1, 0, 0, 1, 0, 0".
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoMatrix = function() {
///
/// Returns a reference to the kendo.geometry.Matrix widget, instantiated on the selector.
///
/// The kendo.geometry.Matrix instance (if present).
};
$.fn.kendoMatrix = function(options) {
///
/// Instantiates a kendo.geometry.Matrix widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.geometry.Point = function() { };
kendo.geometry.Point.prototype = {
clone: function() {
///
/// Creates a new instance with the same coordinates.
///
/// A new Point instance with the same coordinates.
},
distanceTo: function(point) {
///
/// Calculates the distance to another point.
///
/// The point to calculate the distance to.
/// The straight line distance to the given point.
},
equals: function(other) {
///
/// Compares this point with another instance.
///
/// The point to compare with.
/// true if the point coordinates match; false otherwise.
},
getX: function() {
///
/// Gets the x coordinate value.
///
/// The current x coordinate value.
},
getY: function() {
///
/// Gets the y coordinate value.
///
/// The current y coordinate value.
},
move: function(x,y) {
///
/// Moves the point to the specified x and y coordinates.
///
/// The new X coordinate.
/// The new Y coordinate.
/// The current point instance.
},
rotate: function(angle,center) {
///
/// Rotates the point around the given center.
///
/// Angle in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.
/// The rotation center. Can be a Point instance or an [x, y] array.
/// The current Point instance.
},
round: function(digits) {
///
/// Rounds the point coordinates to the specified number of fractional digits.
///
/// Number of fractional digits.
/// The current Point instance.
},
scale: function(scaleX,scaleY) {
///
/// Scales the point coordinates along the x and y axis.
///
/// The x scale multiplier.
/// The y scale multiplier.
/// The current point instance.
},
scaleCopy: function(scaleX,scaleY) {
///
/// Scales the point coordinates on a copy of the current point. The callee coordinates will remain unchanged.
///
/// The x scale multiplier.
/// The y scale multiplier.
/// The new Point instance.
},
setX: function(value) {
///
/// Sets the x coordinate to a new value.
///
/// The new x coordinate value.
/// The current Point instance.
},
setY: function(value) {
///
/// Sets the y coordinate to a new value.
///
/// The new y coordinate value.
/// The current Point instance.
},
toArray: function(digits) {
///
/// Returns the point coordinates as an [x, y] array.
///
/// (Optional) Number of fractional digits.
/// An array representation of the point, e.g. [10, 20]
},
toString: function(digits,separator) {
///
/// Formats the point value to a string.
///
/// (Optional) Number of fractional digits.
/// The separator to place between coordinates.
/// A string representation of the point, e.g. "10 20".
},
transform: function(tansformation) {
///
/// Applies a transformation to the point coordinates. The current coordinates will be overriden.
///
/// The transformation to apply.
/// The current Point instance.
},
transformCopy: function(tansformation) {
///
/// Applies a transformation on a copy of the current point. The callee coordinates will remain unchanged.
///
/// The transformation to apply.
/// The new Point instance.
},
translate: function(dx,dy) {
///
/// Translates the point along the x and y axis.
///
/// The distance to move along the X axis.
/// The distance to move along the Y axis.
/// The current point instance.
},
translateWith: function(vector) {
///
/// Translates the point by using a Point instance as a vector of translation.
///
/// The vector of translation. Can be either a Point instance or an [x, y] array.
/// The current point instance.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoPoint = function() {
///
/// Returns a reference to the kendo.geometry.Point widget, instantiated on the selector.
///
/// The kendo.geometry.Point instance (if present).
};
$.fn.kendoPoint = function(options) {
///
/// Instantiates a kendo.geometry.Point widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.geometry.Rect = function() { };
kendo.geometry.Rect.prototype = {
bbox: function(matrix) {
///
/// Returns the bounding box of this rectangle after applying the specified transformation matrix.
///
/// Transformation matrix to apply.
/// The bounding box after applying the transformation matrix.
},
bottomLeft: function() {
///
/// Gets the position of the bottom-left corner of the rectangle. This is also the rectangle origin
///
/// The position of the bottom-left corner.
},
bottomRight: function() {
///
/// Gets the position of the bottom-right corner of the rectangle.
///
/// The position of the bottom-right corner.
},
center: function() {
///
/// Gets the position of the center of the rectangle.
///
/// The position of the center.
},
clone: function() {
///
/// Creates a new instance with the same origin and size.
///
/// A new Rect instance with the same origin and size.
},
equals: function(other) {
///
/// Compares this rectangle with another instance.
///
/// The rectangle to compare with.
/// true if the origin and size is the same for both rectangles; false otherwise.
},
getOrigin: function() {
///
/// Gets the origin (top-left point) of the rectangle.
///
/// The origin (top-left point).
},
getSize: function() {
///
/// Gets the rectangle size.
///
/// The current rectangle Size.
},
height: function() {
///
/// Gets the rectangle height.
///
/// The rectangle height.
},
setOrigin: function(value) {
///
/// Sets the origin (top-left point) of the rectangle.
///
/// The new origin Point or equivalent [x, y] array.
/// The current rectangle instance.
},
setSize: function(value) {
///
/// Sets the rectangle size.
///
/// The new rectangle Size or equivalent [width, height] array.
/// The current rectangle instance.
},
topLeft: function() {
///
/// Gets the position of the top-left corner of the rectangle. This is also the rectangle origin
///
/// The position of the top-left corner.
},
topRight: function() {
///
/// Gets the position of the top-right corner of the rectangle.
///
/// The position of the top-right corner.
},
width: function() {
///
/// Gets the rectangle width.
///
/// The rectangle width.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoRect = function() {
///
/// Returns a reference to the kendo.geometry.Rect widget, instantiated on the selector.
///
/// The kendo.geometry.Rect instance (if present).
};
$.fn.kendoRect = function(options) {
///
/// Instantiates a kendo.geometry.Rect widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.geometry.Size = function() { };
kendo.geometry.Size.prototype = {
clone: function() {
///
/// Creates a new instance with the same width and height.
///
/// A new Size instance with the same dimensions.
},
equals: function(other) {
///
/// Compares this Size with another instance.
///
/// The Size to compare with.
/// true if the size members match; false otherwise.
},
getWidth: function() {
///
/// Gets the width value.
///
/// The current width value.
},
getHeight: function() {
///
/// Gets the height value.
///
/// The current height value.
},
setWidth: function(value) {
///
/// Sets the width to a new value.
///
/// The new width value.
/// The current Size instance.
},
setHeight: function(value) {
///
/// Sets the height to a new value.
///
/// The new height value.
/// The current Size instance.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoSize = function() {
///
/// Returns a reference to the kendo.geometry.Size widget, instantiated on the selector.
///
/// The kendo.geometry.Size instance (if present).
};
$.fn.kendoSize = function(options) {
///
/// Instantiates a kendo.geometry.Size widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.geometry.Transformation = function() { };
kendo.geometry.Transformation.prototype = {
clone: function() {
///
/// Creates a new instance with the same transformation matrix.
///
/// A new Transformation instance with the same matrix.
},
equals: function(other) {
///
/// Compares this transformation with another instance.
///
/// The transformation to compare with.
/// true if the transformation matrix is the same; false otherwise.
},
matrix: function() {
///
/// Gets the current transformation matrix for this transformation.
///
/// The current transformation matrix.
},
multiply: function(transformation) {
///
/// Multiplies the transformation with another. The underlying transformation matrix is updated in-place.
///
/// The transformation to multiply by.
/// The current transformation instance.
},
rotate: function(angle,center) {
///
/// Sets rotation with the specified parameters.
///
/// The angle of rotation in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.
/// The center of rotation.
/// The current transformation instance.
},
scale: function(scaleX,scaleY) {
///
/// Sets scale with the specified parameters.
///
/// The scale factor on the X axis.
/// The scale factor on the Y axis.
/// The current transformation instance.
},
translate: function(x,y) {
///
/// Sets translation with the specified parameters.
///
/// The distance to translate along the X axis.
/// The distance to translate along the Y axis.
/// The current transformation instance.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoTransformation = function() {
///
/// Returns a reference to the kendo.geometry.Transformation widget, instantiated on the selector.
///
/// The kendo.geometry.Transformation instance (if present).
};
$.fn.kendoTransformation = function(options) {
///
/// Instantiates a kendo.geometry.Transformation widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.ooxml.Workbook = function() { };
kendo.ooxml.Workbook.prototype = {
toDataURL: function() {
///
/// Creates an Excel file that represents the current workbook and returns it as a data URL.
///
/// - the Excel file as data URL.
},
toDataURLAsync: function() {
///
/// Creates an Excel file that represents the current workbook and returns a Promise that is resolved with the data URL.
///
/// - A promise that will be resolved with the Excel file as data URL.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoWorkbook = function() {
///
/// Returns a reference to the kendo.ooxml.Workbook widget, instantiated on the selector.
///
/// The kendo.ooxml.Workbook instance (if present).
};
$.fn.kendoWorkbook = function(options) {
///
/// Instantiates a kendo.ooxml.Workbook widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
creator - String (default: "Kendo UI")
///
The creator of the workbook.
///
///
date - Date
///
The date when the workbook is created. Defaults to new Date().
///
///
rtl - Boolean (default: false)
///
Sets the direction of the workbook. By default, the direction is left-to-right.
///
///
sheets - Array
///
The sheets of the workbook. Every sheet represents a page from the final Excel file.
///
///
///
/// The widget configuration options
///
};
if (!kendo.pdf) {
kendo.pdf = {};
}
kendo.spreadsheet.CustomFilter = function() { };
kendo.spreadsheet.CustomFilter.prototype = {
init: function(options) {
///
/// The constructor of the filter.
///
/// An object which may contain the following keys: logic - string - either "and" or "or". or criteria - an array of objects, containing operator (String) and value (String|Date|Number) fields.. The supported criteria operators are: eq (equal to), neq (not equal to), lt (less than), lte (less than or equal to), gt (greater than), gte (greater than or equal to). In addition, startswith, endswith, contains, doesnotstartwith and doesnotendwith are supported for cells that contain strings.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoCustomFilter = function() {
///
/// Returns a reference to the kendo.spreadsheet.CustomFilter widget, instantiated on the selector.
///
/// The kendo.spreadsheet.CustomFilter instance (if present).
};
$.fn.kendoCustomFilter = function(options) {
///
/// Instantiates a kendo.spreadsheet.CustomFilter widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.spreadsheet.DynamicFilter = function() { };
kendo.spreadsheet.DynamicFilter.prototype = {
init: function(options) {
///
/// The constructor of the filter.
///
/// An object which should have a type field set to: "belowAverage", "aboveAverage", "bottomPercent", or "bottomNumber" for numbers. or "tomorrow", "today", "yesterday", "nextWeek", "thisWeek", "lastWeek", "nextMonth", "thisMonth", "lastMonth", "nextQuarter", "thisQuarter","lastQuarter", "nextYear", "thisYear", "lastYear", "yearToDate" for date fields. "quarter1", "quarter2", "quarter3", "quarter4" and month (en-US) names are also accepted..
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDynamicFilter = function() {
///
/// Returns a reference to the kendo.spreadsheet.DynamicFilter widget, instantiated on the selector.
///
/// The kendo.spreadsheet.DynamicFilter instance (if present).
};
$.fn.kendoDynamicFilter = function(options) {
///
/// Instantiates a kendo.spreadsheet.DynamicFilter widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.spreadsheet.Range = function() { };
kendo.spreadsheet.Range.prototype = {
background: function(value) {
///
/// Gets or sets the background color of the cells in the range.
///
/// Any valid CSS color.
/// the current background color of the top-left cell of the range.
},
bold: function(value) {
///
/// Gets or sets the bold state of the cells in the range.
///
/// True to make the text bold; false otherwise.
/// the current bold state of the top-left cell of the range.
},
borderBottom: function(value) {
///
/// Gets or sets the state of the bottom border of the cells. If the range includes more than a single cell, the setting is applied to all cells.
///
/// The border configuration object. It may contain size and color keys.The color may be set to any valid CSS color. The size should be the border width in pixels (numeric, not string).
/// the current value of the top-left cell of the range.
},
borderLeft: function(value) {
///
/// Gets or sets the state of the left border of the cells. If the range includes more than a single cell, the setting is applied to all cells.
///
/// The border configuration object. It may contain size and color keys.The color may be set to any valid CSS color. The size should be the border width in pixels (numeric, not string).
/// the current value of the top-left cell of the range.
},
borderRight: function(value) {
///
/// Gets or sets the state of the right border of the cells. If the range includes more than a single cell, the setting is applied to all cells.
///
/// The border configuration object. It may contain size and color keys.The color may be set to any valid CSS color. The size should be the border width in pixels (numeric, not string).
/// the current value of the top-left cell of the range.
},
borderTop: function(value) {
///
/// Gets or sets the state of the top border of the cells. If the range includes more than a single cell, the setting is applied to all cells.
///
/// The border configuration object. It may contain size and color keys.The color may be set to any valid CSS color. The size should be the border width in pixels (numeric, not string).
/// the current value of the top-left cell of the range.
},
color: function(value) {
///
/// Gets or sets the text color of the range.
///
/// Any valid CSS color.
/// the current color of the top-left cell of the range.
},
comment: function(value) {
///
/// Gets or sets the comment for the cells. The comment is a text tooltip that appears when the cell is hovered.
///
/// Text comment. Pass null to remove the comment.
/// the current comment of the top-left cell in the range.
},
clear: function(options) {
///
/// Clears the contents of the range cells.
///
/// An object which may contain contentsOnly: true or formatOnly: true key values. Clearing the format will remove the cell formatting and visual styles.If a parameter is not passed, the method will clear both the cells values and the formatting.
},
clearFilter: function(indices) {
///
/// Clears the set filters for the given column(s). The indices is relative to the beginning of the range.
///
/// The column(s) which filters should be cleared.
},
editor: function(value) {
///
/// Gets or sets the editor of the cells in the range.
///
/// The name of the custom cell editor, registered as described in this help article
/// name of the custom cell editor.
},
enable: function(value) {
///
/// Gets or sets the disabled state of the cells in the range.
///
/// True to make the cell enabled; false to disable it.
/// the current disabled state of the top-left cell of the range.
},
fillFrom: function(srcRange,direction) {
///
/// Fills a range with values inferred from a source range. This method employs some heuristics similar to what Excel's auto-filling algorithm does when you select a range of cells and drag the bottom-right handle. The range to be filled is the current object, and you must pass a source range containing data as first argument.
///
/// The source range. It must have the same number of rows or the same number of columns as the current range — otherwise an exception will be thrown (a Range.FillError object having code property "incompatibleRanges").
/// Specifies the fill direction. If the source range (srcRange) and target range (the current object) are adjacent, the fill direction can be inferred from their positions, so it can be missing. For example:In this case it will select vertical reverse filling, because the target range is above the source range.If the ranges are not adjacent and the direction is missing, an exception will be thrown if the ranges don't start either on same column or on the same row ("noFillDirection" error code).Possible values for direction: 0 — fill top-down; 1 — fill left-to-right; 2 — fill bottom-up or 3 — fill right-to-left.
},
filter: function(filter) {
///
/// Enables/disables or sets the filter for a given range.
///
/// Determines the action performed by the method. Passing true enables the filtering for the given range.; Passing false disables and clears the set filters.; Passing a { column: Number, filter: kendo.spreadsheet.Filter } object applies the filter to the respective column. or Passing an array of { column: Number, filter: kendo.spreadsheet.Filter } objects applies each filter to the respective column. The column index is relative to the beginning of the range..
},
fontFamily: function(value) {
///
/// Gets or sets the font family of the cells in the range.
///
/// The font family that should be set.
/// the font family of the top-left cell of the range.
},
fontSize: function(value) {
///
/// Gets or sets the font size of the cells in the range.
///
/// The font size (in pixels) that should be set.
/// the font size of the top-left cell of the range.
},
forEachCell: function(callback) {
///
/// Executes a function for each cell in the range.
///
/// The function that will be executed against every cell. The function receives the following parameters: rowIndex - the row index of the cell; columnIndex - the column index of the cell or value - the cell properties.
},
format: function(format) {
///
/// Gets or sets the format of the cells.
///
/// The new format for the cells.
/// the format of the top-left cell of the range. When used as a setter, format returns the Range object to allow chained calls.More details about the supported format may be found in the cell formatting help topic.
},
formula: function(formula) {
///
/// Gets or sets the formula of the cells.
///
/// The new formula of the cell. The string may optionally start with =.
/// the formula of the top-left cell of the range.
},
hasFilter: function() {
///
/// Returns true if the sheet of the range has filter enabled.
///
/// true if the sheet has a filter, false otherwise.
},
input: function(value) {
///
/// Gets or sets the value of the cells. This is similar to value, but it parses the argument as if it was entered through the text box: if it starts with = (equal sign), a formula is set. This may throw an error if the formula is syntactically invalid. Example: range("C1").input("=A1+B1").; if it looks like a number, a numeric value (not string) is set.; if it's true or false (case-insensitive) the respective boolean value is set.; if it's a Date object, or a string that can be parsed as a date, it is converted to the numerical representation of the date. or if it starts with ' (single quote), a string containing the rest of the characters is set. Example: range("A1").input("'TRUE") — sets the text "TRUE", not the boolean..
///
/// The value to be set to the cells.
/// the current value of the top-left cell of the range.
},
isSortable: function() {
///
/// Returns if a range can be sorted.
///
/// whether the range can be sorted.
},
isFilterable: function() {
///
/// Returns if a range can be filtered.
///
/// whether the range can be filtered.
},
italic: function(value) {
///
/// Gets or sets the italic state of the cells in the range.
///
/// True will make the text of the cells italic; false otherwise.
/// the current italic state of the top-left cell of the range.
},
link: function(url) {
///
/// Gets or sets the hyperlink of the cells in the range.
///
/// Pass a string (the URL) to create a hyperlink. Pass null to remove the link. Omit argument to get the existing URL, if any.
/// the current hyperlink attribute of the top-left cell of the range.
},
merge: function() {
///
/// Merges the range cells into a single merged cell. If the range already includes a merged cell, they are merged, too.
///
},
select: function() {
///
/// Sets the sheet selection to the range cells.``````
///
},
sort: function(sort) {
///
/// Sorts the rows in the range.
///
/// Determines the action performed by the method. Passing a number n sorts the nth column in the range, in ascending order.; Passing a { column: Number, ascending: Boolean } sorts the respective column in ascending / descending order, based on the ascending parameter. The column index is relative to the beginning of the range. or Passing an array of { column: Number, ascending: Boolean } objects sorts each column, specified by the index..
},
textAlign: function(value) {
///
/// Gets or sets the text alignment of the cells in the range.
///
/// One of the following values: "left", "center", "right" and "justify".
/// the current text alignment of the top-left cell of the range.
},
unmerge: function() {
///
/// Un-merges any merged cells which are included in the range.``````
///
},
values: function(values) {
///
/// Gets or sets the values of the range cells. The argument should be an array of arrays which match the dimensions of the range.
///
/// The cell values.
/// the cell values.
},
validation: function(value) {
///
/// Gets or sets the validation of the cells.
///
/// The validation configuration object. It may contain type, comparerType, dataType, from, to, allowNulls, messageTemplate and titleTemplate keys.The type Can be set to "warning" or "reject". By default the type is "warning".The comparerType Can be set to "greaterThan", "lessThan", "between", "equalTo", "notEqualTo", "greaterThanOrEqualTo", "lessThanOrEqualTo", "notBetween" or "custom".The dataType Can be set to "date", "text", "number", "list" or "custom".The from This key holds formula or value. Used as first or only compare value depending on specified comparer.The to This key can be set to formula or value. It's optional depending on the specified comparer.The allowNulls Can be set to boolean value.The messageTemplate The message which will be displayed in the "reject" validation window.The titleTemplate The title of the "reject" validation window.
/// the current validation of the top-left cell of the range.
},
value: function(value) {
///
/// Gets or sets the value of the cells.
///
/// The value to be set to the cells.
/// the current value of the top-left cell of the range.
},
verticalAlign: function(value) {
///
/// Gets or sets the vertical alignment of the cells in the range.
///
/// One of the following values: "top", "center" and "bottom".
/// the current text alignment of the top-left cell of the range.
},
wrap: function(value) {
///
/// Gets or sets the wrap of the range cells.
///
/// if to enable wrapping, false otherwise.
/// the current wrap state of the top-left cell of the range.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoRange = function() {
///
/// Returns a reference to the kendo.spreadsheet.Range widget, instantiated on the selector.
///
/// The kendo.spreadsheet.Range instance (if present).
};
$.fn.kendoRange = function(options) {
///
/// Instantiates a kendo.spreadsheet.Range widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.spreadsheet.Sheet = function() { };
kendo.spreadsheet.Sheet.prototype = {
addDrawing: function(drawing) {
///
/// Adds a new drawing to this sheet.
///
/// This can contain the same properties as you can pass tosheets.drawings configuration options.
/// an internal Drawing object containing the passed properties. The internals of this object are not intended to be public API at this point, but you can pass this object reference to removeDrawing if you want to remove this drawing.
},
clearFilter: function(indexes) {
///
/// Clears the filters for the passed column index. If an array is passed, clearFilter will clear the filter for each column index.
///
/// The column index(es)
},
columnWidth: function(index,width) {
///
/// Gets or sets the width of the column at the given index.
///
/// The zero-based index of the column
/// If passed, the method will set the width of the column at the passed index.
},
batch: function(callback,changeEventArgs) {
///
/// Suppresses triggering of change events for a sequence of actions. Triggers a single change event at the end of the sequence.Greatly improves performance when calling multiple methods that change the sheet state, as the widget will be refreshed once.
///
/// The sequence of actions that will be executed without triggering a change event.
/// The change event arguments that will be used for the change event triggered after the callback finishes executing.
},
deleteColumn: function(index) {
///
/// Deletes the contents of the column at the provided index and shifts the remaining contents of the sheet to the left.
///
/// The zero-based index of the column
},
deleteRow: function(index) {
///
/// Deletes the contents of the row at the provided index and shifts the remaining contents of the sheet up.
///
/// The zero-based index of the row
},
fromJSON: function(data) {
///
/// Loads the sheet from an object in the format defined in the sheet configuration.
///
/// The object to load data from. This should be the deserialized object, not the JSON string.
},
frozenColumns: function(count) {
///
/// Gets or sets the amount of frozen columns displayed by the sheet.
///
/// The amount of columns to be frozen. Pass 0 to remove the frozen pane.
/// The current frozen columns. By default, returns 0.
},
frozenRows: function(count) {
///
/// Gets or sets the amount of frozen rows displayed by the sheet.
///
/// The amount of columns to be frozen. Pass 0 to remove the frozen pane.
/// The current frozen rows. By default, returns 0.
},
hideColumn: function(index) {
///
/// Hides the column at the provided index.
///
/// The zero-based index of the column
},
hideRow: function(index) {
///
/// Hides the row at the provided index.
///
/// The zero-based index of the row
},
insertColumn: function(index) {
///
/// Inserts a new, empty column at the provided index. The contents of the spreadsheet (including the ones in the current column index) are shifted to the right.
///
/// The zero-based index of the column
},
insertRow: function(index) {
///
/// Inserts a new, empty row at the provided index. The contents of the spreadsheet (including the ones in the current row index) are shifted down.
///
/// The zero-based index of the column
},
range: function(ref,rowIndex,columnIndex,rowCount,columnCount) {
///
/// Returns a Range for the given range specification.
///
///
///
///
///
/// If the parameter is a string, it should represent an A1 or RC notation reference of the cells.If the parameters are Numbers, the first two would represent the row index (the first parameter) and the column index (the second parameter) of the top-left cell of the range. If there are only two parameters, only one cell will be included in the range. If the other two Numbers are also present, they will represent the number of rows (the third parameter) and number of columns (the forth parameter) that would be included in the range, starting from the specified top-left cell. If the third or the forth parameter is set to 0 or 1, only one row / column will be included in the range.
/// a range object, which may be used to manipulate the cell state further.
},
removeDrawing: function(drawing) {
///
/// Removes a drawing previously added with addDrawing.
///
/// The drawing object.
},
rowHeight: function(index,width) {
///
/// Gets or sets the height of the row at the given index.
///
/// The zero-based index of the row
/// If passed, the method will set the height of the row at the passed index.
},
selection: function() {
///
/// Returns a range with the current active selection.
///
/// the selection range.
},
setDataSource: function(dataSource,columns) {
///
/// Binds the sheet to a DataSource instance. For more information on the data-binding Spreadsheet functionality, refer to the article on binding the Spreadsheet to a data source.
///
/// The DataSource instance.
/// Columns configuration.
},
showGridLines: function(showGridLines) {
///
/// Gets or sets a flag indicating if the grid lines should be visible.
///
/// If passed, the method will toggle the display of the grid lines according to the value.
/// True if the grid lines are currently visible, false otherwise.
},
toJSON: function() {
///
/// Serializes the sheet in the format defined in the sheet configuration.
///
},
unhideColumn: function(index) {
///
/// Shows the hidden column at the provided index. Does not have any effect if the column is already visible.
///
/// The zero-based index of the column
},
unhideRow: function(index) {
///
/// Shows the hidden row at the provided index. Does not have any effect if the row is already visible.
///
/// The zero-based index of the row
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoSheet = function() {
///
/// Returns a reference to the kendo.spreadsheet.Sheet widget, instantiated on the selector.
///
/// The kendo.spreadsheet.Sheet instance (if present).
};
$.fn.kendoSheet = function(options) {
///
/// Instantiates a kendo.spreadsheet.Sheet widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.spreadsheet.TopFilter = function() { };
kendo.spreadsheet.TopFilter.prototype = {
init: function(options) {
///
/// The constructor of the filter.
///
/// An object which may contain the following keys: type - String - can be "topPercent", "topNumber", "bottomPercent", or "bottomNumber". or value - Number, the count | percentage of items to display..
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoTopFilter = function() {
///
/// Returns a reference to the kendo.spreadsheet.TopFilter widget, instantiated on the selector.
///
/// The kendo.spreadsheet.TopFilter instance (if present).
};
$.fn.kendoTopFilter = function(options) {
///
/// Instantiates a kendo.spreadsheet.TopFilter widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
kendo.spreadsheet.ValueFilter = function() { };
kendo.spreadsheet.ValueFilter.prototype = {
init: function(options) {
///
/// The constructor of the filter.
///
/// An object which may contain the following keys: values - an array of the matching values that should be preserved.; blanks - if set as true, empty cells will be shown, too. or dates - an array which works like the values option, but performs partial matching for date values. It should contain objects with year, month, day, hours, minutes, and seconds. Each field is optional..
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoValueFilter = function() {
///
/// Returns a reference to the kendo.spreadsheet.ValueFilter widget, instantiated on the selector.
///
/// The kendo.spreadsheet.ValueFilter instance (if present).
};
$.fn.kendoValueFilter = function(options) {
///
/// Instantiates a kendo.spreadsheet.ValueFilter widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
///
/// The widget configuration options
///
};
if (!kendo.timezone) {
kendo.timezone = {};
}
if (!kendo.ui) {
kendo.ui = {};
}
kendo.ui.Alert = function() { };
kendo.ui.Alert.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoAlert = function() {
///
/// Returns a reference to the kendo.ui.Alert widget, instantiated on the selector.
///
/// The kendo.ui.Alert instance (if present).
};
$.fn.kendoAlert = function(options) {
///
/// Instantiates a kendo.ui.Alert widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
messages - Object
///
Defines the text of the labels that are shown within the alert dialog. Used primarily for localization.
///
///
///
/// The widget configuration options
///
};
kendo.ui.AutoComplete = function() { };
kendo.ui.AutoComplete.prototype = {
close: function() {
///
/// Closes the widget suggestion popup.
///
},
dataItem: function(index) {
///
/// Returns the data item at the specified index.
///
/// The zero-based index of of the data item.
/// the data item at the specified index. Returns undefined if the index is not within bounds.
},
destroy: function() {
///
/// Prepares the widget for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enables or disables the widget.
///
/// If set to true the widget will be enabled. If set to false the widget will be disabled.
},
focus: function() {
///
/// Focuses the widget.
///
},
items: function() {
///
/// Obtains an Array of the DOM elements, which correspond to the data items from the Kendo UI DataSource view (e.g. the ones that match the user's last filtering input).
///
/// The currently rendered dropdown list items ( elements).
},
readonly: function(readonly) {
///
/// Toggles the readonly state of the widget. When the widget is readonly it doesn't allow user input.
///
/// If set to true the widget will not allow user input. If set to false the widget will allow user input.
},
refresh: function() {
///
/// Refresh the suggestion popup by rendering all items again.
///
},
search: function(word) {
///
/// Searches the data source for the provided value and displays any matches as suggestions.
///
/// The value to search for. All matches are displayed in the suggestion popup.
},
select: function(item) {
///
/// Selects the item provided as an argument and updates the value of the widget.
///
/// A string, DOM element or jQuery object which represents the item to be selected. A string is treated as a jQuery selector.
},
setDataSource: function(dataSource) {
///
/// Sets the data source of the widget.
///
/// The data source to which the widget should be bound.
},
suggest: function(value) {
///
/// Sets the value of the widget to the specified argument and visually selects the text.
///
/// The value to set.
},
value: function(value) {
///
/// Gets or sets the value of the widget.
///
/// The value to set.
/// the value of the widget.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoAutoComplete = function() {
///
/// Returns a reference to the kendo.ui.AutoComplete widget, instantiated on the selector.
///
/// The kendo.ui.AutoComplete instance (if present).
};
$.fn.kendoAutoComplete = function(options) {
///
/// Instantiates a kendo.ui.AutoComplete widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation - Boolean
///
Configures the opening and closing animations of the suggestion popup. Setting the animation option to false will disable the opening and closing animations. As a result the suggestion popup will open and close instantly. is not a valid configuration.
///
///
animation - Object
///
Configures the opening and closing animations of the suggestion popup. Setting the animation option to false will disable the opening and closing animations. As a result the suggestion popup will open and close instantly. is not a valid configuration.
///
///
autoWidth - Boolean
///
If set to true, the widget automatically adjusts the width of the popup element and does not wrap up the item label.
///
///
dataSource - Object|Array|kendo.data.DataSource
///
The data source of the widget which is used to display suggestions for the current value. Can be a JavaScript object which represents a valid data source configuration, a JavaScript array or an existing kendo.data.DataSource instance.If the dataSource option is set to a JavaScript object or array the widget will initialize a new kendo.data.DataSource instance using that value as data source configuration.If the dataSource option is an existing kendo.data.DataSource instance the widget will use that instance and will not initialize a new one.
///
///
clearButton - Boolean (default: true)
///
Unless this options is set to false, a button will appear when hovering the widget. Clicking that button will reset the widget's value and will trigger the change event.
///
///
dataTextField - String (default: null)
///
The field of the data item used when searching for suggestions. This is the text that will be displayed in the list of matched results.
///
///
delay - Number (default: 200)
///
The delay in milliseconds between a keystroke and when the widget displays the suggestion popup.
///
///
enable - Boolean (default: true)
///
If set to false the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input.
///
///
enforceMinLength - Boolean (default: false)
///
If set to true the widget will not show all items when the text of the search input cleared. By default the widget shows all items when the text of the search input is cleared. Works in conjunction with minLength.
///
///
filter - String (default: "startswith")
///
The filtering method used to determine the suggestions for the current value. The default filter is "startswith" - all data items which begin with the current widget value are displayed in the suggestion popup. The supported filter values are startswith, endswith and contains.
///
///
fixedGroupTemplate - String|Function
///
The template used to render the fixed header group. By default the widget displays only the value of the current group.
///
///
footerTemplate - String|Function
///
The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.
///
///
groupTemplate - String|Function
///
The template used to render the groups. By default the widget displays only the value of the group.
///
///
height - Number (default: 200)
///
The height of the suggestion popup in pixels. The default value is 200 pixels.
///
///
highlightFirst - Boolean (default: true)
///
If set to true the first suggestion will be automatically highlighted.
///
///
ignoreCase - Boolean (default: true)
///
If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default.
///
///
minLength - Number (default: 1)
///
The minimum number of characters the user must type before a search is performed. Set to higher value than 1 if the search could match a lot of items.
///
///
noDataTemplate - String|Function (default: "NO DATA FOUND.")
///
The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound.
///
///
placeholder - String (default: "")
///
The hint displayed by the widget when it is empty. Not set by default.
///
///
popup - Object
///
The options that will be used for the popup initialization. For more details about the available options refer to Popup documentation.
///
///
separator - String|Array (default: "")
///
The character used to separate multiple values. Empty by default.
///
///
suggest - Boolean (default: false)
///
If set to true the widget will automatically use the first suggestion as its value.
///
///
headerTemplate - String|Function
///
Specifies a static HTML content, which will be rendered as a header of the popup element.
///
///
template - String|Function
///
The template used to render the suggestions. By default the widget displays only the text of the suggestion (configured via dataTextField).
///
///
value - String (default: "")
///
The value of the widget.
///
///
valuePrimitive - Boolean (default: false)
///
Specifies the value binding behavior for the widget when the initial model value is null. If set to true, the View-Model field will be updated with the selected item text field. If set to false, the View-Model field will be updated with the selected item.
///
///
virtual - Boolean (default: false)
///
Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization.
///
///
virtual - Object (default: false)
///
Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Button = function() { };
kendo.ui.Button.prototype = {
enable: function(toggle) {
///
/// Enables or disables the Button.
///
/// Indicates whether the Button should be enabled or disabled. true and false arguments are accepted. If no argument is supplied, the Button will assume true and will be enabled.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoButton = function() {
///
/// Returns a reference to the kendo.ui.Button widget, instantiated on the selector.
///
/// The kendo.ui.Button instance (if present).
};
$.fn.kendoButton = function(options) {
///
/// Instantiates a kendo.ui.Button widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
enable - Boolean (default: true)
///
Indicates whether the Button should be enabled or disabled. By default, it is enabled, unless a disabled="disabled" attribute is detected.
///
///
icon - String
///
Defines a name of an existing icon in the Kendo UI theme sprite. The icon will be applied as background image of a span element inside the Button. The span element can be added automatically by the widget, or an existing element can be used, if it has a k-icon CSS class applied. For a list of available icon names, please refer to the Icons demo.
///
///
iconClass - String
///
Defines a CSS class - or multiple classes separated by spaced - which are applied to a span element inside the Button. Allows the usage of custom icons.
///
///
imageUrl - String
///
Defines a URL, which will be used for an img element inside the Button. The URL can be relative or absolute. In case it is relative, it will be evaluated with relation to the web page URL.The img element can be added automatically by the widget, or an existing element can be used, if it has a k-image CSS class applied.
///
///
spriteCssClass - String
///
Defines a CSS class (or multiple classes separated by spaces), which will be used for applying a background image to a span element inside the Button. In case you want to use an icon from the Kendo UI theme sprite background image, it is easier to use the icon property.The span element can be added automatically by the widget, or an existing element can be used, if it has a k-sprite CSS class applied.
///
///
///
/// The widget configuration options
///
};
kendo.ui.ButtonGroup = function() { };
kendo.ui.ButtonGroup.prototype = {
badge: function(button,value) {
///
///
///
/// The target button specified either as a jQuery selector/object or as an button index.
/// The target value to be set or false to be removed.
/// the badge value if invoked without parameters, otherwise the ButtonGroup object.
},
current: function() {
///
/// Get the currently selected Button.
///
/// the jQuery object representing the currently selected button.
},
destroy: function() {
///
/// Prepares the ButtonGroup for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enables or disables the widget.
///
/// A boolean flag that indicates whether the widget should be enabled or disabled.
},
select: function(li) {
///
/// Select a Button.
///
/// LI element or index of the Button.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoButtonGroup = function() {
///
/// Returns a reference to the kendo.ui.ButtonGroup widget, instantiated on the selector.
///
/// The kendo.ui.ButtonGroup instance (if present).
};
$.fn.kendoButtonGroup = function(options) {
///
/// Instantiates a kendo.ui.ButtonGroup widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
enable - Boolean (default: true)
///
Defines if the widget is initially enabled or disabled. By default, it is enabled.
///
///
index - Number
///
Defines the initially selected Button (zero based index).
///
///
selection - String (default: default "single")
///
Defines the selection type.
///
///
items - Array
///
A JavaScript array that contains the ButtonGroup's items configuration.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Calendar = function() { };
kendo.ui.Calendar.prototype = {
current: function() {
///
/// Gets currently focused date.
///
/// The current focused date shown in the calendar.
},
destroy: function() {
///
/// Prepares the Calendar for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
max: function(value) {
///
/// Gets/Sets the max value of the calendar.
///
/// The max date to set.
/// The max value of the calendar.
},
min: function(value) {
///
/// Gets/Sets the min value of the calendar.
///
/// The min date to set.
/// The min value of the calendar.
},
navigate: function(value,view) {
///
/// Navigates to view.
///
/// Desired date.
/// Desired view.
},
navigateDown: function(value) {
///
/// Navigates to the lower view.
///
/// Desired date.
},
navigateToFuture: function() {
///
/// Navigates to the future.
///
},
navigateToPast: function() {
///
/// Navigates to the past.
///
},
navigateUp: function() {
///
/// Navigates to the upper view.
///
},
selectDates: function() {
///
/// Gets/Sets the selected dates for the calendar.
///
},
value: function(value) {
///
/// Gets/Sets the value of the calendar.
///
/// The date to set.
/// The value of the calendar.
},
view: function() {
///
/// Gets an instance of the current view used by the calendar.
///
/// The instance of the current view used by the calendar.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoCalendar = function() {
///
/// Returns a reference to the kendo.ui.Calendar widget, instantiated on the selector.
///
/// The kendo.ui.Calendar instance (if present).
};
$.fn.kendoCalendar = function(options) {
///
/// Instantiates a kendo.ui.Calendar widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
culture - String (default: "en-US")
///
Specifies the culture info used by the widget.
///
///
dates - Array
///
Specifies a list of dates, which will be passed to the month template.
///
///
depth - String
///
Specifies the navigation depth. The following settings are available for the depth value: "month" - Shows the days of the month.; "year" - Shows the months of the year.; "decade" - Shows the years of the decade. or "century" - Shows the decades from the century..
///
///
disableDates - Array|Function (default: null)
///
An array or function that will be used to determine which dates to be disabled in the calendar.
///
///
footer - String|Function
///
The template which renders the footer. If false, the footer will not be rendered.
///
///
format - String (default: "M/d/yyyy")
///
Specifies the format, which is used to parse value set with value() method.
///
///
max - Date (default: Date(2099, 11, 31))
///
Specifies the maximum date, which the calendar can show.
///
///
messages - Object
///
Allows localization of the strings that are used in the widget.
///
///
min - Date (default: Date(1900, 0, 1))
///
Specifies the minimum date, which the calendar can show.
///
///
month - Object
///
Templates for the cells rendered in "month" view.
///
///
selectable - String (default: "single")
///
By default user is able to select a single date. The property can also be set to "multiple" in order the multiple date selection to be enabled. More information about multiple selection can be found in the Selection article.
///
///
selectDates - Array (default: [])
///
Specifies which dates to be selected when the calendar is initialized.
///
///
weekNumber - Boolean (default: false)
///
If set to true a week of the year will be shown on the left side of the calendar.
///
///
start - String (default: "month")
///
Specifies the start view. The following settings are available for the start value: "month" - Shows the days of the month.; "year" - Shows the months of the year.; "decade" - Shows the years of the decade. or "century" - Shows the decades from the century..
///
///
value - Date (default: null)
///
Specifies the selected date.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Chat = function() { };
kendo.ui.Chat.prototype = {
getUser: function() {
///
/// Gets the user information that is associated with the Chat instance.
///
/// - The object with the user information. Contains the auto-generated id, name, and iconUrl.
},
postMessage: function(message) {
///
/// Triggers the post event with the message and renders it inside the widget.
///
/// The text that will be sent and rendered.
},
renderAttachments: function(options,sender) {
///
/// Renders an attachment inside the Chat. The attachments are rendered through a predefined or custom template that is registered with the Chat.
///
/// The configuration options for the attachment.
/// The configuration object which contains information about the sender of the message bubble. Determines where the message will be rendered.
},
renderMessage: function(message,sender) {
///
/// Renders a message bubble inside the Chat.
///
/// The configuration options for the message.
/// The configuration object which contains information about the sender of the message bubble. Determines where the message will be rendered.
},
renderSuggestedActions: function(suggestedActions) {
///
/// Renders an array of suggested actions inside the chat.
///
/// An array of suggestedAction objects.
},
renderUserTypingIndicator: function(sender) {
///
/// Renders the typing indicator for the specified user inside the chat. If a Chat indicator is already rendered, renderUserTypingIndicator will add the user to the typing list.
///
/// The configuration object which contains information about the sender of the typing indicator bubble.
},
clearUserTypingIndicator: function(sender) {
///
/// Clears the typing indicator for the specified user inside the chat. If a typing indicator is rendered for multiple users, clearUserTypingIndicator will remove the name of the specified user from the typing list.
///
/// The configuration object which contains information about the sender of the typing indicator bubble.
},
removeTypingIndicator: function() {
///
/// Removes the typing indicator bubble from the chat. If a typing indicator is rendered for multiple users, removeTypingIndicator will remove the entire bubble.
///
},
toggleToolbar: function(skipEffects) {
///
/// Toggles the Chat toolbar.
///
/// If set to true, an animation will not play.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoChat = function() {
///
/// Returns a reference to the kendo.ui.Chat widget, instantiated on the selector.
///
/// The kendo.ui.Chat instance (if present).
};
$.fn.kendoChat = function(options) {
///
/// Instantiates a kendo.ui.Chat widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
messages - Object
///
Allows localization of the strings that are used in the widget.
///
///
user - Object
///
Configures the user information of the Chat.
///
///
toolbar - Object
///
Configures the toolbar of the Chat.
///
///
///
/// The widget configuration options
///
};
kendo.ui.ColorPalette = function() { };
kendo.ui.ColorPalette.prototype = {
value: function(color) {
///
/// Get or set the selected color. If no argument is given, this returns the currently selected color as a string in format #FFFFFF.If one argument is given, it selects the new color and updates the UI. The argument can be a string in hex, rgb or rgba format, or a kendo.Color object object.
///
///
/// the string representation of the current color.
},
color: function(color) {
///
/// Get or set the selected color. If no argument is given, this returns the currently selected color as a kendo.Color object.
///
/// The color that should be set as the current value
/// the current value
},
enable: function(enable) {
///
/// Enables or disables the widget.
///
/// Whether the widget should be enabled (true) or disabled (false). If not specified, the method will enable the widget.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoColorPalette = function() {
///
/// Returns a reference to the kendo.ui.ColorPalette widget, instantiated on the selector.
///
/// The kendo.ui.ColorPalette instance (if present).
};
$.fn.kendoColorPalette = function(options) {
///
/// Instantiates a kendo.ui.ColorPalette widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
palette - String|Array (default: "basic")
///
Specifies the color palette to display. It can be a string with comma-separated colors in hex representation, an array of kendo.Color object objects or of strings that parseColor understands. As a shortcut, you can pass "basic" to get the simple palette (this is the default) or "websafe" to get the Web-safe palette.
///
///
columns - Number (default: 10)
///
The number of columns to display. When you use the "websafe" palette, this will automatically default to 18.
///
///
tileSize - Number (default: 14)
///
The size of a color cell.
///
///
tileSize - Object (default: 14)
///
The size of a color cell.
///
///
value - String (default: null)
///
Specifies the initially selected color.
///
///
///
/// The widget configuration options
///
};
kendo.ui.ColorPicker = function() { };
kendo.ui.ColorPicker.prototype = {
close: function() {
///
/// Closes the popup.
///
},
open: function() {
///
/// Opens the popup element with the color selector.
///
},
toggle: function() {
///
/// Toggles the popup.
///
},
value: function(color) {
///
/// Get or set the selected color. If no argument is given, this returns the currently selected color as a string in format #FFFFFF when the opacity option is off, or rgba(255, 255, 255, 1) when opacity is requested.If one argument is given, it selects the new color and updates the UI. The argument can be a string in hex, rgb or rgba format, or a Color object. This does not trigger the "change" event.
///
///
/// the string representation of the current color.
},
color: function(color) {
///
/// Get or set the selected color. If no argument is given, this returns the currently selected color as a kendo.Color object.
///
/// The color that should be set as the current value
/// the current value
},
enable: function(enable) {
///
/// Enables or disables the widget.
///
/// Whether the widget should be enabled (true) or disabled (false). If not specified, the method will enable the widget.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoColorPicker = function() {
///
/// Returns a reference to the kendo.ui.ColorPicker widget, instantiated on the selector.
///
/// The kendo.ui.ColorPicker instance (if present).
};
$.fn.kendoColorPicker = function(options) {
///
/// Instantiates a kendo.ui.ColorPicker widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
buttons - Boolean (default: true)
///
Specifies whether the widget should display the Apply / Cancel buttons.Applicable only for the HSV selector, when a pallete is not specified.
///
///
clearButton - Boolean (default: false)
///
Specifies whether the widget should display the 'Clear color' button.Applicable only for the HSV selector, when a pallete is not specified.
///
///
columns - Number
///
The number of columns to show in the color dropdown when a pallete is specified. This is automatically initialized for the "basic" and "websafe" palettes. If you use a custom palette then you can set this to some value that makes sense for your colors.
///
///
tileSize - Number (default: 14)
///
The size of a color cell.
///
///
tileSize - Object (default: 14)
///
The size of a color cell.
///
///
messages - Object
///
Allows localization of the strings that are used in the widget.
///
///
palette - String|Array (default: null)
///
When a non-null palette argument is supplied, the drop-down will be a simple color picker that lists the colors. The following are supported: "basic" -- displays 20 basic colors; "websafe" -- display the "web-safe" color palette or otherwise, pass a string with colors in HEX representation separated with commas, or an array of colors, and it will display that palette instead. If you pass an array it can contain strings supported by parseColor orColor objects.. If palette is missing or null, the widget will display the HSV selector.
///
///
opacity - Boolean (default: false)
///
Only for the HSV selector. If true, the widget will display the opacity slider. Note that currently in HTML5 the does not support opacity.
///
///
preview - Boolean (default: true)
///
Only applicable for the HSV selector.Displays the color preview element, along with an input field where the end user can paste a color in a CSS-supported notation.
///
///
toolIcon - String (default: null)
///
A CSS class name to display an icon in the color picker button. If specified, the HTML for the element will look like this:
///
///
value - String (default: null)
///
The initially selected color. Note that when initializing the widget from an element, the initial color will be decided by the field instead.
///
///
///
/// The widget configuration options
///
};
kendo.ui.ComboBox = function() { };
kendo.ui.ComboBox.prototype = {
close: function() {
///
/// Closes the widget popup.
///
},
dataItem: function(index) {
///
/// Returns the data item at the specified index. If the index is not specified, the selected index will be used.
///
/// The zero-based index of the data record.
/// The raw data record. Returns undefined if no data.
},
destroy: function() {
///
/// Prepares the ComboBox for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enables or disables the widget.
///
/// If set to true the widget will be enabled. If set to false the widget will be disabled.
},
focus: function() {
///
/// Focuses the widget.
///
},
items: function() {
///
/// Obtains an Array of the DOM elements, which correspond to the data items from the Kendo UI DataSource view.
///
/// The currently rendered dropdown list items ( elements).
},
open: function() {
///
/// Opens the popup.
///
},
readonly: function(readonly) {
///
/// Toggles the readonly state of the widget. When the widget is readonly it doesn't allow user input.
///
/// If set to true the widget will not allow user input. If set to false the widget will allow user input.
},
refresh: function() {
///
/// Refresh the popup by rendering all items again.
///
},
search: function(word) {
///
/// Searches the data source for the provided value and displays any matches as suggestions.
///
/// The filter value.
},
select: function(li) {
///
/// Gets or sets the selected item. Selects the item provided as an argument and updates the value and text of the widget.
///
/// A string, DOM element or jQuery object which represents the item to be selected. A string is treated as a jQuery selector. A number representing the index of the item or function predicate which returns the correct data item.
/// The index of the selected item, if called with no parameters. If a custom value is entered, the returned selected index is -1. If called with a parameter as a setter.
},
setDataSource: function(dataSource) {
///
/// Sets the dataSource of an existing ComboBox and rebinds it.
///
///
},
suggest: function(value) {
///
/// Sets the value of the widget to the specified argument and visually selects the text.
///
/// Characters to force a suggestion.
},
text: function(text) {
///
/// Gets or sets the text of the ComboBox. Widget will select the item with same text. If there are no matches then the text will be considered as a custom value of the widget.
///
/// The text to set.
/// The text of the ComboBox.
},
toggle: function(toggle) {
///
/// Opens or closes the widget popup.
///
/// Defines the whether to open/close the drop-down list.
},
value: function(value) {
///
/// Gets or sets the value of the ComboBox.
///
/// The value to set.
/// The value of the ComboBox.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoComboBox = function() {
///
/// Returns a reference to the kendo.ui.ComboBox widget, instantiated on the selector.
///
/// The kendo.ui.ComboBox instance (if present).
};
$.fn.kendoComboBox = function(options) {
///
/// Instantiates a kendo.ui.ComboBox widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation - Object
///
Configures the opening and closing animations of the suggestion popup. Setting the animation option to false will disable the opening and closing animations. As a result the suggestion popup will open and close instantly.
///
///
autoBind - Boolean (default: true)
///
Controls whether to bind the widget to the data source on initialization.
///
///
autoWidth - Boolean
///
If set to true, the widget automatically adjusts the width of the popup element and does not wrap up the item label.
///
///
cascadeFrom - String
///
Use it to set the Id of the parent ComboBox widget.Help topic showing how cascading functionality works
///
///
cascadeFromField - String
///
Defines the field to be used to filter the data source. If not defined, it is set to a field with the same name as the parent's dataValueField option.Help topic showing how cascading functionality works
///
///
cascadeFromParentField - String
///
Defines the parent field to be used to retain value from. This value will be used further to filter the dataSource. If not defined the value from the parent's dataValueField will be used.
///
///
clearButton - Boolean (default: true)
///
Unless this options is set to false, a button will appear when hovering the widget. Clicking that button will reset the widget's value and will trigger the change event.
///
///
dataSource - Object|Array|kendo.data.DataSource
///
The data source of the widget which is used to display a list of values. Can be a JavaScript object which represents a valid data source configuration, a JavaScript array or an existing kendo.data.DataSource instance.If the dataSource option is set to a JavaScript object or array the widget will initialize a new kendo.data.DataSource instance using that value as data source configuration.If the dataSource option is an existing kendo.data.DataSource instance the widget will use that instance and will not initialize a new one.
///
///
dataTextField - String (default: "")
///
The field of the data item that provides the text content of the list items. The widget will filter the data source based on this field.
///
///
dataValueField - String (default: "")
///
The field of the data item that provides the value of the widget.
///
///
delay - Number (default: 200)
///
The delay in milliseconds between a keystroke and when the widget displays the popup.
///
///
enable - Boolean (default: true)
///
If set to false the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input.
///
///
enforceMinLength - Boolean (default: false)
///
If set to true the widget will not show all items when the text of the search input cleared. By default the widget shows all items when the text of the search input is cleared. Works in conjunction with minLength.
///
///
filter - String (default: "none")
///
The filtering method used to determine the suggestions for the current value. Filtration is turned off by default, and can be performed over string values only (either the widget's data has to be an array of strings, or over the field, configured in the dataTextField option). The supported filter values are startswith, endswith and contains.
///
///
fixedGroupTemplate - String|Function
///
The template used to render the fixed header group. By default the widget displays only the value of the current group.
///
///
footerTemplate - String|Function
///
The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.
///
///
groupTemplate - String|Function
///
The template used to render the groups. By default the widget displays only the value of the group.
///
///
height - Number (default: 200)
///
The height of the suggestion popup in pixels. The default value is 200 pixels.
///
///
highlightFirst - Boolean (default: true)
///
If set to true the first suggestion will be automatically highlighted.
///
///
ignoreCase - Boolean (default: true)
///
If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default.
///
///
index - Number (default: -1)
///
The index of the initially selected item. The index is 0 based.
///
///
minLength - Number (default: 1)
///
The minimum number of characters the user must type before a search is performed. Set to higher value than 1 if the search could match a lot of items.
///
///
noDataTemplate - String|Function (default: "NO DATA FOUND.")
///
The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound.
///
///
placeholder - String (default: "")
///
The hint displayed by the widget when it is empty. Not set by default.
///
///
popup - Object
///
The options that will be used for the popup initialization. For more details about the available options refer to Popup documentation.
///
///
suggest - Boolean (default: false)
///
If set to true the widget will automatically use the first suggestion as its value.
///
///
syncValueAndText - Boolean (default: true)
///
When set to true the widget will automatically set selected value to the typed custom text. Set the option to false to clear the selected value but keep the custom text.
///
///
headerTemplate - String|Function
///
Specifies a static HTML content, which will be rendered as a header of the popup element.
///
///
template - String|Function
///
The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
///
///
text - String (default: "")
///
The text of the widget used when the autoBind is set to false.
///
///
value - String (default: "")
///
The value of the widget.
///
///
valuePrimitive - Boolean (default: false)
///
Specifies the value binding behavior for the widget when the initial model value is null. If set to true, the View-Model field will be updated with the selected item value field. If set to false, the View-Model field will be updated with the selected item.
///
///
virtual - Boolean (default: false)
///
Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization.
///
///
virtual - Object (default: false)
///
Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Confirm = function() { };
kendo.ui.Confirm.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoConfirm = function() {
///
/// Returns a reference to the kendo.ui.Confirm widget, instantiated on the selector.
///
/// The kendo.ui.Confirm instance (if present).
};
$.fn.kendoConfirm = function(options) {
///
/// Instantiates a kendo.ui.Confirm widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
messages - Object
///
Defines the text of the labels that are shown within the confirm dialog. Used primarily for localization.
///
///
///
/// The widget configuration options
///
};
kendo.ui.ContextMenu = function() { };
kendo.ui.ContextMenu.prototype = {
append: function(item,referenceItem) {
///
/// Appends an item to a ContextMenu in the specified referenceItem's sub menu (or the root ContextMenu if not specified).
///
/// Item to be appended, specified as a JSON object. An array of objects can also be passed.
/// A reference item to append the new item in. If omitted, the new item will be appended to the as a root item.
/// Returns the ContextMenu object to support chaining.
},
close: function(element) {
///
/// Closes the ContextMenu. This method can be prevented to stop the closure.
///
/// If called without arguments, will close the ContextMenu. If passed an item, it will be closed (if opened).
/// Returns the ContextMenu object to support chaining.
},
destroy: function() {
///
/// Safely removes the ContextMenu from the DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.If a new ContextMenu widget should be created afterwards, use a new for that, as the old one no longer exists.
///
},
enable: function(element,enable) {
///
/// Enables or disables an item of a ContextMenu. This can optionally be accomplished on initialization by setting the disabled="disabled" on the desired menu item html element.
///
/// Target element
/// Desired state
/// Returns the ContextMenu object to support chaining.
},
findByUid: function(uid) {
///
/// Returns the ContextMenu item by the dataItem's uid.
///
/// The uid of the data item.
/// the item found.
},
insertAfter: function(item,referenceItem) {
///
/// Inserts an item into a ContextMenu after the specified referenceItem.
///
/// Target item, specified as a JSON object. Can also handle an array of such objects.
/// A reference item to insert the new item after.
/// Returns the ContextMenu object to support chaining.
},
insertBefore: function(item,referenceItem) {
///
/// Inserts an item into a ContextMenu before the specified referenceItem.
///
/// Target item, specified as a JSON object. Can also handle an array of such objects.
/// A reference item to insert the new item before
/// Returns the ContextMenu object to support chaining.
},
open: function(x,y) {
///
/// Shows the ContextMenu at the specified coordinates in pixels or aligned to the specified anchor. If passed an item, it will be opened. This method can be prevented to stop the ContextMenu from opening.
///
/// X coordinate in pixels or the anchor element to which to align. If passed an item - jQuery object or element - it will be opened.
/// Y coordinate in pixels. If not specified, ContextMenu will assume the first parameter is an anchor element.
/// Returns the ContextMenu object to support chaining.
},
remove: function(element) {
///
/// Removes a specified item(s) from a ContextMenu.
///
/// Target item selector.
/// Returns the ContextMenu object to support chaining.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoContextMenu = function() {
///
/// Returns a reference to the kendo.ui.ContextMenu widget, instantiated on the selector.
///
/// The kendo.ui.ContextMenu instance (if present).
};
$.fn.kendoContextMenu = function(options) {
///
/// Instantiates a kendo.ui.ContextMenu widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
alignToAnchor - Boolean (default: false)
///
Specifies that ContextMenu should be shown aligned to the target or the filter element if specified.
///
///
animation - Boolean
///
A collection of Animation objects, used to change default animations. A value of false will disable all animations in the widget. is not a valid configuration.Available animations for the ContextMenu are listed below. Each animation has a reverse options which is used for the close effect by default, but can be over-ridden by setting the close animation. Each animation also has a direction which can be set off the animation (i.e. slideIn:Down).
///
///
animation - Object
///
A collection of Animation objects, used to change default animations. A value of false will disable all animations in the widget. is not a valid configuration.Available animations for the ContextMenu are listed below. Each animation has a reverse options which is used for the close effect by default, but can be over-ridden by setting the close animation. Each animation also has a direction which can be set off the animation (i.e. slideIn:Down).
///
///
appendTo - String|jQuery (default: document.body)
///
The DOM element to which the ContextMenu will be appended. The element needs to be relatively positioned.
///
///
closeOnClick - Boolean (default: true)
///
Specifies that sub menus should close after item selection (provided they won't navigate).
///
///
copyAnchorStyles - Boolean (default: true)
///
Copies and uses the styles from the anchor.
///
///
dataSource - Object|Array|kendo.data.HierarchicalDataSource
///
The data source of the widget which is used to render its items. Can be a JSON object/Array/kendo.data.HierarchicalDataSource that contains an item or an Array of items to be rendered. Refer to the example below for a list of the supported properties.
///
///
dataTextField - String
///
Sets the field of the data item that provides the text of the ContextMenu items.
///
///
dataUrlField - String
///
Sets the field of the data item that provides the url of the ContextMenu items.
///
///
dataSpriteCssClassField - String
///
Sets the field of the data item that provides the sprite css class of the ContextMenu items.
///
///
dataImageUrlField - String
///
Sets the field of the data item that provides the image url of the ContextMenu items.
///
///
dataContentField - String
///
Sets the field of the data item that provides the content of the ContextMenu items.
///
///
direction - String (default: "default")
///
Specifies ContextMenu's sub menu opening direction. Can be "top", "bottom", "left", "right". The example below will initialize the sub menus to open to the left.
///
///
filter - String
///
Specifies ContextMenu filter selector - the ContextMenu will only be shown on items that satisfy the provided selector.
///
///
hoverDelay - Number (default: 100)
///
Specifies the delay in ms before the sub menus are opened/closed - used to avoid accidental closure on leaving.
///
///
orientation - String (default: "vertical")
///
Root menu orientation. Could be horizontal or vertical.
///
///
popupCollision - String
///
Specifies how ContextMenu should adjust to screen boundaries. By default the strategy is "fit" for a sub menu with a horizontal parent or the root menu, meaning it will move to fit in screen boundaries in all directions, and "fit flip" for a sub menu with vertical parent, meaning it will fit vertically and flip over its parent horizontally. You can also switch off the screen boundary detection completely if you set the popupCollision to false.
///
///
scrollable - Boolean (default: false)
///
If enabled, the ContextMenu displays buttons that scroll the items when they cannot fit the viewport height. By default, scrolling is disabled.
///
///
scrollable - Object (default: false)
///
If enabled, the ContextMenu displays buttons that scroll the items when they cannot fit the viewport height. By default, scrolling is disabled.
///
///
showOn - String
///
Specifies the event or events on which ContextMenu should open. By default ContextMenu will show on contextmenu event on desktop and hold event on touch devices. Could be any pointer/mouse/touch event, also several, separated by spaces.
///
///
target - String|jQuery (default: "body")
///
Specifies the element on which ContextMenu should open. The default element is the document body.
///
///
///
/// The widget configuration options
///
};
kendo.ui.DateInput = function() { };
kendo.ui.DateInput.prototype = {
destroy: function() {
///
/// Prepares the DateInput for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enable/Disable the DateInput widget.
///
/// The argument, which defines whether to enable/disable the DateInput.
},
readonly: function(readonly) {
///
/// Toggles the readonly state of the widget. When the widget is readonly it doesn't allow user input.
///
/// The argument, which defines whether the DateInput should be readonly or editable.
},
max: function(value) {
///
/// Gets/Sets the max value of the DateInput.
///
/// The max date to set.
/// The max value of the DateInput.
},
min: function(value) {
///
/// Gets/Sets the min value of the DateInput.
///
/// The min date to set.
/// The min value of the DateInput.
},
setOptions: function(options) {
///
/// Changes the initial DateInput configuration.
///
/// The new configuration options.
},
value: function(value) {
///
/// Gets/Sets the value of the DateInput.
///
/// The value to set.
/// The value of the DateInput.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDateInput = function() {
///
/// Returns a reference to the kendo.ui.DateInput widget, instantiated on the selector.
///
/// The kendo.ui.DateInput instance (if present).
};
$.fn.kendoDateInput = function(options) {
///
/// Instantiates a kendo.ui.DateInput widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
format - String (default: "M/d/yyyy")
///
Specifies the format, which is used to format the value of the DateInput displayed in the input. The format also will be used to parse the input.
///
///
max - Date (default: Date(2099, 11, 31))
///
Specifies the maximum date which can be entered in the input.
///
///
min - Date (default: Date(1900, 0, 1))
///
Specifies the minimum date that which be entered in the input.
///
///
value - Date (default: null)
///
Specifies the selected date.
///
///
messages - Object
///
The messages that DateInput uses. Use it to customize or localize the placeholders of each date/time part.
///
///
///
/// The widget configuration options
///
};
kendo.ui.DatePicker = function() { };
kendo.ui.DatePicker.prototype = {
close: function() {
///
/// Closes the calendar.
///
},
destroy: function() {
///
/// Prepares the DatePicker for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enable/Disable the DatePicker widget.
///
/// The argument, which defines whether to enable/disable the DatePicker.
},
readonly: function(readonly) {
///
/// Toggles the readonly state of the widget. When the widget is readonly it doesn't allow user input.
///
/// The argument, which defines whether the DatePicker should be readonly or editable.
},
max: function(value) {
///
/// Gets/Sets the max value of the DatePicker.
///
/// The max date to set.
/// The max value of the DatePicker.
},
min: function(value) {
///
/// Gets/Sets the min value of the DatePicker.
///
/// The min date to set.
/// The min value of the DatePicker.
},
open: function() {
///
/// Opens the calendar.
///
},
setOptions: function(options) {
///
/// Changes the initial DatePicker configuration.
///
/// The new configuration options.
},
value: function(value) {
///
/// Gets/Sets the value of the DatePicker.
///
/// The value to set.
/// The value of the DatePicker.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDatePicker = function() {
///
/// Returns a reference to the kendo.ui.DatePicker widget, instantiated on the selector.
///
/// The kendo.ui.DatePicker instance (if present).
};
$.fn.kendoDatePicker = function(options) {
///
/// Instantiates a kendo.ui.DatePicker widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation - Boolean
///
Configures the opening and closing animations of the calendar popup. Setting the animation option to false will disable the opening and closing animations. As a result the calendar popup will open and close instantly. is not a valid configuration.
///
///
animation - Object
///
Configures the opening and closing animations of the calendar popup. Setting the animation option to false will disable the opening and closing animations. As a result the calendar popup will open and close instantly. is not a valid configuration.
///
///
ARIATemplate - String (default: "Current focused date is #=kendo.toString(data.current, 'D'#"))
///
Specifies a template used to populate value of the aria-label attribute.
///
///
culture - String (default: "en-US")
///
Specifies the culture info used by the widget.
///
///
dateInput - Boolean (default: false)
///
Specifies if the DatePicker will use DateInput for editing value
///
///
dates - Array
///
Specifies a list of dates, which will be passed to the month template.
///
///
depth - String
///
Specifies the navigation depth. The following settings are available for the depth value: "month" - Shows the days of the month.; "year" - Shows the months of the year.; "decade" - Shows the years of the decade. or "century" - Shows the decades from the century..
///
///
disableDates - Array|Function (default: null)
///
An array or function that will be used to determine which dates to be disabled for selection by the widget.
///
///
footer - String|Function
///
The template which renders the footer of the calendar. If false, the footer will not be rendered.
///
///
format - String (default: "M/d/yyyy")
///
Specifies the format, which is used to format the value of the DatePicker displayed in the input. The format also will be used to parse the input.For more information on date and time formats please refer to Date Formatting.
///
///
max - Date (default: Date(2099, 11, 31))
///
Specifies the maximum date, which the calendar can show.
///
///
min - Date (default: Date(1900, 0, 1))
///
Specifies the minimum date that the calendar can show.
///
///
month - Object
///
Templates for the cells rendered in the calendar "month" view.
///
///
weekNumber - Boolean (default: false)
///
If set to true a week of the year will be shown on the left side of the calendar. It is possible to define a template in order to customize what will be displayed.
///
///
parseFormats - Array
///
Specifies a list of date formats used to parse the value set with value() method or by direct user input. If not set the value of the format will be used. Note that the format option is always used during parsing.
///
///
start - String (default: "month")
///
Specifies the start view. The following settings are available for the start value: "month" - Shows the days of the month.; "year" - Shows the months of the year.; "decade" - Shows the years of the decade. or "century" - Shows the decades from the century..
///
///
value - Date (default: null)
///
Specifies the selected date.
///
///
///
/// The widget configuration options
///
};
kendo.ui.DateRangePicker = function() { };
kendo.ui.DateRangePicker.prototype = {
close: function() {
///
/// Closes the calendar.
///
},
destroy: function() {
///
/// Prepares the DateRangePicker for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enable/Disable the DateRangePicker widget.
///
/// The argument, which defines whether to enable/disable the DateRangePicker.
},
readonly: function(readonly) {
///
/// Toggles the readonly state of the widget. When the widget is readonly it doesn't allow user input.
///
/// The argument, which defines whether the DateRangePicker should be readonly or editable.
},
max: function(value) {
///
/// Gets/Sets the max value of the DateRangePicker.
///
/// The max date to set.
/// The max value of the DateRangePicker.
},
min: function(value) {
///
/// Gets/Sets the min value of the DateRangePicker.
///
/// The min date to set.
/// The min value of the DateRangePicker.
},
open: function() {
///
/// Opens the calendar.
///
},
range: function(range) {
///
/// Gets/Sets the selected range for the DateRangePicker.
///
/// The range to set. It should have a start and end properties with the respective dates.
/// The selected range of the DateRangePicker. The object has a start and end properties.
},
setOptions: function(options) {
///
/// Changes the initial DateRangePicker configuration.
///
/// The new configuration options.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDateRangePicker = function() {
///
/// Returns a reference to the kendo.ui.DateRangePicker widget, instantiated on the selector.
///
/// The kendo.ui.DateRangePicker instance (if present).
};
$.fn.kendoDateRangePicker = function(options) {
///
/// Instantiates a kendo.ui.DateRangePicker widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
ARIATemplate - String (default: "Current focused date is #=kendo.toString(data.current, 'D'#"))
///
Specifies a template used to populate value of the aria-label attribute.
///
///
culture - String (default: "en-US")
///
Specifies the culture info used by the widget.
///
///
dates - Array
///
Specifies a list of dates, which will be passed to the month template.
///
///
depth - String (default: "month")
///
Specifies the navigation depth. The following settings are available for the depth value: "month" - Shows the days of the month. (default value); "year" - Shows the months of the year.; "decade" - Shows the years of the decade. or "century" - Shows the decades from the century..
///
///
disableDates - Array|Function (default: null)
///
An array or function that will be used to determine which dates to be disabled for selection by the widget.
///
///
endField - String (default: "")
///
Specifies the end field name for model binding.
///
///
footer - String|Function
///
The template which renders the footer of the calendar. If false, the footer will not be rendered.
///
///
format - String (default: "M/d/yyyy")
///
Specifies the format, which is used to format the value of the DateRangePicker displayed in the input. The format also will be used to parse the input.For more information on date and time formats please refer to Date Formatting.
///
///
max - Date (default: Date(2099, 11, 31))
///
Specifies the maximum date, which the calendar can show.
///
///
messages - Object
///
Allows localization of the strings that are used in the widget.
///
///
min - Date (default: Date(1900, 0, 1))
///
Specifies the minimum date that the calendar can show.
///
///
month - Object
///
Templates for the cells rendered in the calendar "month" view.
///
///
labels - Boolean (default: true)
///
Determines if the labels for the inputs will be visible.
///
///
weekNumber - Boolean (default: false)
///
If set to true a week of the year will be shown on the left side of the calendar. It is possible to define a template in order to customize what will be displayed.
///
///
range - Object
///
Configures the Kendo UI DateRangePicker range settings.
///
///
start - String (default: "month")
///
Specifies the start view. The following settings are available for the start value: "month" - Shows the days of the month.; "year" - Shows the months of the year.; "decade" - Shows the years of the decade. or "century" - Shows the decades from the century..
///
///
startField - String (default: "")
///
Specifies the start field name for model binding.
///
///
///
/// The widget configuration options
///
};
kendo.ui.DateTimePicker = function() { };
kendo.ui.DateTimePicker.prototype = {
close: function(view) {
///
/// Closes the calendar or the time drop-down list.
///
/// The view of the DateTimePicker, expressed as a string. Available views are "time" and "date".
},
destroy: function() {
///
/// Prepares the DateTimePicker for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enables or disables a DateTimePicker.
///
/// Enables (true or undefined) or disables (false) a DateTimePicker.
},
readonly: function(readonly) {
///
/// Toggles the readonly state of the widget. When the widget is readonly it doesn't allow user input.
///
/// The argument, which defines whether the DateTimePicker should be readonly or editable.
},
max: function(value) {
///
/// Gets or sets the maximum value of the DateTimePicker.
///
/// The maximum time value to set for a DateTimePicker, expressed as a Date object or as a string.
/// The maximum time value of a DateTimePicker.
},
min: function(value) {
///
/// Gets or sets the minimum value of the DateTimePicker.
///
/// The minimum time value to set for a DateTimePicker, expressed as a Date object or as a string.
/// The minimum time value of a DateTimePicker.
},
open: function(view) {
///
/// Opens the calendar or the time drop-down list.
///
/// The view of the DateTimePicker, expressed as a string. Available views are "time" and "date".
},
setOptions: function(options) {
///
///
///
/// The new configuration options.
},
toggle: function(view) {
///
/// Toggles the calendar or the time drop-down list.
///
/// The view of the DateTimePicker, expressed as a string. Available views are "time" and "date".
},
value: function(value) {
///
/// Gets or sets the value of the DateTimePicker.
///
/// The time value to set for a DateTimePicker, expressed as a Date object or as a string.
/// The time value of a DateTimePicker.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDateTimePicker = function() {
///
/// Returns a reference to the kendo.ui.DateTimePicker widget, instantiated on the selector.
///
/// The kendo.ui.DateTimePicker instance (if present).
};
$.fn.kendoDateTimePicker = function(options) {
///
/// Instantiates a kendo.ui.DateTimePicker widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation - Boolean
///
Configures the opening and closing animations of the popups. Setting the animation option to false will disable the opening and closing animations. As a result the popup will open and close instantly. is not a valid configuration.
///
///
animation - Object
///
Configures the opening and closing animations of the popups. Setting the animation option to false will disable the opening and closing animations. As a result the popup will open and close instantly. is not a valid configuration.
///
///
ARIATemplate - String (default: "Current focused date is #=kendo.toString(data.current, 'G'#"))
///
Specifies a template used to populate value of the aria-label attribute.
///
///
culture - String (default: "en-US")
///
Specifies the culture info used by the widget.
///
///
dateInput - Boolean (default: false)
///
Specifies if the DateTimePicker will use DateInput for editing value
///
///
dates - Array
///
Specifies a list of dates, which will be passed to the month template of the DateView. All dates, which match the date portion of the selected date will be used to re-bind the TimeView.
///
///
depth - String
///
Specifies the navigation depth of the calendar. The following settings are available for the depth value: "month" - Shows the days of the month.; "year" - Shows the months of the year.; "decade" - Shows the years of the decade. or "century" - Shows the decades from the century..
///
///
disableDates - Array|Function (default: null)
///
An array or function that will be used to determine which dates to be disabled for selection by the widget.
///
///
footer - String
///
The template which renders the footer of the calendar. If false, the footer will not be rendered.
///
///
format - String (default: "M/d/yyyy h:mm tt")
///
Specifies the format, which is used to format the value of the DateTimePicker displayed in the input. The format also will be used to parse the input.For more information on date and time formats please refer to Date Formatting.
///
///
interval - Number (default: 30)
///
Specifies the interval, between values in the popup list, in minutes.
///
///
max - Date (default: Date(2099, 11, 31))
///
Specifies the maximum date, which the calendar can show.
///
///
min - Date (default: Date(1900, 0, 1))
///
Specifies the minimum date that the calendar can show.
///
///
month - Object
///
Templates for the cells rendered in the calendar "month" view.
///
///
weekNumber - Boolean (default: false)
///
If set to true a week of the year will be shown on the left side of the calendar. It is possible to define a template in order to customize what will be displayed.
///
///
parseFormats - Array
///
Specifies the formats, which are used to parse the value set with value() method or by direct input. If not set the value of the options.format and options.timeFormat will be used. Note that value of the format option is always used. The timeFormat value also will be used if defined.
///
///
start - String (default: "month")
///
Specifies the start view of the calendar. The following settings are available for the start value: "month" - Shows the days of the month.; "year" - Shows the months of the year.; "decade" - Shows the years of the decade. or "century" - Shows the decades from the century..
///
///
timeFormat - String (default: "h:mm tt")
///
Specifies the format, which is used to format the values in the time drop-down list.
///
///
value - Date (default: null)
///
Specifies the selected value.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Dialog = function() { };
kendo.ui.Dialog.prototype = {
close: function() {
///
/// Closes a Dialog.
///
/// Returns the dialog object to support chaining.
},
content: function(content) {
///
/// Gets or set the content of a dialog. Supports chaining when used as a setter.
///
/// The content of the Dialog. Can be an HTML string or jQuery object.
/// The current dialog content, if used as a getter. If used as a setter, the method will return the dialog object to support chaining.
},
destroy: function() {
///
/// Destroys the dialog and its modal overlay, if necessary. Removes the widget HTML elements from the DOM.
///
},
open: function() {
///
/// Opens a Dialog and brings it on top of any other open Dialog or Window instances by calling toFront internally.
///
/// Returns the dialog object to support chaining.
},
title: function(text) {
///
/// Gets or sets the title of a Dialog. Can be a text string. Supports chaining when used as a setter. If passed to the method, an HTML string would be escaped.
///
/// The title of the Dialog.
/// The current dialog title, if used as a getter. If used as a setter, the method will return the dialog object to support chaining.
},
toFront: function() {
///
/// Increases the z-index style of a Dialog wrapper to bring the instance on top of other open Dialogs. This method is executed automatically when the open method is used.
///
/// Returns the dialog object to support chaining.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDialog = function() {
///
/// Returns a reference to the kendo.ui.Dialog widget, instantiated on the selector.
///
/// The kendo.ui.Dialog instance (if present).
};
$.fn.kendoDialog = function(options) {
///
/// Instantiates a kendo.ui.Dialog widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
actions - Array
///
A collection of objects containing text, action and primary attributes used to specify the dialog buttons. #### Example
///
///
animation - Boolean
///
A collection of {Animation} objects, used to change default animations. A value of false will disable all animations in the widget. is not a valid configuration.
///
///
animation - Object
///
A collection of {Animation} objects, used to change default animations. A value of false will disable all animations in the widget. is not a valid configuration.
///
///
buttonLayout - String (default: "stretched")
///
Specifies the possible layout of the action buttons in the Dialog.Possible values are: normal or stretched.
///
///
closable - Boolean (default: true)
///
Specifies whether a close button should be rendered at the top corner of the dialog.
///
///
content - String
///
Specifies the content of a Dialog.
///
///
height - Number|String
///
Specifies height of the dialog.
///
///
maxHeight - Number (default: Infinity)
///
The maximum height (in pixels) that may be achieved by resizing the dialog.
///
///
maxWidth - Number (default: Infinity)
///
The maximum width (in pixels) that may be achieved by resizing the dialog.
///
///
messages - Object
///
Defines the text of the labels that are shown within the dialog. Used primarily for localization.
///
///
minHeight - Number (default: 50)
///
The minimum height (in pixels) that may be achieved by resizing the dialog.
///
///
minWidth - Number (default: 50)
///
The minimum width (in pixels) that may be achieved by resizing the dialog.
///
///
modal - Boolean (default: true)
///
Specifies whether the dialog should show a modal overlay over the page.
///
///
modal - Object (default: true)
///
Specifies whether the dialog should show a modal overlay over the page.
///
///
title - String|Boolean (default: "")
///
The text in the dialog title bar. If false, the dialog will be displayed without a title bar.
///
///
visible - Boolean (default: true)
///
Specifies whether the dialog will be initially visible.
///
///
width - Number|String
///
Specifies width of the dialog.
///
///
size - String (default: "auto")
///
Set predefined size to the dialog. The width and height configuration options override the predefined size.Possible values are: auto; small; medium or large.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Draggable = function() { };
kendo.ui.Draggable.prototype = {
cancelHold: function() {
///
/// Has effect only when holdToDrag is set to true. Cancels the activated state of the widget, caused by pressing and holding.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDraggable = function() {
///
/// Returns a reference to the kendo.ui.Draggable widget, instantiated on the selector.
///
/// The kendo.ui.Draggable instance (if present).
};
$.fn.kendoDraggable = function(options) {
///
/// Instantiates a kendo.ui.Draggable widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
axis - String (default: null)
///
Constrains the hint movement to either the horizontal (x) or vertical (y) axis. Can be set to either "x" or "y".
///
///
autoScroll - Boolean (default: false)
///
If set to true the widget will auto-scroll the container when the mouse/finger is close to the top/bottom of it.
///
///
container - String|jQuery (default: null)
///
If set, the hint movement is constrained to the container boundaries.
///
///
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|jQuery
///
Provides a way for customization of the drag indicator. If a function is supplied, it receives one argument - the draggable element's jQuery object.
///
///
holdToDrag - Boolean (default: false)
///
Suitable for touch oriented user interface, in order to avoid collision with the touch scrolling gesture. When set to true, the widget will be activated after the user taps and holds the finger on the element for a short amount of time.The draggable will also be activated by pressing, holding and lifting the finger without any movement. Dragging it afterwards will initiate the drag immediately. The activated mode can be canceled by calling cancelHold.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Drawer = function() { };
kendo.ui.Drawer.prototype = {
destroy: function() {
///
/// Prepares the Drawer 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.
///
},
hide: function() {
///
/// Hide the Drawer
///
},
show: function() {
///
/// Show the Drawer
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDrawer = function() {
///
/// Returns a reference to the kendo.ui.Drawer widget, instantiated on the selector.
///
/// The kendo.ui.Drawer instance (if present).
};
$.fn.kendoDrawer = function(options) {
///
/// Instantiates a kendo.ui.Drawer widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
position - String (default: 'left')
///
The position of the drawer. Can be left (default) or right.
///
///
mode - String (default: 'overlay')
///
Determines how the Kendo UI Drawer will interact with the associated content. The default one (overlay) will simply overlap the associated content with overlay effect. On the other hand "push" mode will show the drawer next to associated cotent. The associated content will shrink its content.
///
///
template - String
///
Specifies the drawer's content.
///
///
minHeight - Number
///
Specifies the minimum height for the drawer in push mode. The overlay mode takes 100% of the page height.
///
///
mini - Boolean
///
Enables or configures the mini mode for the Kendo UI Drawer. This is a compact view that is displayed when the Kendo UI Drawer is collapsed. Usually it used to show only the icons when the drawer content contains icon and text for an item. When set to true it uses the main template.
///
///
mini - Object
///
Enables or configures the mini mode for the Kendo UI Drawer. This is a compact view that is displayed when the Kendo UI Drawer is collapsed. Usually it used to show only the icons when the drawer content contains icon and text for an item. When set to true it uses the main template.
///
///
swipeToOpen - Boolean (default: true)
///
If set to false, swiping the associated content will not activate the drawer. In this case, the drawer will only be open by calling the show method. should be disabled for browsers, which use side swiping gestures for back/forward navigation, such as iOS Safari. Otherwise, users should swipe from an inner part of the view, and not from the view edge.
///
///
width - Number
///
Defines a specific width for the Kendo UI Drawer when expanded.
///
///
///
/// The widget configuration options
///
};
kendo.ui.DropDownList = function() { };
kendo.ui.DropDownList.prototype = {
close: function() {
///
/// Closes the widget popup.
///
},
dataItem: function(index) {
///
/// Returns the data item at the specified index. If the index is not specified, the selected index will be used.
///
/// The zero-based index of the data record.
/// The raw data record. Returns undefined if no data.
},
destroy: function() {
///
/// Prepares the DropDownList for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
focus: function() {
///
/// Focuses the widget.
///
},
items: function() {
///
/// Obtains an Array of the DOM elements, which correspond to the data items from the Kendo UI DataSource view.
///
/// The currently rendered dropdown list items ( elements).
},
enable: function(enable) {
///
/// Enables or disables the widget.
///
/// If set to true the widget will be enabled. If set to false the widget will be disabled.
},
open: function() {
///
/// Opens the popup.
///
},
readonly: function(readonly) {
///
/// Controls whether the widget is editable or readonly.
///
/// The argument, which defines whether the DropDownList should be readonly or editable.
},
refresh: function() {
///
/// Refresh the popup by rendering all items again.
///
},
search: function(word) {
///
/// If the DropDownList filter is enabled, the method searches and filters the results available in the drop-down. If no filter is configured for the widget it selects the first item, which starts with the provided value.
///
/// The search value.
},
select: function(li) {
///
/// Gets or sets the selected item. Selects the item provided as an argument and updates the value and text of the widget.
///
/// A string, DOM element or jQuery object which represents the item to be selected. A string is treated as a jQuery selector. A number representing the index of the item or function predicate which returns the correct data item.
/// The index of the selected item, if called with no parameters. If a custom value is entered, the returned selected index is -1. If called with a parameter as a setter.
},
setDataSource: function(dataSource) {
///
/// Sets the dataSource of an existing DropDownList and rebinds it.
///
///
},
text: function(text) {
///
/// Gets or sets the text of the DropDownList.
///
/// The text to set.
/// The text of the DropDownList.
},
toggle: function(toggle) {
///
/// Opens or closes the widget popup.
///
/// Defines the whether to open/close the drop-down list.
},
value: function(value) {
///
/// Gets or sets the value of the DropDownList. The value will not be set if there is no item with such value. If value is undefined, text of the data item is used.
///
/// The value to set.
/// The value of the DropDownList.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDropDownList = function() {
///
/// Returns a reference to the kendo.ui.DropDownList widget, instantiated on the selector.
///
/// The kendo.ui.DropDownList instance (if present).
};
$.fn.kendoDropDownList = function(options) {
///
/// Instantiates a kendo.ui.DropDownList widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation - Boolean
///
Configures the opening and closing animations of the suggestion popup. Setting the animation option to false will disable the opening and closing animations. As a result the suggestion popup will open and close instantly. is not a valid configuration.
///
///
animation - Object
///
Configures the opening and closing animations of the suggestion popup. Setting the animation option to false will disable the opening and closing animations. As a result the suggestion popup will open and close instantly. is not a valid configuration.
///
///
autoBind - Boolean (default: true)
///
Controls whether to bind the widget to the data source on initialization.
///
///
autoWidth - Boolean
///
If set to true, the widget automatically adjusts the width of the popup element and does not wrap up the item label.
///
///
cascadeFrom - String
///
Use it to set the Id of the parent DropDownList widget.Help topic showing how cascading functionality works
///
///
cascadeFromField - String
///
Defines the field to be used to filter the data source. If not defined the parent's dataValueField option will be used.Help topic showing how cascading functionality works
///
///
cascadeFromParentField - String
///
Defines the parent field to be used to retain value from. This value will be used further to filter the dataSource. If not defined the value from the parent's dataValueField will be used.
///
///
dataSource - Object|Array|kendo.data.DataSource
///
The data source of the widget which is used to display a list of values. Can be a JavaScript object which represents a valid data source configuration, a JavaScript array or an existing kendo.data.DataSource instance.If the dataSource option is set to a JavaScript object or array the widget will initialize a new kendo.data.DataSource instance using that value as data source configuration.If the dataSource option is an existing kendo.data.DataSource instance the widget will use that instance and will not initialize a new one.
///
///
dataTextField - String (default: "")
///
The field of the data item that provides the text content of the list items. The widget will filter the data source based on this field.
///
///
dataValueField - String (default: "")
///
The field of the data item that provides the value of the widget.
///
///
delay - Number (default: 500)
///
Specifies the delay in milliseconds before the search-text typed by the end user is sent for filtering.
///
///
enable - Boolean (default: true)
///
If set to false the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input.
///
///
enforceMinLength - Boolean (default: false)
///
If set to true the widget will not show all items when the text of the search input cleared. By default the widget shows all items when the text of the search input is cleared. Works in conjunction with minLength.
///
///
filter - String (default: "none")
///
The filtering method used to determine the suggestions for the current value. Filtration is turned off by default, and can be performed over string values only (either the widget's data has to be an array of strings, or over the field, configured in the dataTextField option). The supported filter values are startswith, endswith and contains.
///
///
fixedGroupTemplate - String|Function
///
The template used to render the fixed header group. By default the widget displays only the value of the current group.
///
///
footerTemplate - String|Function
///
The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.
///
///
groupTemplate - String|Function
///
The template used to render the groups. By default the widget displays only the value of the group.
///
///
height - Number (default: 200)
///
The height of the suggestion popup in pixels. The default value is 200 pixels.
///
///
ignoreCase - Boolean (default: true)
///
If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default.
///
///
index - Number (default: 0)
///
The index of the initially selected item. The index is 0 based.
///
///
minLength - Number (default: 1)
///
The minimum number of characters the user must type before a filter is performed. Set to higher value than 1 if the search could match a lot of items.
///
///
noDataTemplate - String|Function (default: "NO DATA FOUND.")
///
The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound.
///
///
popup - Object
///
The options that will be used for the popup initialization. For more details about the available options refer to Popup documentation.
///
///
optionLabel - String|Object (default: "")
///
Define the text of the default empty item. If the value is an object, then the widget will use it as a valid data item. Note that the optionLabel will not be available if the widget is empty.
///
///
optionLabelTemplate - String|Function
///
The template used to render the option label.
///
///
headerTemplate - String|Function
///
Specifies a static HTML content, which will be rendered as a header of the popup element.
///
///
template - String|Function
///
The template used to render the items. By default the widget displays only the text of the data item (configured via dataTextField).
///
///
valueTemplate - String|Function
///
The valueTemplate used to render the selected value. By default the widget displays only the text of the data item (configured via dataTextField).
///
///
text - String (default: "")
///
The text of the widget used when the autoBind is set to false.
///
///
value - String (default: "")
///
The value of the widget.
///
///
valuePrimitive - Boolean (default: false)
///
Specifies the value binding behavior for the widget when the initial model value is null. If set to true, the View-Model field will be updated with the selected item value field. If set to false, the View-Model field will be updated with the selected item.
///
///
virtual - Boolean (default: false)
///
Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization.
///
///
virtual - Object (default: false)
///
Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization.
///
///
///
/// The widget configuration options
///
};
kendo.ui.DropDownTree = function() { };
kendo.ui.DropDownTree.prototype = {
close: function() {
///
/// Closes the widget popup.
///
},
destroy: function() {
///
/// Prepares the DropDownTree for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
enable: function(enable) {
///
/// Enables or disables the widget.
///
/// If set to true the widget will be enabled. If set to false the widget will be disabled.
},
focus: function() {
///
/// Focuses the widget.
///
},
items: function() {
///
/// Obtains an Array of the DOM elements, which correspond to the data items from the Kendo UI HierarchicalDataSource view.
///
/// The currently rendered first level items.
},
open: function() {
///
/// Opens the popup.
///
},
readonly: function(readonly) {
///
/// Toggles the readonly state of the widget. When the widget is readonly it doesn't allow user input.
///
/// If set to true the widget will not allow user input. If set to false the widget will allow user input.
},
refresh: function() {
///
/// Refresh the popup by rendering all items again.
///
},
search: function(word) {
///
/// Searches the data source for the provided value and displays any matches as suggestions.
///
/// The filter value.
},
setDataSource: function(dataSource) {
///
/// Sets the dataSource of an existing DropDownTree and rebinds it.
///
///
},
toggle: function(toggle) {
///
/// Opens or closes the widget popup.
///
/// Defines the whether to open/close the drop-down list.
},
value: function(value) {
///
/// Gets or sets the value of the DropDownTree.
///
/// The value to set. A String value when checkboxes is 'false' and an Array of strings when checkboxes is true. To clear the value, pass an empty array.
/// The value of the DropDownTree.
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDropDownTree = function() {
///
/// Returns a reference to the kendo.ui.DropDownTree widget, instantiated on the selector.
///
/// The kendo.ui.DropDownTree instance (if present).
};
$.fn.kendoDropDownTree = function(options) {
///
/// Instantiates a kendo.ui.DropDownTree widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
animation - Boolean
///
Configures the opening and closing animations of the suggestion popup. Setting the animation option to false will disable the opening and closing animations. As a result, the suggestion popup will open and close instantly. is not a valid configuration.
///
///
animation - Object
///
Configures the opening and closing animations of the suggestion popup. Setting the animation option to false will disable the opening and closing animations. As a result, the suggestion popup will open and close instantly. is not a valid configuration.
///
///
autoBind - Boolean (default: true)
///
Controls whether to bind the widget to the data source on initialization.
///
///
autoClose - Boolean (default: true)
///
Controls whether to close the popup when item is selected or checked.
///
///
autoWidth - Boolean
///
If set to true, the widget automatically adjusts the width of the popup element and does not wrap up the item label.
///
///
checkAll - Boolean (default: false)
///
When this options is set to true and checkboxes are enabled, a tristate checkbox appears above the embedded treeview. Clicking that checkbox will check or uncheck all the loaded enabled items of the treeview.
///
///
checkAllTemplate - String|Function
///
The template used to render the checkAll label. By default, the widget displays only a span element with text "Check all".
///
///
checkboxes - Boolean
///
If true or an object, renders checkboxes beside each node. In this case the widget value should be an array.
///
///
checkboxes - Object
///
If true or an object, renders checkboxes beside each node. In this case the widget value should be an array.
///
///
clearButton - Boolean (default: true)
///
Unless this option is set to false, a button will appear when hovering the widget. Clicking that button will reset the widget's value and will trigger the change event.
///
///
dataImageUrlField - String (default: null)
///
Sets the field of the data item that provides the image URL of the DropDownTree nodes.
///
///
dataSource - Object|Array|kendo.data.HierarchicalDataSource
///
The data source of the widget which is used render nodes. Can be a JavaScript object which represents a valid data source configuration, a JavaScript array or an existing kendo.data.HierarchicalDataSource instance.If the dataSource option is set to a JavaScript object or array the widget will initialize a new kendo.data.HierarchicalDataSource instance using that value as data source configuration.If the dataSource option is an existing kendo.data.HierarchicalDataSource instance the widget will use that instance and will not initialize a new one.
///
///
dataSpriteCssClassField - String (default: null)
///
Sets the field of the data item that provides the sprite CSS class of the nodes. If an array, each level uses the field that is at the same index in the array, or the last item in the array.
///
///
dataTextField - String|Array (default: null)
///
Sets the field of the data item that provides the text content of the nodes. If an array, each level uses the field that is at the same index in the array, or the last item in the array.
///
///
dataUrlField - String (default: null)
///
Sets the field of the data item that provides the link URL of the nodes.
///
///
dataValueField - String|Array (default: null)
///
The field of the data item that provides the value of the widget. If an array, each level uses the field that is at the same index in the array, or the last item in the array.
///
///
delay - Number (default: 200)
///
Specifies the delay in milliseconds after which the DropDownTree will start filtering dataSource.
///
///
enable - Boolean (default: true)
///
If set to false the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input.
///
///
enforceMinLength - Boolean (default: false)
///
If set to true the widget will not show all items when the text of the search input cleared. By default, the widget shows all items when the text of the search input is cleared. Works in conjunction with minLength.
///
///
filter - String (default: "none")
///
The filtering method used to determine the suggestions for the current value. Filtration is turned off by default, and can be performed over string values only (either the widget's data has to be an array of strings, or over the field, configured in the dataTextField option). The supported filter values are startswith, endswith and contains.
///
///
footerTemplate - String|Function
///
The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template.
///
///
height - String|Number (default: 200)
///
Sets max-height of the embedded treeview in pixels. The default value is 200 pixels. If set to "Auto" the height of the popup will depend on the height of the treeview.
///
///
ignoreCase - Boolean (default: true)
///
If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default.
///
///
loadOnDemand - Boolean (default: false)
///
Indicates whether the child DataSources should be fetched lazily when parent groups get expanded. Setting this to true causes loading the child DataSources when expanding the parent node.
///
///
messages - Object
///
The text messages displayed in the widget. Use it to customize or localize the messages.
///
///
minLength - Number (default: 1)
///
The minimum number of characters the user must type before a search is performed. Set to a higher value if the search could match a lot of items.
///
///
noDataTemplate - String|Function (default: "NO DATA FOUND.")
///
The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound.
///
///
placeholder - String (default: "")
///
The hint displayed by the widget when it is empty. Not set by default.
///
///
popup - Object
///
The options that will be used for the popup initialization. For more details about the available options refer to Popup documentation.
///
///
headerTemplate - String|Function
///
Specifies a static HTML content, which will be rendered as a header of the popup element.
///
///
valueTemplate - String|Function
///
The template used to render the value and the or the selected tags.
///
///
tagMode - String (default: "multiple")
///
The mode used to render the selected tags when checkboxes are enabled. The available modes are: - multiple - renders a tag for every selected value - single - renders only one tag that shows the number of the selected values
///
///
template - String|Function
///
Template for rendering each node.
///
///
text - String (default: "")
///
The text of the widget used when the autoBind is set to false.
///
///
value - String|Array
///
Define the value of the widget. It accepts 'String' when it is in single selection mode and 'Array' when multiple selection is enabled via checkboxes property.
///
///
valuePrimitive - Boolean (default: false)
///
Specifies the value binding behavior for the widget. If set to true, the View-Model field will be updated with the selected item value field. If set to false, the View-Model field will be updated with the selected item.
///
///
///
/// The widget configuration options
///
};
kendo.ui.DropTarget = function() { };
kendo.ui.DropTarget.prototype = {
destroyGroup: function() {
///
/// Destroys all DropTarget instances from the group with the given name.
///
},
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDropTarget = function() {
///
/// Returns a reference to the kendo.ui.DropTarget widget, instantiated on the selector.
///
/// The kendo.ui.DropTarget instance (if present).
};
$.fn.kendoDropTarget = function(options) {
///
/// Instantiates a kendo.ui.DropTarget widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
group - String (default: "default")
///
Used to group sets of draggable and drop targets. A draggable with the same group value as a drop target will be accepted by the drop target.
///
///
///
/// The widget configuration options
///
};
kendo.ui.DropTargetArea = function() { };
kendo.ui.DropTargetArea.prototype = {
bind: function(event, callback) {
///
/// Binds to a widget event.
///
/// The event name
/// The callback to be executed when the event is triggered.
},
unbind: function(event, callback) {
///
/// Unbinds a callback from a widget event.
///
/// The event name
/// The callback to be removed.
}
};
$.fn.getKendoDropTargetArea = function() {
///
/// Returns a reference to the kendo.ui.DropTargetArea widget, instantiated on the selector.
///
/// The kendo.ui.DropTargetArea instance (if present).
};
$.fn.kendoDropTargetArea = function(options) {
///
/// Instantiates a kendo.ui.DropTargetArea widget based the DOM elements that match the selector.
///
Accepts an object with the following configuration options:
///
///
group - String (default: "default")
///
Used to group sets of draggable and drop targets. A draggable with the same group value as a drop target will be accepted by the drop target.
///
///
filter - String (default: null)
///
Selector to filter the drop targets in the area. Every matched element acts as a drop target and fires events on the DropTargetArea. Specifying the filter is mandatory.
///
///
///
/// The widget configuration options
///
};
kendo.ui.Editor = function() { };
kendo.ui.Editor.prototype = {
createRange: function(document) {
///
/// Creates a W3C-compatible Range object.
///
/// The document that the range is associated with. If omitted, the document of the editor editing area will be used.
/// The created Range object.
},
destroy: function() {
///
/// Prepares the widget for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
///
},
encodedValue: function() {
///
/// Gets the HTML encoded value of the editor.
///
/// The value of the Editor as HTML encoded string.
},
exec: function(name,params) {
///
/// Executes an editor command on the currently selected text.
///
/// The name of the command to be executed. The available names match the list of tools, plus "undo" and "redo".
/// The parameters for the executed command.
},
focus: function() {
///
/// Focuses the editable area.
///
},
getRange: function() {
///
/// Gets a Range object form the editable area.
///
/// A W3C-compatible Range object that represents the currently selected text in the editor area.
},
getSelection: function() {
///
/// Gets a W3C-compatible Selection object form the editable area.
///
/// a W3C-compatible Selection object form the editable area.
},
paste: function(html,options) {
///
/// Inserts HTML into the editable area. Cleans up MS Word formatting.
///
/// The HTML to be inserted.
/// Options that configure how the content is processed when pasting.
},
selectedHtml: function() {
///
/// Serializes the currently selected text to a XHTML string.
///
/// The selected text as valid XHTML.
},
refresh: function() {
///
/// Reinitializes the editing area iframe. Should be used after moving the editor in the DOM.
///
},
saveAsPDF: function() {
///
/// Initiates the PDF export and returns a promise. Also triggers the pdfExport event.
///
/// A promise that will be resolved when the export completes. The same promise is available in the pdfExport event arguments.
},
selectRange: function(range) {
///
/// Focuses the editable area and selects the range described by the range parameter.
///
/// The Range object that describes the new selection.
},
update: function() {
///
/// Serializes the current state of the editable area to the