From 6cfb75bd5289b4d37bd967c6af2e8a5e61f660e7 Mon Sep 17 00:00:00 2001 From: dxrobot Date: Tue, 27 Oct 2020 18:56:26 +0300 Subject: [PATCH] Update to 19.2.9 (#1090) * Update to 19.2.9 * Revert "Merge branch '19.2' of https://github.com/DevExpress/devextreme-angular into update_branch_19.2.9" This reverts commit e6862b120c2bd842e41e9cb15f785299325fa058, reversing changes made to 90b226a9197349a0cf88b4ae1aba969cfdbe0303. Co-authored-by: dxvladislavvolkov --- .gitignore | 1 - gulpfile.js | 6 +- metadata/DeprecatedComponentsMetadata.json | 36 +- metadata/NGMetaData.json | 17832 ++++++++---------- package.json | 9 +- templates/base-nested-component.tst | 4 +- templates/component.tst | 35 +- templates/nested-component.tst | 17 +- tools/spec/tests/metadata-generator.spec.js | 221 +- tools/src/helpers.ts | 8 - tools/src/import-helper.ts | 81 - tools/src/metadata-generator.ts | 226 +- tools/src/metadata-model.ts | 50 - 13 files changed, 7985 insertions(+), 10541 deletions(-) delete mode 100644 tools/src/helpers.ts delete mode 100644 tools/src/import-helper.ts delete mode 100644 tools/src/metadata-model.ts diff --git a/.gitignore b/.gitignore index b9ede4714..a7db30237 100644 --- a/.gitignore +++ b/.gitignore @@ -9,4 +9,3 @@ npm-debug.log metadata/generated src/ui/ src/index.ts -artifacts diff --git a/gulpfile.js b/gulpfile.js index c60e7c57e..c3846a0f8 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -148,11 +148,7 @@ gulp.task('npm.content', gulp.series('build.components', function() { .pipe(gulp.dest(npmConfig.distPath)); })); -gulp.task('npm.pack', gulp.series( - 'npm.content', - shell.task('npm run inject-descriptions'), - shell.task(['npm pack'], { cwd: buildConfig.npm.distPath }) -)); +gulp.task('npm.pack', gulp.series('npm.content', shell.task(['npm pack'], { cwd: buildConfig.npm.distPath }))); //------------TSLint------------ diff --git a/metadata/DeprecatedComponentsMetadata.json b/metadata/DeprecatedComponentsMetadata.json index a57f8b7ca..6ddbc8c91 100644 --- a/metadata/DeprecatedComponentsMetadata.json +++ b/metadata/DeprecatedComponentsMetadata.json @@ -132,18 +132,12 @@ }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], "Description": "Specifies a display format for field values." }, "groupIndex": { @@ -351,34 +345,14 @@ }, "store": { "PrimitiveTypes": [ - "Store", - "StoreOptions", - "XmlaStore", - "XmlaStoreOptions" + "DevExpress.data.Store", + "DevExpress.data.StoreOptions", + "DevExpress.data.XmlaStore", + "DevExpress.data.XmlaStoreOptions" ], "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "Store", - "Path": "data/abstract_store" - }, - { - "Name": "StoreOptions", - "Path": "data/abstract_store" - }, - { - "Name": "default", - "Alias": "XmlaStore", - "Path": "ui/pivot_grid/xmla_store" - }, - { - "Name": "XmlaStoreOptions", - "Path": "ui/pivot_grid/xmla_store" - } - ], "Description": "Specifies the underlying Store instance used to access data.", "Options": { "type": { diff --git a/metadata/NGMetaData.json b/metadata/NGMetaData.json index cfefcc3e2..b4dc9811a 100644 --- a/metadata/NGMetaData.json +++ b/metadata/NGMetaData.json @@ -1,32 +1,32 @@ { "Widgets": { "dxAccordion": { - "DocID": "dxAccordion", + "Description": "The Accordion widget contains several panels displayed one under another. These panels can be collapsed or expanded by an end user, which makes this widget very useful for presenting information in a limited amount of space.", "Module": "ui/accordion", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "animationDuration": { "PrimitiveTypes": [ "number" ], - "DocID": "dxAccordion.Options.animationDuration" + "Description": "A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel." }, "collapsible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxAccordion.Options.collapsible" + "Description": "Specifies whether all items can be collapsed or whether at least one item must always be expanded." }, "dataSource": { "PrimitiveTypes": [ @@ -42,39 +42,32 @@ "ItemComplexTypes": [ "AccordionItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxAccordion.Options.dataSource" + "Description": "Binds the widget to data." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxAccordion.Options.deferRendering" + "Description": "Specifies whether to render the panel's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxAccordion.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -83,25 +76,25 @@ "string" ], "IsFunc": true, - "DocID": "dxAccordion.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxAccordion.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -111,50 +104,50 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxAccordion.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxAccordionItem.icon" + "Description": "Specifies the icon to be displayed in the panel's title." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "dxAccordionItem.title" + "Description": "Specifies text displayed for the widget item title." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -163,14 +156,14 @@ "any" ], "IsTemplate": true, - "DocID": "dxAccordion.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "itemTitleTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxAccordion.Options.itemTitleTemplate" + "Description": "Specifies a custom template for item titles." }, "keyExpr": { "PrimitiveTypes": [ @@ -178,19 +171,19 @@ "string" ], "IsFunc": true, - "DocID": "CollectionWidget.Options.keyExpr" + "Description": "Specifies the key property that provides key values to access data items. Each key value must be unique." }, "multiple": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxAccordion.Options.multiple" + "Description": "Specifies whether the widget can expand several items or only a single item at once." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidget.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onContentReady": { "PrimitiveTypes": [ @@ -198,7 +191,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -206,7 +199,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -214,7 +207,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -223,7 +216,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -231,7 +224,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemHold": { "PrimitiveTypes": [ @@ -239,7 +232,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -247,7 +240,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onItemTitleClick": { "PrimitiveTypes": [ @@ -256,7 +249,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxAccordion.Options.onItemTitleClick" + "Description": "A function that is executed when an accordion item's title is clicked or tapped." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -264,7 +257,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -272,33 +265,33 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onSelectionChanged" + "Description": "A function that is executed when a collection item is selected or selection is canceled." }, "repaintChangesOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxAccordion.Options.repaintChangesOnly" + "Description": "Specifies whether to repaint only those elements whose data changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectedIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "dxAccordion.Options.selectedIndex" + "Description": "The index number of the currently selected item." }, "selectedItem": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "CollectionWidget.Options.selectedItem" + "Description": "The selected item object." }, "selectedItemKeys": { "ItemPrimitiveTypes": [ @@ -307,7 +300,7 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "selectedItemKey", - "DocID": "CollectionWidget.Options.selectedItemKeys" + "Description": "Specifies an array of currently selected item keys." }, "selectedItems": { "ItemPrimitiveTypes": [ @@ -316,19 +309,19 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "selectedItem", - "DocID": "CollectionWidget.Options.selectedItems" + "Description": "An array of currently selected item objects." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -337,19 +330,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxActionSheet": { - "DocID": "dxActionSheet", + "Description": "The ActionSheet widget is a sheet containing a set of buttons located one under the other. These buttons usually represent several choices relating to a single task.", "Module": "ui/action_sheet", "Options": { "cancelText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxActionSheet.Options.cancelText" + "Description": "The text displayed in the button that closes the action sheet." }, "dataSource": { "PrimitiveTypes": [ @@ -365,27 +358,20 @@ "ItemComplexTypes": [ "ActionSheetItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxActionSheet.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -394,25 +380,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -422,19 +408,19 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxActionSheet.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxActionSheetItem.icon" + "Description": "Specifies the icon to be displayed on the action sheet button." }, "onClick": { "PrimitiveTypes": [ @@ -443,26 +429,26 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxActionSheetItem.onClick" + "Description": "A handler for the click event raised for the button representing the given action sheet button." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxActionSheetItem.type" + "Description": "Specifies the type of the button that represents an action sheet item." } } }, @@ -471,7 +457,7 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "onCancelClick": { "PrimitiveTypes": [ @@ -480,7 +466,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxActionSheet.Options.onCancelClick" + "Description": "A function that is executed when the Cancel button is clicked or tapped." }, "onContentReady": { "PrimitiveTypes": [ @@ -488,7 +474,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -496,7 +482,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -504,7 +490,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -513,7 +499,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -521,7 +507,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemHold": { "PrimitiveTypes": [ @@ -529,7 +515,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -537,7 +523,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -545,25 +531,25 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showCancelButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxActionSheet.Options.showCancelButton" + "Description": "Specifies whether or not to display the Cancel button in action sheet." }, "showTitle": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxActionSheet.Options.showTitle" + "Description": "A Boolean value specifying whether or not the title of the action sheet is visible." }, "target": { "PrimitiveTypes": [ @@ -571,26 +557,26 @@ "JQuery", "string" ], - "DocID": "dxActionSheet.Options.target" + "Description": "Specifies the element the action sheet popover points at. Applies only if usePopover is true." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "dxActionSheet.Options.title" + "Description": "The title of the action sheet." }, "usePopover": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxActionSheet.Options.usePopover" + "Description": "Specifies whether or not to show the action sheet within a Popover widget." }, "visible": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxActionSheet.Options.visible" + "Description": "A Boolean value specifying whether or not the ActionSheet widget is visible." }, "width": { "PrimitiveTypes": [ @@ -599,12 +585,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxAutocomplete": { - "DocID": "dxAutocomplete", + "Description": "The Autocomplete widget is a textbox that provides suggestions while a user types into it.", "Module": "ui/autocomplete", "IsEditor": true, "Options": { @@ -612,13 +598,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "buttons": { "ItemPrimitiveTypes": [ @@ -628,16 +614,9 @@ "ItemComplexTypes": [ "TextEditorButton" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "button", - "DocID": "dxDropDownEditor.Options.buttons" + "Description": "Allows you to add custom buttons to the input text field." }, "dataSource": { "PrimitiveTypes": [ @@ -649,66 +628,59 @@ "DevExpress.ui.CollectionWidgetItem", "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "DataExpressionMixin.Options.dataSource" + "Description": "Binds the widget to data." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.deferRendering" + "Description": "Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "displayValue": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxDropDownList.Options.displayValue" + "Description": "Returns the value currently displayed by the widget." }, "dropDownButtonTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDropDownEditor.Options.dropDownButtonTemplate" + "Description": "Specifies a custom template for the drop-down button." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "grouped": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownList.Options.grouped" + "Description": "Specifies whether data items should be grouped." }, "groupTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDropDownList.Options.groupTemplate" + "Description": "Specifies a custom template for group captions." }, "height": { "PrimitiveTypes": [ @@ -717,31 +689,31 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "inputAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTextEditor.Options.inputAttr" + "Description": "Specifies the attributes to be passed on to the underlying HTML element." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "items": { "ItemPrimitiveTypes": [ @@ -749,38 +721,38 @@ ], "IsCollection": true, "SingularName": "item", - "DocID": "DataExpressionMixin.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -789,32 +761,32 @@ "any" ], "IsTemplate": true, - "DocID": "DataExpressionMixin.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "maxItemCount": { "PrimitiveTypes": [ "number" ], - "DocID": "dxAutocomplete.Options.maxItemCount" + "Description": "Specifies the maximum count of items displayed by the widget." }, "maxLength": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxTextBox.Options.maxLength" + "Description": "Specifies the maximum number of characters you can enter into the textbox." }, "minSearchLength": { "PrimitiveTypes": [ "number" ], - "DocID": "dxAutocomplete.Options.minSearchLength" + "Description": "The minimum number of characters that must be entered into the text box to begin a search." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "onChange": { "PrimitiveTypes": [ @@ -822,7 +794,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onChange" + "Description": "A function that is executed when the widget loses focus after the text field's content was changed using the keyboard." }, "onClosed": { "PrimitiveTypes": [ @@ -830,7 +802,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onClosed" + "Description": "A function that is executed once the drop-down editor is closed." }, "onContentReady": { "PrimitiveTypes": [ @@ -838,7 +810,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onCopy": { "PrimitiveTypes": [ @@ -846,7 +818,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCopy" + "Description": "A function that is executed when the widget's input has been copied." }, "onCut": { "PrimitiveTypes": [ @@ -854,7 +826,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCut" + "Description": "A function that is executed when the widget's input has been cut." }, "onDisposing": { "PrimitiveTypes": [ @@ -862,7 +834,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEnterKey": { "PrimitiveTypes": [ @@ -870,7 +842,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onEnterKey" + "Description": "A function that is executed when the Enter key has been pressed while the widget is focused." }, "onFocusIn": { "PrimitiveTypes": [ @@ -878,7 +850,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusIn" + "Description": "A function that is executed when the widget gets focus." }, "onFocusOut": { "PrimitiveTypes": [ @@ -886,7 +858,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusOut" + "Description": "A function that is executed when the widget loses focus." }, "onInitialized": { "PrimitiveTypes": [ @@ -894,7 +866,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onInput": { "PrimitiveTypes": [ @@ -902,7 +874,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onInput" + "Description": "A function that is executed each time the widget's input is changed while the widget is focused." }, "onItemClick": { "PrimitiveTypes": [ @@ -910,7 +882,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownList.Options.onItemClick" + "Description": "A function that is executed when a list item is clicked or tapped." }, "onKeyDown": { "PrimitiveTypes": [ @@ -918,7 +890,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyDown" + "Description": "A function that is executed when a user is pressing a key on the keyboard." }, "onKeyPress": { "PrimitiveTypes": [ @@ -926,7 +898,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyPress" + "Description": "A function that is executed when a user presses a key on the keyboard." }, "onKeyUp": { "PrimitiveTypes": [ @@ -934,7 +906,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyUp" + "Description": "A function that is executed when a user releases a key on the keyboard." }, "onOpened": { "PrimitiveTypes": [ @@ -942,7 +914,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onOpened" + "Description": "A function that is executed once the drop-down editor is opened." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -950,7 +922,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPaste": { "PrimitiveTypes": [ @@ -958,7 +930,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onPaste" + "Description": "A function that is executed when the widget's input has been pasted." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -966,7 +938,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownList.Options.onSelectionChanged" + "Description": "A function that is executed when a list item is selected or selection is canceled." }, "onValueChanged": { "PrimitiveTypes": [ @@ -974,113 +946,111 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownList.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "opened": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxDropDownEditor.Options.opened" + "Description": "Specifies whether or not the drop-down editor is displayed." }, "openOnFieldClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.openOnFieldClick" + "Description": "Specifies whether a user can open the drop-down list by clicking a text field." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.placeholder" + "Description": "The text displayed by the widget when the widget value is empty." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "searchExpr": { "PrimitiveTypes": [ - "Function", - "string" + "Function" ], "ItemPrimitiveTypes": [ - "Function", - "string" + "Function" ], "IsCollection": true, "SingularName": "searchExpr", - "DocID": "dxDropDownList.Options.searchExpr" + "Description": "Specifies the name of a data source item field or an expression whose value is compared to the search criterion." }, "searchMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownList.Options.searchMode" + "Description": "Specifies a comparison operation used to search widget items." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDropDownList.Options.searchTimeout" + "Description": "Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed." }, "selectedItem": { "PrimitiveTypes": [ "any" ], "IsReadonly": true, - "DocID": "dxDropDownList.Options.selectedItem" + "Description": "Gets the currently selected item." }, "showClearButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.showClearButton" + "Description": "Specifies whether to display the Clear button in the widget." }, "showDropDownButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxAutocomplete.Options.showDropDownButton" + "Description": "Specifies whether the drop-down button is visible." }, "spellcheck": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.spellcheck" + "Description": "Specifies whether or not the widget checks the inner text for spelling mistakes." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.stylingMode" + "Description": "Specifies how the widget's text field is styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "text": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxTextEditor.Options.text" + "Description": "The read-only option that holds the text displayed by the widget input element." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -1088,32 +1058,32 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "dxAutocomplete.Options.value" + "Description": "Specifies the current value displayed by the widget." }, "valueChangeEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownList.Options.valueChangeEvent" + "Description": "Specifies the DOM events after which the widget's value should be updated." }, "valueExpr": { "PrimitiveTypes": [ @@ -1121,13 +1091,13 @@ "string" ], "IsFunc": true, - "DocID": "DataExpressionMixin.Options.valueExpr" + "Description": "Specifies which data field provides unique values to the widget's value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -1136,40 +1106,40 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." }, "wrapItemText": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownList.Options.wrapItemText" + "Description": "Specifies whether text that exceeds the drop-down list width should be wrapped." } } }, "dxBarGauge": { - "DocID": "dxBarGauge", + "Description": "The BarGauge widget contains several circular bars that each indicates a single value.", "Module": "viz/bar_gauge", "Options": { "animation": { - "DocID": "dxBarGauge.Options.animation", + "Description": "Specifies animation options.", "Options": { "duration": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.animation.duration" + "Description": "Determines how long animation runs." }, "easing": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.animation.easing" + "Description": "Specifies the animation easing mode." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.animation.enabled" + "Description": "Indicates whether or not animation is enabled." } } }, @@ -1177,58 +1147,58 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxBarGauge.Options.backgroundColor" + "Description": "Specifies a color for the remaining segment of the bar's track." }, "barSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBarGauge.Options.barSpacing" + "Description": "Specifies a distance between bars in pixels." }, "baseValue": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBarGauge.Options.baseValue" + "Description": "Specifies a base value for bars." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "endValue": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBarGauge.Options.endValue" + "Description": "Specifies an end value for the gauge's invisible scale." }, "export": { - "DocID": "BaseWidget.Options.export", + "Description": "Configures the exporting and printing features.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.backgroundColor" + "Description": "Specifies the color that will fill transparent regions in the resulting file or document." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.enabled" + "Description": "Enables the client-side exporting in the widget." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.fileName" + "Description": "Specifies a default name for the file to which the widget will be exported." }, "formats": { "ItemPrimitiveTypes": [ @@ -1236,74 +1206,74 @@ ], "IsCollection": true, "SingularName": "format", - "DocID": "BaseWidget.Options.export.formats" + "Description": "Specifies a set of export formats." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.export.margin" + "Description": "Adds an empty space around the exported widget; measured in pixels." }, "printingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.printingEnabled" + "Description": "Enables the printing feature in the widget. Applies only if the export.enabled option is true." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "BaseWidget.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." }, "svgToCanvas": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseWidget.Options.export.svgToCanvas" + "Description": "A function that renders SVG markup on the HTML canvas. Required to export custom SVG elements (for example, markerTemplate)." } } }, "geometry": { - "DocID": "dxBarGauge.Options.geometry", + "Description": "Defines the shape of the gauge's arc.", "Options": { "endAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBarGauge.Options.geometry.endAngle" + "Description": "Specifies the end angle of the bar gauge's arc." }, "startAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBarGauge.Options.geometry.startAngle" + "Description": "Specifies the start angle of the bar gauge's arc." } } }, "label": { - "DocID": "dxBarGauge.Options.label", + "Description": "Specifies the options of the labels that accompany gauge bars.", "Options": { "connectorColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxBarGauge.Options.label.connectorColor" + "Description": "Specifies a color for the label connector text." }, "connectorWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBarGauge.Options.label.connectorWidth" + "Description": "Specifies the width of the label connector in pixels." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxBarGauge.Options.label.customizeText" + "Description": "Specifies a callback function that returns a text for labels." }, "font": { "PrimitiveTypes": [ @@ -1312,14 +1282,7 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxBarGauge.Options.label.font" + "Description": "Specifies font options for bar labels." }, "format": { "PrimitiveTypes": [ @@ -1329,76 +1292,69 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxBarGauge.Options.label.format" + "Description": "Formats a value before it is displayed in a label. Accepts only numeric formats." }, "indent": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBarGauge.Options.label.indent" + "Description": "Specifies the distance between the upper bar and bar labels in pixels." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxBarGauge.Options.label.visible" + "Description": "Specifies whether bar labels appear on a gauge or not." } } }, "legend": { - "DocID": "dxBarGauge.Options.legend", + "Description": "Configures the legend.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.backgroundColor" + "Description": "Colors the legend's background." }, "border": { - "DocID": "BaseLegend.border", + "Description": "Configures the legend's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.border.color" + "Description": "Colors the legend's border." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.cornerRadius" + "Description": "Makes all the legend's corners rounded." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.border.dashStyle" + "Description": "Sets a dash style for the legend's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.opacity" + "Description": "Specifies the transparency of the legend's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseLegend.border.visible" + "Description": "Shows the legend's border." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.width" + "Description": "Specifies the width of the legend's border in pixels." } } }, @@ -1406,113 +1362,101 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.columnCount" + "Description": "Arranges legend items into several columns." }, "columnItemSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.columnItemSpacing" + "Description": "Specifies an empty space between item columns in pixels." }, "customizeHint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxBarGauge.Options.legend.customizeHint" + "Description": "Specifies the hint that appears when a user hovers the mouse pointer over a legend item." }, "customizeItems": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxBarGauge.Options.legend.customizeItems" + "Description": "Allows you to change the order, text, and visibility of legend items." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxBarGauge.Options.legend.customizeText" + "Description": "Customizes the text displayed by legend items." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseLegend.font" + "Description": "Specifies the legend items' font options." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.horizontalAlignment" + "Description": "Along with verticalAlignment, specifies the legend's position." }, "itemsAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.itemsAlignment" + "Description": "Aligns items in the last column or row (depending on the legend's orientation). Applies when legend items are not divided into columns or rows equally." }, "itemTextFormat": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxBarGauge.Options.legend.itemTextFormat" + "Description": "Formats the item text before it is displayed. Accepts only numeric formats. When unspecified, it inherits the label's format." }, "itemTextPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.itemTextPosition" + "Description": "Specifies the text's position relative to the marker in a legend item." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin", + "Description": "Generates an empty space, measured in pixels, around the legend.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.bottom" + "Description": "Specifies the legend's bottom margin in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.left" + "Description": "Specifies the legend's left margin in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.right" + "Description": "Specifies the legend's right margin in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.top" + "Description": "Specifies the legend's top margin in pixels." } } }, @@ -1520,50 +1464,50 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.markerSize" + "Description": "Specifies the marker's size in a legend item in pixels." }, "markerTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxBarGauge.Options.legend.markerTemplate" + "Description": "Specifies an SVG element that serves as a custom legend item marker." }, "orientation": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.orientation" + "Description": "Arranges legend items vertically (in a column) or horizontally (in a row). The default value is \"horizontal\" if the legend.horizontalAlignment is \"center\". Otherwise, it is \"vertical\"." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between the legend's left/right border and its items." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between the legend's top/bottom border and its items." }, "rowCount": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.rowCount" + "Description": "Arranges legend items in several rows." }, "rowItemSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.rowItemSpacing" + "Description": "Specifies an empty space between item rows in pixels." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title", + "Description": "Configures the legend title.", "Options": { "font": { "PrimitiveTypes": [ @@ -1572,47 +1516,40 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseLegend.title.font" + "Description": "Specifies the legend title's font options." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.horizontalAlignment" + "Description": "Along with verticalAlignment, specifies the legend title's position." }, "margin": { - "DocID": "BaseLegend.title.margin", + "Description": "Generates space around the legend title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.bottom" + "Description": "Specifies the legend title's bottom margin." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.left" + "Description": "Specifies the legend title's left margin." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.right" + "Description": "Specifies the legend title's right margin." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.top" + "Description": "Specifies the legend title's top margin." } } }, @@ -1620,13 +1557,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the legend title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.subtitle", + "Description": "Configures the legend subtitle. The subtitle appears only if the title is specified.", "Options": { "font": { "PrimitiveTypes": [ @@ -1635,26 +1572,19 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseLegend.title.subtitle.font" + "Description": "Specifies the legend subtitle's font options." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.subtitle.offset" + "Description": "Specifies the distance between the legend's title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.subtitle.text" + "Description": "Specifies the subtitle's text." } } }, @@ -1662,13 +1592,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.text" + "Description": "Specifies the legend title's text." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.verticalAlignment" + "Description": "Specifies the legend title's vertical alignment." } } }, @@ -1676,81 +1606,75 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.verticalAlignment" + "Description": "Along with horizontalAlignment, specifies the legend's position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxBarGauge.Options.legend.visible" + "Description": "Specifies the legend's visibility." } } }, "loadingIndicator": { - "DocID": "dxBarGauge.Options.loadingIndicator", + "Description": "Configures the loading indicator.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.backgroundColor" + "Description": "Colors the background of the loading indicator." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.loadingIndicator.font" + "Description": "Specifies font options for the loading indicator." }, "show": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "BaseWidget.Options.loadingIndicator.show" + "Description": "Allows you to change the loading indicator's visibility." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.text" + "Description": "Specifies the text to be displayed by the loading indicator." } } }, "margin": { - "DocID": "BaseWidget.Options.margin", + "Description": "Generates space around the widget.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.bottom" + "Description": "Specifies the bottom margin of the widget in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.left" + "Description": "Specifies the left margin of the widget in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.right" + "Description": "Specifies the right margin of the widget in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.top" + "Description": "Specifies the top margin of the widget in pixels." } } }, @@ -1760,7 +1684,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDrawn": { "PrimitiveTypes": [ @@ -1768,7 +1692,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onExported": { "PrimitiveTypes": [ @@ -1776,7 +1700,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -1784,7 +1708,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -1792,7 +1716,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -1800,7 +1724,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -1808,7 +1732,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -1816,7 +1740,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onTooltipHidden": { "PrimitiveTypes": [ @@ -1824,7 +1748,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxBarGauge.Options.onTooltipHidden" + "Description": "A function that is executed when a tooltip becomes hidden." }, "onTooltipShown": { "PrimitiveTypes": [ @@ -1832,7 +1756,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxBarGauge.Options.onTooltipShown" + "Description": "A function that is executed when a tooltip appears." }, "palette": { "PrimitiveTypes": [ @@ -1843,58 +1767,58 @@ ], "IsCollection": true, "SingularName": "palette", - "DocID": "dxBarGauge.Options.palette" + "Description": "Sets the palette to be used for colorizing bars in the gauge." }, "paletteExtensionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxBarGauge.Options.paletteExtensionMode" + "Description": "Specifies what to do with colors in the palette when their number is less than the number of bars in the gauge." }, "pathModified": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "redrawOnResize": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.redrawOnResize" + "Description": "Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates." }, "relativeInnerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBarGauge.Options.relativeInnerRadius" + "Description": "Defines the radius of the bar that is closest to the center relatively to the radius of the topmost bar." }, "resolveLabelOverlapping": { "PrimitiveTypes": [ "string" ], - "DocID": "dxBarGauge.Options.resolveLabelOverlapping" + "Description": "Specifies how the widget should behave when bar labels overlap: hide certain labels or leave them overlapped." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, @@ -1902,70 +1826,64 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxBarGauge.Options.startValue" + "Description": "Specifies a start value for the gauge's invisible scale." }, "theme": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title", + "Description": "Configures the widget's title.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.title.font" + "Description": "Specifies font options for the title." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.horizontalAlignment" + "Description": "Specifies the title's alignment in a horizontal direction." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin", + "Description": "Generates space around the title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.bottom" + "Description": "Specifies the bottom margin of the title." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.left" + "Description": "Specifies the left margin of the title." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.right" + "Description": "Specifies the right margin of the title." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.top" + "Description": "Specifies the top margin of the title." } } }, @@ -1973,13 +1891,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle", + "Description": "Configures the widget's subtitle.", "Options": { "font": { "PrimitiveTypes": [ @@ -1988,38 +1906,31 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseWidget.Options.title.subtitle.font" + "Description": "Specifies font options for the subtitle." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.subtitle.offset" + "Description": "Specifies the distance between the title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.text" + "Description": "Specifies text for the subtitle." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.textOverflow" + "Description": "Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.wordWrap" + "Description": "Specifies how to wrap the subtitle if it does not fit into a single line." } } }, @@ -2027,69 +1938,69 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.text" + "Description": "Specifies the title's text." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.textOverflow" + "Description": "Specifies what to do with the title when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.verticalAlignment" + "Description": "Specifies the title's alignment in a vertical direction." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.wordWrap" + "Description": "Specifies how to wrap the title if it does not fit into a single line." } } }, "tooltip": { - "DocID": "dxBarGauge.Options.tooltip", + "Description": "Configures tooltips.", "Options": { "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.arrowLength" + "Description": "Specifies the length of a tooltip's arrow in pixels." }, "border": { - "DocID": "BaseWidget.Options.tooltip.border", + "Description": "Configures a tooltip's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.color" + "Description": "Colors a tooltip's border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.dashStyle" + "Description": "Specifies the dash style of a tooltip's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.opacity" + "Description": "Specifies the transparency of a tooltip's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.border.visible" + "Description": "Specifies whether a tooltip's border is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.width" + "Description": "Specifies the width of a tooltip's border in pixels." } } }, @@ -2097,7 +2008,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.color" + "Description": "Colors all tooltips." }, "container": { "PrimitiveTypes": [ @@ -2105,115 +2016,103 @@ "JQuery", "string" ], - "DocID": "BaseWidget.Options.tooltip.container" + "Description": "Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxBarGauge.Options.tooltip.contentTemplate" + "Description": "Specifies a custom template for a tooltip." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.cornerRadius" + "Description": "Makes all the tooltip's corners rounded." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxBarGauge.Options.tooltip.customizeTooltip" + "Description": "Allows you to change tooltip appearance." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.enabled" + "Description": "Enables tooltips." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.font" + "Description": "Specifies tooltips' font options." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.format" + "Description": "Formats a value before it is displayed it in a tooltip." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.opacity" + "Description": "Specifies tooltips' transparency." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between a tooltip's left/right border and its text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text." }, "shadow": { - "DocID": "BaseWidget.Options.tooltip.shadow", + "Description": "Configures a tooltip's shadow.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.blur" + "Description": "Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.shadow.color" + "Description": "Colors a tooltip's shadow." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetX" + "Description": "Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetY" + "Description": "Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.opacity" + "Description": "Specifies the transparency of a tooltip's shadow." } } }, @@ -2221,7 +2120,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.zIndex" + "Description": "Specifies a tooltip's z-index." } } }, @@ -2232,25 +2131,25 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "value", - "DocID": "dxBarGauge.Options.values" + "Description": "Specifies the array of values to be indicated on a bar gauge." } } }, "dxBox": { - "DocID": "dxBox", + "Description": "The Box widget allows you to arrange various elements within it. Separate and adaptive, the Box widget acts as a building block for the layout.", "Module": "ui/box", "Options": { "align": { "PrimitiveTypes": [ "string" ], - "DocID": "dxBox.Options.align" + "Description": "Specifies how widget items are aligned along the main direction." }, "crossAlign": { "PrimitiveTypes": [ "string" ], - "DocID": "dxBox.Options.crossAlign" + "Description": "Specifies how widget items are aligned cross-wise." }, "dataSource": { "PrimitiveTypes": [ @@ -2266,33 +2165,26 @@ "ItemComplexTypes": [ "BoxItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxBox.Options.dataSource" + "Description": "Binds the widget to data." }, "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxBox.Options.direction" + "Description": "Specifies the direction of item positioning in the widget." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -2301,19 +2193,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -2323,72 +2215,66 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxBox.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "baseSize": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxBoxItem.baseSize" + "Description": "Specifies the base size of an item element along the main direction." }, "box": { "PrimitiveTypes": [ - "dxBoxOptions" + "DevExpress.ui.dxBoxOptions" ], "ComplexTypes": [ "dxBoxOptions" ], - "TypeImports": [ - { - "Name": "dxBoxOptions", - "Path": "ui/box" - } - ], - "DocID": "dxBoxItem.box" + "Description": "Holds a Box configuration object for the item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "ratio": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBoxItem.ratio" + "Description": "Specifies the ratio value used to count the item element size along the main direction." }, "shrink": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBoxItem.shrink" + "Description": "A factor that defines how much an item shrinks relative to the rest of the items in the container." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -2397,7 +2283,7 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "onContentReady": { "PrimitiveTypes": [ @@ -2405,7 +2291,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -2413,7 +2299,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -2421,7 +2307,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -2430,7 +2316,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -2438,7 +2324,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemHold": { "PrimitiveTypes": [ @@ -2446,7 +2332,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -2454,7 +2340,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -2462,19 +2348,19 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -2483,64 +2369,64 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxBullet": { - "DocID": "dxBullet", + "Description": "The Bullet widget is useful when you need to compare a single measure to a target value. The widget comprises a horizontal bar indicating the measure and a vertical line indicating the target value.", "Module": "viz/bullet", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxBullet.Options.color" + "Description": "Specifies a color for the bullet bar." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "endScaleValue": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBullet.Options.endScaleValue" + "Description": "Specifies an end value for the invisible scale." }, "margin": { - "DocID": "BaseWidget.Options.margin", + "Description": "Generates space around the widget.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.bottom" + "Description": "Specifies the bottom margin of the widget in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.left" + "Description": "Specifies the left margin of the widget in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.right" + "Description": "Specifies the right margin of the widget in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.top" + "Description": "Specifies the top margin of the widget in pixels." } } }, @@ -2550,7 +2436,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDrawn": { "PrimitiveTypes": [ @@ -2558,7 +2444,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onExported": { "PrimitiveTypes": [ @@ -2566,7 +2452,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -2574,7 +2460,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -2582,7 +2468,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -2590,7 +2476,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -2598,7 +2484,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -2606,7 +2492,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onTooltipHidden": { "PrimitiveTypes": [ @@ -2614,7 +2500,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseSparkline.Options.onTooltipHidden" + "Description": "A function that is executed when a tooltip becomes hidden." }, "onTooltipShown": { "PrimitiveTypes": [ @@ -2622,46 +2508,46 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseSparkline.Options.onTooltipShown" + "Description": "A function that is executed when a tooltip appears." }, "pathModified": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showTarget": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxBullet.Options.showTarget" + "Description": "Specifies whether or not to show the target line." }, "showZeroLevel": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxBullet.Options.showZeroLevel" + "Description": "Specifies whether or not to show the line indicating zero on the invisible scale." }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, @@ -2669,73 +2555,73 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxBullet.Options.startScaleValue" + "Description": "Specifies a start value for the invisible scale." }, "target": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBullet.Options.target" + "Description": "Specifies the value indicated by the target line." }, "targetColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxBullet.Options.targetColor" + "Description": "Specifies a color for both the target and zero level lines." }, "targetWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBullet.Options.targetWidth" + "Description": "Specifies the width of the target line." }, "theme": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "tooltip": { - "DocID": "BaseSparkline.Options.tooltip", + "Description": "Configures the tooltip.", "Options": { "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.arrowLength" + "Description": "Specifies the length of a tooltip's arrow in pixels." }, "border": { - "DocID": "BaseWidget.Options.tooltip.border", + "Description": "Configures a tooltip's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.color" + "Description": "Colors a tooltip's border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.dashStyle" + "Description": "Specifies the dash style of a tooltip's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.opacity" + "Description": "Specifies the transparency of a tooltip's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.border.visible" + "Description": "Specifies whether a tooltip's border is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.width" + "Description": "Specifies the width of a tooltip's border in pixels." } } }, @@ -2743,7 +2629,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.color" + "Description": "Colors all tooltips." }, "container": { "PrimitiveTypes": [ @@ -2751,115 +2637,103 @@ "JQuery", "string" ], - "DocID": "BaseWidget.Options.tooltip.container" + "Description": "Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "BaseSparkline.Options.tooltip.contentTemplate" + "Description": "Specifies a custom template for tooltips." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.cornerRadius" + "Description": "Makes all the tooltip's corners rounded." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseSparkline.Options.tooltip.customizeTooltip" + "Description": "Allows you to change tooltip appearance." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseSparkline.Options.tooltip.enabled" + "Description": "Enables tooltips." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.font" + "Description": "Specifies tooltips' font options." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.format" + "Description": "Formats a value before it is displayed it in a tooltip." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.opacity" + "Description": "Specifies tooltips' transparency." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between a tooltip's left/right border and its text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text." }, "shadow": { - "DocID": "BaseWidget.Options.tooltip.shadow", + "Description": "Configures a tooltip's shadow.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.blur" + "Description": "Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.shadow.color" + "Description": "Colors a tooltip's shadow." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetX" + "Description": "Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetY" + "Description": "Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.opacity" + "Description": "Specifies the transparency of a tooltip's shadow." } } }, @@ -2867,7 +2741,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.zIndex" + "Description": "Specifies a tooltip's z-index." } } }, @@ -2875,12 +2749,12 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxBullet.Options.value" + "Description": "Specifies the primary value indicated by the bullet bar." } } }, "dxButton": { - "DocID": "dxButton", + "Description": "The Button widget is a simple button that performs specified commands when a user clicks it.", "IsTranscludedContent": true, "Module": "ui/button", "Options": { @@ -2888,31 +2762,31 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxButton.Options.activeStateEnabled" + "Description": "A Boolean value specifying whether or not the widget changes its state when interacting with a user." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxButton.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -2921,25 +2795,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxButton.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxButton.Options.icon" + "Description": "Specifies the icon to be displayed on the button." }, "onClick": { "PrimitiveTypes": [ @@ -2947,7 +2821,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxButton.Options.onClick" + "Description": "A function that is executed when the Button is clicked or tapped." }, "onContentReady": { "PrimitiveTypes": [ @@ -2955,7 +2829,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -2963,7 +2837,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -2971,7 +2845,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -2979,62 +2853,62 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxButton.Options.stylingMode" + "Description": "Specifies how the button is styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxButton.Options.template" + "Description": "Specifies a custom template for the Button widget." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxButton.Options.text" + "Description": "The text displayed on the button." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxButton.Options.type" + "Description": "Specifies the button type." }, "useSubmitBehavior": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxButton.Options.useSubmitBehavior" + "Description": "Specifies whether the button submits an HTML form." }, "validationGroup": { "PrimitiveTypes": [ "string" ], - "DocID": "dxButton.Options.validationGroup" + "Description": "Specifies the name of the validation group to be accessed in the click event handler." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -3043,50 +2917,50 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxButtonGroup": { - "DocID": "dxButtonGroup", + "Description": "The ButtonGroup is a widget that contains a set of toggle buttons and can be used as a mode switcher.", "Module": "ui/button_group", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "buttonTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxButtonGroup.Options.buttonTemplate" + "Description": "Specifies a template for all the buttons in the group." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxButtonGroup.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -3095,19 +2969,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxButtonGroup.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "items": { "ItemPrimitiveTypes": [ @@ -3116,16 +2990,9 @@ "ItemComplexTypes": [ "ButtonGroupItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "item", - "DocID": "dxButtonGroup.Options.items" + "Description": "Configures buttons in the group." }, "itemTemplate": { "PrimitiveTypes": [ @@ -3133,7 +3000,7 @@ ], "IsDeprecated": true, "IsTemplate": true, - "DocID": "dxButtonGroup.Options.itemTemplate" + "Description": "Use the buttonTemplate option instead." }, "keyExpr": { "PrimitiveTypes": [ @@ -3141,7 +3008,7 @@ "string" ], "IsFunc": true, - "DocID": "dxButtonGroup.Options.keyExpr" + "Description": "Specifies which data field provides keys used to distinguish between the selected buttons." }, "onContentReady": { "PrimitiveTypes": [ @@ -3149,7 +3016,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -3157,7 +3024,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -3165,7 +3032,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -3173,7 +3040,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxButtonGroup.Options.onItemClick" + "Description": "A function that is executed when a button is clicked or tapped." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -3181,7 +3048,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -3189,13 +3056,13 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxButtonGroup.Options.onSelectionChanged" + "Description": "A function that is executed when a button is selected or selection is canceled." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectedItemKeys": { "ItemPrimitiveTypes": [ @@ -3204,7 +3071,7 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "selectedItemKey", - "DocID": "dxButtonGroup.Options.selectedItemKeys" + "Description": "Contains the keys of the selected buttons and allows selecting buttons initially." }, "selectedItems": { "ItemPrimitiveTypes": [ @@ -3213,31 +3080,31 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "selectedItem", - "DocID": "dxButtonGroup.Options.selectedItems" + "Description": "Contains the data objects that correspond to the selected buttons. The data objects are taken from the items array." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxButtonGroup.Options.selectionMode" + "Description": "Specifies whether a single or multiple buttons can be in the selected state simultaneously." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxButtonGroup.Options.stylingMode" + "Description": "Specifies how buttons in the group are styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -3246,12 +3113,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxCalendar": { - "DocID": "dxCalendar", + "Description": "The Calendar is a widget that displays a calendar and allows an end user to select the required date within a specified date range.", "Module": "ui/calendar", "IsEditor": true, "Options": { @@ -3259,32 +3126,32 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxCalendar.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "cellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxCalendar.Options.cellTemplate" + "Description": "Specifies a custom template for calendar cells." }, "dateSerializationFormat": { "PrimitiveTypes": [ "string" ], - "DocID": "dxCalendar.Options.dateSerializationFormat" + "Description": "Specifies the date-time value serialization format. Use it only if you do not specify the value at design time." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "disabledDates": { "PrimitiveTypes": [ @@ -3296,26 +3163,26 @@ "IsCollection": true, "IsFunc": true, "SingularName": "disabledDate", - "DocID": "dxCalendar.Options.disabledDates" + "Description": "Specifies dates that users cannot select." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "firstDayOfWeek": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxCalendar.Options.firstDayOfWeek" + "Description": "Specifies the first day of a week." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxCalendar.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -3324,25 +3191,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxCalendar.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "max": { "PrimitiveTypes": [ @@ -3350,13 +3217,13 @@ "number", "string" ], - "DocID": "dxCalendar.Options.max" + "Description": "The latest date the widget allows to select." }, "maxZoomLevel": { "PrimitiveTypes": [ "string" ], - "DocID": "dxCalendar.Options.maxZoomLevel" + "Description": "Specifies the maximum zoom level of the calendar." }, "min": { "PrimitiveTypes": [ @@ -3364,19 +3231,19 @@ "number", "string" ], - "DocID": "dxCalendar.Options.min" + "Description": "The earliest date the widget allows to select." }, "minZoomLevel": { "PrimitiveTypes": [ "string" ], - "DocID": "dxCalendar.Options.minZoomLevel" + "Description": "Specifies the minimum zoom level of the calendar." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxCalendar.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "onDisposing": { "PrimitiveTypes": [ @@ -3384,7 +3251,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -3392,7 +3259,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -3400,7 +3267,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onValueChanged": { "PrimitiveTypes": [ @@ -3408,37 +3275,37 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showTodayButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxCalendar.Options.showTodayButton" + "Description": "Specifies whether or not the widget displays a button that selects the current date." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -3446,19 +3313,19 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ @@ -3467,13 +3334,13 @@ "string" ], "IsChangeable": true, - "DocID": "dxCalendar.Options.value" + "Description": "An object or a value specifying the date and time currently selected in the calendar." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -3482,41 +3349,41 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." }, "zoomLevel": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "dxCalendar.Options.zoomLevel" + "Description": "Specifies the current calendar zoom level." } } }, "dxChart": { - "DocID": "dxChart", + "Description": "The Chart is a widget that visualizes data from a local or remote storage using a great variety of series types along with different interactive elements, such as tooltips, crosshair pointer, legend, etc.", "Module": "viz/chart", "Options": { "adaptiveLayout": { - "DocID": "BaseChart.Options.adaptiveLayout", + "Description": "Specifies adaptive layout options.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseChart.Options.adaptiveLayout.height" + "Description": "Specifies the minimum container height at which the layout begins to adapt." }, "keepLabels": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseChart.Options.adaptiveLayout.keepLabels" + "Description": "Specifies whether point labels should be kept when the widget adapts the layout." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseChart.Options.adaptiveLayout.width" + "Description": "Specifies the minimum container width at which the layout begins to adapt." } } }, @@ -3524,37 +3391,37 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.adjustOnZoom" + "Description": "Specifies whether to adjust the value axis's visualRange when the argument axis is being zoomed or panned." }, "animation": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseChart.Options.animation", + "Description": "Specifies animation options.", "Options": { "duration": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseChart.Options.animation.duration" + "Description": "Specifies how long the animation runs in milliseconds." }, "easing": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseChart.Options.animation.easing" + "Description": "Specifies the easing function of the animation." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseChart.Options.animation.enabled" + "Description": "Enables the animation in the widget." }, "maxPointCountSupported": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseChart.Options.animation.maxPointCountSupported" + "Description": "Specifies how many series points the widget should have before the animation will be disabled." } } }, @@ -3566,92 +3433,85 @@ "ItemComplexTypes": [ "ChartAnnotationConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "annotation", - "DocID": "dxChart.Options.annotations" + "Description": "Specifies the annotation collection." }, "argumentAxis": { - "DocID": "dxChart.Options.argumentAxis", + "Description": "Configures the argument axis.", "Options": { "aggregateByCategory": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.argumentAxis.aggregateByCategory" + "Description": "Aggregates series points that fall into the same category." }, "aggregationGroupWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.argumentAxis.aggregationGroupWidth" + "Description": "Specifies the length of aggregation intervals in pixels. Does not apply if aggregateByCategory is true. May be ignored in favor of the aggregationInterval option." }, "aggregationInterval": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxChart.Options.argumentAxis.aggregationInterval", + "Description": "Specifies the length of aggregation intervals in axis units. Applies only to axes of continuous and logarithmic types.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -3659,19 +3519,19 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.allowDecimals" + "Description": "Specifies whether to allow decimal values on the axis. When false, the axis contains integer values only." }, "argumentType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.argumentType" + "Description": "Casts arguments to a specified data type." }, "axisDivisionFactor": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.argumentAxis.axisDivisionFactor" + "Description": "Specifies the minimum distance between two neighboring major ticks in pixels. Applies only to the axes of the \"continuous\" and \"logarithmic\" types." }, "breaks": { "ItemPrimitiveTypes": [ @@ -3680,37 +3540,30 @@ "ItemComplexTypes": [ "VizScaleBreak" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "break", - "DocID": "dxChart.Options.argumentAxis.breaks" + "Description": "Declares a scale break collection. Applies only if the axis' type is \"continuous\" or \"logarithmic\"." }, "breakStyle": { - "DocID": "dxChart.Options.commonAxisSettings.breakStyle", + "Description": "Configures the scale breaks' appearance.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.breakStyle.color" + "Description": "Specifies the scale breaks' color." }, "line": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.breakStyle.line" + "Description": "Specifies the scale breaks' line style." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.breakStyle.width" + "Description": "Specifies the scale breaks' width in pixels." } } }, @@ -3722,13 +3575,13 @@ ], "IsCollection": true, "SingularName": "category", - "DocID": "dxChart.Options.argumentAxis.categories" + "Description": "Specifies the order of categories on an axis of the \"discrete\" type." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.color" + "Description": "Specifies the color of the axis line." }, "constantLines": { "ItemPrimitiveTypes": [ @@ -3736,79 +3589,73 @@ ], "IsCollection": true, "SingularName": "constantLine", - "DocID": "dxChart.Options.argumentAxis.constantLines", + "Description": "Declares a collection of constant lines belonging to the argument axis.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.color" + "Description": "Specifies the color of constant lines." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.dashStyle" + "Description": "Specifies the dash style of constant lines." }, "displayBehindSeries": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.argumentAxis.constantLines.displayBehindSeries" + "Description": "Specifies whether to display the constant line behind or in front of the series." }, "extendAxis": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.argumentAxis.constantLines.extendAxis" + "Description": "Specifies whether to extend the axis's default visual range to display the constant line." }, "label": { - "DocID": "dxChart.Options.argumentAxis.constantLines.label", + "Description": "Configures the constant line label.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.font" + "Description": "Specifies font options for constant line labels." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.constantLines.label.horizontalAlignment" + "Description": "Aligns constant line labels in the horizontal direction." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.position" + "Description": "Specifies the position of constant line labels on the chart plot." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.constantLines.label.text" + "Description": "Specifies the text of a constant line label. By default, equals to the value of the constant line." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.constantLines.label.verticalAlignment" + "Description": "Aligns constant line labels in the vertical direction." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.visible" + "Description": "Makes constant line labels visible." } } }, @@ -3816,13 +3663,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.paddingLeftRight" + "Description": "Generates a pixel-measured empty space between the left/right side of a constant line and the constant line label." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.paddingTopBottom" + "Description": "Generates a pixel-measured empty space between the top/bottom side of a constant line and the constant line label." }, "value": { "PrimitiveTypes": [ @@ -3830,72 +3677,66 @@ "number", "string" ], - "DocID": "dxChart.Options.argumentAxis.constantLines.value" + "Description": "Specifies the value indicated by a constant line. Setting this option is necessary." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.width" + "Description": "Specifies the width of constant lines in pixels." } } }, "constantLineStyle": { - "DocID": "dxChart.Options.argumentAxis.constantLineStyle", + "Description": "Specifies the appearance of those constant lines that belong to the argument axis.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.color" + "Description": "Specifies the color of constant lines." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.dashStyle" + "Description": "Specifies the dash style of constant lines." }, "label": { - "DocID": "dxChart.Options.argumentAxis.constantLineStyle.label", + "Description": "Specifies the appearance of the labels of those constant lines that belong to the argument axis.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.font" + "Description": "Specifies font options for constant line labels." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.constantLineStyle.label.horizontalAlignment" + "Description": "Aligns constant line labels in the horizontal direction." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.position" + "Description": "Specifies the position of constant line labels on the chart plot." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.constantLineStyle.label.verticalAlignment" + "Description": "Aligns constant line labels in the vertical direction." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.visible" + "Description": "Makes constant line labels visible." } } }, @@ -3903,19 +3744,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.paddingLeftRight" + "Description": "Generates a pixel-measured empty space between the left/right side of a constant line and the constant line label." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.paddingTopBottom" + "Description": "Generates a pixel-measured empty space between the top/bottom side of a constant line and the constant line label." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.width" + "Description": "Specifies the width of constant lines in pixels." } } }, @@ -3923,40 +3764,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.discreteAxisDivisionMode" + "Description": "Specifies whether ticks and grid lines should cross axis labels or lie between them. Applies only to the axes of the \"discrete\" type." }, "endOnTick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.argumentAxis.endOnTick" + "Description": "Specifies whether to force the axis to start and end on ticks." }, "grid": { - "DocID": "dxChart.Options.commonAxisSettings.grid", + "Description": "Configures the grid.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.grid.color" + "Description": "Specifies the color of grid lines." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.grid.opacity" + "Description": "Specifies how transparent grid lines should be." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.grid.visible" + "Description": "Makes grid lines visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.grid.width" + "Description": "Specifies the width of grid lines in pixels." } } }, @@ -3968,121 +3809,109 @@ ], "IsCollection": true, "SingularName": "holiday", - "DocID": "dxChart.Options.argumentAxis.holidays" + "Description": "Dates to be excluded from the axis when workdaysOnly is true." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.hoverMode" + "Description": "Specifies chart elements to be highlighted when a user points to an axis label." }, "inverted": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.inverted" + "Description": "Inverts the axis." }, "label": { - "DocID": "dxChart.Options.argumentAxis.label", + "Description": "Configures the labels of the argument axis.", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.alignment" + "Description": "Aligns axis labels in relation to ticks." }, "customizeHint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChart.Options.argumentAxis.label.customizeHint" + "Description": "Specifies the hint that appears when a user points to an axis label." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChart.Options.argumentAxis.label.customizeText" + "Description": "Customizes the text displayed by axis labels." }, "displayMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.displayMode" + "Description": "Allows you to rotate or stagger axis labels. Applies to the horizontal axis only." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.label.font" + "Description": "Specifies font options for axis labels." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxChart.Options.argumentAxis.label.format" + "Description": "Formats a value before it is displayed in an axis label." }, "indentFromAxis": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.label.indentFromAxis" + "Description": "Adds a pixel-measured empty space between an axis and its labels." }, "overlappingBehavior": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.overlappingBehavior" + "Description": "Decides how to arrange axis labels when there is not enough space to keep all of them." }, "rotationAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.label.rotationAngle" + "Description": "Specifies the rotation angle of axis labels. Applies only if displayMode or overlappingBehavior is \"rotate\"." }, "staggeringSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.label.staggeringSpacing" + "Description": "Adds a pixel-measured empty space between two staggered rows of axis labels. Applies only if displayMode or overlappingBehavior is \"stagger\"." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.textOverflow" + "Description": "Specifies what to do with axis labels that overflow the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.label.visible" + "Description": "Shows/hides axis labels." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.wordWrap" + "Description": "Specifies how to wrap texts that do not fit into a single line." } } }, @@ -4090,13 +3919,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.argumentAxis.linearThreshold" + "Description": "Specifies a value used to calculate the range on a logarithmic axis within which the axis should be linear. Applies only if the data source contains negative values or zeroes." }, "logarithmBase": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.argumentAxis.logarithmBase" + "Description": "Specifies the value to be raised to a power when generating ticks for an axis of the \"logarithmic\" type." }, "max": { "PrimitiveTypes": [ @@ -4105,13 +3934,13 @@ "string" ], "IsDeprecated": true, - "DocID": "dxChart.Options.argumentAxis.max" + "Description": "Use the argumentAxis.visualRange option instead." }, "maxValueMargin": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.maxValueMargin" + "Description": "Controls the empty space between the maximum series points and the axis. Applies only to the axes of the \"continuous\" and \"logarithmic\" type." }, "min": { "PrimitiveTypes": [ @@ -4120,75 +3949,75 @@ "string" ], "IsDeprecated": true, - "DocID": "dxChart.Options.argumentAxis.min" + "Description": "Use the argumentAxis.visualRange option instead." }, "minorGrid": { - "DocID": "dxChart.Options.commonAxisSettings.minorGrid", + "Description": "Configures the minor grid.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.minorGrid.color" + "Description": "Specifies a color for the lines of the minor grid." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorGrid.opacity" + "Description": "Specifies how transparent the lines of the minor grid should be." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.minorGrid.visible" + "Description": "Makes the minor grid visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorGrid.width" + "Description": "Specifies a width for the lines of the minor grid in pixels." } } }, "minorTick": { - "DocID": "dxChart.Options.commonAxisSettings.minorTick", + "Description": "Configures the appearance of minor axis ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.color" + "Description": "Specifies the color of minor ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.length" + "Description": "Specifies the length of minor ticks in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.opacity" + "Description": "Specifies how transparent minor ticks should be." }, "shift": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.shift" + "Description": "Shifts minor ticks from the reference position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.visible" + "Description": "Makes minor ticks visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.width" + "Description": "Specifies the width of minor ticks in pixels." } } }, @@ -4196,68 +4025,68 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.argumentAxis.minorTickCount" + "Description": "Specifies how many minor ticks to place between two neighboring major ticks." }, "minorTickInterval": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxChart.Options.argumentAxis.minorTickInterval", + "Description": "Specifies the interval between minor ticks. Applies only to the axes of the \"continuous\" type.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -4265,68 +4094,68 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minValueMargin" + "Description": "Controls the empty space between the minimum series points and the axis. Applies only to the axes of the \"continuous\" and \"logarithmic\" type." }, "minVisualRangeLength": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxChart.Options.argumentAxis.minVisualRangeLength", + "Description": "Specifies the minimum length of the visual range.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -4334,19 +4163,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.opacity" + "Description": "Specifies how transparent the axis line should be." }, "placeholderSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.placeholderSize" + "Description": "Reserves a pixel-measured space for the axis." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.position" + "Description": "Relocates the argument axis." }, "singleWorkdays": { "ItemPrimitiveTypes": [ @@ -4356,7 +4185,7 @@ ], "IsCollection": true, "SingularName": "singleWorkday", - "DocID": "dxChart.Options.argumentAxis.singleWorkdays" + "Description": "Dates to be included on the axis when workdaysOnly is true." }, "strips": { "ItemPrimitiveTypes": [ @@ -4364,13 +4193,13 @@ ], "IsCollection": true, "SingularName": "strip", - "DocID": "dxChart.Options.argumentAxis.strips", + "Description": "Declares a collection of strips belonging to the argument axis.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.strips.color" + "Description": "Specifies the color of the strip." }, "endValue": { "PrimitiveTypes": [ @@ -4378,43 +4207,37 @@ "number", "string" ], - "DocID": "dxChart.Options.argumentAxis.strips.endValue" + "Description": "Along with the startValue option, limits the strip." }, "label": { - "DocID": "dxChart.Options.argumentAxis.strips.label", + "Description": "Configures the strip label.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.font" + "Description": "Specifies font options for strip labels." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.horizontalAlignment" + "Description": "Aligns strip labels in the horizontal direction." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.strips.label.text" + "Description": "Specifies the text of the strip label." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.verticalAlignment" + "Description": "Aligns strip labels in the vertical direction." } } }, @@ -4422,13 +4245,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.paddingLeftRight" + "Description": "Generates a pixel-measured empty space between the left/right border of a strip and the strip label." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.paddingTopBottom" + "Description": "Generates a pixel-measured empty space between the top/bottom border of a strip and the strip label." }, "startValue": { "PrimitiveTypes": [ @@ -4436,42 +4259,36 @@ "number", "string" ], - "DocID": "dxChart.Options.argumentAxis.strips.startValue" + "Description": "Along with the endValue option, limits the strip." } } }, "stripStyle": { - "DocID": "dxChart.Options.commonAxisSettings.stripStyle", + "Description": "Configures the appearance of strips.", "Options": { "label": { - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label", + "Description": "Configures the appearance of strip labels.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.font" + "Description": "Specifies font options for strip labels." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.horizontalAlignment" + "Description": "Aligns strip labels in the horizontal direction." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.verticalAlignment" + "Description": "Aligns strip labels in the vertical direction." } } }, @@ -4479,54 +4296,54 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.paddingLeftRight" + "Description": "Generates a pixel-measured empty space between the left/right border of a strip and the strip label." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.paddingTopBottom" + "Description": "Generates a pixel-measured empty space between the top/bottom border of a strip and the strip label." } } }, "tick": { - "DocID": "dxChart.Options.commonAxisSettings.tick", + "Description": "Configures the appearance of major axis ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.color" + "Description": "Specifies the color of ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.length" + "Description": "Specifies the length of ticks in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.opacity" + "Description": "Specifies how transparent ticks should be." }, "shift": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.shift" + "Description": "Shifts ticks from the reference position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.visible" + "Description": "Makes ticks visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.width" + "Description": "Specifies the width of ticks in pixels." } } }, @@ -4535,61 +4352,61 @@ "number", "string" ], - "DocID": "dxChart.Options.argumentAxis.tickInterval", + "Description": "Specifies the interval between major ticks.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -4597,52 +4414,46 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.title", + "Description": "Configures the axis title.", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.title.alignment" + "Description": "Aligns the axis title to the left, center, or right of the axis." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.title.font" + "Description": "Specifies font options for the axis title." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.title.margin" + "Description": "Adds a pixel-measured empty space between the axis title and axis labels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.title.text" + "Description": "Specifies the text of the axis title." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.title.textOverflow" + "Description": "Specifies what to do with the axis title when it overflows the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.title.wordWrap" + "Description": "Specifies how to wrap the axis title if it does not fit into a single line." } } }, @@ -4650,19 +4461,19 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.type" + "Description": "Specifies the type of the argument axis." }, "valueMarginsEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.valueMarginsEnabled" + "Description": "Adds an empty space between the axis and the minimum and maximum series points." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.visible" + "Description": "Makes the axis line visible." }, "visualRange": { "PrimitiveTypes": [ @@ -4676,23 +4487,16 @@ "string", "Date" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "IsChangeable": true, "SingularName": "visualRange", - "DocID": "dxChart.Options.argumentAxis.visualRange" + "Description": "Defines the axis' displayed range. Cannot be wider than the wholeRange." }, "visualRangeUpdateMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.argumentAxis.visualRangeUpdateMode" + "Description": "Specifies how the axis's visual range should behave when chart data is updated." }, "wholeRange": { "PrimitiveTypes": [ @@ -4706,28 +4510,21 @@ "string", "Date" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "wholeRange", - "DocID": "dxChart.Options.argumentAxis.wholeRange" + "Description": "Defines the range where the axis can be zoomed and panned." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.width" + "Description": "Specifies the width of the axis line in pixels." }, "workdaysOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.argumentAxis.workdaysOnly" + "Description": "Leaves only workdays on the axis: the work week days plus single workdays minus holidays. Applies only if the axis' argumentType is \"datetime\"." }, "workWeek": { "ItemPrimitiveTypes": [ @@ -4735,7 +4532,7 @@ ], "IsCollection": true, "SingularName": "workWeek", - "DocID": "dxChart.Options.argumentAxis.workWeek" + "Description": "Specifies which days are workdays. The array can contain values from 0 (Sunday) to 6 (Saturday). Applies only if workdaysOnly is true." } } }, @@ -4743,71 +4540,65 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.autoHidePointMarkers" + "Description": "Specifies whether to hide series point markers automatically to reduce visual clutter." }, "barGroupPadding": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.barGroupPadding" + "Description": "Controls the padding and consequently the width of a group of bars with the same argument using relative units. Ignored if the barGroupWidth option is set." }, "barGroupWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.barGroupWidth" + "Description": "Specifies a fixed width for groups of bars with the same argument, measured in pixels. Takes precedence over the barGroupPadding option." }, "barWidth": { "PrimitiveTypes": [ "number" ], "IsDeprecated": true, - "DocID": "dxChart.Options.barWidth" + "Description": "Use CommonSeries.barPadding instead." }, "commonAnnotationSettings": { "PrimitiveTypes": [ - "dxChartCommonAnnotationConfig" + "DevExpress.viz.dxChartCommonAnnotationConfig" ], "ComplexTypes": [ "ChartCommonAnnotationConfig" ], - "TypeImports": [ - { - "Name": "dxChartCommonAnnotationConfig", - "Path": "viz/chart" - } - ], - "DocID": "dxChart.Options.commonAnnotationSettings" + "Description": "Specifies settings common for all annotations in the chart." }, "commonAxisSettings": { - "DocID": "dxChart.Options.commonAxisSettings", + "Description": "Defines common settings for both the argument and value axis in a chart.", "Options": { "allowDecimals": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.allowDecimals" + "Description": "Specifies whether to allow decimal values on the axis. When false, the axis contains integer values only." }, "breakStyle": { - "DocID": "dxChart.Options.commonAxisSettings.breakStyle", + "Description": "Configures the scale breaks' appearance.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.breakStyle.color" + "Description": "Specifies the scale breaks' color." }, "line": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.breakStyle.line" + "Description": "Specifies the scale breaks' line style." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.breakStyle.width" + "Description": "Specifies the scale breaks' width in pixels." } } }, @@ -4815,52 +4606,46 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.color" + "Description": "Specifies the color of the axis line." }, "constantLineStyle": { - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle", + "Description": "Configures the appearance of all constant lines in the widget.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.color" + "Description": "Specifies the color of constant lines." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.dashStyle" + "Description": "Specifies the dash style of constant lines." }, "label": { - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label", + "Description": "Configures constant line labels.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.font" + "Description": "Specifies font options for constant line labels." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.position" + "Description": "Specifies the position of constant line labels on the chart plot." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.visible" + "Description": "Makes constant line labels visible." } } }, @@ -4868,19 +4653,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.paddingLeftRight" + "Description": "Generates a pixel-measured empty space between the left/right side of a constant line and the constant line label." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.paddingTopBottom" + "Description": "Generates a pixel-measured empty space between the top/bottom side of a constant line and the constant line label." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.width" + "Description": "Specifies the width of constant lines in pixels." } } }, @@ -4888,40 +4673,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.discreteAxisDivisionMode" + "Description": "Specifies whether ticks and grid lines should cross axis labels or lie between them. Applies only to the axes of the \"discrete\" type." }, "endOnTick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.endOnTick" + "Description": "Specifies whether to force the axis to start and end on ticks." }, "grid": { - "DocID": "dxChart.Options.commonAxisSettings.grid", + "Description": "Configures the grid.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.grid.color" + "Description": "Specifies the color of grid lines." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.grid.opacity" + "Description": "Specifies how transparent grid lines should be." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.grid.visible" + "Description": "Makes grid lines visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.grid.width" + "Description": "Specifies the width of grid lines in pixels." } } }, @@ -4929,79 +4714,73 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.inverted" + "Description": "Inverts the axis." }, "label": { - "DocID": "dxChart.Options.commonAxisSettings.label", + "Description": "Configures axis labels.", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.alignment" + "Description": "Aligns axis labels in relation to ticks." }, "displayMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.displayMode" + "Description": "Allows you to rotate or stagger axis labels. Applies to the horizontal axis only." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.label.font" + "Description": "Specifies font options for axis labels." }, "indentFromAxis": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.label.indentFromAxis" + "Description": "Adds a pixel-measured empty space between an axis and its labels." }, "overlappingBehavior": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.overlappingBehavior" + "Description": "Decides how to arrange axis labels when there is not enough space to keep all of them." }, "rotationAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.label.rotationAngle" + "Description": "Specifies the rotation angle of axis labels. Applies only if displayMode or overlappingBehavior is \"rotate\"." }, "staggeringSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.label.staggeringSpacing" + "Description": "Adds a pixel-measured empty space between two staggered rows of axis labels. Applies only if displayMode or overlappingBehavior is \"stagger\"." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.textOverflow" + "Description": "Specifies what to do with axis labels that overflow the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.label.visible" + "Description": "Shows/hides axis labels." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.wordWrap" + "Description": "Specifies how to wrap texts that do not fit into a single line." } } }, @@ -5009,75 +4788,75 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.maxValueMargin" + "Description": "Controls the empty space between the maximum series points and the axis. Applies only to the axes of the \"continuous\" and \"logarithmic\" type." }, "minorGrid": { - "DocID": "dxChart.Options.commonAxisSettings.minorGrid", + "Description": "Configures the minor grid.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.minorGrid.color" + "Description": "Specifies a color for the lines of the minor grid." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorGrid.opacity" + "Description": "Specifies how transparent the lines of the minor grid should be." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.minorGrid.visible" + "Description": "Makes the minor grid visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorGrid.width" + "Description": "Specifies a width for the lines of the minor grid in pixels." } } }, "minorTick": { - "DocID": "dxChart.Options.commonAxisSettings.minorTick", + "Description": "Configures the appearance of minor axis ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.color" + "Description": "Specifies the color of minor ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.length" + "Description": "Specifies the length of minor ticks in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.opacity" + "Description": "Specifies how transparent minor ticks should be." }, "shift": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.shift" + "Description": "Shifts minor ticks from the reference position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.visible" + "Description": "Makes minor ticks visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.width" + "Description": "Specifies the width of minor ticks in pixels." } } }, @@ -5085,52 +4864,46 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minValueMargin" + "Description": "Controls the empty space between the minimum series points and the axis. Applies only to the axes of the \"continuous\" and \"logarithmic\" type." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.opacity" + "Description": "Specifies how transparent the axis line should be." }, "placeholderSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.placeholderSize" + "Description": "Reserves a pixel-measured space for the axis." }, "stripStyle": { - "DocID": "dxChart.Options.commonAxisSettings.stripStyle", + "Description": "Configures the appearance of strips.", "Options": { "label": { - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label", + "Description": "Configures the appearance of strip labels.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.font" + "Description": "Specifies font options for strip labels." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.horizontalAlignment" + "Description": "Aligns strip labels in the horizontal direction." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.verticalAlignment" + "Description": "Aligns strip labels in the vertical direction." } } }, @@ -5138,98 +4911,92 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.paddingLeftRight" + "Description": "Generates a pixel-measured empty space between the left/right border of a strip and the strip label." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.paddingTopBottom" + "Description": "Generates a pixel-measured empty space between the top/bottom border of a strip and the strip label." } } }, "tick": { - "DocID": "dxChart.Options.commonAxisSettings.tick", + "Description": "Configures the appearance of major axis ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.color" + "Description": "Specifies the color of ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.length" + "Description": "Specifies the length of ticks in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.opacity" + "Description": "Specifies how transparent ticks should be." }, "shift": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.shift" + "Description": "Shifts ticks from the reference position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.visible" + "Description": "Makes ticks visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.width" + "Description": "Specifies the width of ticks in pixels." } } }, "title": { - "DocID": "dxChart.Options.commonAxisSettings.title", + "Description": "Configures axis titles.", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.title.alignment" + "Description": "Aligns the axis title to the left, center, or right of the axis." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.title.font" + "Description": "Specifies font options for the axis title." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.title.margin" + "Description": "Adds a pixel-measured empty space between the axis title and axis labels." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.title.textOverflow" + "Description": "Specifies what to do with the axis title when it overflows the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.title.wordWrap" + "Description": "Specifies how to wrap the axis title if it does not fit into a single line." } } }, @@ -5237,87 +5004,87 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.valueMarginsEnabled" + "Description": "Adds an empty space between the axis and the minimum and maximum series points." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.visible" + "Description": "Makes the axis line visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.width" + "Description": "Specifies the width of the axis line in pixels." } } }, "commonPaneSettings": { - "DocID": "dxChart.Options.commonPaneSettings", + "Description": "Defines common settings for all panes in a chart.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonPaneSettings.backgroundColor" + "Description": "Specifies the color of the pane's background." }, "border": { - "DocID": "dxChart.Options.commonPaneSettings.border", + "Description": "Configures the pane border.", "Options": { "bottom": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonPaneSettings.border.bottom" + "Description": "Shows/hides the bottom border of the pane. Applies only when the border.visible option is true." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonPaneSettings.border.color" + "Description": "Specifies the color of the pane border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonPaneSettings.border.dashStyle" + "Description": "Specifies the dash style of the pane border." }, "left": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonPaneSettings.border.left" + "Description": "Shows/hides the left border of the pane. Applies only when the border.visible option is true." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonPaneSettings.border.opacity" + "Description": "Specifies how transparent the pane border should be." }, "right": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonPaneSettings.border.right" + "Description": "Shows/hides the right border of the pane. Applies only when the border.visible option is true." }, "top": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonPaneSettings.border.top" + "Description": "Shows/hides the top border of the pane. Applies only when the border.visible option is true." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonPaneSettings.border.visible" + "Description": "Shows the pane border." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonPaneSettings.border.width" + "Description": "Specifies the width of the pane border in pixels." } } } @@ -5330,68 +5097,68 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "dxChart.Options.commonSeriesSettings" + "Description": "Specifies settings common for all series in the chart." }, "containerBackgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.containerBackgroundColor" + "Description": "Colors the background of the chart container." }, "crosshair": { - "DocID": "dxChart.Options.crosshair", + "Description": "Configures the crosshair feature.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.crosshair.color" + "Description": "Specifies the color of the crosshair lines." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.crosshair.dashStyle" + "Description": "Specifies the dash style of the crosshair lines." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.crosshair.enabled" + "Description": "Enables the crosshair." }, "horizontalLine": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.crosshair.horizontalLine", + "Description": "Configures the horizontal crosshair line individually.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.crosshair.horizontalLine.color" + "Description": "Specifies the color of the horizontal crosshair line." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.crosshair.horizontalLine.dashStyle" + "Description": "Specifies the dash style of the horizontal crosshair line." }, "label": { - "DocID": "dxChart.Options.crosshair.horizontalLine.label", + "Description": "Configures the label that belongs to the horizontal crosshair line.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.crosshair.horizontalLine.label.backgroundColor" + "Description": "Paints the background of the label that belongs to the horizontal crosshair line." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChart.Options.crosshair.horizontalLine.label.customizeText" + "Description": "Customizes the text displayed by the label that belongs to the horizontal crosshair line." }, "font": { "PrimitiveTypes": [ @@ -5400,14 +5167,7 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxChart.Options.crosshair.horizontalLine.label.font" + "Description": "Specifies font options for the label of the horizontal crosshair line." }, "format": { "PrimitiveTypes": [ @@ -5417,20 +5177,13 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxChart.Options.crosshair.horizontalLine.label.format" + "Description": "Formats a point value before it is displayed in the crosshair label." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.crosshair.horizontalLine.label.visible" + "Description": "Makes the label of the horizontal crosshair line visible. Applies only if the crosshair feature is enabled and the horizontal line is visible." } } }, @@ -5438,37 +5191,37 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.crosshair.horizontalLine.opacity" + "Description": "Specifies how transparent the horizontal crosshair line should be." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.crosshair.horizontalLine.visible" + "Description": "Specifies whether to show the horizontal crosshair line or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.crosshair.horizontalLine.width" + "Description": "Specifies the width of the horizontal crosshair line in pixels." } } }, "label": { - "DocID": "dxChart.Options.crosshair.label", + "Description": "Configures the crosshair labels.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.crosshair.label.backgroundColor" + "Description": "Paints the background of the crosshair labels." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChart.Options.crosshair.label.customizeText" + "Description": "Customizes the text displayed by the crosshair labels." }, "font": { "PrimitiveTypes": [ @@ -5477,14 +5230,7 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxChart.Options.crosshair.label.font" + "Description": "Specifies font options for the crosshair labels." }, "format": { "PrimitiveTypes": [ @@ -5494,20 +5240,13 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxChart.Options.crosshair.label.format" + "Description": "Formats a point value/argument before it is displayed in the crosshair label." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.crosshair.label.visible" + "Description": "Makes the crosshair labels visible. Applies only if the crosshair feature is enabled." } } }, @@ -5515,41 +5254,41 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.crosshair.opacity" + "Description": "Specifies how transparent the crosshair lines should be." }, "verticalLine": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.crosshair.verticalLine", + "Description": "Configures the vertical crosshair line individually.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.crosshair.verticalLine.color" + "Description": "Specifies the color of the vertical crosshair line." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.crosshair.verticalLine.dashStyle" + "Description": "Specifies the dash style of the vertical crosshair line." }, "label": { - "DocID": "dxChart.Options.crosshair.verticalLine.label", + "Description": "Configures the label that belongs to the vertical crosshair line.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.crosshair.verticalLine.label.backgroundColor" + "Description": "Paints the background of the label that belongs to the vertical crosshair line." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChart.Options.crosshair.verticalLine.label.customizeText" + "Description": "Customizes the text displayed by the label that belongs to the vertical crosshair line." }, "font": { "PrimitiveTypes": [ @@ -5558,14 +5297,7 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxChart.Options.crosshair.verticalLine.label.font" + "Description": "Specifies font options for the label of the vertical crosshair line." }, "format": { "PrimitiveTypes": [ @@ -5575,20 +5307,13 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxChart.Options.crosshair.verticalLine.label.format" + "Description": "Formats the point argument before it is displayed in the crosshair label." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.crosshair.verticalLine.label.visible" + "Description": "Makes the label of the vertical crosshair line visible. Applies only if the crosshair feature is enabled and the vertical line is visible." } } }, @@ -5596,19 +5321,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.crosshair.verticalLine.opacity" + "Description": "Specifies how transparent the vertical crosshair line should be." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.crosshair.verticalLine.visible" + "Description": "Specifies whether to show the vertical crosshair line or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.crosshair.verticalLine.width" + "Description": "Specifies the width of the vertical crosshair line in pixels." } } }, @@ -5616,7 +5341,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.crosshair.width" + "Description": "Specifies the width of the crosshair lines." } } }, @@ -5625,36 +5350,36 @@ "Function" ], "IsFunc": true, - "DocID": "dxChart.Options.customizeAnnotation" + "Description": "Customizes an individual annotation." }, "customizeLabel": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseChart.Options.customizeLabel" + "Description": "Customizes the appearance of an individual point label." }, "customizePoint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseChart.Options.customizePoint" + "Description": "Customizes the appearance of an individual series point." }, "dataPrepareSettings": { - "DocID": "dxChart.Options.dataPrepareSettings", + "Description": "Processes data before visualizing it.", "Options": { "checkTypeForAllData": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.dataPrepareSettings.checkTypeForAllData" + "Description": "Validates the type of each value coming from the data source." }, "convertToAxisDataType": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.dataPrepareSettings.convertToAxisDataType" + "Description": "Converts data coming from a data source into a data type supported by the axis." }, "sortingMethod": { "PrimitiveTypes": [ @@ -5662,7 +5387,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxChart.Options.dataPrepareSettings.sortingMethod" + "Description": "Specifies the sorting order in which series points should be drawn." } } }, @@ -5675,61 +5400,54 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "BaseChart.Options.dataSource" + "Description": "Binds the widget to data." }, "defaultPane": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.defaultPane" + "Description": "Specifies which pane should be used by default." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "equalBarWidth": { "PrimitiveTypes": [ "boolean" ], "IsDeprecated": true, - "DocID": "dxChart.Options.equalBarWidth" + "Description": "Use CommonSeries.ignoreEmptyPoints instead." }, "export": { - "DocID": "BaseWidget.Options.export", + "Description": "Configures the exporting and printing features.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.backgroundColor" + "Description": "Specifies the color that will fill transparent regions in the resulting file or document." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.enabled" + "Description": "Enables the client-side exporting in the widget." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.fileName" + "Description": "Specifies a default name for the file to which the widget will be exported." }, "formats": { "ItemPrimitiveTypes": [ @@ -5737,83 +5455,83 @@ ], "IsCollection": true, "SingularName": "format", - "DocID": "BaseWidget.Options.export.formats" + "Description": "Specifies a set of export formats." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.export.margin" + "Description": "Adds an empty space around the exported widget; measured in pixels." }, "printingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.printingEnabled" + "Description": "Enables the printing feature in the widget. Applies only if the export.enabled option is true." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "BaseWidget.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." }, "svgToCanvas": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseWidget.Options.export.svgToCanvas" + "Description": "A function that renders SVG markup on the HTML canvas. Required to export custom SVG elements (for example, markerTemplate)." } } }, "legend": { - "DocID": "dxChart.Options.legend", + "Description": "Specifies the options of a chart's legend.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.backgroundColor" + "Description": "Colors the legend's background." }, "border": { - "DocID": "BaseLegend.border", + "Description": "Configures the legend's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.border.color" + "Description": "Colors the legend's border." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.cornerRadius" + "Description": "Makes all the legend's corners rounded." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.border.dashStyle" + "Description": "Sets a dash style for the legend's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.opacity" + "Description": "Specifies the transparency of the legend's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseLegend.border.visible" + "Description": "Shows the legend's border." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.width" + "Description": "Specifies the width of the legend's border in pixels." } } }, @@ -5821,103 +5539,97 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.columnCount" + "Description": "Arranges legend items into several columns." }, "columnItemSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.columnItemSpacing" + "Description": "Specifies an empty space between item columns in pixels." }, "customizeHint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChart.Options.legend.customizeHint" + "Description": "Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item." }, "customizeItems": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseChart.Options.legend.customizeItems" + "Description": "Allows you to change the order, text, and visibility of legend items." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChart.Options.legend.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed by a legend item." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseLegend.font" + "Description": "Specifies the legend items' font options." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.horizontalAlignment" + "Description": "Along with verticalAlignment, specifies the legend's position." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.legend.hoverMode" + "Description": "Specifies what series elements to highlight when a corresponding item in the legend is hovered over." }, "itemsAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.itemsAlignment" + "Description": "Aligns items in the last column or row (depending on the legend's orientation). Applies when legend items are not divided into columns or rows equally." }, "itemTextPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.itemTextPosition" + "Description": "Specifies the text's position relative to the marker in a legend item." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin", + "Description": "Generates an empty space, measured in pixels, around the legend.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.bottom" + "Description": "Specifies the legend's bottom margin in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.left" + "Description": "Specifies the legend's left margin in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.right" + "Description": "Specifies the legend's right margin in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.top" + "Description": "Specifies the legend's top margin in pixels." } } }, @@ -5925,56 +5637,56 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.markerSize" + "Description": "Specifies the marker's size in a legend item in pixels." }, "markerTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "BaseChart.Options.legend.markerTemplate" + "Description": "Specifies an SVG element that serves as a custom legend item marker." }, "orientation": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.orientation" + "Description": "Arranges legend items vertically (in a column) or horizontally (in a row). The default value is \"horizontal\" if the legend.horizontalAlignment is \"center\". Otherwise, it is \"vertical\"." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between the legend's left/right border and its items." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between the legend's top/bottom border and its items." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.legend.position" + "Description": "Specifies whether the legend is located outside or inside the chart's plot." }, "rowCount": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.rowCount" + "Description": "Arranges legend items in several rows." }, "rowItemSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.rowItemSpacing" + "Description": "Specifies an empty space between item rows in pixels." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title", + "Description": "Configures the legend title.", "Options": { "font": { "PrimitiveTypes": [ @@ -5983,47 +5695,40 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseLegend.title.font" + "Description": "Specifies the legend title's font options." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.horizontalAlignment" + "Description": "Along with verticalAlignment, specifies the legend title's position." }, "margin": { - "DocID": "BaseLegend.title.margin", + "Description": "Generates space around the legend title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.bottom" + "Description": "Specifies the legend title's bottom margin." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.left" + "Description": "Specifies the legend title's left margin." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.right" + "Description": "Specifies the legend title's right margin." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.top" + "Description": "Specifies the legend title's top margin." } } }, @@ -6031,13 +5736,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the legend title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.subtitle", + "Description": "Configures the legend subtitle. The subtitle appears only if the title is specified.", "Options": { "font": { "PrimitiveTypes": [ @@ -6046,26 +5751,19 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseLegend.title.subtitle.font" + "Description": "Specifies the legend subtitle's font options." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.subtitle.offset" + "Description": "Specifies the distance between the legend's title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.subtitle.text" + "Description": "Specifies the subtitle's text." } } }, @@ -6073,13 +5771,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.text" + "Description": "Specifies the legend title's text." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.verticalAlignment" + "Description": "Specifies the legend title's vertical alignment." } } }, @@ -6087,87 +5785,81 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.verticalAlignment" + "Description": "Along with horizontalAlignment, specifies the legend's position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseLegend.visible" + "Description": "Specifies the legend's visibility." } } }, "loadingIndicator": { - "DocID": "BaseWidget.Options.loadingIndicator", + "Description": "Configures the loading indicator.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.backgroundColor" + "Description": "Colors the background of the loading indicator." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.loadingIndicator.enabled" + "Description": "Specifies whether the loading indicator should be displayed and hidden automatically." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.loadingIndicator.font" + "Description": "Specifies font options for the loading indicator." }, "show": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "BaseWidget.Options.loadingIndicator.show" + "Description": "Allows you to change the loading indicator's visibility." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.text" + "Description": "Specifies the text to be displayed by the loading indicator." } } }, "margin": { - "DocID": "BaseWidget.Options.margin", + "Description": "Generates space around the widget.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.bottom" + "Description": "Specifies the bottom margin of the widget in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.left" + "Description": "Specifies the left margin of the widget in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.right" + "Description": "Specifies the right margin of the widget in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.top" + "Description": "Specifies the top margin of the widget in pixels." } } }, @@ -6175,19 +5867,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.maxBubbleSize" + "Description": "Specifies a coefficient determining the diameter of the largest bubble." }, "minBubbleSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.minBubbleSize" + "Description": "Specifies the diameter of the smallest bubble measured in pixels." }, "negativesAsZeroes": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.negativesAsZeroes" + "Description": "Forces the widget to treat negative values as zeroes. Applies to stacked-like series only." }, "onArgumentAxisClick": { "PrimitiveTypes": [ @@ -6196,7 +5888,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxChart.Options.onArgumentAxisClick" + "Description": "A function that is executed when a label on the argument axis is clicked or tapped." }, "onDisposing": { "PrimitiveTypes": [ @@ -6204,7 +5896,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDone": { "PrimitiveTypes": [ @@ -6212,7 +5904,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onDone" + "Description": "A function that is executed when all series are ready." }, "onDrawn": { "PrimitiveTypes": [ @@ -6220,7 +5912,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onExported": { "PrimitiveTypes": [ @@ -6228,7 +5920,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -6236,7 +5928,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -6244,7 +5936,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -6252,7 +5944,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -6260,7 +5952,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onLegendClick": { "PrimitiveTypes": [ @@ -6269,7 +5961,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxChart.Options.onLegendClick" + "Description": "A function that is executed when a legend item is clicked or tapped." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -6277,7 +5969,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPointClick": { "PrimitiveTypes": [ @@ -6286,7 +5978,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onPointClick" + "Description": "A function that is executed when a series point is clicked or tapped." }, "onPointHoverChanged": { "PrimitiveTypes": [ @@ -6294,7 +5986,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onPointHoverChanged" + "Description": "A function that is executed after the pointer enters or leaves a series point." }, "onPointSelectionChanged": { "PrimitiveTypes": [ @@ -6302,7 +5994,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onPointSelectionChanged" + "Description": "A function that is executed when a series point is selected or selection is canceled." }, "onSeriesClick": { "PrimitiveTypes": [ @@ -6311,7 +6003,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxChart.Options.onSeriesClick" + "Description": "A function that is executed when a series is clicked or tapped." }, "onSeriesHoverChanged": { "PrimitiveTypes": [ @@ -6319,7 +6011,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxChart.Options.onSeriesHoverChanged" + "Description": "A function that is executed after the pointer enters or leaves a series." }, "onSeriesSelectionChanged": { "PrimitiveTypes": [ @@ -6327,7 +6019,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxChart.Options.onSeriesSelectionChanged" + "Description": "A function that is executed when a series is selected or selection is canceled." }, "onTooltipHidden": { "PrimitiveTypes": [ @@ -6335,7 +6027,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onTooltipHidden" + "Description": "A function that is executed when a tooltip becomes hidden." }, "onTooltipShown": { "PrimitiveTypes": [ @@ -6343,7 +6035,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onTooltipShown" + "Description": "A function that is executed when a tooltip appears." }, "onZoomEnd": { "PrimitiveTypes": [ @@ -6351,7 +6043,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxChart.Options.onZoomEnd" + "Description": "A function that is executed when zooming or panning ends." }, "onZoomStart": { "PrimitiveTypes": [ @@ -6359,7 +6051,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxChart.Options.onZoomStart" + "Description": "A function that is executed when zooming or panning begins." }, "palette": { "PrimitiveTypes": [ @@ -6370,13 +6062,13 @@ ], "IsCollection": true, "SingularName": "palette", - "DocID": "BaseChart.Options.palette" + "Description": "Sets the palette to be used for colorizing series and their elements." }, "paletteExtensionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseChart.Options.paletteExtensionMode" + "Description": "Specifies what to do with colors in the palette when their number is less than the number of series (in the Chart widget) or points in a series (in the PieChart widget)." }, "panes": { "ItemPrimitiveTypes": [ @@ -6384,70 +6076,70 @@ ], "IsCollection": true, "SingularName": "pane", - "DocID": "dxChart.Options.panes", + "Description": "Declares a collection of panes.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonPaneSettings.backgroundColor" + "Description": "Specifies the color of the pane's background." }, "border": { - "DocID": "dxChart.Options.commonPaneSettings.border", + "Description": "Configures the pane border.", "Options": { "bottom": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonPaneSettings.border.bottom" + "Description": "Shows/hides the bottom border of the pane. Applies only when the border.visible option is true." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonPaneSettings.border.color" + "Description": "Specifies the color of the pane border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonPaneSettings.border.dashStyle" + "Description": "Specifies the dash style of the pane border." }, "left": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonPaneSettings.border.left" + "Description": "Shows/hides the left border of the pane. Applies only when the border.visible option is true." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonPaneSettings.border.opacity" + "Description": "Specifies how transparent the pane border should be." }, "right": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonPaneSettings.border.right" + "Description": "Shows/hides the right border of the pane. Applies only when the border.visible option is true." }, "top": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonPaneSettings.border.top" + "Description": "Shows/hides the top border of the pane. Applies only when the border.visible option is true." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonPaneSettings.border.visible" + "Description": "Shows the pane border." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonPaneSettings.border.width" + "Description": "Specifies the width of the pane border in pixels." } } }, @@ -6456,13 +6148,13 @@ "number", "string" ], - "DocID": "dxChart.Options.panes.height" + "Description": "Specifies the pane's height (or width when the chart is rotated) in a multi-pane chart." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.panes.name" + "Description": "Specifies the name of the pane." } } }, @@ -6470,82 +6162,82 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "pointSelectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseChart.Options.pointSelectionMode" + "Description": "Specifies whether a single point or multiple points can be selected in the chart." }, "redrawOnResize": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.redrawOnResize" + "Description": "Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates." }, "resizePanesOnZoom": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.resizePanesOnZoom" + "Description": "Specifies whether panes can be resized if other chart elements require more space after zooming or panning." }, "resolveLabelOverlapping": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.resolveLabelOverlapping" + "Description": "Specifies how the chart must behave when series point labels overlap." }, "rotated": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.rotated" + "Description": "Swaps the axes around making the value axis horizontal and the argument axis vertical." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scrollBar": { - "DocID": "dxChart.Options.scrollBar", + "Description": "Specifies the settings of the scroll bar.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.scrollBar.color" + "Description": "Specifies the color of the scroll bar." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.scrollBar.offset" + "Description": "Specifies the spacing between the scroll bar and the chart's plot in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.scrollBar.opacity" + "Description": "Specifies the opacity of the scroll bar." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.scrollBar.position" + "Description": "Specifies the position of the scroll bar in the chart." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.scrollBar.visible" + "Description": "Specifies whether the scroll bar is visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.scrollBar.width" + "Description": "Specifies the width of the scroll bar in pixels." } } }, @@ -6554,7 +6246,7 @@ "string" ], "IsDeprecated": true, - "DocID": "dxChart.Options.scrollingMode" + "Description": "Use the zoomAndPan option instead." }, "series": { "PrimitiveTypes": [ @@ -6571,46 +6263,46 @@ ], "IsCollection": true, "SingularName": "series", - "DocID": "dxChart.Options.series" + "Description": "Specifies options for Chart widget series." }, "seriesSelectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.seriesSelectionMode" + "Description": "Specifies whether a single series or multiple series can be selected in the chart." }, "seriesTemplate": { - "DocID": "dxChart.Options.seriesTemplate", + "Description": "Defines options for the series template.", "Options": { "customizeSeries": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChart.Options.seriesTemplate.customizeSeries" + "Description": "Specifies a callback function that returns a series object with individual series settings." }, "nameField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.seriesTemplate.nameField" + "Description": "Specifies a data source field that represents the series name." } } }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, @@ -6618,76 +6310,70 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.stickyHovering" + "Description": "Specifies whether a point should remain in the hover state when the mouse pointer moves away." }, "synchronizeMultiAxes": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.synchronizeMultiAxes" + "Description": "Indicates whether or not to synchronize value axes when they are displayed on a single pane." }, "theme": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title", + "Description": "Configures the widget's title.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.title.font" + "Description": "Specifies font options for the title." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.horizontalAlignment" + "Description": "Specifies the title's alignment in a horizontal direction." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin", + "Description": "Generates space around the title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.bottom" + "Description": "Specifies the bottom margin of the title." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.left" + "Description": "Specifies the left margin of the title." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.right" + "Description": "Specifies the right margin of the title." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.top" + "Description": "Specifies the top margin of the title." } } }, @@ -6695,13 +6381,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle", + "Description": "Configures the widget's subtitle.", "Options": { "font": { "PrimitiveTypes": [ @@ -6710,38 +6396,31 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseWidget.Options.title.subtitle.font" + "Description": "Specifies font options for the subtitle." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.subtitle.offset" + "Description": "Specifies the distance between the title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.text" + "Description": "Specifies text for the subtitle." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.textOverflow" + "Description": "Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.wordWrap" + "Description": "Specifies how to wrap the subtitle if it does not fit into a single line." } } }, @@ -6749,85 +6428,79 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.text" + "Description": "Specifies the title's text." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.textOverflow" + "Description": "Specifies what to do with the title when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.verticalAlignment" + "Description": "Specifies the title's alignment in a vertical direction." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.wordWrap" + "Description": "Specifies how to wrap the title if it does not fit into a single line." } } }, "tooltip": { - "DocID": "dxChart.Options.tooltip", + "Description": "Configures tooltips.", "Options": { "argumentFormat": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseChart.Options.tooltip.argumentFormat" + "Description": "Formats the point argument before it is displayed in the tooltip. To format the point value, use the format option." }, "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.arrowLength" + "Description": "Specifies the length of a tooltip's arrow in pixels." }, "border": { - "DocID": "BaseWidget.Options.tooltip.border", + "Description": "Configures a tooltip's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.color" + "Description": "Colors a tooltip's border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.dashStyle" + "Description": "Specifies the dash style of a tooltip's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.opacity" + "Description": "Specifies the transparency of a tooltip's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.border.visible" + "Description": "Specifies whether a tooltip's border is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.width" + "Description": "Specifies the width of a tooltip's border in pixels." } } }, @@ -6835,7 +6508,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.color" + "Description": "Colors all tooltips." }, "container": { "PrimitiveTypes": [ @@ -6843,121 +6516,109 @@ "JQuery", "string" ], - "DocID": "BaseWidget.Options.tooltip.container" + "Description": "Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "BaseChart.Options.tooltip.contentTemplate" + "Description": "Specifies a custom template for a tooltip." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.cornerRadius" + "Description": "Makes all the tooltip's corners rounded." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseChart.Options.tooltip.customizeTooltip" + "Description": "Allows you to change tooltip appearance." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.enabled" + "Description": "Enables tooltips." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.font" + "Description": "Specifies tooltips' font options." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.format" + "Description": "Formats a value before it is displayed it in a tooltip." }, "location": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.tooltip.location" + "Description": "Specifies whether the tooltip must be located in the center of a series point or on its edge. Applies to bar-like and bubble series only." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.opacity" + "Description": "Specifies tooltips' transparency." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between a tooltip's left/right border and its text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text." }, "shadow": { - "DocID": "BaseWidget.Options.tooltip.shadow", + "Description": "Configures a tooltip's shadow.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.blur" + "Description": "Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.shadow.color" + "Description": "Colors a tooltip's shadow." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetX" + "Description": "Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetY" + "Description": "Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.opacity" + "Description": "Specifies the transparency of a tooltip's shadow." } } }, @@ -6965,13 +6626,13 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseChart.Options.tooltip.shared" + "Description": "Specifies whether the tooltip is shared across all series points with the same argument." }, "zIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.zIndex" + "Description": "Specifies a tooltip's z-index." } } }, @@ -6980,7 +6641,7 @@ "boolean" ], "IsDeprecated": true, - "DocID": "dxChart.Options.useAggregation" + "Description": "Use CommonSeries.aggregation.enabled instead." }, "valueAxis": { "ItemPrimitiveTypes": [ @@ -6988,25 +6649,25 @@ ], "IsCollection": true, "SingularName": "valueAxis", - "DocID": "dxChart.Options.valueAxis", + "Description": "Configures the value axis.", "Options": { "allowDecimals": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.allowDecimals" + "Description": "Specifies whether to allow decimal values on the axis. When false, the axis contains integer values only." }, "autoBreaksEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.valueAxis.autoBreaksEnabled" + "Description": "Enables auto-calculated scale breaks. Applies only if the axis' type is \"continuous\" or \"logarithmic\" and valueType is \"numeric\"." }, "axisDivisionFactor": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.valueAxis.axisDivisionFactor" + "Description": "Specifies the minimum distance between two neighboring major ticks in pixels. Applies only to the axes of the \"continuous\" and \"logarithmic\" types." }, "breaks": { "ItemPrimitiveTypes": [ @@ -7015,37 +6676,30 @@ "ItemComplexTypes": [ "VizScaleBreak" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "break", - "DocID": "dxChart.Options.valueAxis.breaks" + "Description": "Declares a custom scale break collection. Applies only if the axis' type is \"continuous\" or \"logarithmic\"." }, "breakStyle": { - "DocID": "dxChart.Options.commonAxisSettings.breakStyle", + "Description": "Configures the scale breaks' appearance.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.breakStyle.color" + "Description": "Specifies the scale breaks' color." }, "line": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.breakStyle.line" + "Description": "Specifies the scale breaks' line style." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.breakStyle.width" + "Description": "Specifies the scale breaks' width in pixels." } } }, @@ -7057,13 +6711,13 @@ ], "IsCollection": true, "SingularName": "category", - "DocID": "dxChart.Options.valueAxis.categories" + "Description": "Specifies the order of categories on an axis of the \"discrete\" type." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.color" + "Description": "Specifies the color of the axis line." }, "constantLines": { "ItemPrimitiveTypes": [ @@ -7071,79 +6725,73 @@ ], "IsCollection": true, "SingularName": "constantLine", - "DocID": "dxChart.Options.valueAxis.constantLines", + "Description": "Declares a collection of constant lines belonging to the value axis.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.color" + "Description": "Specifies the color of constant lines." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.dashStyle" + "Description": "Specifies the dash style of constant lines." }, "displayBehindSeries": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.valueAxis.constantLines.displayBehindSeries" + "Description": "Specifies whether to display the constant line behind or in front of the series." }, "extendAxis": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.valueAxis.constantLines.extendAxis" + "Description": "Specifies whether to extend the axis's default visual range to display the constant line." }, "label": { - "DocID": "dxChart.Options.valueAxis.constantLines.label", + "Description": "Configures the constant line label.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.font" + "Description": "Specifies font options for constant line labels." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.constantLines.label.horizontalAlignment" + "Description": "Aligns constant line labels in the horizontal direction." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.position" + "Description": "Specifies the position of constant line labels on the chart plot." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.constantLines.label.text" + "Description": "Specifies the text of a constant line label. By default, equals to the value of the constant line." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.constantLines.label.verticalAlignment" + "Description": "Aligns constant line labels in the vertical direction." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.visible" + "Description": "Makes constant line labels visible." } } }, @@ -7151,13 +6799,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.paddingLeftRight" + "Description": "Generates a pixel-measured empty space between the left/right side of a constant line and the constant line label." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.paddingTopBottom" + "Description": "Generates a pixel-measured empty space between the top/bottom side of a constant line and the constant line label." }, "value": { "PrimitiveTypes": [ @@ -7165,72 +6813,66 @@ "number", "string" ], - "DocID": "dxChart.Options.valueAxis.constantLines.value" + "Description": "Specifies the value indicated by a constant line. Setting this option is necessary." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.width" + "Description": "Specifies the width of constant lines in pixels." } } }, "constantLineStyle": { - "DocID": "dxChart.Options.valueAxis.constantLineStyle", + "Description": "Specifies the appearance of those constant lines that belong to the value axis.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.color" + "Description": "Specifies the color of constant lines." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.dashStyle" + "Description": "Specifies the dash style of constant lines." }, "label": { - "DocID": "dxChart.Options.valueAxis.constantLineStyle.label", + "Description": "Specifies the appearance of the labels of those constant lines that belong to the value axis.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.font" + "Description": "Specifies font options for constant line labels." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.constantLineStyle.label.horizontalAlignment" + "Description": "Aligns constant line labels in the horizontal direction." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.position" + "Description": "Specifies the position of constant line labels on the chart plot." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.constantLineStyle.label.verticalAlignment" + "Description": "Aligns constant line labels in the vertical direction." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.label.visible" + "Description": "Makes constant line labels visible." } } }, @@ -7238,19 +6880,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.paddingLeftRight" + "Description": "Generates a pixel-measured empty space between the left/right side of a constant line and the constant line label." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.paddingTopBottom" + "Description": "Generates a pixel-measured empty space between the top/bottom side of a constant line and the constant line label." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.constantLineStyle.width" + "Description": "Specifies the width of constant lines in pixels." } } }, @@ -7258,40 +6900,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.discreteAxisDivisionMode" + "Description": "Specifies whether ticks and grid lines should cross axis labels or lie between them. Applies only to the axes of the \"discrete\" type." }, "endOnTick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.valueAxis.endOnTick" + "Description": "Specifies whether to force the axis to start and end on ticks." }, "grid": { - "DocID": "dxChart.Options.commonAxisSettings.grid", + "Description": "Configures the grid.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.grid.color" + "Description": "Specifies the color of grid lines." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.grid.opacity" + "Description": "Specifies how transparent grid lines should be." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.grid.visible" + "Description": "Makes grid lines visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.grid.width" + "Description": "Specifies the width of grid lines in pixels." } } }, @@ -7299,109 +6941,97 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.inverted" + "Description": "Inverts the axis." }, "label": { - "DocID": "dxChart.Options.valueAxis.label", + "Description": "Configures the labels of the value axis.", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.alignment" + "Description": "Aligns axis labels in relation to ticks." }, "customizeHint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChart.Options.valueAxis.label.customizeHint" + "Description": "Specifies the hint that appears when a user points to an axis label." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChart.Options.valueAxis.label.customizeText" + "Description": "Customizes the text displayed by axis labels." }, "displayMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.displayMode" + "Description": "Allows you to rotate or stagger axis labels. Applies to the horizontal axis only." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.label.font" + "Description": "Specifies font options for axis labels." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxChart.Options.valueAxis.label.format" + "Description": "Formats a value before it is displayed in an axis label." }, "indentFromAxis": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.label.indentFromAxis" + "Description": "Adds a pixel-measured empty space between an axis and its labels." }, "overlappingBehavior": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.overlappingBehavior" + "Description": "Decides how to arrange axis labels when there is not enough space to keep all of them." }, "rotationAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.label.rotationAngle" + "Description": "Specifies the rotation angle of axis labels. Applies only if displayMode or overlappingBehavior is \"rotate\"." }, "staggeringSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.label.staggeringSpacing" + "Description": "Adds a pixel-measured empty space between two staggered rows of axis labels. Applies only if displayMode or overlappingBehavior is \"stagger\"." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.textOverflow" + "Description": "Specifies what to do with axis labels that overflow the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.label.visible" + "Description": "Shows/hides axis labels." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.label.wordWrap" + "Description": "Specifies how to wrap texts that do not fit into a single line." } } }, @@ -7409,13 +7039,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.valueAxis.linearThreshold" + "Description": "Specifies a value used to calculate the range on a logarithmic axis within which the axis should be linear. Applies only if the data source contains negative values or zeroes." }, "logarithmBase": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.valueAxis.logarithmBase" + "Description": "Specifies the value to be raised to a power when generating ticks for an axis of the \"logarithmic\" type." }, "max": { "PrimitiveTypes": [ @@ -7424,19 +7054,19 @@ "string" ], "IsDeprecated": true, - "DocID": "dxChart.Options.valueAxis.max" + "Description": "Use the valueAxis.visualRange option instead." }, "maxAutoBreakCount": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.valueAxis.maxAutoBreakCount" + "Description": "Sets a limit on auto-calculated scale breaks. Custom scale breaks are not counted." }, "maxValueMargin": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.maxValueMargin" + "Description": "Controls the empty space between the maximum series points and the axis. Applies only to the axes of the \"continuous\" and \"logarithmic\" type." }, "min": { "PrimitiveTypes": [ @@ -7445,75 +7075,75 @@ "string" ], "IsDeprecated": true, - "DocID": "dxChart.Options.valueAxis.min" + "Description": "Use the valueAxis.visualRange option instead." }, "minorGrid": { - "DocID": "dxChart.Options.commonAxisSettings.minorGrid", + "Description": "Configures the minor grid.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.minorGrid.color" + "Description": "Specifies a color for the lines of the minor grid." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorGrid.opacity" + "Description": "Specifies how transparent the lines of the minor grid should be." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.minorGrid.visible" + "Description": "Makes the minor grid visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorGrid.width" + "Description": "Specifies a width for the lines of the minor grid in pixels." } } }, "minorTick": { - "DocID": "dxChart.Options.commonAxisSettings.minorTick", + "Description": "Configures the appearance of minor axis ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.color" + "Description": "Specifies the color of minor ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.length" + "Description": "Specifies the length of minor ticks in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.opacity" + "Description": "Specifies how transparent minor ticks should be." }, "shift": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.shift" + "Description": "Shifts minor ticks from the reference position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.visible" + "Description": "Makes minor ticks visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minorTick.width" + "Description": "Specifies the width of minor ticks in pixels." } } }, @@ -7521,68 +7151,68 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.valueAxis.minorTickCount" + "Description": "Specifies how many minor ticks to place between two neighboring major ticks." }, "minorTickInterval": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxChart.Options.valueAxis.minorTickInterval", + "Description": "Specifies the interval between minor ticks. Applies only to continuous axes.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -7590,68 +7220,68 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.minValueMargin" + "Description": "Controls the empty space between the minimum series points and the axis. Applies only to the axes of the \"continuous\" and \"logarithmic\" type." }, "minVisualRangeLength": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxChart.Options.valueAxis.minVisualRangeLength", + "Description": "Specifies the minimum length of the visual range.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -7659,43 +7289,43 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.valueAxis.multipleAxesSpacing" + "Description": "Adds a pixel-measured empty space between two side-by-side value axes. Applies if several value axes are located on one side of the chart." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.name" + "Description": "Specifies the name of the value axis." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.opacity" + "Description": "Specifies how transparent the axis line should be." }, "pane": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.pane" + "Description": "Binds the value axis to a pane." }, "placeholderSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.placeholderSize" + "Description": "Reserves a pixel-measured space for the axis." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.position" + "Description": "Relocates the value axis." }, "showZero": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.valueAxis.showZero" + "Description": "Specifies whether or not to show zero on the value axis." }, "strips": { "ItemPrimitiveTypes": [ @@ -7703,13 +7333,13 @@ ], "IsCollection": true, "SingularName": "strip", - "DocID": "dxChart.Options.valueAxis.strips", + "Description": "Declares a collection of strips belonging to the value axis.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.strips.color" + "Description": "Specifies the color of the strip." }, "endValue": { "PrimitiveTypes": [ @@ -7717,43 +7347,37 @@ "number", "string" ], - "DocID": "dxChart.Options.valueAxis.strips.endValue" + "Description": "Along with the startValue option, limits the strip." }, "label": { - "DocID": "dxChart.Options.valueAxis.strips.label", + "Description": "Configures the strip label.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.font" + "Description": "Specifies font options for strip labels." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.horizontalAlignment" + "Description": "Aligns strip labels in the horizontal direction." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.strips.label.text" + "Description": "Specifies the text of the strip label." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.verticalAlignment" + "Description": "Aligns strip labels in the vertical direction." } } }, @@ -7761,13 +7385,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.paddingLeftRight" + "Description": "Generates a pixel-measured empty space between the left/right border of a strip and the strip label." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.paddingTopBottom" + "Description": "Generates a pixel-measured empty space between the top/bottom border of a strip and the strip label." }, "startValue": { "PrimitiveTypes": [ @@ -7775,42 +7399,36 @@ "number", "string" ], - "DocID": "dxChart.Options.valueAxis.strips.startValue" + "Description": "Along with the endValue option, limits the strip." } } }, "stripStyle": { - "DocID": "dxChart.Options.commonAxisSettings.stripStyle", + "Description": "Configures the appearance of strips.", "Options": { "label": { - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label", + "Description": "Configures the appearance of strip labels.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.font" + "Description": "Specifies font options for strip labels." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.horizontalAlignment" + "Description": "Aligns strip labels in the horizontal direction." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.label.verticalAlignment" + "Description": "Aligns strip labels in the vertical direction." } } }, @@ -7818,13 +7436,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.paddingLeftRight" + "Description": "Generates a pixel-measured empty space between the left/right border of a strip and the strip label." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.stripStyle.paddingTopBottom" + "Description": "Generates a pixel-measured empty space between the top/bottom border of a strip and the strip label." } } }, @@ -7832,46 +7450,46 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.valueAxis.synchronizedValue" + "Description": "Synchronizes two or more value axes with each other at a specific value." }, "tick": { - "DocID": "dxChart.Options.commonAxisSettings.tick", + "Description": "Configures the appearance of major axis ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.color" + "Description": "Specifies the color of ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.length" + "Description": "Specifies the length of ticks in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.opacity" + "Description": "Specifies how transparent ticks should be." }, "shift": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.shift" + "Description": "Shifts ticks from the reference position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.visible" + "Description": "Makes ticks visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.tick.width" + "Description": "Specifies the width of ticks in pixels." } } }, @@ -7880,61 +7498,61 @@ "number", "string" ], - "DocID": "dxChart.Options.valueAxis.tickInterval", + "Description": "Specifies the interval between major ticks. Does not apply to discrete axes.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -7942,52 +7560,46 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.title", + "Description": "Configures the axis title.", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.title.alignment" + "Description": "Aligns the axis title to the left, center, or right of the axis." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChart.Options.commonAxisSettings.title.font" + "Description": "Specifies font options for the axis title." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.title.margin" + "Description": "Adds a pixel-measured empty space between the axis title and axis labels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.title.text" + "Description": "Specifies the text of the axis title." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.title.textOverflow" + "Description": "Specifies what to do with the axis title when it overflows the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.commonAxisSettings.title.wordWrap" + "Description": "Specifies how to wrap the axis title if it does not fit into a single line." } } }, @@ -7995,25 +7607,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.type" + "Description": "Specifies the type of the value axis." }, "valueMarginsEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.valueMarginsEnabled" + "Description": "Adds an empty space between the axis and the minimum and maximum series points." }, "valueType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.valueType" + "Description": "Casts values to a specified data type." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.commonAxisSettings.visible" + "Description": "Makes the axis line visible." }, "visualRange": { "PrimitiveTypes": [ @@ -8027,23 +7639,16 @@ "string", "Date" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "IsChangeable": true, "SingularName": "visualRange", - "DocID": "dxChart.Options.valueAxis.visualRange" + "Description": "Defines the axis' displayed range. Cannot be wider than the wholeRange." }, "visualRangeUpdateMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.valueAxis.visualRangeUpdateMode" + "Description": "Specifies how the axis's visual range should behave when chart data is updated." }, "wholeRange": { "PrimitiveTypes": [ @@ -8057,60 +7662,53 @@ "string", "Date" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "wholeRange", - "DocID": "dxChart.Options.valueAxis.wholeRange" + "Description": "Defines the range where the axis can be zoomed and panned." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.commonAxisSettings.width" + "Description": "Specifies the width of the axis line in pixels." } } }, "zoomAndPan": { - "DocID": "dxChart.Options.zoomAndPan", + "Description": "Configures zooming and panning.", "Options": { "allowMouseWheel": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.zoomAndPan.allowMouseWheel" + "Description": "Specifies whether users can use the mouse wheel to zoom the chart. Applies only if zoom is allowed for the argument or value axis." }, "allowTouchGestures": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.zoomAndPan.allowTouchGestures" + "Description": "Specifies whether users can use touch gestures to zoom or pan the chart. Applies only if zoom and pan are allowed for the argument or value axis." }, "argumentAxis": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.zoomAndPan.argumentAxis" + "Description": "Specifies whether users are allowed to zoom and/or pan the argument axis." }, "dragBoxStyle": { - "DocID": "dxChart.Options.zoomAndPan.dragBoxStyle", + "Description": "Configures the box that appears when users zoom the chart by selecting an area with the drag gesture. Applies only if dragToZoom is true.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.zoomAndPan.dragBoxStyle.color" + "Description": "Specifies the drag box's color." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChart.Options.zoomAndPan.dragBoxStyle.opacity" + "Description": "Specifies the drag box's transparency." } } }, @@ -8118,19 +7716,19 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChart.Options.zoomAndPan.dragToZoom" + "Description": "Enables users to zoom the chart by selecting an area with the drag gesture. Applies only on devices that use a mouse." }, "panKey": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.zoomAndPan.panKey" + "Description": "Specifies the key that enables panning when dragToZoom is true. Applies only on devices that use a mouse." }, "valueAxis": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChart.Options.zoomAndPan.valueAxis" + "Description": "Specifies whether users are allowed to zoom and/or pan the value axis." } } }, @@ -8139,12 +7737,12 @@ "string" ], "IsDeprecated": true, - "DocID": "dxChart.Options.zoomingMode" + "Description": "Use the zoomAndPan option instead." } } }, "dxCheckBox": { - "DocID": "dxCheckBox", + "Description": "The CheckBox is a small box, which when selected by the end user, shows that a particular feature has been enabled or a specific option has been chosen.", "Module": "ui/check_box", "IsEditor": true, "Options": { @@ -8152,31 +7750,31 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxCheckBox.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxCheckBox.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -8185,31 +7783,31 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxCheckBox.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxCheckBox.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "onContentReady": { "PrimitiveTypes": [ @@ -8217,7 +7815,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -8225,7 +7823,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -8233,7 +7831,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -8241,7 +7839,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onValueChanged": { "PrimitiveTypes": [ @@ -8249,37 +7847,37 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxCheckBox.Options.text" + "Description": "Specifies the text displayed by the check box." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -8287,32 +7885,32 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxCheckBox.Options.value" + "Description": "Specifies the widget state." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -8321,34 +7919,34 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxCircularGauge": { - "DocID": "dxCircularGauge", + "Description": "The CircularGauge is a widget that indicates values on a circular numeric scale.", "Module": "viz/circular_gauge", "Options": { "animation": { - "DocID": "BaseGauge.Options.animation", + "Description": "Specifies animation options.", "Options": { "duration": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.animation.duration" + "Description": "Determines how long animation runs." }, "easing": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.animation.easing" + "Description": "Specifies the animation easing mode." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.animation.enabled" + "Description": "Indicates whether or not animation is enabled." } } }, @@ -8356,40 +7954,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.containerBackgroundColor" + "Description": "Specifies the color of the parent page element." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "export": { - "DocID": "BaseWidget.Options.export", + "Description": "Configures the exporting and printing features.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.backgroundColor" + "Description": "Specifies the color that will fill transparent regions in the resulting file or document." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.enabled" + "Description": "Enables the client-side exporting in the widget." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.fileName" + "Description": "Specifies a default name for the file to which the widget will be exported." }, "formats": { "ItemPrimitiveTypes": [ @@ -8397,118 +7995,112 @@ ], "IsCollection": true, "SingularName": "format", - "DocID": "BaseWidget.Options.export.formats" + "Description": "Specifies a set of export formats." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.export.margin" + "Description": "Adds an empty space around the exported widget; measured in pixels." }, "printingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.printingEnabled" + "Description": "Enables the printing feature in the widget. Applies only if the export.enabled option is true." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "BaseWidget.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." }, "svgToCanvas": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseWidget.Options.export.svgToCanvas" + "Description": "A function that renders SVG markup on the HTML canvas. Required to export custom SVG elements (for example, markerTemplate)." } } }, "geometry": { - "DocID": "dxCircularGauge.Options.geometry", + "Description": "Specifies the options required to set the geometry of the CircularGauge widget.", "Options": { "endAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxCircularGauge.Options.geometry.endAngle" + "Description": "Specifies the end angle of the circular gauge's arc." }, "startAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxCircularGauge.Options.geometry.startAngle" + "Description": "Specifies the start angle of the circular gauge's arc." } } }, "loadingIndicator": { - "DocID": "BaseGauge.Options.loadingIndicator", + "Description": "Configures the loading indicator.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.backgroundColor" + "Description": "Colors the background of the loading indicator." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.loadingIndicator.font" + "Description": "Specifies font options for the loading indicator." }, "show": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "BaseWidget.Options.loadingIndicator.show" + "Description": "Allows you to change the loading indicator's visibility." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.text" + "Description": "Specifies the text to be displayed by the loading indicator." } } }, "margin": { - "DocID": "BaseWidget.Options.margin", + "Description": "Generates space around the widget.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.bottom" + "Description": "Specifies the bottom margin of the widget in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.left" + "Description": "Specifies the left margin of the widget in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.right" + "Description": "Specifies the right margin of the widget in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.top" + "Description": "Specifies the top margin of the widget in pixels." } } }, @@ -8518,7 +8110,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDrawn": { "PrimitiveTypes": [ @@ -8526,7 +8118,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onExported": { "PrimitiveTypes": [ @@ -8534,7 +8126,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -8542,7 +8134,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -8550,7 +8142,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -8558,7 +8150,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -8566,7 +8158,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -8574,7 +8166,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onTooltipHidden": { "PrimitiveTypes": [ @@ -8582,7 +8174,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseGauge.Options.onTooltipHidden" + "Description": "A function that is executed when a tooltip becomes hidden." }, "onTooltipShown": { "PrimitiveTypes": [ @@ -8590,34 +8182,34 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseGauge.Options.onTooltipShown" + "Description": "A function that is executed when a tooltip appears." }, "pathModified": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "rangeContainer": { - "DocID": "dxCircularGauge.Options.rangeContainer", + "Description": "Specifies gauge range container options.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.rangeContainer.backgroundColor" + "Description": "Specifies a range container's background color." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.rangeContainer.offset" + "Description": "Specifies the offset of the range container from an invisible scale line in pixels." }, "orientation": { "PrimitiveTypes": [ "string" ], - "DocID": "dxCircularGauge.Options.rangeContainer.orientation" + "Description": "Specifies the orientation of the range container in the CircularGauge widget." }, "palette": { "PrimitiveTypes": [ @@ -8628,13 +8220,13 @@ ], "IsCollection": true, "SingularName": "palette", - "DocID": "BaseGauge.Options.rangeContainer.palette" + "Description": "Specifies the palette to be used for colorizing ranges in the range container." }, "paletteExtensionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.rangeContainer.paletteExtensionMode" + "Description": "Specifies what to do with colors in the palette when their number is less than the number of ranges in the range container." }, "ranges": { "ItemPrimitiveTypes": [ @@ -8642,25 +8234,25 @@ ], "IsCollection": true, "SingularName": "range", - "DocID": "BaseGauge.Options.rangeContainer.ranges", + "Description": "An array of objects representing ranges contained in the range container.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.rangeContainer.ranges.color" + "Description": "Specifies a color of a range." }, "endValue": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.rangeContainer.ranges.endValue" + "Description": "Specifies an end value of a range." }, "startValue": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.rangeContainer.ranges.startValue" + "Description": "Specifies a start value of a range." } } }, @@ -8668,7 +8260,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxCircularGauge.Options.rangeContainer.width" + "Description": "Specifies the range container's width in pixels." } } }, @@ -8676,22 +8268,22 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.redrawOnResize" + "Description": "Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scale": { - "DocID": "dxCircularGauge.Options.scale", + "Description": "Specifies a gauge's scale options.", "Options": { "allowDecimals": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.scale.allowDecimals" + "Description": "Specifies whether to allow decimal values on the scale. When false, the scale contains integer values only." }, "customMinorTicks": { "ItemPrimitiveTypes": [ @@ -8699,7 +8291,7 @@ ], "IsCollection": true, "SingularName": "customMinorTick", - "DocID": "BaseGauge.Options.scale.customMinorTicks" + "Description": "Specifies an array of custom minor ticks." }, "customTicks": { "ItemPrimitiveTypes": [ @@ -8707,119 +8299,107 @@ ], "IsCollection": true, "SingularName": "customTick", - "DocID": "BaseGauge.Options.scale.customTicks" + "Description": "Specifies an array of custom major ticks." }, "endValue": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.endValue" + "Description": "Specifies the end value for the scale of the gauge." }, "label": { - "DocID": "dxCircularGauge.Options.scale.label", + "Description": "Specifies common options for scale labels.", "Options": { "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseGauge.Options.scale.label.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed in scale labels." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseGauge.Options.scale.label.font" + "Description": "Specifies font options for the text displayed in the scale labels of the gauge." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseGauge.Options.scale.label.format" + "Description": "Formats a value before it is displayed in a scale label. Accepts only numeric formats." }, "hideFirstOrLast": { "PrimitiveTypes": [ "string" ], - "DocID": "dxCircularGauge.Options.scale.label.hideFirstOrLast" + "Description": "Specifies which label to hide in case of overlapping." }, "indentFromTick": { "PrimitiveTypes": [ "number" ], - "DocID": "dxCircularGauge.Options.scale.label.indentFromTick" + "Description": "Specifies the spacing between scale labels and ticks." }, "overlappingBehavior": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.scale.label.overlappingBehavior" + "Description": "Decides how to arrange scale labels when there is not enough space to keep all of them." }, "useRangeColors": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.scale.label.useRangeColors" + "Description": "Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.scale.label.visible" + "Description": "Specifies whether or not scale labels are visible on the gauge." } } }, "minorTick": { - "DocID": "BaseGauge.Options.scale.minorTick", + "Description": "Specifies options of the gauge's minor ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.scale.minorTick.color" + "Description": "Specifies the color of the scale's minor ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.minorTick.length" + "Description": "Specifies the length of the scale's minor ticks." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.minorTick.opacity" + "Description": "Specifies the opacity of the scale's minor ticks." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.scale.minorTick.visible" + "Description": "Indicates whether scale minor ticks are visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.minorTick.width" + "Description": "Specifies the width of the scale's minor ticks." } } }, @@ -8827,58 +8407,58 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.minorTickInterval" + "Description": "Specifies an interval between minor ticks." }, "orientation": { "PrimitiveTypes": [ "string" ], - "DocID": "dxCircularGauge.Options.scale.orientation" + "Description": "Specifies the orientation of scale ticks." }, "scaleDivisionFactor": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.scaleDivisionFactor" + "Description": "Specifies the minimum distance between two neighboring major ticks in pixels." }, "startValue": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.startValue" + "Description": "Specifies the start value for the scale of the gauge." }, "tick": { - "DocID": "BaseGauge.Options.scale.tick", + "Description": "Specifies options of the gauge's major ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.scale.tick.color" + "Description": "Specifies the color of the scale's major ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.tick.length" + "Description": "Specifies the length of the scale's major ticks." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.tick.opacity" + "Description": "Specifies the opacity of the scale's major ticks." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.scale.tick.visible" + "Description": "Indicates whether scale major ticks are visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.tick.width" + "Description": "Specifies the width of the scale's major ticks." } } }, @@ -8886,24 +8466,24 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.tickInterval" + "Description": "Specifies an interval between major ticks." } } }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, @@ -8911,7 +8491,7 @@ "ComplexTypes": [ "GaugeIndicator" ], - "DocID": "dxCircularGauge.Options.subvalueIndicator" + "Description": "Specifies the appearance options of subvalue indicators." }, "subvalues": { "ItemPrimitiveTypes": [ @@ -8920,70 +8500,64 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "subvalue", - "DocID": "BaseGauge.Options.subvalues" + "Description": "Specifies a set of subvalues to be designated by the subvalue indicators." }, "theme": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title", + "Description": "Configures the widget's title.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.title.font" + "Description": "Specifies font options for the title." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.horizontalAlignment" + "Description": "Specifies the title's alignment in a horizontal direction." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin", + "Description": "Generates space around the title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.bottom" + "Description": "Specifies the bottom margin of the title." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.left" + "Description": "Specifies the left margin of the title." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.right" + "Description": "Specifies the right margin of the title." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.top" + "Description": "Specifies the top margin of the title." } } }, @@ -8991,13 +8565,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle", + "Description": "Configures the widget's subtitle.", "Options": { "font": { "PrimitiveTypes": [ @@ -9006,38 +8580,31 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseWidget.Options.title.subtitle.font" + "Description": "Specifies font options for the subtitle." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.subtitle.offset" + "Description": "Specifies the distance between the title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.text" + "Description": "Specifies text for the subtitle." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.textOverflow" + "Description": "Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.wordWrap" + "Description": "Specifies how to wrap the subtitle if it does not fit into a single line." } } }, @@ -9045,69 +8612,69 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.text" + "Description": "Specifies the title's text." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.textOverflow" + "Description": "Specifies what to do with the title when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.verticalAlignment" + "Description": "Specifies the title's alignment in a vertical direction." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.wordWrap" + "Description": "Specifies how to wrap the title if it does not fit into a single line." } } }, "tooltip": { - "DocID": "BaseGauge.Options.tooltip", + "Description": "Configures tooltips.", "Options": { "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.arrowLength" + "Description": "Specifies the length of a tooltip's arrow in pixels." }, "border": { - "DocID": "BaseWidget.Options.tooltip.border", + "Description": "Configures a tooltip's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.color" + "Description": "Colors a tooltip's border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.dashStyle" + "Description": "Specifies the dash style of a tooltip's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.opacity" + "Description": "Specifies the transparency of a tooltip's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.border.visible" + "Description": "Specifies whether a tooltip's border is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.width" + "Description": "Specifies the width of a tooltip's border in pixels." } } }, @@ -9115,7 +8682,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.color" + "Description": "Colors all tooltips." }, "container": { "PrimitiveTypes": [ @@ -9123,115 +8690,103 @@ "JQuery", "string" ], - "DocID": "BaseWidget.Options.tooltip.container" + "Description": "Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "BaseGauge.Options.tooltip.contentTemplate" + "Description": "Specifies a custom template for a tooltip." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.cornerRadius" + "Description": "Makes all the tooltip's corners rounded." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseGauge.Options.tooltip.customizeTooltip" + "Description": "Allows you to change the appearance of specified tooltips." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.enabled" + "Description": "Enables tooltips." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.font" + "Description": "Specifies tooltips' font options." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.format" + "Description": "Formats a value before it is displayed it in a tooltip." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.opacity" + "Description": "Specifies tooltips' transparency." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between a tooltip's left/right border and its text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text." }, "shadow": { - "DocID": "BaseWidget.Options.tooltip.shadow", + "Description": "Configures a tooltip's shadow.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.blur" + "Description": "Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.shadow.color" + "Description": "Colors a tooltip's shadow." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetX" + "Description": "Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetY" + "Description": "Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.opacity" + "Description": "Specifies the transparency of a tooltip's shadow." } } }, @@ -9239,7 +8794,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.zIndex" + "Description": "Specifies a tooltip's z-index." } } }, @@ -9248,18 +8803,18 @@ "number" ], "IsChangeable": true, - "DocID": "BaseGauge.Options.value" + "Description": "Specifies the main value on a gauge." }, "valueIndicator": { "ComplexTypes": [ "GaugeIndicator" ], - "DocID": "dxCircularGauge.Options.valueIndicator" + "Description": "Specifies the appearance options of the value indicator." } } }, "dxColorBox": { - "DocID": "dxColorBox", + "Description": "The ColorBox is a widget that allows an end user to enter a color or pick it out from the drop-down editor.", "Module": "ui/color_box", "IsEditor": true, "Options": { @@ -9267,31 +8822,31 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.acceptCustomValue" + "Description": "Specifies whether or not the widget allows an end-user to enter a custom value." }, "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "applyButtonText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxColorBox.Options.applyButtonText" + "Description": "Specifies the text displayed on the button that applies changes and closes the drop-down editor." }, "applyValueMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxColorBox.Options.applyValueMode" + "Description": "Specifies the way an end-user applies the selected value." }, "buttons": { "ItemPrimitiveTypes": [ @@ -9301,66 +8856,59 @@ "ItemComplexTypes": [ "TextEditorButton" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "button", - "DocID": "dxDropDownEditor.Options.buttons" + "Description": "Allows you to add custom buttons to the input text field." }, "cancelButtonText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxColorBox.Options.cancelButtonText" + "Description": "Specifies the text displayed on the button that cancels changes and closes the drop-down editor." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.deferRendering" + "Description": "Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "dropDownButtonTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDropDownEditor.Options.dropDownButtonTemplate" + "Description": "Specifies a custom template for the drop-down button." }, "editAlphaChannel": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxColorBox.Options.editAlphaChannel" + "Description": "Specifies whether or not the widget value includes the alpha channel component." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "fieldTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxColorBox.Options.fieldTemplate" + "Description": "Specifies a custom template for the input field. Must contain the TextBox widget." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -9369,43 +8917,43 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "inputAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTextEditor.Options.inputAttr" + "Description": "Specifies the attributes to be passed on to the underlying HTML element." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "keyStep": { "PrimitiveTypes": [ "number" ], - "DocID": "dxColorBox.Options.keyStep" + "Description": "Specifies the size of a step by which a handle is moved using a keyboard shortcut." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "onChange": { "PrimitiveTypes": [ @@ -9413,7 +8961,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onChange" + "Description": "A function that is executed when the widget loses focus after the text field's content was changed using the keyboard." }, "onClosed": { "PrimitiveTypes": [ @@ -9421,7 +8969,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onClosed" + "Description": "A function that is executed once the drop-down editor is closed." }, "onCopy": { "PrimitiveTypes": [ @@ -9429,7 +8977,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCopy" + "Description": "A function that is executed when the widget's input has been copied." }, "onCut": { "PrimitiveTypes": [ @@ -9437,7 +8985,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCut" + "Description": "A function that is executed when the widget's input has been cut." }, "onDisposing": { "PrimitiveTypes": [ @@ -9445,7 +8993,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEnterKey": { "PrimitiveTypes": [ @@ -9453,7 +9001,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onEnterKey" + "Description": "A function that is executed when the Enter key has been pressed while the widget is focused." }, "onFocusIn": { "PrimitiveTypes": [ @@ -9461,7 +9009,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusIn" + "Description": "A function that is executed when the widget gets focus." }, "onFocusOut": { "PrimitiveTypes": [ @@ -9469,7 +9017,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusOut" + "Description": "A function that is executed when the widget loses focus." }, "onInitialized": { "PrimitiveTypes": [ @@ -9477,7 +9025,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onInput": { "PrimitiveTypes": [ @@ -9485,7 +9033,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onInput" + "Description": "A function that is executed each time the widget's input is changed while the widget is focused." }, "onKeyDown": { "PrimitiveTypes": [ @@ -9493,7 +9041,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyDown" + "Description": "A function that is executed when a user is pressing a key on the keyboard." }, "onKeyPress": { "PrimitiveTypes": [ @@ -9501,7 +9049,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyPress" + "Description": "A function that is executed when a user presses a key on the keyboard." }, "onKeyUp": { "PrimitiveTypes": [ @@ -9509,7 +9057,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyUp" + "Description": "A function that is executed when a user releases a key on the keyboard." }, "onOpened": { "PrimitiveTypes": [ @@ -9517,7 +9065,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onOpened" + "Description": "A function that is executed once the drop-down editor is opened." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -9525,7 +9073,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPaste": { "PrimitiveTypes": [ @@ -9533,7 +9081,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onPaste" + "Description": "A function that is executed when the widget's input has been pasted." }, "onValueChanged": { "PrimitiveTypes": [ @@ -9541,75 +9089,75 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "opened": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxDropDownEditor.Options.opened" + "Description": "Specifies whether or not the drop-down editor is displayed." }, "openOnFieldClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.openOnFieldClick" + "Description": "Specifies whether a user can open the drop-down list by clicking a text field." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.placeholder" + "Description": "The text displayed by the widget when the widget value is empty." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showClearButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.showClearButton" + "Description": "Specifies whether to display the Clear button in the widget." }, "showDropDownButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.showDropDownButton" + "Description": "Specifies whether the drop-down button is visible." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.stylingMode" + "Description": "Specifies how the widget's text field is styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "text": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxTextEditor.Options.text" + "Description": "The read-only option that holds the text displayed by the widget input element." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -9617,32 +9165,32 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "dxColorBox.Options.value" + "Description": "Specifies the currently selected value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -9651,28 +9199,28 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxContextMenu": { - "DocID": "dxContextMenu", + "Description": "The ContextMenu widget displays a single- or multi-level context menu. An end user invokes this menu by a right click or a long press.", "Module": "ui/context_menu", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBase.Options.activeStateEnabled" + "Description": "A Boolean value specifying whether or not the widget changes its state when interacting with a user." }, "animation": { - "DocID": "dxMenuBase.Options.animation", + "Description": "Configures widget visibility animations. This object contains two fields: show and hide.", "Options": { "hide": { "PrimitiveTypes": [ @@ -9681,14 +9229,7 @@ "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxMenuBase.Options.animation.hide" + "Description": "An object that defines the animation options used when the widget is being hidden." }, "show": { "PrimitiveTypes": [ @@ -9697,14 +9238,7 @@ "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxMenuBase.Options.animation.show" + "Description": "An object that defines the animation options used when the widget is being shown." } } }, @@ -9714,13 +9248,13 @@ "Function" ], "IsFunc": true, - "DocID": "dxContextMenu.Options.closeOnOutsideClick" + "Description": "Specifies whether to close the ContextMenu if a user clicks outside it." }, "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBase.Options.cssClass" + "Description": "Specifies the name of the CSS class to be applied to the root menu level and all submenus." }, "dataSource": { "PrimitiveTypes": [ @@ -9734,21 +9268,14 @@ "ItemComplexTypes": [ "ContextMenuItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxContextMenu.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "disabledExpr": { "PrimitiveTypes": [ @@ -9756,7 +9283,7 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.disabledExpr" + "Description": "Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled." }, "displayExpr": { "PrimitiveTypes": [ @@ -9764,19 +9291,19 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.displayExpr" + "Description": "Specifies the data field whose values should be displayed." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "HierarchicalCollectionWidget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -9785,19 +9312,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "HierarchicalCollectionWidget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "items": { "ItemPrimitiveTypes": [ @@ -9806,17 +9333,10 @@ "ItemComplexTypes": [ "ContextMenuItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxContextMenu.Options.items" + "Description": "Holds an array of menu items." }, "itemsExpr": { "PrimitiveTypes": [ @@ -9824,14 +9344,14 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.itemsExpr" + "Description": "Specifies which data field contains nested items." }, "itemTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "onContentReady": { "PrimitiveTypes": [ @@ -9839,7 +9359,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -9847,7 +9367,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onHidden": { "PrimitiveTypes": [ @@ -9855,7 +9375,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxContextMenu.Options.onHidden" + "Description": "A function that is executed after the ContextMenu is hidden." }, "onHiding": { "PrimitiveTypes": [ @@ -9863,7 +9383,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxContextMenu.Options.onHiding" + "Description": "A function that is executed before the ContextMenu is hidden." }, "onInitialized": { "PrimitiveTypes": [ @@ -9871,7 +9391,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -9880,7 +9400,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -9888,7 +9408,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemRendered": { "PrimitiveTypes": [ @@ -9896,7 +9416,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -9904,7 +9424,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPositioning": { "PrimitiveTypes": [ @@ -9912,7 +9432,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxContextMenu.Options.onPositioning" + "Description": "A function that is executed before the ContextMenu is positioned." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -9920,7 +9440,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onSelectionChanged" + "Description": "A function that is executed when a collection item is selected or selection is canceled." }, "onShowing": { "PrimitiveTypes": [ @@ -9928,7 +9448,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxContextMenu.Options.onShowing" + "Description": "A function that is executed before the ContextMenu is shown." }, "onShown": { "PrimitiveTypes": [ @@ -9936,34 +9456,28 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxContextMenu.Options.onShown" + "Description": "A function that is executed after the ContextMenu is shown." }, "position": { "PrimitiveTypes": [ - "positionConfig" + "DevExpress.positionConfig" ], "ComplexTypes": [ "PositionConfig" ], - "TypeImports": [ - { - "Name": "positionConfig", - "Path": "animation/position" - } - ], - "DocID": "dxContextMenu.Options.position" + "Description": "An object defining widget positioning options." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectByClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBase.Options.selectByClick" + "Description": "Specifies whether or not an item becomes selected if a user clicks it." }, "selectedExpr": { "PrimitiveTypes": [ @@ -9971,38 +9485,38 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.selectedExpr" + "Description": "Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected." }, "selectedItem": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "CollectionWidget.Options.selectedItem" + "Description": "The selected item object." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBase.Options.selectionMode" + "Description": "Specifies the selection mode supported by the menu." }, "showEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxContextMenu.Options.showEvent", + "Description": "Specifies options for displaying the widget.", "Options": { "delay": { "PrimitiveTypes": [ "number" ], - "DocID": "dxContextMenu.Options.showEvent.delay" + "Description": "The delay in milliseconds after which the widget is displayed." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxContextMenu.Options.showEvent.name" + "Description": "Specifies the event names on which the widget is shown." } } }, @@ -10010,25 +9524,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBase.Options.showSubmenuMode", + "Description": "Specifies options of submenu showing and hiding.", "Options": { "delay": { "PrimitiveTypes": [ "number" ], - "DocID": "dxMenuBase.Options.showSubmenuMode.delay", + "Description": "Specifies the delay of submenu show and hiding.", "Options": { "hide": { "PrimitiveTypes": [ "number" ], - "DocID": "dxMenuBase.Options.showSubmenuMode.delay.hide" + "Description": "The time span after which the submenu is hidden." }, "show": { "PrimitiveTypes": [ "number" ], - "DocID": "dxMenuBase.Options.showSubmenuMode.delay.show" + "Description": "The time span after which the submenu is shown." } } }, @@ -10036,7 +9550,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBase.Options.showSubmenuMode.name" + "Description": "Specifies the mode name." } } }, @@ -10044,13 +9558,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxContextMenu.Options.submenuDirection" + "Description": "Specifies the direction at which submenus are displayed." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "target": { "PrimitiveTypes": [ @@ -10058,14 +9572,14 @@ "JQuery", "string" ], - "DocID": "dxContextMenu.Options.target" + "Description": "The target element associated with the context menu." }, "visible": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxContextMenu.Options.visible" + "Description": "A Boolean value specifying whether or not the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -10074,150 +9588,150 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxDataGrid": { - "DocID": "dxDataGrid", + "Description": "The DataGrid is a widget that represents data from a local or remote source in the form of a grid. This widget offers such basic features as sorting, grouping, filtering, as well as more advanced capabilities, like state storing, export to Excel, master-detail interface, and many others.", "Module": "ui/data_grid", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "allowColumnReordering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.allowColumnReordering" + "Description": "Specifies whether a user can reorder columns." }, "allowColumnResizing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.allowColumnResizing" + "Description": "Specifies whether a user can resize columns." }, "autoNavigateToFocusedRow": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.autoNavigateToFocusedRow" + "Description": "Automatically scrolls to the focused row when the focusedRowKey is changed." }, "cacheEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.cacheEnabled" + "Description": "Specifies whether data should be cached." }, "cellHintEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.cellHintEnabled" + "Description": "Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content." }, "columnAutoWidth": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.columnAutoWidth" + "Description": "Specifies whether columns should adjust their widths to the content." }, "columnChooser": { - "DocID": "GridBase.Options.columnChooser", + "Description": "Configures the column chooser.", "Options": { "allowSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.columnChooser.allowSearch" + "Description": "Specifies whether searching is enabled in the column chooser." }, "emptyPanelText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnChooser.emptyPanelText" + "Description": "Specifies text displayed by the column chooser when it is empty." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.columnChooser.enabled" + "Description": "Specifies whether a user can open the column chooser." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.columnChooser.height" + "Description": "Specifies the height of the column chooser." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnChooser.mode" + "Description": "Specifies how a user manages columns using the column chooser." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.columnChooser.searchTimeout" + "Description": "Specifies a delay in milliseconds between when a user finishes typing in the column chooser's search panel, and when the search is executed." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnChooser.title" + "Description": "Specifies the title of the column chooser." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.columnChooser.width" + "Description": "Specifies the width of the column chooser." } } }, "columnFixing": { - "DocID": "GridBase.Options.columnFixing", + "Description": "Configures column fixing.", "Options": { "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.columnFixing.enabled" + "Description": "Enables column fixing." }, "texts": { - "DocID": "GridBase.Options.columnFixing.texts", + "Description": "Contains options that specify texts for column fixing commands in the context menu of a column header.", "Options": { "fix": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnFixing.texts.fix" + "Description": "Specifies text for the context menu item that fixes a column." }, "leftPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnFixing.texts.leftPosition" + "Description": "Specifies text for the context menu subitem that fixes a column to the left edge of the widget." }, "rightPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnFixing.texts.rightPosition" + "Description": "Specifies text for the context menu subitem that fixes a column to the right edge of the widget." }, "unfix": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnFixing.texts.unfix" + "Description": "Specifies text for the context menu item that unfixes a column." } } } @@ -10227,19 +9741,19 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.columnHidingEnabled" + "Description": "Specifies whether the widget should hide columns to adapt to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is \"widget\"." }, "columnMinWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.columnMinWidth" + "Description": "Specifies the minimum width of columns." }, "columnResizingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnResizingMode" + "Description": "Specifies how the widget resizes columns. Applies only if allowColumnResizing is true." }, "columns": { "ItemPrimitiveTypes": [ @@ -10249,37 +9763,30 @@ "ItemComplexTypes": [ "DataGridColumn" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "IsChangeable": true, "SingularName": "column", - "DocID": "dxDataGrid.Options.columns" + "Description": "An array of grid columns." }, "columnWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.columnWidth" + "Description": "Specifies the width for all data columns. Has a lower priority than the column.width option." }, "customizeColumns": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxDataGrid.Options.customizeColumns" + "Description": "Customizes columns after they are created." }, "customizeExportData": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxDataGrid.Options.customizeExportData" + "Description": "Customizes data before export. You can use the export.customizeExcelCell function instead." }, "dataSource": { "PrimitiveTypes": [ @@ -10290,36 +9797,29 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "GridBase.Options.dataSource" + "Description": "Binds the widget to data." }, "dateSerializationFormat": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.dateSerializationFormat" + "Description": "Specifies the format in which date-time values should be sent to the server. Use it only if you do not specify the dataSource at design time." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "editing": { - "DocID": "dxDataGrid.Options.editing", + "Description": "Configures editing.", "Options": { "allowAdding": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.editing.allowAdding" + "Description": "Specifies whether a user can add new rows." }, "allowDeleting": { "PrimitiveTypes": [ @@ -10327,7 +9827,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxDataGrid.Options.editing.allowDeleting" + "Description": "Specifies whether a user can delete rows. It is called for each data row when defined as a function." }, "allowUpdating": { "PrimitiveTypes": [ @@ -10335,130 +9835,118 @@ "Function" ], "IsFunc": true, - "DocID": "dxDataGrid.Options.editing.allowUpdating" + "Description": "Specifies whether a user can update rows. It is called for each data row when defined as a function." }, "form": { "PrimitiveTypes": [ - "dxFormOptions" + "DevExpress.ui.dxFormOptions" ], "ComplexTypes": [ "dxFormOptions" ], - "TypeImports": [ - { - "Name": "dxFormOptions", - "Path": "ui/form" - } - ], - "DocID": "GridBase.Options.editing.form" + "Description": "Configures the form. Used only if editing.mode is \"form\" or \"popup\"." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.mode" + "Description": "Specifies how a user edits data." }, "popup": { "PrimitiveTypes": [ - "dxPopupOptions" + "DevExpress.ui.dxPopupOptions" ], "ComplexTypes": [ "dxPopupOptions" ], - "TypeImports": [ - { - "Name": "dxPopupOptions", - "Path": "ui/popup" - } - ], - "DocID": "GridBase.Options.editing.popup" + "Description": "Configures the popup. Used only if editing.mode is \"popup\"." }, "refreshMode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.refreshMode" + "Description": "Specifies operations that are performed after saving changes." }, "selectTextOnEditStart": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.editing.selectTextOnEditStart" + "Description": "Specifies whether to select text in a cell when a user starts editing." }, "startEditAction": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.startEditAction" + "Description": "Specifies whether a single or double click should switch a cell to the editing state. Applies if editing.mode is \"cell\" or \"batch\"." }, "texts": { - "DocID": "dxDataGrid.Options.editing.texts", + "Description": "Contains options that specify texts for editing-related UI elements.", "Options": { "addRow": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.addRow" + "Description": "Specifies text for a hint that appears when a user pauses on the global \"Add\" button. Applies only if editing.allowAdding is true." }, "cancelAllChanges": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.cancelAllChanges" + "Description": "Specifies text for a hint that appears when a user pauses on the \"Discard\" button. Applies only if editing.mode is \"batch\"." }, "cancelRowChanges": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.cancelRowChanges" + "Description": "Specifies text for a button that cancels changes in a row. Applies only if editing.allowUpdating is true and editing.mode is \"row\"." }, "confirmDeleteMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.confirmDeleteMessage" + "Description": "Specifies a message that prompts a user to confirm deletion." }, "confirmDeleteTitle": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.confirmDeleteTitle" + "Description": "Specifies a title for the window that asks a user to confirm deletion." }, "deleteRow": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.deleteRow" + "Description": "Specifies text for buttons that delete rows. Applies only if allowDeleting is true." }, "editRow": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.editRow" + "Description": "Specifies text for buttons that switch rows into the editing state. Applies only if allowUpdating is true." }, "saveAllChanges": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.saveAllChanges" + "Description": "Specifies text for a hint that appears when a user pauses on the global \"Save\" button. Applies only if editing.mode is \"batch\"." }, "saveRowChanges": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.saveRowChanges" + "Description": "Specifies text for a button that saves changes made in a row. Applies only if allowUpdating is true." }, "undeleteRow": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.undeleteRow" + "Description": "Specifies text for buttons that recover deleted rows. Applies only if allowDeleting is true and editing.mode is \"batch\"." }, "validationCancelChanges": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.validationCancelChanges" + "Description": "Specifies text for a hint appearing when a user pauses on the button that cancels changes in a cell. Applies only if editing.mode is \"cell\" and data validation is enabled." } } }, @@ -10466,7 +9954,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.editing.useIcons" + "Description": "Specifies whether the editing column uses icons instead of links." } } }, @@ -10474,87 +9962,87 @@ "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "errorRowEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.errorRowEnabled" + "Description": "Indicates whether to show the error row." }, "export": { - "DocID": "dxDataGrid.Options.export", + "Description": "Configures client-side exporting.", "Options": { "allowExportSelectedData": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.export.allowExportSelectedData" + "Description": "Allows an end user to export selected rows only." }, "customizeExcelCell": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxDataGrid.Options.export.customizeExcelCell" + "Description": "Customizes an Excel cell after it is created." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.export.enabled" + "Description": "Enables the client-side exporting." }, "excelFilterEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.export.excelFilterEnabled" + "Description": "Specifies whether to enable Excel filtering for the exported data in the resulting XLSX file." }, "excelWrapTextEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.export.excelWrapTextEnabled" + "Description": "Specifies whether to enable word wrapping for the exported data in the resulting XLSX file." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.export.fileName" + "Description": "Specifies a default name for the file to which grid data is exported." }, "ignoreExcelErrors": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.export.ignoreExcelErrors" + "Description": "Specifies whether Excel should hide warnings if there are errors in the exported document." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "dxDataGrid.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." }, "texts": { - "DocID": "dxDataGrid.Options.export.texts", + "Description": "Configures the texts of export commands, buttons, and hints.", "Options": { "exportAll": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.export.texts.exportAll" + "Description": "The text or hint of the command that exports all data." }, "exportSelectedRows": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.export.texts.exportSelectedRows" + "Description": "The text of the command that exports selected rows. Applies when allowExportSelectedData option is true." }, "exportTo": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.export.texts.exportTo" + "Description": "The hint of the Export button when the allowExportSelectedData option is true." } } } @@ -10562,71 +10050,59 @@ }, "filterBuilder": { "PrimitiveTypes": [ - "dxFilterBuilderOptions" + "DevExpress.ui.dxFilterBuilderOptions" ], "ComplexTypes": [ "dxFilterBuilderOptions" ], - "TypeImports": [ - { - "Name": "dxFilterBuilderOptions", - "Path": "ui/filter_builder" - } - ], - "DocID": "GridBase.Options.filterBuilder" + "Description": "Configures the integrated filter builder." }, "filterBuilderPopup": { "PrimitiveTypes": [ - "dxPopupOptions" + "DevExpress.ui.dxPopupOptions" ], "ComplexTypes": [ "dxPopupOptions" ], - "TypeImports": [ - { - "Name": "dxPopupOptions", - "Path": "ui/popup" - } - ], - "DocID": "GridBase.Options.filterBuilderPopup" + "Description": "Configures the popup in which the integrated filter builder is shown." }, "filterPanel": { - "DocID": "GridBase.Options.filterPanel", + "Description": "Configures the filter panel.", "Options": { "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBase.Options.filterPanel.customizeText" + "Description": "Customizes the filter expression's text representation." }, "filterEnabled": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "GridBase.Options.filterPanel.filterEnabled" + "Description": "Specifies whether the filter expression is applied." }, "texts": { - "DocID": "GridBase.Options.filterPanel.texts", + "Description": "Specifies texts for the filter panel's elements.", "Options": { "clearFilter": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterPanel.texts.clearFilter" + "Description": "The text of the \"Clear\" link." }, "createFilter": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterPanel.texts.createFilter" + "Description": "The text of the \"Create Filter\" link." }, "filterEnabledHint": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterPanel.texts.filterEnabledHint" + "Description": "The hint of the checkbox that applies the filter." } } }, @@ -10634,105 +10110,105 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.filterPanel.visible" + "Description": "Specifies whether the filter panel is visible." } } }, "filterRow": { - "DocID": "GridBase.Options.filterRow", + "Description": "Configures the filter row.", "Options": { "applyFilter": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.applyFilter" + "Description": "Specifies when to apply a filter." }, "applyFilterText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.applyFilterText" + "Description": "Specifies text for a hint that appears when a user pauses on a button that applies the filter." }, "betweenEndText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.betweenEndText" + "Description": "Specifies a placeholder for the editor that specifies the end of a range when a user selects the \"between\" filter operation." }, "betweenStartText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.betweenStartText" + "Description": "Specifies a placeholder for the editor that specifies the start of a range when a user selects the \"between\" filter operation." }, "operationDescriptions": { - "DocID": "GridBase.Options.filterRow.operationDescriptions", + "Description": "Specifies descriptions for filter operations on the filter list.", "Options": { "between": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.between" + "Description": "A description for the \"between\" operation." }, "contains": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.contains" + "Description": "A description for the \"contains\" operation." }, "endsWith": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.endsWith" + "Description": "A description for the \"endswith\" operation." }, "equal": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.equal" + "Description": "A description for the \"=\" operation." }, "greaterThan": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.greaterThan" + "Description": "A description for the \">\" operation." }, "greaterThanOrEqual": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.greaterThanOrEqual" + "Description": "A description for the \">=\" operation." }, "lessThan": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.lessThan" + "Description": "A description for the \"<\" operation." }, "lessThanOrEqual": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.lessThanOrEqual" + "Description": "A description for the \"<=\" operation." }, "notContains": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.notContains" + "Description": "A description for the \"notcontains\" operation." }, "notEqual": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.notEqual" + "Description": "A description for the \"<>\" operation." }, "startsWith": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.startsWith" + "Description": "A description for the \"startswith\" operation." } } }, @@ -10740,25 +10216,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.resetOperationText" + "Description": "Specifies text for the reset operation on the filter list." }, "showAllText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.showAllText" + "Description": "Specifies text for the item that clears the applied filter. Used only when a cell of the filter row contains a select box." }, "showOperationChooser": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.filterRow.showOperationChooser" + "Description": "Specifies whether icons that open the filter lists are visible." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.filterRow.visible" + "Description": "Specifies whether the filter row is visible." } } }, @@ -10767,7 +10243,7 @@ "boolean", "string" ], - "DocID": "GridBase.Options.filterSyncEnabled" + "Description": "Specifies whether to synchronize the filter row, header filter, and filter builder. The synchronized filter expression is stored in the filterValue option." }, "filterValue": { "PrimitiveTypes": [ @@ -10775,170 +10251,170 @@ ], "IsFilterExpr": true, "IsChangeable": true, - "DocID": "GridBase.Options.filterValue" + "Description": "Specifies a filter expression." }, "focusedColumnIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "GridBase.Options.focusedColumnIndex" + "Description": "The index of the column that contains the focused data cell." }, "focusedRowEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.focusedRowEnabled" + "Description": "Specifies whether the focused row feature is enabled." }, "focusedRowIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "GridBase.Options.focusedRowIndex" + "Description": "Specifies the initially or currently focused grid row's index. Use it when focusedRowEnabled is true." }, "focusedRowKey": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "GridBase.Options.focusedRowKey" + "Description": "Specifies initially or currently focused grid row's key. Use it when focusedRowEnabled is true." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "grouping": { - "DocID": "dxDataGrid.Options.grouping", + "Description": "Configures grouping.", "Options": { "allowCollapsing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.grouping.allowCollapsing" + "Description": "Specifies whether the user can collapse grouped records in a grid or not." }, "autoExpandAll": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.grouping.autoExpandAll" + "Description": "Specifies whether groups appear expanded or not." }, "contextMenuEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.grouping.contextMenuEnabled" + "Description": "Enables the user to group data using the context menu." }, "expandMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.grouping.expandMode" + "Description": "Specifies the event on which a group will be expanded/collapsed." }, "texts": { - "DocID": "dxDataGrid.Options.grouping.texts", + "Description": "Defines the texts of grouping-related visual elements.", "Options": { "groupByThisColumn": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.grouping.texts.groupByThisColumn" + "Description": "Specifies the text of the context menu item that groups data by a specific column." }, "groupContinuedMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.grouping.texts.groupContinuedMessage" + "Description": "Specifies the message displayed in a group row when the corresponding group is continued from the previous page." }, "groupContinuesMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.grouping.texts.groupContinuesMessage" + "Description": "Specifies the message displayed in a group row when the corresponding group continues on the next page." }, "ungroup": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.grouping.texts.ungroup" + "Description": "Specifies the text of the context menu item that clears grouping settings of a specific column." }, "ungroupAll": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.grouping.texts.ungroupAll" + "Description": "Specifies the text of the context menu item that clears grouping settings of all columns." } } } } }, "groupPanel": { - "DocID": "dxDataGrid.Options.groupPanel", + "Description": "Configures the group panel.", "Options": { "allowColumnDragging": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.groupPanel.allowColumnDragging" + "Description": "Specifies whether columns can be dragged onto or from the group panel." }, "emptyPanelText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.groupPanel.emptyPanelText" + "Description": "Specifies text displayed by the group panel when it does not contain any columns." }, "visible": { "PrimitiveTypes": [ "boolean", "string" ], - "DocID": "dxDataGrid.Options.groupPanel.visible" + "Description": "Specifies whether the group panel is visible or not." } } }, "headerFilter": { - "DocID": "GridBase.Options.headerFilter", + "Description": "Configures the header filter feature.", "Options": { "allowSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.headerFilter.allowSearch" + "Description": "Specifies whether searching is enabled in the header filter." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.headerFilter.height" + "Description": "Specifies the height of the popup menu that contains values for filtering." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.headerFilter.searchTimeout" + "Description": "Specifies a delay in milliseconds between when a user finishes typing in the header filter's search panel, and when the search is executed." }, "texts": { - "DocID": "GridBase.Options.headerFilter.texts", + "Description": "Contains options that specify text for various elements of the popup menu.", "Options": { "cancel": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.headerFilter.texts.cancel" + "Description": "Specifies text for the button that closes the popup menu without applying a filter." }, "emptyValue": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.headerFilter.texts.emptyValue" + "Description": "Specifies a name for the item that represents empty values in the popup menu." }, "ok": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.headerFilter.texts.ok" + "Description": "Specifies text for the button that applies the specified filter." } } }, @@ -10946,13 +10422,13 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.headerFilter.visible" + "Description": "Indicates whether header filter icons are visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.headerFilter.width" + "Description": "Specifies the width of the popup menu that contains values for filtering." } } }, @@ -10963,52 +10439,52 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "highlightChanges": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.highlightChanges" + "Description": "Specifies whether to highlight rows and cells with edited data. repaintChangesOnly should be true." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "keyboardNavigation": { - "DocID": "GridBase.Options.keyboardNavigation", + "Description": "Configures keyboard navigation.", "Options": { "editOnKeyPress": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.keyboardNavigation.editOnKeyPress" + "Description": "Specifies whether users can enter a new cell value on a key press. Applies if editing.mode is \"cell\" or \"batch\"." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.keyboardNavigation.enabled" + "Description": "Enables keyboard navigation." }, "enterKeyAction": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.keyboardNavigation.enterKeyAction" + "Description": "Specifies whether the Enter key switches the cell to the editing state or moves focus in the enterKeyDirection. Applies if editing.mode is \"cell\" or \"batch\"." }, "enterKeyDirection": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.keyboardNavigation.enterKeyDirection" + "Description": "Specifies the direction in which to move focus when a user presses Enter. Applies if editing.mode is \"cell\" or \"batch\"." } } }, @@ -11021,89 +10497,89 @@ ], "IsCollection": true, "SingularName": "keyExpr", - "DocID": "dxDataGrid.Options.keyExpr" + "Description": "Specifies the key property (or properties) that provide(s) key values to access data items. Each key value must be unique. This option applies only if data is a simple array." }, "loadPanel": { - "DocID": "GridBase.Options.loadPanel", + "Description": "Configures the load panel.", "Options": { "enabled": { "PrimitiveTypes": [ "boolean", "string" ], - "DocID": "GridBase.Options.loadPanel.enabled" + "Description": "Enables displaying the load panel automatically." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.loadPanel.height" + "Description": "Specifies the height of the load panel in pixels." }, "indicatorSrc": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.loadPanel.indicatorSrc" + "Description": "Specifies a URL pointing to an image to be used as a loading indicator." }, "shading": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.loadPanel.shading" + "Description": "Specifies whether to shade the widget when the load panel is shown." }, "shadingColor": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.loadPanel.shadingColor" + "Description": "Specifies the shading color. Applies only if shading is true." }, "showIndicator": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.loadPanel.showIndicator" + "Description": "Specifies whether to show the loading indicator." }, "showPane": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.loadPanel.showPane" + "Description": "Specifies whether to show the pane of the load panel." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.loadPanel.text" + "Description": "Specifies text displayed on the load panel." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.loadPanel.width" + "Description": "Specifies the width of the load panel in pixels." } } }, "masterDetail": { - "DocID": "dxDataGrid.Options.masterDetail", + "Description": "Allows you to build a master-detail interface in the grid.", "Options": { "autoExpandAll": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.masterDetail.autoExpandAll" + "Description": "Specifies whether detail sections appear expanded or collapsed." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.masterDetail.enabled" + "Description": "Enables an end-user to expand/collapse detail sections." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDataGrid.Options.masterDetail.template" + "Description": "Specifies a custom template for detail sections." } } }, @@ -11111,7 +10587,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.noDataText" + "Description": "Specifies text shown when the widget does not display any data." }, "onAdaptiveDetailRowPreparing": { "PrimitiveTypes": [ @@ -11119,7 +10595,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onAdaptiveDetailRowPreparing" + "Description": "A function that is executed before an adaptive detail row is rendered." }, "onCellClick": { "PrimitiveTypes": [ @@ -11128,7 +10604,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onCellClick" + "Description": "A function that is executed when a cell is clicked or tapped. Executed before onRowClick." }, "onCellDblClick": { "PrimitiveTypes": [ @@ -11136,7 +10612,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onCellDblClick" + "Description": "A function that is executed when a cell is double-clicked or double-tapped. Executed before onRowDblClick." }, "onCellHoverChanged": { "PrimitiveTypes": [ @@ -11144,7 +10620,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onCellHoverChanged" + "Description": "A function that is executed after the pointer enters or leaves a cell." }, "onCellPrepared": { "PrimitiveTypes": [ @@ -11152,7 +10628,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onCellPrepared" + "Description": "A function that is executed after a cell is created." }, "onContentReady": { "PrimitiveTypes": [ @@ -11160,7 +10636,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onContextMenuPreparing": { "PrimitiveTypes": [ @@ -11168,7 +10644,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onContextMenuPreparing" + "Description": "A function that is executed before the context menu is rendered." }, "onDataErrorOccurred": { "PrimitiveTypes": [ @@ -11176,7 +10652,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onDataErrorOccurred" + "Description": "A function that is executed when an error occurs in the data source." }, "onDisposing": { "PrimitiveTypes": [ @@ -11184,7 +10660,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEditingStart": { "PrimitiveTypes": [ @@ -11192,7 +10668,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onEditingStart" + "Description": "A function that is executed before a cell or row switches to the editing state." }, "onEditorPrepared": { "PrimitiveTypes": [ @@ -11200,7 +10676,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onEditorPrepared" + "Description": "A function that is executed after an editor is created. Not executed for cells with an editCellTemplate." }, "onEditorPreparing": { "PrimitiveTypes": [ @@ -11208,7 +10684,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onEditorPreparing" + "Description": "A function used to customize or replace default editors. Not executed for cells with an editCellTemplate." }, "onExported": { "PrimitiveTypes": [ @@ -11216,7 +10692,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onExported" + "Description": "A function that is executed after data is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -11224,7 +10700,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onExporting" + "Description": "A function that is executed before data is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -11232,7 +10708,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onFileSaving" + "Description": "A function that is executed before a file with exported data is saved to the user's local storage." }, "onFocusedCellChanged": { "PrimitiveTypes": [ @@ -11240,7 +10716,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onFocusedCellChanged" + "Description": "A function that is executed after the focused cell changes. Applies only to cells in data or group rows." }, "onFocusedCellChanging": { "PrimitiveTypes": [ @@ -11248,7 +10724,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onFocusedCellChanging" + "Description": "A function that is executed before the focused cell changes. Applies only to cells in data or group rows." }, "onFocusedRowChanged": { "PrimitiveTypes": [ @@ -11256,7 +10732,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onFocusedRowChanged" + "Description": "A function that is executed after the focused row changes. Applies only to data or group rows. focusedRowEnabled should be true." }, "onFocusedRowChanging": { "PrimitiveTypes": [ @@ -11264,7 +10740,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onFocusedRowChanging" + "Description": "A function that is executed before the focused row changes. Applies only to data or group rows. focusedRowEnabled should be true." }, "onInitialized": { "PrimitiveTypes": [ @@ -11272,7 +10748,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onInitNewRow": { "PrimitiveTypes": [ @@ -11280,7 +10756,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onInitNewRow" + "Description": "A function that is executed before a new row is added to the widget." }, "onKeyDown": { "PrimitiveTypes": [ @@ -11288,7 +10764,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onKeyDown" + "Description": "A function that is executed when the widget is in focus and a key has been pressed down." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -11296,7 +10772,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onRowClick": { "PrimitiveTypes": [ @@ -11305,7 +10781,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onRowClick" + "Description": "A function that is executed when a row is clicked or tapped." }, "onRowCollapsed": { "PrimitiveTypes": [ @@ -11313,7 +10789,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowCollapsed" + "Description": "A function that is executed after a row is collapsed." }, "onRowCollapsing": { "PrimitiveTypes": [ @@ -11321,7 +10797,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowCollapsing" + "Description": "A function that is executed before a row is collapsed." }, "onRowDblClick": { "PrimitiveTypes": [ @@ -11329,7 +10805,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onRowDblClick" + "Description": "A function that is executed when a row is double-clicked or double-tapped. Executed after onCellDblClick." }, "onRowExpanded": { "PrimitiveTypes": [ @@ -11337,7 +10813,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowExpanded" + "Description": "A function that is executed after a row is expanded." }, "onRowExpanding": { "PrimitiveTypes": [ @@ -11345,7 +10821,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowExpanding" + "Description": "A function that is executed before a row is expanded." }, "onRowInserted": { "PrimitiveTypes": [ @@ -11353,7 +10829,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowInserted" + "Description": "A function that is executed after a new row has been inserted into the data source." }, "onRowInserting": { "PrimitiveTypes": [ @@ -11361,7 +10837,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowInserting" + "Description": "A function that is executed before a new row is inserted into the data source." }, "onRowPrepared": { "PrimitiveTypes": [ @@ -11369,7 +10845,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGrid.Options.onRowPrepared" + "Description": "A function that is executed after a row is created." }, "onRowRemoved": { "PrimitiveTypes": [ @@ -11377,7 +10853,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowRemoved" + "Description": "A function that is executed after a row has been removed from the data source." }, "onRowRemoving": { "PrimitiveTypes": [ @@ -11385,7 +10861,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowRemoving" + "Description": "A function that is executed before a row is removed from the data source." }, "onRowUpdated": { "PrimitiveTypes": [ @@ -11393,7 +10869,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowUpdated" + "Description": "A function that is executed after a row has been updated in the data source." }, "onRowUpdating": { "PrimitiveTypes": [ @@ -11401,7 +10877,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowUpdating" + "Description": "A function that is executed before a row is updated in the data source." }, "onRowValidating": { "PrimitiveTypes": [ @@ -11409,7 +10885,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowValidating" + "Description": "A function that is executed after cells in a row are validated against validation rules." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -11417,7 +10893,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onSelectionChanged" + "Description": "A function that is executed after selecting a row or clearing its selection." }, "onToolbarPreparing": { "PrimitiveTypes": [ @@ -11425,10 +10901,10 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onToolbarPreparing" + "Description": "A function that is executed before the toolbar is created." }, "pager": { - "DocID": "GridBase.Options.pager", + "Description": "Configures the pager.", "Options": { "allowedPageSizes": { "PrimitiveTypes": [ @@ -11439,63 +10915,63 @@ ], "IsCollection": true, "SingularName": "allowedPageSize", - "DocID": "GridBase.Options.pager.allowedPageSizes" + "Description": "Specifies the available page sizes in the page size selector." }, "infoText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.pager.infoText" + "Description": "Specifies the page information text." }, "showInfo": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.pager.showInfo" + "Description": "Specifies whether to show the page information." }, "showNavigationButtons": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.pager.showNavigationButtons" + "Description": "Specifies whether to show navigation buttons." }, "showPageSizeSelector": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.pager.showPageSizeSelector" + "Description": "Specifies whether to show the page size selector." }, "visible": { "PrimitiveTypes": [ "boolean", "string" ], - "DocID": "GridBase.Options.pager.visible" + "Description": "Specifies whether the pager is visible." } } }, "paging": { - "DocID": "GridBase.Options.paging", + "Description": "Configures paging.", "Options": { "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.paging.enabled" + "Description": "Enables paging." }, "pageIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "GridBase.Options.paging.pageIndex" + "Description": "Specifies the page to be displayed using a zero-based index." }, "pageSize": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "GridBase.Options.paging.pageSize" + "Description": "Specifies the page size." } } }, @@ -11504,43 +10980,43 @@ "boolean", "string" ], - "DocID": "dxDataGrid.Options.remoteOperations", + "Description": "Notifies the DataGrid of the server's data processing operations.", "Options": { "filtering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.remoteOperations.filtering" + "Description": "Specifies whether or not filtering must be performed on the server side." }, "grouping": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.remoteOperations.grouping" + "Description": "Specifies whether or not grouping must be performed on the server side." }, "groupPaging": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.remoteOperations.groupPaging" + "Description": "Specifies whether paging by groups should be performed on the server side." }, "paging": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.remoteOperations.paging" + "Description": "Specifies whether or not paging must be performed on the server side." }, "sorting": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.remoteOperations.sorting" + "Description": "Specifies whether or not sorting must be performed on the server side." }, "summary": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.remoteOperations.summary" + "Description": "Specifies whether or not summaries calculation must be performed on the server." } } }, @@ -11548,40 +11024,40 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.renderAsync" + "Description": "Specifies whether to render the filter row, command columns, and columns with showEditorAlways set to true after other elements." }, "repaintChangesOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.repaintChangesOnly" + "Description": "Specifies whether to repaint only those cells whose data changed." }, "rowAlternationEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.rowAlternationEnabled" + "Description": "Specifies whether rows should be shaded differently." }, "rowDragging": { - "DocID": "GridBase.Options.rowDragging", + "Description": "Configures row reordering using drag and drop gestures.", "Options": { "allowDropInsideItem": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.rowDragging.allowDropInsideItem" + "Description": "Allows users to drop a row inside another row." }, "allowReordering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.rowDragging.allowReordering" + "Description": "Allows row reordering using drag and drop gestures." }, "autoScroll": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.rowDragging.autoScroll" + "Description": "Enables automatic scrolling while dragging a row beyond the viewport." }, "boundary": { "PrimitiveTypes": [ @@ -11589,7 +11065,7 @@ "JQuery", "string" ], - "DocID": "GridBase.Options.rowDragging.boundary" + "Description": "Specifies a DOM element that limits the dragging area." }, "container": { "PrimitiveTypes": [ @@ -11597,25 +11073,25 @@ "JQuery", "string" ], - "DocID": "GridBase.Options.rowDragging.container" + "Description": "Specifies a custom container in which the draggable row should be rendered." }, "cursorOffset": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.rowDragging.cursorOffset", + "Description": "Specifies the cursor offset from the dragged row.", "Options": { "x": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.rowDragging.cursorOffset.x" + "Description": "Specifies the horizontal cursor offset from the dragged row in pixels." }, "y": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.rowDragging.cursorOffset.y" + "Description": "Specifies the vertical cursor offset from the dragged row in pixels." } } }, @@ -11623,44 +11099,44 @@ "PrimitiveTypes": [ "any" ], - "DocID": "GridBase.Options.rowDragging.data" + "Description": "A container for custom data." }, "dragDirection": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.rowDragging.dragDirection" + "Description": "Specifies the directions in which a row can be dragged." }, "dragTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "GridBase.Options.rowDragging.dragTemplate" + "Description": "Specifies custom markup to be shown instead of the item being dragged." }, "dropFeedbackMode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.rowDragging.dropFeedbackMode" + "Description": "Specifies how to highlight the row's drop position." }, "filter": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.rowDragging.filter" + "Description": "Specifies a CSS selector for draggable rows." }, "group": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.rowDragging.group" + "Description": "Allows you to group several widgets so that users can drag and drop rows between them." }, "handle": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.rowDragging.handle" + "Description": "Specifies a CSS selector (ID or class) for the element(s) that should act as the drag handle(s)." }, "onAdd": { "PrimitiveTypes": [ @@ -11668,7 +11144,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onAdd" + "Description": "A function that is called when a new row is added." }, "onDragChange": { "PrimitiveTypes": [ @@ -11676,7 +11152,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onDragChange" + "Description": "A function that is called when the dragged row's position is changed." }, "onDragEnd": { "PrimitiveTypes": [ @@ -11684,7 +11160,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onDragEnd" + "Description": "A function that is called when the drag gesture is finished." }, "onDragMove": { "PrimitiveTypes": [ @@ -11692,7 +11168,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onDragMove" + "Description": "A function that is called every time a draggable row is moved." }, "onDragStart": { "PrimitiveTypes": [ @@ -11700,7 +11176,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onDragStart" + "Description": "A function that is called when the drag gesture is initialized." }, "onRemove": { "PrimitiveTypes": [ @@ -11708,7 +11184,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onRemove" + "Description": "A function that is called when a draggable row is removed." }, "onReorder": { "PrimitiveTypes": [ @@ -11716,25 +11192,25 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onReorder" + "Description": "A function that is called when the draggable rows are reordered." }, "scrollSensitivity": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.rowDragging.scrollSensitivity" + "Description": "Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true." }, "scrollSpeed": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.rowDragging.scrollSpeed" + "Description": "Specifies the scrolling speed when dragging a row beyond the viewport. Applies only if autoScroll is true." }, "showDragIcons": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.rowDragging.showDragIcons" + "Description": "Shows or hides row dragging icons." } } }, @@ -11743,113 +11219,113 @@ "any" ], "IsTemplate": true, - "DocID": "dxDataGrid.Options.rowTemplate" + "Description": "Specifies a custom template for rows." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scrolling": { - "DocID": "dxDataGrid.Options.scrolling", + "Description": "Configures scrolling.", "Options": { "columnRenderingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.scrolling.columnRenderingMode" + "Description": "Specifies the rendering mode for columns. Applies when columns are left outside the viewport. Requires the columnWidth, columnAutoWidth, or width (for all columns) option specified." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.scrolling.mode" + "Description": "Specifies the scrolling mode." }, "preloadEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.scrolling.preloadEnabled" + "Description": "Specifies whether the widget should load adjacent pages. Applies only if scrolling.mode is \"virtual\" or \"infinite\"." }, "rowRenderingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.scrolling.rowRenderingMode" + "Description": "Specifies the rendering mode for loaded rows." }, "scrollByContent": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.scrolling.scrollByContent" + "Description": "Specifies whether a user can scroll the content with a swipe gesture. Applies only if useNative is false." }, "scrollByThumb": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.scrolling.scrollByThumb" + "Description": "Specifies whether a user can scroll the content with the scrollbar. Applies only if useNative is false." }, "showScrollbar": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.scrolling.showScrollbar" + "Description": "Specifies when to show scrollbars. Applies only if useNative is false." }, "useNative": { "PrimitiveTypes": [ "boolean", "string" ], - "DocID": "GridBase.Options.scrolling.useNative" + "Description": "Specifies whether the widget should use native or simulated scrolling." } } }, "searchPanel": { - "DocID": "GridBase.Options.searchPanel", + "Description": "Configures the search panel.", "Options": { "highlightCaseSensitive": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.searchPanel.highlightCaseSensitive" + "Description": "Notifies the widget whether search is case-sensitive to ensure that search results are highlighted correctly. Applies only if highlightSearchText is true." }, "highlightSearchText": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.searchPanel.highlightSearchText" + "Description": "Specifies whether found substrings should be highlighted." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.searchPanel.placeholder" + "Description": "Specifies a placeholder for the search panel." }, "searchVisibleColumnsOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.searchPanel.searchVisibleColumnsOnly" + "Description": "Specifies whether the widget should search against all columns or only visible ones." }, "text": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "GridBase.Options.searchPanel.text" + "Description": "Sets a search string for the search panel." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.searchPanel.visible" + "Description": "Specifies whether the search panel is visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.searchPanel.width" + "Description": "Specifies the width of the search panel in pixels." } } }, @@ -11860,40 +11336,40 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "selectedRowKey", - "DocID": "GridBase.Options.selectedRowKeys" + "Description": "Allows you to select rows or determine which rows are selected." }, "selection": { - "DocID": "dxDataGrid.Options.selection", + "Description": "Configures runtime selection.", "Options": { "allowSelectAll": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.selection.allowSelectAll" + "Description": "Specifies whether a user can select all rows at once." }, "deferred": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.selection.deferred" + "Description": "Makes selection deferred." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.selection.mode" + "Description": "Specifies the selection mode." }, "selectAllMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.selection.selectAllMode" + "Description": "Specifies the mode in which all the records are selected. Applies only if selection.allowSelectAll is true." }, "showCheckBoxesMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.selection.showCheckBoxesMode" + "Description": "Specifies when to display check boxes in rows. Applies only if selection.mode is \"multiple\"." } } }, @@ -11903,31 +11379,31 @@ ], "IsFilterExpr": true, "IsChangeable": true, - "DocID": "dxDataGrid.Options.selectionFilter" + "Description": "Specifies filters for the rows that must be selected initially. Applies only if selection.deferred is true." }, "showBorders": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.showBorders" + "Description": "Specifies whether the outer borders of the widget are visible." }, "showColumnHeaders": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.showColumnHeaders" + "Description": "Specifies whether column headers are visible." }, "showColumnLines": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.showColumnLines" + "Description": "Specifies whether vertical lines that separate one column from another are visible." }, "showRowLines": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.showRowLines" + "Description": "Specifies whether horizontal lines that separate one row from another are visible." }, "sortByGroupSummaryInfo": { "ItemPrimitiveTypes": [ @@ -11935,116 +11411,116 @@ ], "IsCollection": true, "SingularName": "sortByGroupSummaryInfo", - "DocID": "dxDataGrid.Options.sortByGroupSummaryInfo", + "Description": "Allows you to sort groups according to the values of group summary items.", "Options": { "groupColumn": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.sortByGroupSummaryInfo.groupColumn" + "Description": "Specifies the identifier of the column that must be used in grouping so that sorting by group summary item values be applied." }, "sortOrder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.sortByGroupSummaryInfo.sortOrder" + "Description": "Specifies the sort order of group summary item values." }, "summaryItem": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxDataGrid.Options.sortByGroupSummaryInfo.summaryItem" + "Description": "Specifies the group summary item whose values must be used to sort groups." } } }, "sorting": { - "DocID": "GridBase.Options.sorting", + "Description": "Configures runtime sorting.", "Options": { "ascendingText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.sorting.ascendingText" + "Description": "Specifies text for the context menu item that sets an ascending sort order in a column." }, "clearText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.sorting.clearText" + "Description": "Specifies text for the context menu item that clears sorting settings for a column." }, "descendingText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.sorting.descendingText" + "Description": "Specifies text for the context menu item that sets a descending sort order in a column." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.sorting.mode" + "Description": "Specifies the sorting mode." }, "showSortIndexes": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.sorting.showSortIndexes" + "Description": "Specifies whether to display sort indexes in column headers. Applies only when sorting.mode is \"multiple\" and data is sorted by two or more columns." } } }, "stateStoring": { - "DocID": "GridBase.Options.stateStoring", + "Description": "Configures state storing.", "Options": { "customLoad": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBase.Options.stateStoring.customLoad" + "Description": "Specifies a function that is executed on state loading. Applies only if the type is 'custom'." }, "customSave": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBase.Options.stateStoring.customSave" + "Description": "Specifies a function that is executed on state saving. Applies only if the type is \"custom\"." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.stateStoring.enabled" + "Description": "Enables state storing." }, "savingTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.stateStoring.savingTimeout" + "Description": "Specifies the delay in milliseconds between when a user makes a change and when this change is saved." }, "storageKey": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.stateStoring.storageKey" + "Description": "Specifies the key for storing the widget state." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.stateStoring.type" + "Description": "Specifies the type of storage where the state is saved." } } }, "summary": { - "DocID": "dxDataGrid.Options.summary", + "Description": "Specifies the options of the grid summary.", "Options": { "calculateCustomSummary": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxDataGrid.Options.summary.calculateCustomSummary" + "Description": "Specifies a custom aggregate function. This function is called for summary items whose summaryType is \"custom\"." }, "groupItems": { "ItemPrimitiveTypes": [ @@ -12052,62 +11528,62 @@ ], "IsCollection": true, "SingularName": "groupItem", - "DocID": "dxDataGrid.Options.summary.groupItems", + "Description": "Specifies items of the group summary.", "Options": { "alignByColumn": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.summary.groupItems.alignByColumn" + "Description": "Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row." }, "column": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.groupItems.column" + "Description": "Specifies the column that provides data for a group summary item." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxDataGrid.Options.summary.groupItems.customizeText" + "Description": "Customizes the text to be displayed in the summary item." }, "displayFormat": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.groupItems.displayFormat" + "Description": "Specifies the summary item's text." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.groupItems.name" + "Description": "Specifies the group summary item's identifier." }, "showInColumn": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.groupItems.showInColumn" + "Description": "Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row." }, "showInGroupFooter": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.summary.groupItems.showInGroupFooter" + "Description": "Specifies whether or not a summary item must be displayed in the group footer." }, "skipEmptyValues": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.summary.groupItems.skipEmptyValues" + "Description": "Specifies whether or not to skip empty strings, null and undefined values when calculating a summary." }, "summaryType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.groupItems.summaryType" + "Description": "Specifies how to aggregate data for the group summary item." }, "valueFormat": { "PrimitiveTypes": [ @@ -12117,14 +11593,7 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxDataGrid.Options.summary.groupItems.valueFormat" + "Description": "Specifies a summary item value's display format." } } }, @@ -12132,70 +11601,70 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.summary.recalculateWhileEditing" + "Description": "Specifies whether to recalculate summaries while a user edits data." }, "skipEmptyValues": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.summary.skipEmptyValues" + "Description": "Specifies whether or not to skip empty strings, null and undefined values when calculating a summary." }, "texts": { - "DocID": "dxDataGrid.Options.summary.texts", + "Description": "Contains options that specify text patterns for summary items.", "Options": { "avg": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.texts.avg" + "Description": "Specifies a pattern for the \"avg\" summary items when they are displayed in the parent column." }, "avgOtherColumn": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.texts.avgOtherColumn" + "Description": "Specifies a pattern for the \"avg\" summary items displayed in a group row or in any other column rather than the parent one." }, "count": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.texts.count" + "Description": "Specifies a pattern for the \"count\" summary items." }, "max": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.texts.max" + "Description": "Specifies a pattern for the \"max\" summary items when they are displayed in the parent column." }, "maxOtherColumn": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.texts.maxOtherColumn" + "Description": "Specifies a pattern for the \"max\" summary items displayed in a group row or in any other column rather than the parent one." }, "min": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.texts.min" + "Description": "Specifies a pattern for the \"min\" summary items when they are displayed in the parent column." }, "minOtherColumn": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.texts.minOtherColumn" + "Description": "Specifies a pattern for the \"min\" summary items displayed in a group row or in any other column rather than the parent one." }, "sum": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.texts.sum" + "Description": "Specifies a pattern for the \"sum\" summary items when they are displayed in the parent column." }, "sumOtherColumn": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.texts.sumOtherColumn" + "Description": "Specifies a pattern for the \"sum\" summary items displayed in a group row or in any other column rather than the parent one." } } }, @@ -12205,62 +11674,62 @@ ], "IsCollection": true, "SingularName": "totalItem", - "DocID": "dxDataGrid.Options.summary.totalItems", + "Description": "Specifies items of the total summary.", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.totalItems.alignment" + "Description": "Specifies the alignment of a summary item." }, "column": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.totalItems.column" + "Description": "Specifies the column that provides data for a summary item." }, "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.totalItems.cssClass" + "Description": "Specifies a CSS class to be applied to a summary item." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxDataGrid.Options.summary.totalItems.customizeText" + "Description": "Customizes the text to be displayed in the summary item." }, "displayFormat": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.totalItems.displayFormat" + "Description": "Specifies the summary item's text." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.totalItems.name" + "Description": "Specifies the total summary item's identifier." }, "showInColumn": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.totalItems.showInColumn" + "Description": "Specifies the column that must hold the summary item." }, "skipEmptyValues": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGrid.Options.summary.totalItems.skipEmptyValues" + "Description": "Specifies whether or not to skip empty strings, null and undefined values when calculating a summary." }, "summaryType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGrid.Options.summary.totalItems.summaryType" + "Description": "Specifies how to aggregate data for the total summary item." }, "valueFormat": { "PrimitiveTypes": [ @@ -12270,14 +11739,7 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxDataGrid.Options.summary.totalItems.valueFormat" + "Description": "Specifies a summary item value's display format." } } } @@ -12287,19 +11749,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "twoWayBindingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.twoWayBindingEnabled" + "Description": "Specifies whether to enable two-way data binding." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -12308,18 +11770,18 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." }, "wordWrapEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.wordWrapEnabled" + "Description": "Specifies whether text that does not fit into a column should be wrapped." } } }, "dxDateBox": { - "DocID": "dxDateBox", + "Description": "The DateBox is a widget that displays date and time in a specified format, and enables a user to pick or type in the required date/time value.", "Module": "ui/date_box", "IsEditor": true, "Options": { @@ -12327,37 +11789,37 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.acceptCustomValue" + "Description": "Specifies whether or not the widget allows an end-user to enter a custom value." }, "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "adaptivityEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDateBox.Options.adaptivityEnabled" + "Description": "Specifies whether or not adaptive widget rendering is enabled on a small screen." }, "applyButtonText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDateBox.Options.applyButtonText" + "Description": "The text displayed on the Apply button." }, "applyValueMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownEditor.Options.applyValueMode" + "Description": "Specifies the way an end-user applies the selected value." }, "buttons": { "ItemPrimitiveTypes": [ @@ -12367,61 +11829,48 @@ "ItemComplexTypes": [ "TextEditorButton" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "button", - "DocID": "dxDropDownEditor.Options.buttons" + "Description": "Allows you to add custom buttons to the input text field." }, "calendarOptions": { "PrimitiveTypes": [ - "dxCalendarOptions" + "DevExpress.ui.dxCalendarOptions" ], "ComplexTypes": [ "dxCalendarOptions" ], - "TypeImports": [ - { - "Name": "dxCalendarOptions", - "Path": "ui/calendar" - } - ], - "DocID": "dxDateBox.Options.calendarOptions" + "Description": "Configures the calendar's value picker. Applies only if the pickerType is \"calendar\"." }, "cancelButtonText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDateBox.Options.cancelButtonText" + "Description": "The text displayed on the Cancel button." }, "dateOutOfRangeMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDateBox.Options.dateOutOfRangeMessage" + "Description": "Specifies the message displayed if the specified date is later than the max value or earlier than the min value." }, "dateSerializationFormat": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDateBox.Options.dateSerializationFormat" + "Description": "Specifies the date-time value serialization format. Use it only if you do not specify the value at design time." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.deferRendering" + "Description": "Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "disabledDates": { "PrimitiveTypes": [ @@ -12433,42 +11882,36 @@ "IsCollection": true, "IsFunc": true, "SingularName": "disabledDate", - "DocID": "dxDateBox.Options.disabledDates" + "Description": "Specifies dates that users cannot select. Applies only if pickerType is \"calendar\"." }, "displayFormat": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxDateBox.Options.displayFormat" + "Description": "Specifies the date display format. Ignored if the pickerType option is \"native\"" }, "dropDownButtonTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDropDownEditor.Options.dropDownButtonTemplate" + "Description": "Specifies a custom template for the drop-down button." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -12477,43 +11920,43 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "inputAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTextEditor.Options.inputAttr" + "Description": "Specifies the attributes to be passed on to the underlying HTML element." }, "interval": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDateBox.Options.interval" + "Description": "Specifies the interval between neighboring values in the popup list in minutes." }, "invalidDateMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDateBox.Options.invalidDateMessage" + "Description": "Specifies the message displayed if the typed value is not a valid date or time." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "max": { "PrimitiveTypes": [ @@ -12521,21 +11964,21 @@ "number", "string" ], - "DocID": "dxDateBox.Options.max" + "Description": "The last date that can be selected within the widget." }, "maxLength": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxTextBox.Options.maxLength" + "Description": "Specifies the maximum number of characters you can enter into the textbox." }, "maxZoomLevel": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "dxDateBox.Options.maxZoomLevel" + "Description": "Use the calendarOptions option instead." }, "min": { "PrimitiveTypes": [ @@ -12543,20 +11986,20 @@ "number", "string" ], - "DocID": "dxDateBox.Options.min" + "Description": "The minimum date that can be selected within the widget." }, "minZoomLevel": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "dxDateBox.Options.minZoomLevel" + "Description": "Use the calendarOptions option instead." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "onChange": { "PrimitiveTypes": [ @@ -12564,7 +12007,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onChange" + "Description": "A function that is executed when the widget loses focus after the text field's content was changed using the keyboard." }, "onClosed": { "PrimitiveTypes": [ @@ -12572,7 +12015,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onClosed" + "Description": "A function that is executed once the drop-down editor is closed." }, "onContentReady": { "PrimitiveTypes": [ @@ -12580,7 +12023,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onCopy": { "PrimitiveTypes": [ @@ -12588,7 +12031,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCopy" + "Description": "A function that is executed when the widget's input has been copied." }, "onCut": { "PrimitiveTypes": [ @@ -12596,7 +12039,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCut" + "Description": "A function that is executed when the widget's input has been cut." }, "onDisposing": { "PrimitiveTypes": [ @@ -12604,7 +12047,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEnterKey": { "PrimitiveTypes": [ @@ -12612,7 +12055,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onEnterKey" + "Description": "A function that is executed when the Enter key has been pressed while the widget is focused." }, "onFocusIn": { "PrimitiveTypes": [ @@ -12620,7 +12063,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusIn" + "Description": "A function that is executed when the widget gets focus." }, "onFocusOut": { "PrimitiveTypes": [ @@ -12628,7 +12071,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusOut" + "Description": "A function that is executed when the widget loses focus." }, "onInitialized": { "PrimitiveTypes": [ @@ -12636,7 +12079,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onInput": { "PrimitiveTypes": [ @@ -12644,7 +12087,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onInput" + "Description": "A function that is executed each time the widget's input is changed while the widget is focused." }, "onKeyDown": { "PrimitiveTypes": [ @@ -12652,7 +12095,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyDown" + "Description": "A function that is executed when a user is pressing a key on the keyboard." }, "onKeyPress": { "PrimitiveTypes": [ @@ -12660,7 +12103,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyPress" + "Description": "A function that is executed when a user presses a key on the keyboard." }, "onKeyUp": { "PrimitiveTypes": [ @@ -12668,7 +12111,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyUp" + "Description": "A function that is executed when a user releases a key on the keyboard." }, "onOpened": { "PrimitiveTypes": [ @@ -12676,7 +12119,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onOpened" + "Description": "A function that is executed once the drop-down editor is opened." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -12684,7 +12127,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPaste": { "PrimitiveTypes": [ @@ -12692,7 +12135,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onPaste" + "Description": "A function that is executed when the widget's input has been pasted." }, "onValueChanged": { "PrimitiveTypes": [ @@ -12700,105 +12143,105 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "opened": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxDropDownEditor.Options.opened" + "Description": "Specifies whether or not the drop-down editor is displayed." }, "openOnFieldClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.openOnFieldClick" + "Description": "Specifies whether a user can open the drop-down list by clicking a text field." }, "pickerType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDateBox.Options.pickerType" + "Description": "Specifies the type of the date/time picker." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDateBox.Options.placeholder" + "Description": "Specifies a placeholder for the input field." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showAnalogClock": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDateBox.Options.showAnalogClock" + "Description": "Specifies whether to show the analog clock in the value picker. Applies only if type is \"datetime\" and pickerType is \"calendar\"." }, "showClearButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.showClearButton" + "Description": "Specifies whether to display the Clear button in the widget." }, "showDropDownButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.showDropDownButton" + "Description": "Specifies whether the drop-down button is visible." }, "spellcheck": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.spellcheck" + "Description": "Specifies whether or not the widget checks the inner text for spelling mistakes." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.stylingMode" + "Description": "Specifies how the widget's text field is styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "text": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxTextEditor.Options.text" + "Description": "The read-only option that holds the text displayed by the widget input element." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDateBox.Options.type" + "Description": "A format used to display date/time information." }, "useMaskBehavior": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDateBox.Options.useMaskBehavior" + "Description": "Specifies whether to control user input using a mask created based on the displayFormat." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -12806,19 +12249,19 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ @@ -12827,19 +12270,19 @@ "string" ], "IsChangeable": true, - "DocID": "dxDateBox.Options.value" + "Description": "An object or a value specifying the date and time currently selected using the date box." }, "valueChangeEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.valueChangeEvent" + "Description": "Specifies the DOM events after which the widget's value should be updated." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -12848,58 +12291,52 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxDeferRendering": { - "DocID": "dxDeferRendering", + "Description": "The DeferRendering is a widget that waits for its content to be ready before rendering it. While the content is getting ready, the DeferRendering displays a loading indicator.", "Module": "ui/defer_rendering", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "animation": { "PrimitiveTypes": [ - "animationConfig" + "DevExpress.animationConfig" ], "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "animationConfig", - "Path": "animation/fx" - } - ], - "DocID": "dxDeferRendering.Options.animation" + "Description": "Specifies the animation to be used to show the rendered content." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -12908,19 +12345,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "onContentReady": { "PrimitiveTypes": [ @@ -12928,7 +12365,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -12936,7 +12373,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -12944,7 +12381,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -12952,7 +12389,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onRendered": { "PrimitiveTypes": [ @@ -12960,7 +12397,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDeferRendering.Options.onRendered" + "Description": "A function that is executed when the content is rendered but not yet displayed." }, "onShown": { "PrimitiveTypes": [ @@ -12968,7 +12405,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDeferRendering.Options.onShown" + "Description": "A function that is executed when the content is displayed and animation is completed." }, "renderWhen": { "PrimitiveTypes": [ @@ -12978,37 +12415,37 @@ "void" ], "IsPromise": true, - "DocID": "dxDeferRendering.Options.renderWhen" + "Description": "Specifies when the widget content is rendered." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showLoadIndicator": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDeferRendering.Options.showLoadIndicator" + "Description": "Indicates if a load indicator should be shown until the widget's content is rendered." }, "staggerItemSelector": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDeferRendering.Options.staggerItemSelector" + "Description": "Specifies a jQuery selector of items that should be rendered using a staggered animation." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -13017,34 +12454,34 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxDiagram": { - "DocID": "dxDiagram", + "Description": "[tags] ctp The Diagram widget provides a visual interface to help you design new and modify existing diagrams. #include common-ctp-note with { component: \"Diagram\" }", "Module": "ui/diagram", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "autoZoom": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.autoZoom" + "Description": "Specifies whether the Diagram widget automatically zooms the work area." }, "contextMenu": { - "DocID": "dxDiagram.Options.contextMenu", + "Description": "Configures the context menu's settings.", "Options": { "commands": { "ItemPrimitiveTypes": [ @@ -13052,13 +12489,13 @@ ], "IsCollection": true, "SingularName": "command", - "DocID": "dxDiagram.Options.contextMenu.commands" + "Description": "Lists commands in the context menu." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.contextMenu.enabled" + "Description": "Specifies whether the context menu is enabled." } } }, @@ -13068,61 +12505,61 @@ ], "IsCollection": true, "SingularName": "customShape", - "DocID": "dxDiagram.Options.customShapes", + "Description": "Provide access to an array of custom shapes.", "Options": { "allowEditImage": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.customShapes.allowEditImage" + "Description": "Specifies whether the shape's image can be edited." }, "allowEditText": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.customShapes.allowEditText" + "Description": "Specifies whether the shape's text can be edited." }, "backgroundImageHeight": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.backgroundImageHeight" + "Description": "Specifies the shape background image's fractional height." }, "backgroundImageLeft": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.backgroundImageLeft" + "Description": "Specifies the shape background image's left offset." }, "backgroundImageTop": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.backgroundImageTop" + "Description": "Specifies the shape background image's top offset." }, "backgroundImageUrl": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.customShapes.backgroundImageUrl" + "Description": "Specifies the shape background image's URL." }, "backgroundImageWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.backgroundImageWidth" + "Description": "Specifies the shape background image's fractional width." }, "baseType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.customShapes.baseType" + "Description": "Specifies the base shape type for the custom shape." }, "category": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.customShapes.category" + "Description": "Specifies a category to which the custom shape belongs." }, "connectionPoints": { "ItemPrimitiveTypes": [ @@ -13130,19 +12567,19 @@ ], "IsCollection": true, "SingularName": "connectionPoint", - "DocID": "dxDiagram.Options.customShapes.connectionPoints", + "Description": "An array of the shape's connection points.", "Options": { "x": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.connectionPoints.x" + "Description": "Specifies the horizontal offset." }, "y": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.connectionPoints.y" + "Description": "Specifies the vertical offset." } } }, @@ -13150,85 +12587,85 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.defaultHeight" + "Description": "Specifies the initial height of the shape." }, "defaultImageUrl": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.customShapes.defaultImageUrl" + "Description": "Specifies the shape image's URL." }, "defaultText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.customShapes.defaultText" + "Description": "Specifies the initial text of the shape." }, "defaultWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.defaultWidth" + "Description": "Specifies the initial width of the shape." }, "imageHeight": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.imageHeight" + "Description": "Specifies the shape image's fractional height." }, "imageLeft": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.imageLeft" + "Description": "Specifies the shape image's left offset." }, "imageTop": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.imageTop" + "Description": "Specifies the shape image's top offset." }, "imageWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.imageWidth" + "Description": "Specifies the shape image's fractional width." }, "textHeight": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.textHeight" + "Description": "Specifies the shape text container's height." }, "textLeft": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.textLeft" + "Description": "Specifies the shape text's left offset." }, "textTop": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.textTop" + "Description": "Specifies the shape text's top offset." }, "textWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.customShapes.textWidth" + "Description": "Specifies the shape text container's width." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.customShapes.title" + "Description": "Specifies the shape's tooltip in the toolbox panel." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.customShapes.type" + "Description": "Specifies the shape's type." } } }, @@ -13236,10 +12673,10 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "edges": { - "DocID": "dxDiagram.Options.edges", + "Description": "Allows you to bind the collection of diagram edges to a data source.", "Options": { "dataSource": { "PrimitiveTypes": [ @@ -13249,15 +12686,8 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxDiagram.Options.edges.dataSource" + "Description": "Binds the edges collection to the specified data." }, "fromExpr": { "PrimitiveTypes": [ @@ -13265,7 +12695,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.fromExpr" + "Description": "Specifies the name of a data source field or an expression that provides an edge's start node key." }, "fromLineEndExpr": { "PrimitiveTypes": [ @@ -13273,7 +12703,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.fromLineEndExpr" + "Description": "Specifies the name of a data source field or an expression that provides an edge's line start tip." }, "fromPointIndexExpr": { "PrimitiveTypes": [ @@ -13281,7 +12711,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.fromPointIndexExpr" + "Description": "Specifies the name of a data source field or an expression that provides an index of a shape connection point where an edge starts." }, "keyExpr": { "PrimitiveTypes": [ @@ -13289,7 +12719,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.keyExpr" + "Description": "Specifies the name of a data source field or an expression that provides edge keys." }, "lineTypeExpr": { "PrimitiveTypes": [ @@ -13297,7 +12727,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.lineTypeExpr" + "Description": "Specifies the name of a data source field or an expression that provides an edge's line type." }, "lockedExpr": { "PrimitiveTypes": [ @@ -13305,7 +12735,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.lockedExpr" + "Description": "Specifies the name of a data source field or an expression whose values indicate whether an edge is locked." }, "pointsExpr": { "PrimitiveTypes": [ @@ -13313,7 +12743,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.pointsExpr" + "Description": "Specifies the name of a data source field or an expression that provides an edge's key points." }, "styleExpr": { "PrimitiveTypes": [ @@ -13321,7 +12751,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.styleExpr" + "Description": "Specifies the name of a data source field or an expression that provides an edge style." }, "textExpr": { "PrimitiveTypes": [ @@ -13329,7 +12759,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.textExpr" + "Description": "Specifies the name of a data source field or an expression that provides edge texts." }, "textStyleExpr": { "PrimitiveTypes": [ @@ -13337,7 +12767,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.textStyleExpr" + "Description": "Specifies the name of a data source field or an expression that provides an edge's text style." }, "toExpr": { "PrimitiveTypes": [ @@ -13345,7 +12775,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.toExpr" + "Description": "Specifies the name of a data source field or an expression that provides an edge's end node key." }, "toLineEndExpr": { "PrimitiveTypes": [ @@ -13353,7 +12783,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.toLineEndExpr" + "Description": "Specifies the name of a data source field or an expression that provides an edge's line end tip." }, "toPointIndexExpr": { "PrimitiveTypes": [ @@ -13361,7 +12791,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.toPointIndexExpr" + "Description": "Specifies the name of a data source field or an expression that provides an index of a shape connection point where an edge ends." }, "zIndexExpr": { "PrimitiveTypes": [ @@ -13369,7 +12799,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.edges.zIndexExpr" + "Description": "Specifies the name of a data source field or an expression that provides an edge's z-index." } } }, @@ -13377,23 +12807,23 @@ "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "export": { - "DocID": "dxDiagram.Options.export", + "Description": "Configures export settings.", "Options": { "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.export.fileName" + "Description": "Specifies the name of the file to which the diagram is exported." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "dxDiagram.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." } } }, @@ -13401,19 +12831,19 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "fullScreen": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.fullScreen" + "Description": "Specifies whether or not to display the widget in full-screen mode." }, "gridSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.gridSize", + "Description": "Specifies the grid pitch.", "Options": { "items": { "ItemPrimitiveTypes": [ @@ -13421,13 +12851,13 @@ ], "IsCollection": true, "SingularName": "item", - "DocID": "dxDiagram.Options.gridSize.items" + "Description": "An array that specifies the _Grid Size_ combobox items on 'Properties' panel." }, "value": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.gridSize.value" + "Description": "Specifies the grid's pitch." } } }, @@ -13438,40 +12868,40 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "nodes": { - "DocID": "dxDiagram.Options.nodes", + "Description": "Allows you to bind the collection of diagram nodes to a data source.", "Options": { "autoLayout": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.nodes.autoLayout", + "Description": "Specifies an auto-layout algorithm that the widget uses to build a diagram.", "Options": { "orientation": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.nodes.autoLayout.orientation" + "Description": "Specifies the diagram layout orientation." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.nodes.autoLayout.type" + "Description": "Specifies the diagram layout type." } } }, @@ -13481,7 +12911,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.childrenExpr" + "Description": "Specifies the name of a data source field or an expression that provides a container's nested items." }, "containerKeyExpr": { "PrimitiveTypes": [ @@ -13489,7 +12919,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.containerKeyExpr" + "Description": "Specifies the name of a data source field or an expression that provides a key of a node's parent container node." }, "dataSource": { "PrimitiveTypes": [ @@ -13499,15 +12929,8 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxDiagram.Options.nodes.dataSource" + "Description": "Binds the nodes collection to the specified data." }, "heightExpr": { "PrimitiveTypes": [ @@ -13515,7 +12938,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.heightExpr" + "Description": "Specifies the name of a data source field or an expression that provides a node's height." }, "imageUrlExpr": { "PrimitiveTypes": [ @@ -13523,7 +12946,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.imageUrlExpr" + "Description": "Specifies the name of a data source field or an expression that provides a node image's URL." }, "itemsExpr": { "PrimitiveTypes": [ @@ -13531,7 +12954,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.itemsExpr" + "Description": "Specifies the name of a data source field or an expression that provides a node's nested items." }, "keyExpr": { "PrimitiveTypes": [ @@ -13539,7 +12962,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.keyExpr" + "Description": "Specifies the name of a data source field or an expression that provides node keys." }, "leftExpr": { "PrimitiveTypes": [ @@ -13547,7 +12970,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.leftExpr" + "Description": "Specifies the name of a data source field or an expression that provides the x-coordinate of a node's left border." }, "lockedExpr": { "PrimitiveTypes": [ @@ -13555,7 +12978,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.lockedExpr" + "Description": "Specifies the name of a data source field or an expression whose values indicate whether a node is locked." }, "parentKeyExpr": { "PrimitiveTypes": [ @@ -13563,7 +12986,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.parentKeyExpr" + "Description": "Specifies the name of a data source field or an expression that provides a parent node key for a node." }, "styleExpr": { "PrimitiveTypes": [ @@ -13571,7 +12994,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.styleExpr" + "Description": "Specifies the name of a data source field or an expression that provides a node style." }, "textExpr": { "PrimitiveTypes": [ @@ -13579,7 +13002,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.textExpr" + "Description": "Specifies the name of a data source field or an expression that provides node texts." }, "textStyleExpr": { "PrimitiveTypes": [ @@ -13587,7 +13010,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.textStyleExpr" + "Description": "Specifies the name of a data source field or an expression that provides a node's text style." }, "topExpr": { "PrimitiveTypes": [ @@ -13595,7 +13018,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.topExpr" + "Description": "Specifies the name of a data source field or an expression that provides the y-coordinate of a node's top border." }, "typeExpr": { "PrimitiveTypes": [ @@ -13603,7 +13026,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.typeExpr" + "Description": "Specifies the name of a data source field or an expression that provides the shape type for a node." }, "widthExpr": { "PrimitiveTypes": [ @@ -13611,7 +13034,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.widthExpr" + "Description": "Specifies the name of a data source field or an expression that provides a node's width." }, "zIndexExpr": { "PrimitiveTypes": [ @@ -13619,7 +13042,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDiagram.Options.nodes.zIndexExpr" + "Description": "Specifies the name of a data source field or an expression that provides a node's z-index." } } }, @@ -13629,7 +13052,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDataChanged": { "PrimitiveTypes": [ @@ -13637,7 +13060,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDiagram.Options.onDataChanged" + "Description": "A function that is executed when the diagram's data changes." }, "onDisposing": { "PrimitiveTypes": [ @@ -13645,7 +13068,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -13653,7 +13076,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -13661,7 +13084,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDiagram.Options.onItemClick" + "Description": "A function that is executed after a shape or connector is clicked." }, "onItemDblClick": { "PrimitiveTypes": [ @@ -13669,7 +13092,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDiagram.Options.onItemDblClick" + "Description": "A function that is executed after a shape or connector is double-clicked." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -13677,7 +13100,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -13685,28 +13108,28 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDiagram.Options.onSelectionChanged" + "Description": "A function that is executed after the selection is changed in the Diagram." }, "pageColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.pageColor" + "Description": "Specifies the color of a diagram page." }, "pageOrientation": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.pageOrientation" + "Description": "Specifies the page orientation." }, "pageSize": { - "DocID": "dxDiagram.Options.pageSize", + "Description": "Specifies a size of pages.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.pageSize.height" + "Description": "Specifies the page height." }, "items": { "ItemPrimitiveTypes": [ @@ -13714,25 +13137,25 @@ ], "IsCollection": true, "SingularName": "item", - "DocID": "dxDiagram.Options.pageSize.items", + "Description": "An array that specifies the page size items in the _Paze Size_ combobox on 'Properties' panel.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.pageSize.items.height" + "Description": "Specifies the page height." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.pageSize.items.text" + "Description": "Specifies the display text." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.pageSize.items.width" + "Description": "Specifies the page width." } } }, @@ -13740,24 +13163,24 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.pageSize.width" + "Description": "Specifies the page width." } } }, "propertiesPanel": { - "DocID": "dxDiagram.Options.propertiesPanel", + "Description": "Provides access to Properties panel settings.", "Options": { "collapsible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.propertiesPanel.collapsible" + "Description": "Specifies whether the Properties panel can be collapsed." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.propertiesPanel.enabled" + "Description": "Specifies whether the Properties panel is available." }, "groups": { "ItemPrimitiveTypes": [ @@ -13765,7 +13188,7 @@ ], "IsCollection": true, "SingularName": "group", - "DocID": "dxDiagram.Options.propertiesPanel.groups", + "Description": "Contains an array of command groups in the Properties panel.", "Options": { "commands": { "ItemPrimitiveTypes": [ @@ -13773,7 +13196,7 @@ ], "IsCollection": true, "SingularName": "command", - "DocID": "dxDiagram.Options.propertiesPanel.groups.commands" + "Description": "Lists commands in a group." } } } @@ -13783,40 +13206,40 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.readOnly" + "Description": "Specifies whether the diagram is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showGrid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.showGrid" + "Description": "Specifies whether grid lines are visible." }, "simpleView": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.simpleView" + "Description": "Switch the Diagram widget to simple view mode." }, "snapToGrid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.snapToGrid" + "Description": "Specifies whether diagram elements should snap to grid lines." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "toolbar": { - "DocID": "dxDiagram.Options.toolbar", + "Description": "Provides access to toolbar settings.", "Options": { "commands": { "ItemPrimitiveTypes": [ @@ -13824,18 +13247,18 @@ ], "IsCollection": true, "SingularName": "command", - "DocID": "dxDiagram.Options.toolbar.commands" + "Description": "Lists commands in the toolbar." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.toolbar.visible" + "Description": "Specifies the toolbar's visibility." } } }, "toolbox": { - "DocID": "dxDiagram.Options.toolbox", + "Description": "Provides access to toolbox settings.", "Options": { "groups": { "ItemPrimitiveTypes": [ @@ -13844,25 +13267,25 @@ ], "IsCollection": true, "SingularName": "group", - "DocID": "dxDiagram.Options.toolbox.groups", + "Description": "Lists toolbox groups.", "Options": { "category": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.toolbox.groups.category" + "Description": "Specifies the category of shapes that are displayed in the group." }, "displayMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.toolbox.groups.displayMode" + "Description": "Specifies how shapes are displayed in the toolbox." }, "expanded": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.toolbox.groups.expanded" + "Description": "Specifies whether the group is expanded." }, "shapes": { "ItemPrimitiveTypes": [ @@ -13870,13 +13293,13 @@ ], "IsCollection": true, "SingularName": "shape", - "DocID": "dxDiagram.Options.toolbox.groups.shapes" + "Description": "Lists the shapes in the group." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.toolbox.groups.title" + "Description": "Specifies the group title in the toolbox." } } }, @@ -13884,7 +13307,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDiagram.Options.toolbox.visible" + "Description": "Specifies the toolbox's visibility." } } }, @@ -13892,19 +13315,19 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.units" + "Description": "Specifies the unit for measurement options (for example, defaultHeight, gridSize, leftExpr)." }, "viewUnits": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDiagram.Options.viewUnits" + "Description": "Specifies the measurement unit that is displayed in user interface elements." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -13913,13 +13336,13 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." }, "zoomLevel": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.zoomLevel", + "Description": "Specifies the zoom level.", "Options": { "items": { "ItemPrimitiveTypes": [ @@ -13927,20 +13350,20 @@ ], "IsCollection": true, "SingularName": "item", - "DocID": "dxDiagram.Options.zoomLevel.items" + "Description": "An array that specifies the zoom level items in the _Zoom Level_ combobox on 'Properties' panel." }, "value": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDiagram.Options.zoomLevel.value" + "Description": "Specifies the zoom level." } } } } }, "dxDraggable": { - "DocID": "dxDraggable", + "Description": "Draggable is a user interface utility that allows widget elements to be dragged and dropped.", "IsTranscludedContent": true, "Module": "ui/draggable", "Options": { @@ -13948,7 +13371,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "DraggableBase.Options.autoScroll" + "Description": "Enables automatic scrolling while dragging an item beyond the viewport." }, "boundary": { "PrimitiveTypes": [ @@ -13956,13 +13379,13 @@ "JQuery", "string" ], - "DocID": "DraggableBase.Options.boundary" + "Description": "Specifies a DOM element that limits the dragging area." }, "clone": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDraggable.Options.clone" + "Description": "Allows a user to drag clones of items instead of actual items." }, "container": { "PrimitiveTypes": [ @@ -13970,25 +13393,25 @@ "JQuery", "string" ], - "DocID": "DraggableBase.Options.container" + "Description": "Specifies a custom container in which the draggable item should be rendered." }, "cursorOffset": { "PrimitiveTypes": [ "string" ], - "DocID": "DraggableBase.Options.cursorOffset", + "Description": "Specifies the cursor offset from the dragged item.", "Options": { "x": { "PrimitiveTypes": [ "number" ], - "DocID": "DraggableBase.Options.cursorOffset.x" + "Description": "Specifies the horizontal cursor offset from the dragged item in pixels." }, "y": { "PrimitiveTypes": [ "number" ], - "DocID": "DraggableBase.Options.cursorOffset.y" + "Description": "Specifies the vertical cursor offset from the dragged item in pixels." } } }, @@ -13996,38 +13419,38 @@ "PrimitiveTypes": [ "any" ], - "DocID": "DraggableBase.Options.data" + "Description": "A container for custom data." }, "dragDirection": { "PrimitiveTypes": [ "string" ], - "DocID": "DraggableBase.Options.dragDirection" + "Description": "Specifies the directions in which an item can be dragged." }, "dragTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDraggable.Options.dragTemplate" + "Description": "Specifies custom markup to be shown instead of the item being dragged." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "group": { "PrimitiveTypes": [ "string" ], - "DocID": "DraggableBase.Options.group" + "Description": "Allows you to group several widgets, so that users can drag and drop items between them." }, "handle": { "PrimitiveTypes": [ "string" ], - "DocID": "DraggableBase.Options.handle" + "Description": "Specifies a CSS selector (ID or class) that should act as the drag handle(s) for the item(s)." }, "height": { "PrimitiveTypes": [ @@ -14036,7 +13459,7 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "onDisposing": { "PrimitiveTypes": [ @@ -14044,7 +13467,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDragEnd": { "PrimitiveTypes": [ @@ -14052,7 +13475,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDraggable.Options.onDragEnd" + "Description": "A function that is called when drag gesture is finished." }, "onDragMove": { "PrimitiveTypes": [ @@ -14060,7 +13483,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDraggable.Options.onDragMove" + "Description": "A function that is called every time a draggable item is moved." }, "onDragStart": { "PrimitiveTypes": [ @@ -14068,7 +13491,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDraggable.Options.onDragStart" + "Description": "A function that is called when the drag gesture is initialized." }, "onInitialized": { "PrimitiveTypes": [ @@ -14076,7 +13499,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -14084,25 +13507,25 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scrollSensitivity": { "PrimitiveTypes": [ "number" ], - "DocID": "DraggableBase.Options.scrollSensitivity" + "Description": "Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true." }, "scrollSpeed": { "PrimitiveTypes": [ "number" ], - "DocID": "DraggableBase.Options.scrollSpeed" + "Description": "Specifies the scrolling speed when dragging an item beyond the viewport. Applies only if autoScroll is true." }, "width": { "PrimitiveTypes": [ @@ -14111,12 +13534,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxDrawer": { - "DocID": "dxDrawer", + "Description": "The Drawer is a dismissible or permanently visible panel used for navigation in responsive web application layouts.", "IsTranscludedContent": true, "Module": "ui/drawer", "Options": { @@ -14124,19 +13547,19 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "animationDuration": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDrawer.Options.animationDuration" + "Description": "Specifies the duration of the drawer's opening and closing animation (in milliseconds). Applies only if animationEnabled is true." }, "animationEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDrawer.Options.animationEnabled" + "Description": "Specifies whether to use an opening and closing animation." }, "closeOnOutsideClick": { "PrimitiveTypes": [ @@ -14144,19 +13567,19 @@ "Function" ], "IsFunc": true, - "DocID": "dxDrawer.Options.closeOnOutsideClick" + "Description": "Specifies whether to close the drawer if a user clicks or taps the view area." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -14165,31 +13588,31 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "maxSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDrawer.Options.maxSize" + "Description": "Specifies the drawer's width or height (depending on the drawer's position) in the opened state." }, "minSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDrawer.Options.minSize" + "Description": "Specifies the drawer's width or height (depending on the drawer's position) in the closed state." }, "onDisposing": { "PrimitiveTypes": [ @@ -14197,7 +13620,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -14205,7 +13628,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -14213,44 +13636,44 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "opened": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxDrawer.Options.opened" + "Description": "Specifies whether the drawer is opened." }, "openedStateMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDrawer.Options.openedStateMode" + "Description": "Specifies how the drawer interacts with the view in the opened state." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDrawer.Options.position" + "Description": "Specifies the drawer's position in relation to the view." }, "revealMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDrawer.Options.revealMode" + "Description": "Specifies the drawer's reveal mode." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "shading": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDrawer.Options.shading" + "Description": "Specifies whether to shade the view when the drawer is opened." }, "target": { "PrimitiveTypes": [ @@ -14258,20 +13681,20 @@ "JQuery", "string" ], - "DocID": "dxDrawer.Options.target" + "Description": "Specifies a CSS selector for the element in which the drawer should be rendered. Applies only when the openedStateMode is \"overlap\"." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDrawer.Options.template" + "Description": "Specifies the drawer's content." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -14280,12 +13703,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxDropDownBox": { - "DocID": "dxDropDownBox", + "Description": "The DropDownBox widget consists of a text field, which displays the current value, and a drop-down field, which can contain any UI element.", "IsTranscludedContent": true, "Module": "ui/drop_down_box", "IsEditor": true, @@ -14294,19 +13717,19 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownBox.Options.acceptCustomValue" + "Description": "Specifies whether the widget allows a user to enter a custom value." }, "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "buttons": { "ItemPrimitiveTypes": [ @@ -14316,23 +13739,16 @@ "ItemComplexTypes": [ "TextEditorButton" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "button", - "DocID": "dxDropDownEditor.Options.buttons" + "Description": "Allows you to add custom buttons to the input text field." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDropDownBox.Options.contentTemplate" + "Description": "Specifies a custom template for the drop-down content." }, "dataSource": { "PrimitiveTypes": [ @@ -14344,27 +13760,20 @@ "DevExpress.ui.CollectionWidgetItem", "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "DataExpressionMixin.Options.dataSource" + "Description": "Binds the widget to data." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.deferRendering" + "Description": "Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "displayExpr": { "PrimitiveTypes": [ @@ -14372,55 +13781,49 @@ "string" ], "IsFunc": true, - "DocID": "DataExpressionMixin.Options.displayExpr" + "Description": "Specifies the data field whose values should be displayed." }, "displayValueFormatter": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxDropDownBox.Options.displayValueFormatter" + "Description": "Customizes text before it is displayed in the input field." }, "dropDownButtonTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDropDownEditor.Options.dropDownButtonTemplate" + "Description": "Specifies a custom template for the drop-down button." }, "dropDownOptions": { "PrimitiveTypes": [ - "dxPopupOptions" + "DevExpress.ui.dxPopupOptions" ], "ComplexTypes": [ "dxPopupOptions" ], - "TypeImports": [ - { - "Name": "dxPopupOptions", - "Path": "ui/popup" - } - ], - "DocID": "dxDropDownBox.Options.dropDownOptions" + "Description": "Configures the drop-down field which holds the content." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "fieldTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDropDownBox.Options.fieldTemplate" + "Description": "Specifies a custom template for the text field. Must contain the TextBox widget." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -14429,31 +13832,31 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "inputAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTextEditor.Options.inputAttr" + "Description": "Specifies the attributes to be passed on to the underlying HTML element." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "items": { "ItemPrimitiveTypes": [ @@ -14461,38 +13864,38 @@ ], "IsCollection": true, "SingularName": "item", - "DocID": "DataExpressionMixin.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -14501,13 +13904,13 @@ "number", "string" ], - "DocID": "dxTextBox.Options.maxLength" + "Description": "Specifies the maximum number of characters you can enter into the textbox." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "onChange": { "PrimitiveTypes": [ @@ -14515,7 +13918,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onChange" + "Description": "A function that is executed when the widget loses focus after the text field's content was changed using the keyboard." }, "onClosed": { "PrimitiveTypes": [ @@ -14523,7 +13926,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onClosed" + "Description": "A function that is executed once the drop-down editor is closed." }, "onCopy": { "PrimitiveTypes": [ @@ -14531,7 +13934,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCopy" + "Description": "A function that is executed when the widget's input has been copied." }, "onCut": { "PrimitiveTypes": [ @@ -14539,7 +13942,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCut" + "Description": "A function that is executed when the widget's input has been cut." }, "onDisposing": { "PrimitiveTypes": [ @@ -14547,7 +13950,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEnterKey": { "PrimitiveTypes": [ @@ -14555,7 +13958,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onEnterKey" + "Description": "A function that is executed when the Enter key has been pressed while the widget is focused." }, "onFocusIn": { "PrimitiveTypes": [ @@ -14563,7 +13966,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusIn" + "Description": "A function that is executed when the widget gets focus." }, "onFocusOut": { "PrimitiveTypes": [ @@ -14571,7 +13974,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusOut" + "Description": "A function that is executed when the widget loses focus." }, "onInitialized": { "PrimitiveTypes": [ @@ -14579,7 +13982,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onInput": { "PrimitiveTypes": [ @@ -14587,7 +13990,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onInput" + "Description": "A function that is executed each time the widget's input is changed while the widget is focused." }, "onKeyDown": { "PrimitiveTypes": [ @@ -14595,7 +13998,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyDown" + "Description": "A function that is executed when a user is pressing a key on the keyboard." }, "onKeyPress": { "PrimitiveTypes": [ @@ -14603,7 +14006,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyPress" + "Description": "A function that is executed when a user presses a key on the keyboard." }, "onKeyUp": { "PrimitiveTypes": [ @@ -14611,7 +14014,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyUp" + "Description": "A function that is executed when a user releases a key on the keyboard." }, "onOpened": { "PrimitiveTypes": [ @@ -14619,7 +14022,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onOpened" + "Description": "A function that is executed once the drop-down editor is opened." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -14627,7 +14030,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPaste": { "PrimitiveTypes": [ @@ -14635,7 +14038,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onPaste" + "Description": "A function that is executed when the widget's input has been pasted." }, "onValueChanged": { "PrimitiveTypes": [ @@ -14643,75 +14046,75 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "opened": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxDropDownEditor.Options.opened" + "Description": "Specifies whether or not the drop-down editor is displayed." }, "openOnFieldClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownBox.Options.openOnFieldClick" + "Description": "Specifies whether a user can open the drop-down list by clicking a text field." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.placeholder" + "Description": "The text displayed by the widget when the widget value is empty." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showClearButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.showClearButton" + "Description": "Specifies whether to display the Clear button in the widget." }, "showDropDownButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.showDropDownButton" + "Description": "Specifies whether the drop-down button is visible." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.stylingMode" + "Description": "Specifies how the widget's text field is styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "text": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxTextEditor.Options.text" + "Description": "The read-only option that holds the text displayed by the widget input element." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -14719,31 +14122,31 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "any" ], - "DocID": "DataExpressionMixin.Options.value" + "Description": "Specifies the currently selected value. May be an object if dataSource contains objects and valueExpr is not set." }, "valueChangeEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownBox.Options.valueChangeEvent" + "Description": "Specifies the DOM events after which the widget's value should be updated." }, "valueExpr": { "PrimitiveTypes": [ @@ -14751,13 +14154,13 @@ "string" ], "IsFunc": true, - "DocID": "DataExpressionMixin.Options.valueExpr" + "Description": "Specifies which data field provides unique values to the widget's value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -14766,25 +14169,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxDropDownButton": { - "DocID": "dxDropDownButton", + "Description": "The DropDownButton is a button that opens a drop-down menu.", "Module": "ui/drop_down_button", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "dataSource": { "PrimitiveTypes": [ @@ -14799,27 +14202,20 @@ "ItemComplexTypes": [ "DropDownButtonItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxDropDownButton.Options.dataSource" + "Description": "Provides data for the drop-down menu." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownButton.Options.deferRendering" + "Description": "Specifies whether to wait until the drop-down menu is opened the first time to render its content." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "displayExpr": { "PrimitiveTypes": [ @@ -14827,41 +14223,35 @@ "string" ], "IsFunc": true, - "DocID": "dxDropDownButton.Options.displayExpr" + "Description": "Specifies the data field whose values should be displayed in the drop-down menu." }, "dropDownContentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDropDownButton.Options.dropDownContentTemplate" + "Description": "Specifies custom content for the drop-down field." }, "dropDownOptions": { "PrimitiveTypes": [ - "dxPopupOptions" + "DevExpress.ui.dxPopupOptions" ], "ComplexTypes": [ "dxPopupOptions" ], - "TypeImports": [ - { - "Name": "dxPopupOptions", - "Path": "ui/popup" - } - ], - "DocID": "dxDropDownButton.Options.dropDownOptions" + "Description": "Configures the drop-down field." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownButton.Options.focusStateEnabled" + "Description": "Specifies whether users can use keyboard to focus the widget." }, "height": { "PrimitiveTypes": [ @@ -14870,25 +14260,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownButton.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user hovers the mouse pointer over it." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownButton.Options.icon" + "Description": "Specifies the button's icon." }, "items": { "ItemPrimitiveTypes": [ @@ -14896,59 +14286,50 @@ ], "IsCollection": true, "SingularName": "item", - "DocID": "dxDropDownButton.Options.items", + "Description": "Provides drop-down menu items.", "Options": { "badge": { "PrimitiveTypes": [ "string" ], - "DocID": "dxListItem.badge" + "Description": "Specifies the text of a badge displayed for the list item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxListItem.icon" - }, - "onClick": { - "PrimitiveTypes": [ - "Function", - "string" - ], - "IsFunc": true, - "IsEvent": true, - "DocID": "dxDropDownButtonItem.onClick" + "Description": "Specifies the list item's icon." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -14957,19 +14338,19 @@ "any" ], "IsTemplate": true, - "DocID": "dxDropDownButton.Options.itemTemplate" + "Description": "Specifies a custom template for drop-down menu items." }, "keyExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownButton.Options.keyExpr" + "Description": "Specifies which data field provides keys used to distinguish between the selected drop-down menu items." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownButton.Options.noDataText" + "Description": "Specifies text or HTML markup displayed in the drop-down menu when it does not contain any items." }, "onButtonClick": { "PrimitiveTypes": [ @@ -14978,7 +14359,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownButton.Options.onButtonClick" + "Description": "A function that is executed when the button is clicked or tapped. If splitButton is true, this function is executed for the action button only." }, "onContentReady": { "PrimitiveTypes": [ @@ -14986,7 +14367,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -14994,7 +14375,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -15002,7 +14383,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -15011,7 +14392,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownButton.Options.onItemClick" + "Description": "A function that is executed when a drop-down menu item is clicked." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -15019,7 +14400,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -15028,19 +14409,19 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownButton.Options.onSelectionChanged" + "Description": "A function that is executed when an item is selected or selection is canceled. In effect when useSelectMode is true." }, "opened": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownButton.Options.opened" + "Description": "Specifies whether the drop-down menu is opened." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectedItem": { "PrimitiveTypes": [ @@ -15049,56 +14430,56 @@ "string" ], "IsReadonly": true, - "DocID": "dxDropDownButton.Options.selectedItem" + "Description": "Contains the selected item's data. Available when useSelectMode is true." }, "selectedItemKey": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxDropDownButton.Options.selectedItemKey" + "Description": "Contains the selected item's key and allows you to specify the initially selected item. Applies when useSelectMode is true." }, "showArrowIcon": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownButton.Options.showArrowIcon" + "Description": "Specifies whether the arrow icon should be displayed." }, "splitButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownButton.Options.splitButton" + "Description": "Specifies whether to split the button in two: one executes an action, the other opens and closes the drop-down menu." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownButton.Options.stylingMode" + "Description": "Specifies how the button is styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownButton.Options.text" + "Description": "Specifies the button's text. Applies only if useSelectMode is false." }, "useSelectMode": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownButton.Options.useSelectMode" + "Description": "Specifies whether the widget stores the selected drop-down menu item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -15107,31 +14488,31 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." }, "wrapItemText": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownButton.Options.wrapItemText" + "Description": "Specifies whether text that exceeds the drop-down list width should be wrapped." } } }, "dxFileManager": { - "DocID": "dxFileManager", + "Description": "[tags] ctp The FileManager is a widget that allows users to upload, select, and manage files and directories in different file storages. #include common-ctp-note with { component: \"FileManager\" }", "Module": "ui/file_manager", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "allowedFileExtensions": { "ItemPrimitiveTypes": [ @@ -15139,66 +14520,60 @@ ], "IsCollection": true, "SingularName": "allowedFileExtension", - "DocID": "dxFileManager.Options.allowedFileExtensions" + "Description": "Specifies the allowed upload file extensions." }, "contextMenu": { "PrimitiveTypes": [ - "dxFileManagerContextMenu" + "DevExpress.ui.dxFileManagerContextMenu" ], "ComplexTypes": [ "FileManagerContextMenu" ], - "TypeImports": [ - { - "Name": "dxFileManagerContextMenu", - "Path": "ui/file_manager" - } - ], - "DocID": "dxFileManager.Options.contextMenu" + "Description": "Configures the context menu settings." }, "currentPath": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileManager.Options.currentPath" + "Description": "Specifies the path that is used when the FileManager is initialized." }, "customizeDetailColumns": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxFileManager.Options.customizeDetailColumns" + "Description": "Customizes columns in details view. Applies only if itemView.mode is \"details\"." }, "customizeThumbnail": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxFileManager.Options.customizeThumbnail" + "Description": "Allows you to provide custom icons to be used as thumbnails." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "fileProvider": { "PrimitiveTypes": [ "any" ], - "DocID": "dxFileManager.Options.fileProvider" + "Description": "Specifies the file provider." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -15207,40 +14582,40 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemView": { - "DocID": "dxFileManager.Options.itemView", + "Description": "Configures the file and folder view.", "Options": { "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileManager.Options.itemView.mode" + "Description": "Specifies the file system representation mode." }, "showFolders": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileManager.Options.itemView.showFolders" + "Description": "Specifies whether to display folders in the view. When this option is false, folders are displayed in the navigation pane only." }, "showParentFolder": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileManager.Options.itemView.showParentFolder" + "Description": "Specifies whether to display the parent folder in the view." } } }, @@ -15250,7 +14625,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onCurrentDirectoryChanged": { "PrimitiveTypes": [ @@ -15258,7 +14633,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFileManager.Options.onCurrentDirectoryChanged" + "Description": "A function that is executed when the current directory is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -15266,7 +14641,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -15274,7 +14649,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -15282,7 +14657,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectedFileOpened": { "PrimitiveTypes": [ @@ -15290,52 +14665,52 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFileManager.Options.onSelectedFileOpened" + "Description": "A function that is executed when the selected file is opened." }, "permissions": { - "DocID": "dxFileManager.Options.permissions", + "Description": "Specifies actions that a user is allowed to perform on files and folders.", "Options": { "copy": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileManager.Options.permissions.copy" + "Description": "Specifies whether a user is allowed to copy files and folders." }, "create": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileManager.Options.permissions.create" + "Description": "Specifies whether a user is allowed to create files and folders." }, "download": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileManager.Options.permissions.download" + "Description": "Specifies whether a user is allowed to download files and folders." }, "move": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileManager.Options.permissions.move" + "Description": "Specifies whether a user is allowed to move files and folders." }, "remove": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileManager.Options.permissions.remove" + "Description": "Specifies whether a user is allowed to remove files and folders." }, "rename": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileManager.Options.permissions.rename" + "Description": "Specifies whether a user is allowed to rename files and folders." }, "upload": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileManager.Options.permissions.upload" + "Description": "Specifies whether a user is allowed to upload files." } } }, @@ -15343,49 +14718,43 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxFileManager.Options.rootFolderName" + "Description": "Specifies the root folder name." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileManager.Options.selectionMode" + "Description": "Specifies whether a user can select a single or multiple files and folders in the item view simultaneously." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "toolbar": { "PrimitiveTypes": [ - "dxFileManagerToolbar" + "DevExpress.ui.dxFileManagerToolbar" ], "ComplexTypes": [ "FileManagerToolbar" ], - "TypeImports": [ - { - "Name": "dxFileManagerToolbar", - "Path": "ui/file_manager" - } - ], - "DocID": "dxFileManager.Options.toolbar" + "Description": "Configures toolbar settings." }, "upload": { - "DocID": "dxFileManager.Options.upload", + "Description": "Configures upload settings.", "Options": { "maxFileSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFileManager.Options.upload.maxFileSize" + "Description": "Specifies the maximum upload file size." } } }, @@ -15393,7 +14762,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -15402,12 +14771,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxFileUploader": { - "DocID": "dxFileUploader", + "Description": "The FileUploader widget enables an end user to upload files to the server. An end user can select files in the file explorer or drag and drop files to the FileUploader area on the page.", "Module": "ui/file_uploader", "Options": { "abortUpload": { @@ -15415,31 +14784,31 @@ "Function" ], "IsFunc": true, - "DocID": "dxFileUploader.Options.abortUpload" + "Description": "A function that cancels the file upload." }, "accept": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.accept" + "Description": "Specifies a file type or several types accepted by the widget." }, "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "allowCanceling": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileUploader.Options.allowCanceling" + "Description": "Specifies if an end user can remove a file from the selection and interrupt uploading." }, "allowedFileExtensions": { "ItemPrimitiveTypes": [ @@ -15447,31 +14816,31 @@ ], "IsCollection": true, "SingularName": "allowedFileExtension", - "DocID": "dxFileUploader.Options.allowedFileExtensions" + "Description": "Restricts file extensions that can be uploaded to the server." }, "chunkSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFileUploader.Options.chunkSize" + "Description": "Specifies the chunk size in bytes. Applies only if uploadMode is \"instantly\" or \"useButtons\". Requires a server that can process file chunks." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileUploader.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -15480,79 +14849,79 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "inputAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "dxFileUploader.Options.inputAttr" + "Description": "Specifies the attributes to be passed on to the underlying `` element of the `file` type." }, "invalidFileExtensionMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.invalidFileExtensionMessage" + "Description": "The text displayed when the extension of the file being uploaded is not an allowed file extension." }, "invalidMaxFileSizeMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.invalidMaxFileSizeMessage" + "Description": "The text displayed when the size of the file being uploaded is greater than the maxFileSize." }, "invalidMinFileSizeMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.invalidMinFileSizeMessage" + "Description": "The text displayed when the size of the file being uploaded is less than the minFileSize." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "labelText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.labelText" + "Description": "Specifies the text displayed on the area to which an end-user can drop a file." }, "maxFileSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFileUploader.Options.maxFileSize" + "Description": "Specifies the maximum file size (in bytes) allowed for uploading. Applies only if uploadMode is \"instantly\" or \"useButtons\"." }, "minFileSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFileUploader.Options.minFileSize" + "Description": "Specifies the minimum file size (in bytes) allowed for uploading. Applies only if uploadMode is \"instantly\" or \"useButtons\"." }, "multiple": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileUploader.Options.multiple" + "Description": "Specifies whether the widget enables an end-user to select a single file or multiple files." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.name" + "Description": "Specifies the value passed to the name attribute of the underlying input element. Required to access uploaded files on the server." }, "onContentReady": { "PrimitiveTypes": [ @@ -15560,7 +14929,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -15568,7 +14937,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -15576,7 +14945,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -15584,7 +14953,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onProgress": { "PrimitiveTypes": [ @@ -15592,7 +14961,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFileUploader.Options.onProgress" + "Description": "A function that is executed when a file segment is uploaded." }, "onUploadAborted": { "PrimitiveTypes": [ @@ -15600,7 +14969,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFileUploader.Options.onUploadAborted" + "Description": "A function that is executed when the file upload is aborted." }, "onUploaded": { "PrimitiveTypes": [ @@ -15608,7 +14977,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFileUploader.Options.onUploaded" + "Description": "A function that is executed when a file is successfully uploaded." }, "onUploadError": { "PrimitiveTypes": [ @@ -15616,7 +14985,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFileUploader.Options.onUploadError" + "Description": "A function that is executed when an error occurs during the file upload." }, "onUploadStarted": { "PrimitiveTypes": [ @@ -15624,7 +14993,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFileUploader.Options.onUploadStarted" + "Description": "A function that is executed when the file upload is started." }, "onValueChanged": { "PrimitiveTypes": [ @@ -15632,111 +15001,111 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFileUploader.Options.onValueChanged" + "Description": "A function that is executed when one or several files are added to or removed from the selection." }, "progress": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFileUploader.Options.progress" + "Description": "Gets the current progress in percentages." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "readyToUploadMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.readyToUploadMessage" + "Description": "The message displayed by the widget when it is ready to upload the specified files." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectButtonText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.selectButtonText" + "Description": "The text displayed on the button that opens the file browser." }, "showFileList": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileUploader.Options.showFileList" + "Description": "Specifies whether or not the widget displays the list of selected files." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "uploadButtonText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.uploadButtonText" + "Description": "The text displayed on the button that starts uploading." }, "uploadChunk": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxFileUploader.Options.uploadChunk" + "Description": "A function that uploads a file in chunks." }, "uploadedMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.uploadedMessage" + "Description": "The message displayed by the widget when uploading is finished." }, "uploadFailedMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.uploadFailedMessage" + "Description": "The message displayed by the widget on uploading failure." }, "uploadFile": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxFileUploader.Options.uploadFile" + "Description": "A function that uploads a file." }, "uploadHeaders": { "PrimitiveTypes": [ "any" ], - "DocID": "dxFileUploader.Options.uploadHeaders" + "Description": "Specifies headers for the upload request." }, "uploadMethod": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.uploadMethod" + "Description": "Specifies the method for the upload request." }, "uploadMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.uploadMode" + "Description": "Specifies how the widget uploads files." }, "uploadUrl": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileUploader.Options.uploadUrl" + "Description": "Specifies a target Url for the upload request." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -15744,13 +15113,13 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "ItemPrimitiveTypes": [ @@ -15759,13 +15128,13 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "value", - "DocID": "dxFileUploader.Options.value" + "Description": "Specifies a File instance representing the selected file. Read-only when uploadMode is \"useForm\"." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -15774,31 +15143,31 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxFilterBuilder": { - "DocID": "dxFilterBuilder", + "Description": "The FilterBuilder widget allows a user to build complex filter expressions with an unlimited number of filter conditions, combined by logical operations using the UI.", "Module": "ui/filter_builder", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "allowHierarchicalFields": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFilterBuilder.Options.allowHierarchicalFields" + "Description": "Specifies whether the widget can display hierarchical data fields." }, "customOperations": { "ItemPrimitiveTypes": [ @@ -15807,28 +15176,21 @@ "ItemComplexTypes": [ "FilterBuilderCustomOperation" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "customOperation", - "DocID": "dxFilterBuilder.Options.customOperations" + "Description": "Configures custom filter operations." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "fields": { "ItemPrimitiveTypes": [ @@ -15837,97 +15199,90 @@ "ItemComplexTypes": [ "FilterBuilderField" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "field", - "DocID": "dxFilterBuilder.Options.fields" + "Description": "Configures fields." }, "filterOperationDescriptions": { - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions", + "Description": "Specifies filter operation descriptions.", "Options": { "between": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.between" + "Description": "The \"between\" operation's description." }, "contains": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.contains" + "Description": "The \"contains\" operation's description." }, "endsWith": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.endsWith" + "Description": "The \"endswith\" operation's description." }, "equal": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.equal" + "Description": "The \"=\" operation's description." }, "greaterThan": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.greaterThan" + "Description": "The \">\" operation's description." }, "greaterThanOrEqual": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.greaterThanOrEqual" + "Description": "The \">=\" operation's description." }, "isBlank": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.isBlank" + "Description": "The \"isblank\" operation's description." }, "isNotBlank": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.isNotBlank" + "Description": "The \"isnotblank\" operation's description." }, "lessThan": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.lessThan" + "Description": "The \"<\" operation's description." }, "lessThanOrEqual": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.lessThanOrEqual" + "Description": "The \"<=\" operation's description." }, "notContains": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.notContains" + "Description": "The \"notcontains\" operation's description." }, "notEqual": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.notEqual" + "Description": "The \"<>\" operation's description." }, "startsWith": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.filterOperationDescriptions.startsWith" + "Description": "The \"startswith\" operation's description." } } }, @@ -15935,34 +15290,34 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "groupOperationDescriptions": { - "DocID": "dxFilterBuilder.Options.groupOperationDescriptions", + "Description": "Specifies group operation descriptions.", "Options": { "and": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.groupOperationDescriptions.and" + "Description": "The \"and\" operation's description." }, "notAnd": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.groupOperationDescriptions.notAnd" + "Description": "The \"notand\" operation's description." }, "notOr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.groupOperationDescriptions.notOr" + "Description": "The \"notor\" operation's description." }, "or": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilder.Options.groupOperationDescriptions.or" + "Description": "The \"or\" operation's description." } } }, @@ -15972,7 +15327,7 @@ ], "IsCollection": true, "SingularName": "groupOperation", - "DocID": "dxFilterBuilder.Options.groupOperations" + "Description": "Specifies a set of available group operations." }, "height": { "PrimitiveTypes": [ @@ -15981,25 +15336,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "maxGroupLevel": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFilterBuilder.Options.maxGroupLevel" + "Description": "Specifies groups' maximum nesting level." }, "onContentReady": { "PrimitiveTypes": [ @@ -16007,7 +15362,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -16015,7 +15370,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEditorPrepared": { "PrimitiveTypes": [ @@ -16023,7 +15378,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFilterBuilder.Options.onEditorPrepared" + "Description": "A function that is executed after an editor is created." }, "onEditorPreparing": { "PrimitiveTypes": [ @@ -16031,7 +15386,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFilterBuilder.Options.onEditorPreparing" + "Description": "A function that is executed before an editor is created." }, "onInitialized": { "PrimitiveTypes": [ @@ -16039,7 +15394,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -16047,7 +15402,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onValueChanged": { "PrimitiveTypes": [ @@ -16055,19 +15410,19 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFilterBuilder.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "value": { "PrimitiveTypes": [ @@ -16075,13 +15430,13 @@ ], "IsFilterExpr": true, "IsChangeable": true, - "DocID": "dxFilterBuilder.Options.value" + "Description": "Allows you to specify a filter." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -16090,71 +15445,71 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxForm": { - "DocID": "dxForm", + "Description": "The Form widget represents fields of a data object as a collection of label-editor pairs. These pairs can be arranged in several groups, tabs and columns.", "Module": "ui/form", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "alignItemLabels": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxForm.Options.alignItemLabels" + "Description": "Specifies whether or not all root item labels are aligned." }, "alignItemLabelsInAllGroups": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxForm.Options.alignItemLabelsInAllGroups" + "Description": "Specifies whether or not item labels in all groups are aligned." }, "colCount": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxForm.Options.colCount" + "Description": "The count of columns in the form layout." }, "colCountByScreen": { - "DocID": "dxForm.Options.colCountByScreen", + "Description": "Specifies dependency between the screen factor and the count of columns in the form layout.", "Options": { "lg": { "PrimitiveTypes": [ "number" ], - "DocID": "ColCountResponsible.lg" + "Description": "The count of columns for a large screen size." }, "md": { "PrimitiveTypes": [ "number" ], - "DocID": "ColCountResponsible.md" + "Description": "The count of columns for a middle-sized screen." }, "sm": { "PrimitiveTypes": [ "number" ], - "DocID": "ColCountResponsible.sm" + "Description": "The count of columns for a small-sized screen." }, "xs": { "PrimitiveTypes": [ "number" ], - "DocID": "ColCountResponsible.xs" + "Description": "The count of columns for an extra small-sized screen." } } }, @@ -16163,32 +15518,32 @@ "Function" ], "IsFunc": true, - "DocID": "dxForm.Options.customizeItem" + "Description": "Specifies a function that customizes a form item after it has been created." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "formData": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "dxForm.Options.formData" + "Description": "Provides the Form's data. Gets updated every time form fields change." }, "height": { "PrimitiveTypes": [ @@ -16197,19 +15552,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "items": { "ItemPrimitiveTypes": [ @@ -16226,28 +15581,21 @@ "FormEmptyItem", "FormButtonItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "item", - "DocID": "dxForm.Options.items" + "Description": "Holds an array of form items." }, "labelLocation": { "PrimitiveTypes": [ "string" ], - "DocID": "dxForm.Options.labelLocation" + "Description": "Specifies the location of a label against the editor." }, "minColWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxForm.Options.minColWidth" + "Description": "The minimum column width used for calculating column count in the form layout." }, "onContentReady": { "PrimitiveTypes": [ @@ -16255,7 +15603,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -16263,7 +15611,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEditorEnterKey": { "PrimitiveTypes": [ @@ -16271,7 +15619,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxForm.Options.onEditorEnterKey" + "Description": "A function that is executed when the Enter key has been pressed while an editor is focused." }, "onFieldDataChanged": { "PrimitiveTypes": [ @@ -16279,7 +15627,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxForm.Options.onFieldDataChanged" + "Description": "A function that is executed when the value of a formData object field is changed." }, "onInitialized": { "PrimitiveTypes": [ @@ -16287,7 +15635,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -16295,92 +15643,92 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "optionalMark": { "PrimitiveTypes": [ "string" ], - "DocID": "dxForm.Options.optionalMark" + "Description": "The text displayed for optional fields." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxForm.Options.readOnly" + "Description": "Specifies whether all editors on the form are read-only. Applies only to non-templated items." }, "requiredMark": { "PrimitiveTypes": [ "string" ], - "DocID": "dxForm.Options.requiredMark" + "Description": "The text displayed for required fields." }, "requiredMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxForm.Options.requiredMessage" + "Description": "Specifies the message that is shown for end-users if a required field value is not specified." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "screenByWidth": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxForm.Options.screenByWidth" + "Description": "Specifies a function that categorizes screens by their width." }, "scrollingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxForm.Options.scrollingEnabled" + "Description": "A Boolean value specifying whether to enable or disable form scrolling." }, "showColonAfterLabel": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxForm.Options.showColonAfterLabel" + "Description": "Specifies whether or not a colon is displayed at the end of form labels." }, "showOptionalMark": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxForm.Options.showOptionalMark" + "Description": "Specifies whether or not the optional mark is displayed for optional fields." }, "showRequiredMark": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxForm.Options.showRequiredMark" + "Description": "Specifies whether or not the required mark is displayed for required fields." }, "showValidationSummary": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxForm.Options.showValidationSummary" + "Description": "Specifies whether or not the total validation summary is displayed on the form." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "validationGroup": { "PrimitiveTypes": [ "string" ], - "DocID": "dxForm.Options.validationGroup" + "Description": "Gives a name to the internal validation group." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -16389,34 +15737,34 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxFunnel": { - "DocID": "dxFunnel", + "Description": "The Funnel is a widget that visualizes a value at different stages. It helps assess value changes throughout these stages and identify potential issues. The Funnel widget conveys information using different interactive elements (tooltips, labels, legend) and enables you to create not only a funnel, but also a pyramid chart.", "Module": "viz/funnel", "Options": { "adaptiveLayout": { - "DocID": "dxFunnel.Options.adaptiveLayout", + "Description": "Specifies adaptive layout options.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.adaptiveLayout.height" + "Description": "Specifies the minimum container height at which the layout begins to adapt." }, "keepLabels": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFunnel.Options.adaptiveLayout.keepLabels" + "Description": "Specifies whether item labels should be kept when the widget adapts the layout." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.adaptiveLayout.width" + "Description": "Specifies the minimum container width at which the layout begins to adapt." } } }, @@ -16424,19 +15772,19 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.algorithm" + "Description": "Specifies the algorithm for building the funnel." }, "argumentField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.argumentField" + "Description": "Specifies which data source field provides arguments for funnel items. The argument identifies a funnel item and represents it on the legend." }, "colorField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.colorField" + "Description": "Specifies which data source field provides colors for funnel items. If this field is absent, the palette provides the colors." }, "dataSource": { "PrimitiveTypes": [ @@ -16447,48 +15795,41 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxFunnel.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "export": { - "DocID": "BaseWidget.Options.export", + "Description": "Configures the exporting and printing features.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.backgroundColor" + "Description": "Specifies the color that will fill transparent regions in the resulting file or document." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.enabled" + "Description": "Enables the client-side exporting in the widget." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.fileName" + "Description": "Specifies a default name for the file to which the widget will be exported." }, "formats": { "ItemPrimitiveTypes": [ @@ -16496,33 +15837,33 @@ ], "IsCollection": true, "SingularName": "format", - "DocID": "BaseWidget.Options.export.formats" + "Description": "Specifies a set of export formats." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.export.margin" + "Description": "Adds an empty space around the exported widget; measured in pixels." }, "printingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.printingEnabled" + "Description": "Enables the printing feature in the widget. Applies only if the export.enabled option is true." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "BaseWidget.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." }, "svgToCanvas": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseWidget.Options.export.svgToCanvas" + "Description": "A function that renders SVG markup on the HTML canvas. Required to export custom SVG elements (for example, markerTemplate)." } } }, @@ -16530,149 +15871,149 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFunnel.Options.hoverEnabled" + "Description": "Specifies whether funnel items change their style when a user pauses on them." }, "inverted": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFunnel.Options.inverted" + "Description": "Turns the funnel upside down." }, "item": { - "DocID": "dxFunnel.Options.item", + "Description": "Configures funnel items' appearance.", "Options": { "border": { - "DocID": "dxFunnel.Options.item.border", + "Description": "Configures a funnel item's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.item.border.color" + "Description": "Colors a funnel item's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFunnel.Options.item.border.visible" + "Description": "Makes a funnel item's border visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.item.border.width" + "Description": "Sets the width of a funnel item's border in pixels." } } }, "hoverStyle": { - "DocID": "dxFunnel.Options.item.hoverStyle", + "Description": "Configures a funnel item's appearance when a user presses the item or hovers the mouse pointer over it.", "Options": { "border": { - "DocID": "dxFunnel.Options.item.hoverStyle.border", + "Description": "Configures a funnel item's border appearance when a user presses the item or hovers the mouse pointer over it.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.item.hoverStyle.border.color" + "Description": "Colors a funnel item's border when a user presses the item or hovers the mouse pointer over it." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFunnel.Options.item.hoverStyle.border.visible" + "Description": "Shows a funnel item's border when a user presses the item or hovers the mouse pointer over it." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.item.hoverStyle.border.width" + "Description": "Thickens a funnel item's border when a user presses the item or hovers the mouse pointer over it." } } }, "hatching": { - "DocID": "dxFunnel.Options.item.hoverStyle.hatching", + "Description": "Applies hatching to a funnel item when a user presses the item or hovers the mouse pointer over it.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.item.hoverStyle.hatching.direction" + "Description": "Specifies hatching line direction." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.item.hoverStyle.hatching.opacity" + "Description": "Specifies the transparency of hatching lines." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.item.hoverStyle.hatching.step" + "Description": "Specifies the distance between two side-by-side hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.item.hoverStyle.hatching.width" + "Description": "Specifies hatching lines' width in pixels." } } } } }, "selectionStyle": { - "DocID": "dxFunnel.Options.item.selectionStyle", + "Description": "Configures a funnel item's appearance when a user selects it.", "Options": { "border": { - "DocID": "dxFunnel.Options.item.selectionStyle.border", + "Description": "Configures a funnel item's border appearance when a user selects this item.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.item.selectionStyle.border.color" + "Description": "Colors the selected funnel item's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFunnel.Options.item.selectionStyle.border.visible" + "Description": "Shows the selected funnel item's border." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.item.selectionStyle.border.width" + "Description": "Thickens the selected funnel item's border." } } }, "hatching": { - "DocID": "dxFunnel.Options.item.selectionStyle.hatching", + "Description": "Applies hatching to a selected funnel item.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.item.selectionStyle.hatching.direction" + "Description": "Specifies hatching line direction." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.item.selectionStyle.hatching.opacity" + "Description": "Specifies hatching line transparency." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.item.selectionStyle.hatching.step" + "Description": "Specifies the distance between two side-by-side hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.item.selectionStyle.hatching.width" + "Description": "Specifies hatching line width in pixels." } } } @@ -16681,69 +16022,69 @@ } }, "label": { - "DocID": "dxFunnel.Options.label", + "Description": "Configures funnel item labels.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.label.backgroundColor" + "Description": "Colors the labels' background. The default color is inherited from the funnel items." }, "border": { - "DocID": "dxFunnel.Options.label.border", + "Description": "Configures the label borders.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.label.border.color" + "Description": "Colors the label borders." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.label.border.dashStyle" + "Description": "Sets the label border dash style." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFunnel.Options.label.border.visible" + "Description": "Shows the label borders." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.label.border.width" + "Description": "Specifies the label border width." } } }, "connector": { - "DocID": "dxFunnel.Options.label.connector", + "Description": "Configures label connectors.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.label.connector.color" + "Description": "Colors label connectors." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.label.connector.opacity" + "Description": "Specifies the transparency of label connectors." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFunnel.Options.label.connector.visible" + "Description": "Shows label connectors." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.label.connector.width" + "Description": "Specifies the label connector width in pixels." } } }, @@ -16752,7 +16093,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxFunnel.Options.label.customizeText" + "Description": "Customizes labels' text." }, "font": { "PrimitiveTypes": [ @@ -16761,14 +16102,7 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxFunnel.Options.label.font" + "Description": "Specifies labels' font options." }, "format": { "PrimitiveTypes": [ @@ -16778,106 +16112,99 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxFunnel.Options.label.format" + "Description": "Formats the item value before displaying it in the label." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.label.horizontalAlignment" + "Description": "Specifies labels' position in relation to the funnel items." }, "horizontalOffset": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.label.horizontalOffset" + "Description": "Moves labels from their initial positions." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.label.position" + "Description": "Specifies whether to display labels inside or outside funnel items or arrange them in columns." }, "showForZeroValues": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFunnel.Options.label.showForZeroValues" + "Description": "Specifies whether to show labels for items with zero value." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.label.textOverflow" + "Description": "Specifies what to do with label texts that overflow the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFunnel.Options.label.visible" + "Description": "Controls the labels' visibility." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.label.wordWrap" + "Description": "Specifies how to wrap label texts if they do not fit into a single line." } } }, "legend": { - "DocID": "dxFunnel.Options.legend", + "Description": "Configures the legend.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.backgroundColor" + "Description": "Colors the legend's background." }, "border": { - "DocID": "BaseLegend.border", + "Description": "Configures the legend's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.border.color" + "Description": "Colors the legend's border." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.cornerRadius" + "Description": "Makes all the legend's corners rounded." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.border.dashStyle" + "Description": "Sets a dash style for the legend's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.opacity" + "Description": "Specifies the transparency of the legend's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseLegend.border.visible" + "Description": "Shows the legend's border." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.width" + "Description": "Specifies the width of the legend's border in pixels." } } }, @@ -16885,97 +16212,91 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.columnCount" + "Description": "Arranges legend items into several columns." }, "columnItemSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.columnItemSpacing" + "Description": "Specifies an empty space between item columns in pixels." }, "customizeHint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxFunnel.Options.legend.customizeHint" + "Description": "Specifies the hint that appears when a user hovers the mouse pointer over a legend item." }, "customizeItems": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxFunnel.Options.legend.customizeItems" + "Description": "Allows you to change the order, text, and visibility of legend items." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxFunnel.Options.legend.customizeText" + "Description": "Customizes the text displayed by legend items." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseLegend.font" + "Description": "Specifies the legend items' font options." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.horizontalAlignment" + "Description": "Along with verticalAlignment, specifies the legend's position." }, "itemsAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.itemsAlignment" + "Description": "Aligns items in the last column or row (depending on the legend's orientation). Applies when legend items are not divided into columns or rows equally." }, "itemTextPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.itemTextPosition" + "Description": "Specifies the text's position relative to the marker in a legend item." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin", + "Description": "Generates an empty space, measured in pixels, around the legend.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.bottom" + "Description": "Specifies the legend's bottom margin in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.left" + "Description": "Specifies the legend's left margin in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.right" + "Description": "Specifies the legend's right margin in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.top" + "Description": "Specifies the legend's top margin in pixels." } } }, @@ -16983,50 +16304,50 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.markerSize" + "Description": "Specifies the marker's size in a legend item in pixels." }, "markerTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxFunnel.Options.legend.markerTemplate" + "Description": "Specifies an SVG element that serves as a custom legend item marker." }, "orientation": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.orientation" + "Description": "Arranges legend items vertically (in a column) or horizontally (in a row). The default value is \"horizontal\" if the legend.horizontalAlignment is \"center\". Otherwise, it is \"vertical\"." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between the legend's left/right border and its items." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between the legend's top/bottom border and its items." }, "rowCount": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.rowCount" + "Description": "Arranges legend items in several rows." }, "rowItemSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.rowItemSpacing" + "Description": "Specifies an empty space between item rows in pixels." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title", + "Description": "Configures the legend title.", "Options": { "font": { "PrimitiveTypes": [ @@ -17035,47 +16356,40 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseLegend.title.font" + "Description": "Specifies the legend title's font options." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.horizontalAlignment" + "Description": "Along with verticalAlignment, specifies the legend title's position." }, "margin": { - "DocID": "BaseLegend.title.margin", + "Description": "Generates space around the legend title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.bottom" + "Description": "Specifies the legend title's bottom margin." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.left" + "Description": "Specifies the legend title's left margin." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.right" + "Description": "Specifies the legend title's right margin." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.top" + "Description": "Specifies the legend title's top margin." } } }, @@ -17083,13 +16397,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the legend title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.subtitle", + "Description": "Configures the legend subtitle. The subtitle appears only if the title is specified.", "Options": { "font": { "PrimitiveTypes": [ @@ -17098,26 +16412,19 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseLegend.title.subtitle.font" + "Description": "Specifies the legend subtitle's font options." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.subtitle.offset" + "Description": "Specifies the distance between the legend's title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.subtitle.text" + "Description": "Specifies the subtitle's text." } } }, @@ -17125,13 +16432,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.text" + "Description": "Specifies the legend title's text." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.verticalAlignment" + "Description": "Specifies the legend title's vertical alignment." } } }, @@ -17139,87 +16446,81 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.verticalAlignment" + "Description": "Along with horizontalAlignment, specifies the legend's position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFunnel.Options.legend.visible" + "Description": "Specifies the legend's visibility." } } }, "loadingIndicator": { - "DocID": "BaseWidget.Options.loadingIndicator", + "Description": "Configures the loading indicator.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.backgroundColor" + "Description": "Colors the background of the loading indicator." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.loadingIndicator.enabled" + "Description": "Specifies whether the loading indicator should be displayed and hidden automatically." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.loadingIndicator.font" + "Description": "Specifies font options for the loading indicator." }, "show": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "BaseWidget.Options.loadingIndicator.show" + "Description": "Allows you to change the loading indicator's visibility." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.text" + "Description": "Specifies the text to be displayed by the loading indicator." } } }, "margin": { - "DocID": "BaseWidget.Options.margin", + "Description": "Generates space around the widget.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.bottom" + "Description": "Specifies the bottom margin of the widget in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.left" + "Description": "Specifies the left margin of the widget in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.right" + "Description": "Specifies the right margin of the widget in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.top" + "Description": "Specifies the top margin of the widget in pixels." } } }, @@ -17227,13 +16528,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.neckHeight" + "Description": "Specifies the ratio between the height of the neck and that of the whole funnel. Accepts values from 0 to 1. Applies only if the algorithm is \"dynamicHeight\"." }, "neckWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFunnel.Options.neckWidth" + "Description": "Specifies the ratio between the width of the neck and that of the whole funnel. Accepts values from 0 to 1. Applies only if the algorithm is \"dynamicHeight\"." }, "onDisposing": { "PrimitiveTypes": [ @@ -17241,7 +16542,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDrawn": { "PrimitiveTypes": [ @@ -17249,7 +16550,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onExported": { "PrimitiveTypes": [ @@ -17257,7 +16558,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -17265,7 +16566,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -17273,7 +16574,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onHoverChanged": { "PrimitiveTypes": [ @@ -17281,7 +16582,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFunnel.Options.onHoverChanged" + "Description": "A function that is executed after the pointer enters or leaves a funnel item." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -17289,7 +16590,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -17297,7 +16598,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -17306,7 +16607,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFunnel.Options.onItemClick" + "Description": "A function that is executed when a funnel item is clicked or tapped." }, "onLegendClick": { "PrimitiveTypes": [ @@ -17315,7 +16616,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFunnel.Options.onLegendClick" + "Description": "A function that is executed when a legend item is clicked or tapped." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -17323,7 +16624,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -17331,7 +16632,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxFunnel.Options.onSelectionChanged" + "Description": "A function that is executed when a funnel item is selected or selection is canceled." }, "palette": { "PrimitiveTypes": [ @@ -17342,58 +16643,58 @@ ], "IsCollection": true, "SingularName": "palette", - "DocID": "dxFunnel.Options.palette" + "Description": "Sets the palette to be used to colorize funnel items." }, "paletteExtensionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.paletteExtensionMode" + "Description": "Specifies what to do with colors in the palette when their number is less than the number of funnel items." }, "pathModified": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "redrawOnResize": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.redrawOnResize" + "Description": "Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates." }, "resolveLabelOverlapping": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.resolveLabelOverlapping" + "Description": "Specifies how item labels should behave when they overlap." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.selectionMode" + "Description": "Specifies whether a single or multiple funnel items can be in the selected state at a time. Assigning \"none\" disables the selection feature." }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, @@ -17401,70 +16702,64 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFunnel.Options.sortData" + "Description": "Specifies whether to sort funnel items." }, "theme": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title", + "Description": "Configures the widget's title.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.title.font" + "Description": "Specifies font options for the title." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.horizontalAlignment" + "Description": "Specifies the title's alignment in a horizontal direction." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin", + "Description": "Generates space around the title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.bottom" + "Description": "Specifies the bottom margin of the title." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.left" + "Description": "Specifies the left margin of the title." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.right" + "Description": "Specifies the right margin of the title." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.top" + "Description": "Specifies the top margin of the title." } } }, @@ -17472,13 +16767,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle", + "Description": "Configures the widget's subtitle.", "Options": { "font": { "PrimitiveTypes": [ @@ -17487,38 +16782,31 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseWidget.Options.title.subtitle.font" + "Description": "Specifies font options for the subtitle." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.subtitle.offset" + "Description": "Specifies the distance between the title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.text" + "Description": "Specifies text for the subtitle." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.textOverflow" + "Description": "Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.wordWrap" + "Description": "Specifies how to wrap the subtitle if it does not fit into a single line." } } }, @@ -17526,69 +16814,69 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.text" + "Description": "Specifies the title's text." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.textOverflow" + "Description": "Specifies what to do with the title when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.verticalAlignment" + "Description": "Specifies the title's alignment in a vertical direction." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.wordWrap" + "Description": "Specifies how to wrap the title if it does not fit into a single line." } } }, "tooltip": { - "DocID": "dxFunnel.Options.tooltip", + "Description": "Configures tooltips - small pop-up rectangles that display information about a data-visualizing widget element being pressed or hovered over with the mouse pointer.", "Options": { "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.arrowLength" + "Description": "Specifies the length of a tooltip's arrow in pixels." }, "border": { - "DocID": "BaseWidget.Options.tooltip.border", + "Description": "Configures a tooltip's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.color" + "Description": "Colors a tooltip's border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.dashStyle" + "Description": "Specifies the dash style of a tooltip's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.opacity" + "Description": "Specifies the transparency of a tooltip's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.border.visible" + "Description": "Specifies whether a tooltip's border is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.width" + "Description": "Specifies the width of a tooltip's border in pixels." } } }, @@ -17596,7 +16884,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.color" + "Description": "Colors all tooltips." }, "container": { "PrimitiveTypes": [ @@ -17604,115 +16892,103 @@ "JQuery", "string" ], - "DocID": "BaseWidget.Options.tooltip.container" + "Description": "Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxFunnel.Options.tooltip.contentTemplate" + "Description": "Specifies a custom template for a tooltip." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.cornerRadius" + "Description": "Makes all the tooltip's corners rounded." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxFunnel.Options.tooltip.customizeTooltip" + "Description": "Customizes a specific tooltip's appearance." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.enabled" + "Description": "Enables tooltips." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.font" + "Description": "Specifies tooltips' font options." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.format" + "Description": "Formats a value before it is displayed it in a tooltip." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.opacity" + "Description": "Specifies tooltips' transparency." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between a tooltip's left/right border and its text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text." }, "shadow": { - "DocID": "BaseWidget.Options.tooltip.shadow", + "Description": "Configures a tooltip's shadow.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.blur" + "Description": "Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.shadow.color" + "Description": "Colors a tooltip's shadow." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetX" + "Description": "Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetY" + "Description": "Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.opacity" + "Description": "Specifies the transparency of a tooltip's shadow." } } }, @@ -17720,7 +16996,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.zIndex" + "Description": "Specifies a tooltip's z-index." } } }, @@ -17728,31 +17004,31 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxFunnel.Options.valueField" + "Description": "Specifies which data source field provides values for funnel items. The value defines a funnel item's area." } } }, "dxGallery": { - "DocID": "dxGallery", + "Description": "The Gallery is a widget that displays a collection of images in a carousel. The widget is supplied with various navigation controls that allow a user to switch between images.", "Module": "ui/gallery", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "animationDuration": { "PrimitiveTypes": [ "number" ], - "DocID": "dxGallery.Options.animationDuration" + "Description": "The time, in milliseconds, spent on slide animation." }, "animationEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGallery.Options.animationEnabled" + "Description": "Specifies whether or not to animate the displayed item change." }, "dataSource": { "PrimitiveTypes": [ @@ -17768,33 +17044,26 @@ "ItemComplexTypes": [ "GalleryItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxGallery.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGallery.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -17803,37 +17072,37 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "indicatorEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGallery.Options.indicatorEnabled" + "Description": "A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator." }, "initialItemWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxGallery.Options.initialItemWidth" + "Description": "Specifies the width of an area used to display a single image." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -17843,44 +17112,44 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxGallery.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "imageAlt": { "PrimitiveTypes": [ "string" ], - "DocID": "dxGalleryItem.imageAlt" + "Description": "Specifies the text passed to the alt attribute of the image markup element." }, "imageSrc": { "PrimitiveTypes": [ "string" ], - "DocID": "dxGalleryItem.imageSrc" + "Description": "Specifies the URL of the image displayed by the item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." } } }, @@ -17889,19 +17158,19 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "loop": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGallery.Options.loop" + "Description": "A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxGallery.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onContentReady": { "PrimitiveTypes": [ @@ -17909,7 +17178,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -17917,7 +17186,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -17925,7 +17194,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -17934,7 +17203,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -17942,7 +17211,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemHold": { "PrimitiveTypes": [ @@ -17950,7 +17219,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -17958,7 +17227,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -17966,7 +17235,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -17974,69 +17243,69 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onSelectionChanged" + "Description": "A function that is executed when a collection item is selected or selection is canceled." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectedIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "dxGallery.Options.selectedIndex" + "Description": "The index of the currently active gallery item." }, "selectedItem": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "CollectionWidget.Options.selectedItem" + "Description": "The selected item object." }, "showIndicator": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGallery.Options.showIndicator" + "Description": "A Boolean value specifying whether or not to display an indicator that points to the selected gallery item." }, "showNavButtons": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGallery.Options.showNavButtons" + "Description": "A Boolean value that specifies the availability of the \"Forward\" and \"Back\" navigation buttons." }, "slideshowDelay": { "PrimitiveTypes": [ "number" ], - "DocID": "dxGallery.Options.slideshowDelay" + "Description": "The time interval in milliseconds, after which the gallery switches to the next item." }, "stretchImages": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGallery.Options.stretchImages" + "Description": "Specifies if the widget stretches images to fit the total gallery width." }, "swipeEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGallery.Options.swipeEnabled" + "Description": "A Boolean value specifying whether or not to allow users to switch between items by swiping." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -18045,37 +17314,37 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." }, "wrapAround": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGallery.Options.wrapAround" + "Description": "Specifies whether or not to display parts of previous and next images along the sides of the current image." } } }, "dxGantt": { - "DocID": "dxGantt", + "Description": "[tags] ctp The Gantt is a widget that displays the task flow and dependencies between tasks. #include common-ctp-note with { component: \"Gantt\" }", "Module": "ui/gantt", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "allowSelection": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.allowSelection" + "Description": "Specifies whether users can select tasks in the Gantt." }, "columns": { "ItemPrimitiveTypes": [ @@ -18085,19 +17354,12 @@ "ItemComplexTypes": [ "TreeListColumn" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "column", - "DocID": "dxGantt.Options.columns" + "Description": "An array of columns in the Gantt." }, "dependencies": { - "DocID": "dxGantt.Options.dependencies", + "Description": "Configures dependencies.", "Options": { "dataSource": { "PrimitiveTypes": [ @@ -18107,15 +17369,8 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxGantt.Options.dependencies.dataSource" + "Description": "Binds the widget to the data source which contains dependencies." }, "keyExpr": { "PrimitiveTypes": [ @@ -18123,7 +17378,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.dependencies.keyExpr" + "Description": "Specifies the data field that provides keys for dependencies." }, "predecessorIdExpr": { "PrimitiveTypes": [ @@ -18131,7 +17386,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.dependencies.predecessorIdExpr" + "Description": "Specifies the data field that provides predecessor IDs." }, "successorIdExpr": { "PrimitiveTypes": [ @@ -18139,7 +17394,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.dependencies.successorIdExpr" + "Description": "Specifies the data field that provides successor IDs." }, "typeExpr": { "PrimitiveTypes": [ @@ -18147,7 +17402,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.dependencies.typeExpr" + "Description": "Specifies the data field that provides dependency types." } } }, @@ -18155,70 +17410,70 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "editing": { - "DocID": "dxGantt.Options.editing", + "Description": "Configures edit options.", "Options": { "allowDependencyAdding": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.editing.allowDependencyAdding" + "Description": "Specifies whether a user can add dependencies." }, "allowDependencyDeleting": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.editing.allowDependencyDeleting" + "Description": "Specifies whether a user can delete dependencies." }, "allowDependencyUpdating": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.editing.allowDependencyUpdating" + "Description": "Specifies whether a user can update dependencies." }, "allowResourceAdding": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.editing.allowResourceAdding" + "Description": "Specifies whether a user can add resources." }, "allowResourceDeleting": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.editing.allowResourceDeleting" + "Description": "Specifies whether a user can delete resources." }, "allowResourceUpdating": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.editing.allowResourceUpdating" + "Description": "Specifies whether a user can update resources." }, "allowTaskAdding": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.editing.allowTaskAdding" + "Description": "Specifies whether a user can add tasks." }, "allowTaskDeleting": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.editing.allowTaskDeleting" + "Description": "Specifies whether a user can delete tasks." }, "allowTaskUpdating": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.editing.allowTaskUpdating" + "Description": "Specifies whether a user can update tasks." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.editing.enabled" + "Description": "Specifies whether a user can edit tasks, resources and dependencies." } } }, @@ -18226,13 +17481,13 @@ "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -18241,19 +17496,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "onContentReady": { "PrimitiveTypes": [ @@ -18261,7 +17516,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -18269,7 +17524,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -18277,7 +17532,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -18285,7 +17540,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -18293,10 +17548,10 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxGantt.Options.onSelectionChanged" + "Description": "A function that is executed after users select a task or clear its selection." }, "resourceAssignments": { - "DocID": "dxGantt.Options.resourceAssignments", + "Description": "Configures resource assignments.", "Options": { "dataSource": { "PrimitiveTypes": [ @@ -18306,15 +17561,8 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxGantt.Options.resourceAssignments.dataSource" + "Description": "Binds the widget to the data source, which contains resource assignments." }, "keyExpr": { "PrimitiveTypes": [ @@ -18322,7 +17570,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.resourceAssignments.keyExpr" + "Description": "Specifies the data field that provides keys for resource assignments." }, "resourceIdExpr": { "PrimitiveTypes": [ @@ -18330,7 +17578,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.resourceAssignments.resourceIdExpr" + "Description": "Specifies the data field that provides resource IDs." }, "taskIdExpr": { "PrimitiveTypes": [ @@ -18338,12 +17586,12 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.resourceAssignments.taskIdExpr" + "Description": "Specifies the data field that provides task IDs." } } }, "resources": { - "DocID": "dxGantt.Options.resources", + "Description": "Configures task resources.", "Options": { "dataSource": { "PrimitiveTypes": [ @@ -18353,15 +17601,8 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxGantt.Options.resources.dataSource" + "Description": "Binds the widget to the data source, which contains resources." }, "keyExpr": { "PrimitiveTypes": [ @@ -18369,7 +17610,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.resources.keyExpr" + "Description": "Specifies the data field that provides keys for resources." }, "textExpr": { "PrimitiveTypes": [ @@ -18377,7 +17618,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.resources.textExpr" + "Description": "Specifies the data field that provides resource texts." } } }, @@ -18385,40 +17626,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxGantt.Options.scaleType" + "Description": "Specifies the zoom level of tasks in the Gantt chart." }, "selectedRowKey": { "PrimitiveTypes": [ "any" ], - "DocID": "dxGantt.Options.selectedRowKey" + "Description": "Allows you to select a row or determine which row is selected." }, "showResources": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.showResources" + "Description": "Specifies whether to display task resources." }, "showRowLines": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxGantt.Options.showRowLines" + "Description": "Specifies whether to show/hide horizontal faint lines that separate tasks." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "taskListWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxGantt.Options.taskListWidth" + "Description": "Specifies the width of the task list in pixels." }, "tasks": { - "DocID": "dxGantt.Options.tasks", + "Description": "Configures tasks.", "Options": { "dataSource": { "PrimitiveTypes": [ @@ -18428,15 +17669,8 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxGantt.Options.tasks.dataSource" + "Description": "Binds the widget to the data source which contains tasks." }, "endExpr": { "PrimitiveTypes": [ @@ -18444,7 +17678,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.tasks.endExpr" + "Description": "Specifies the data field that provides tasks' end dates." }, "keyExpr": { "PrimitiveTypes": [ @@ -18452,7 +17686,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.tasks.keyExpr" + "Description": "Specifies the data field that provides keys for tasks." }, "parentIdExpr": { "PrimitiveTypes": [ @@ -18460,7 +17694,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.tasks.parentIdExpr" + "Description": "Specifies the data field that provides tasks' parent IDs." }, "progressExpr": { "PrimitiveTypes": [ @@ -18468,7 +17702,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.tasks.progressExpr" + "Description": "Specifies the data field that provides tasks' progress." }, "startExpr": { "PrimitiveTypes": [ @@ -18476,7 +17710,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.tasks.startExpr" + "Description": "Specifies the data field that provides tasks' start dates." }, "titleExpr": { "PrimitiveTypes": [ @@ -18484,7 +17718,7 @@ "string" ], "IsFunc": true, - "DocID": "dxGantt.Options.tasks.titleExpr" + "Description": "Specifies the data field that provides task titles." } } }, @@ -18492,13 +17726,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxGantt.Options.taskTitlePosition" + "Description": "Specifies a task's title position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -18507,12 +17741,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxHtmlEditor": { - "DocID": "dxHtmlEditor", + "Description": "[tags] ctp HtmlEditor is a WYSIWYG editor that allows you to format textual and visual content and to output it in HTML or Markdown. HtmlEditor is built on top of and requires Quill. #include common-ctp-note with { component: \"HtmlEditor\" }", "IsTranscludedContent": true, "Module": "ui/html_editor", "IsEditor": true, @@ -18521,38 +17755,38 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "customizeModules": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxHtmlEditor.Options.customizeModules" + "Description": "Allows you to customize Quill and 3rd-party modules." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxHtmlEditor.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -18561,40 +17795,34 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "mediaResizing": { "PrimitiveTypes": [ - "dxHtmlEditorMediaResizing" + "DevExpress.ui.dxHtmlEditorMediaResizing" ], "ComplexTypes": [ "HtmlEditorMediaResizing" ], - "TypeImports": [ - { - "Name": "dxHtmlEditorMediaResizing", - "Path": "ui/html_editor" - } - ], - "DocID": "dxHtmlEditor.Options.mediaResizing" + "Description": "Configures media resizing." }, "mentions": { "ItemPrimitiveTypes": [ @@ -18603,22 +17831,15 @@ "ItemComplexTypes": [ "HtmlEditorMention" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "mention", - "DocID": "dxHtmlEditor.Options.mentions" + "Description": "Configures mentions." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxHtmlEditor.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "onContentReady": { "PrimitiveTypes": [ @@ -18626,7 +17847,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -18634,7 +17855,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onFocusIn": { "PrimitiveTypes": [ @@ -18642,7 +17863,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxHtmlEditor.Options.onFocusIn" + "Description": "A function that is executed when the widget gets focus." }, "onFocusOut": { "PrimitiveTypes": [ @@ -18650,7 +17871,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxHtmlEditor.Options.onFocusOut" + "Description": "A function that is executed when the widget loses focus." }, "onInitialized": { "PrimitiveTypes": [ @@ -18658,7 +17879,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -18666,7 +17887,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onValueChanged": { "PrimitiveTypes": [ @@ -18674,52 +17895,46 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxHtmlEditor.Options.placeholder" + "Description": "Specifies the text displayed when the input field is empty." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "toolbar": { "PrimitiveTypes": [ - "dxHtmlEditorToolbar" + "DevExpress.ui.dxHtmlEditorToolbar" ], "ComplexTypes": [ "HtmlEditorToolbar" ], - "TypeImports": [ - { - "Name": "dxHtmlEditorToolbar", - "Path": "ui/html_editor" - } - ], - "DocID": "dxHtmlEditor.Options.toolbar" + "Description": "Configures the widget's toolbar." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -18727,53 +17942,47 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "Editor.Options.value" + "Description": "Specifies the widget's value." }, "valueType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxHtmlEditor.Options.valueType" + "Description": "Specifies in which markup language the value is stored." }, "variables": { "PrimitiveTypes": [ - "dxHtmlEditorVariables" + "DevExpress.ui.dxHtmlEditorVariables" ], "ComplexTypes": [ "HtmlEditorVariables" ], - "TypeImports": [ - { - "Name": "dxHtmlEditorVariables", - "Path": "ui/html_editor" - } - ], - "DocID": "dxHtmlEditor.Options.variables" + "Description": "Configures variables, which are placeholders to be replaced with actual values when processing text." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -18782,34 +17991,34 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxLinearGauge": { - "DocID": "dxLinearGauge", + "Description": "The LinearGauge is a widget that indicates values on a linear numeric scale.", "Module": "viz/linear_gauge", "Options": { "animation": { - "DocID": "BaseGauge.Options.animation", + "Description": "Specifies animation options.", "Options": { "duration": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.animation.duration" + "Description": "Determines how long animation runs." }, "easing": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.animation.easing" + "Description": "Specifies the animation easing mode." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.animation.enabled" + "Description": "Indicates whether or not animation is enabled." } } }, @@ -18817,40 +18026,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.containerBackgroundColor" + "Description": "Specifies the color of the parent page element." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "export": { - "DocID": "BaseWidget.Options.export", + "Description": "Configures the exporting and printing features.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.backgroundColor" + "Description": "Specifies the color that will fill transparent regions in the resulting file or document." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.enabled" + "Description": "Enables the client-side exporting in the widget." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.fileName" + "Description": "Specifies a default name for the file to which the widget will be exported." }, "formats": { "ItemPrimitiveTypes": [ @@ -18858,112 +18067,106 @@ ], "IsCollection": true, "SingularName": "format", - "DocID": "BaseWidget.Options.export.formats" + "Description": "Specifies a set of export formats." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.export.margin" + "Description": "Adds an empty space around the exported widget; measured in pixels." }, "printingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.printingEnabled" + "Description": "Enables the printing feature in the widget. Applies only if the export.enabled option is true." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "BaseWidget.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." }, "svgToCanvas": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseWidget.Options.export.svgToCanvas" + "Description": "A function that renders SVG markup on the HTML canvas. Required to export custom SVG elements (for example, markerTemplate)." } } }, "geometry": { - "DocID": "dxLinearGauge.Options.geometry", + "Description": "Specifies the options required to set the geometry of the LinearGauge widget.", "Options": { "orientation": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLinearGauge.Options.geometry.orientation" + "Description": "Indicates whether to display the LinearGauge widget vertically or horizontally." } } }, "loadingIndicator": { - "DocID": "BaseGauge.Options.loadingIndicator", + "Description": "Configures the loading indicator.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.backgroundColor" + "Description": "Colors the background of the loading indicator." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.loadingIndicator.font" + "Description": "Specifies font options for the loading indicator." }, "show": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "BaseWidget.Options.loadingIndicator.show" + "Description": "Allows you to change the loading indicator's visibility." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.text" + "Description": "Specifies the text to be displayed by the loading indicator." } } }, "margin": { - "DocID": "BaseWidget.Options.margin", + "Description": "Generates space around the widget.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.bottom" + "Description": "Specifies the bottom margin of the widget in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.left" + "Description": "Specifies the left margin of the widget in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.right" + "Description": "Specifies the right margin of the widget in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.top" + "Description": "Specifies the top margin of the widget in pixels." } } }, @@ -18973,7 +18176,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDrawn": { "PrimitiveTypes": [ @@ -18981,7 +18184,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onExported": { "PrimitiveTypes": [ @@ -18989,7 +18192,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -18997,7 +18200,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -19005,7 +18208,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -19013,7 +18216,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -19021,7 +18224,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -19029,7 +18232,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onTooltipHidden": { "PrimitiveTypes": [ @@ -19037,7 +18240,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseGauge.Options.onTooltipHidden" + "Description": "A function that is executed when a tooltip becomes hidden." }, "onTooltipShown": { "PrimitiveTypes": [ @@ -19045,34 +18248,34 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseGauge.Options.onTooltipShown" + "Description": "A function that is executed when a tooltip appears." }, "pathModified": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "rangeContainer": { - "DocID": "dxLinearGauge.Options.rangeContainer", + "Description": "Specifies gauge range container options.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.rangeContainer.backgroundColor" + "Description": "Specifies a range container's background color." }, "horizontalOrientation": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLinearGauge.Options.rangeContainer.horizontalOrientation" + "Description": "Specifies the orientation of the range container. Applies only if the geometry.orientation option is \"vertical\"." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.rangeContainer.offset" + "Description": "Specifies the offset of the range container from an invisible scale line in pixels." }, "palette": { "PrimitiveTypes": [ @@ -19083,13 +18286,13 @@ ], "IsCollection": true, "SingularName": "palette", - "DocID": "BaseGauge.Options.rangeContainer.palette" + "Description": "Specifies the palette to be used for colorizing ranges in the range container." }, "paletteExtensionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.rangeContainer.paletteExtensionMode" + "Description": "Specifies what to do with colors in the palette when their number is less than the number of ranges in the range container." }, "ranges": { "ItemPrimitiveTypes": [ @@ -19097,25 +18300,25 @@ ], "IsCollection": true, "SingularName": "range", - "DocID": "BaseGauge.Options.rangeContainer.ranges", + "Description": "An array of objects representing ranges contained in the range container.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.rangeContainer.ranges.color" + "Description": "Specifies a color of a range." }, "endValue": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.rangeContainer.ranges.endValue" + "Description": "Specifies an end value of a range." }, "startValue": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.rangeContainer.ranges.startValue" + "Description": "Specifies a start value of a range." } } }, @@ -19123,25 +18326,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxLinearGauge.Options.rangeContainer.verticalOrientation" + "Description": "Specifies the orientation of the range container. Applies only if the geometry.orientation option is \"horizontal\"." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxLinearGauge.Options.rangeContainer.width", + "Description": "Specifies the width of the range container's start and end boundaries in the LinearGauge widget.", "Options": { "end": { "PrimitiveTypes": [ "number" ], - "DocID": "dxLinearGauge.Options.rangeContainer.width.end" + "Description": "Specifies an end width of a range container." }, "start": { "PrimitiveTypes": [ "number" ], - "DocID": "dxLinearGauge.Options.rangeContainer.width.start" + "Description": "Specifies a start width of a range container." } } } @@ -19151,22 +18354,22 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.redrawOnResize" + "Description": "Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scale": { - "DocID": "dxLinearGauge.Options.scale", + "Description": "Specifies the gauge's scale options.", "Options": { "allowDecimals": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.scale.allowDecimals" + "Description": "Specifies whether to allow decimal values on the scale. When false, the scale contains integer values only." }, "customMinorTicks": { "ItemPrimitiveTypes": [ @@ -19174,7 +18377,7 @@ ], "IsCollection": true, "SingularName": "customMinorTick", - "DocID": "BaseGauge.Options.scale.customMinorTicks" + "Description": "Specifies an array of custom minor ticks." }, "customTicks": { "ItemPrimitiveTypes": [ @@ -19182,119 +18385,107 @@ ], "IsCollection": true, "SingularName": "customTick", - "DocID": "BaseGauge.Options.scale.customTicks" + "Description": "Specifies an array of custom major ticks." }, "endValue": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.endValue" + "Description": "Specifies the end value for the scale of the gauge." }, "horizontalOrientation": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLinearGauge.Options.scale.horizontalOrientation" + "Description": "Specifies the orientation of scale ticks. Applies only if the geometry.orientation option is \"vertical\"." }, "label": { - "DocID": "dxLinearGauge.Options.scale.label", + "Description": "Specifies common options for scale labels.", "Options": { "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseGauge.Options.scale.label.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed in scale labels." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseGauge.Options.scale.label.font" + "Description": "Specifies font options for the text displayed in the scale labels of the gauge." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseGauge.Options.scale.label.format" + "Description": "Formats a value before it is displayed in a scale label. Accepts only numeric formats." }, "indentFromTick": { "PrimitiveTypes": [ "number" ], - "DocID": "dxLinearGauge.Options.scale.label.indentFromTick" + "Description": "Specifies the spacing between scale labels and ticks." }, "overlappingBehavior": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.scale.label.overlappingBehavior" + "Description": "Decides how to arrange scale labels when there is not enough space to keep all of them." }, "useRangeColors": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.scale.label.useRangeColors" + "Description": "Specifies whether or not scale labels should be colored similarly to their corresponding ranges in the range container." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.scale.label.visible" + "Description": "Specifies whether or not scale labels are visible on the gauge." } } }, "minorTick": { - "DocID": "BaseGauge.Options.scale.minorTick", + "Description": "Specifies options of the gauge's minor ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.scale.minorTick.color" + "Description": "Specifies the color of the scale's minor ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.minorTick.length" + "Description": "Specifies the length of the scale's minor ticks." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.minorTick.opacity" + "Description": "Specifies the opacity of the scale's minor ticks." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.scale.minorTick.visible" + "Description": "Indicates whether scale minor ticks are visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.minorTick.width" + "Description": "Specifies the width of the scale's minor ticks." } } }, @@ -19302,52 +18493,52 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.minorTickInterval" + "Description": "Specifies an interval between minor ticks." }, "scaleDivisionFactor": { "PrimitiveTypes": [ "number" ], - "DocID": "dxLinearGauge.Options.scale.scaleDivisionFactor" + "Description": "Specifies the minimum distance between two neighboring major ticks in pixels." }, "startValue": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.startValue" + "Description": "Specifies the start value for the scale of the gauge." }, "tick": { - "DocID": "BaseGauge.Options.scale.tick", + "Description": "Specifies options of the gauge's major ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseGauge.Options.scale.tick.color" + "Description": "Specifies the color of the scale's major ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.tick.length" + "Description": "Specifies the length of the scale's major ticks." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.tick.opacity" + "Description": "Specifies the opacity of the scale's major ticks." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseGauge.Options.scale.tick.visible" + "Description": "Indicates whether scale major ticks are visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.tick.width" + "Description": "Specifies the width of the scale's major ticks." } } }, @@ -19355,30 +18546,30 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseGauge.Options.scale.tickInterval" + "Description": "Specifies an interval between major ticks." }, "verticalOrientation": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLinearGauge.Options.scale.verticalOrientation" + "Description": "Specifies the orientation of scale ticks. Applies only if the geometry.orientation option is \"horizontal\"." } } }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, @@ -19386,7 +18577,7 @@ "ComplexTypes": [ "GaugeIndicator" ], - "DocID": "dxLinearGauge.Options.subvalueIndicator" + "Description": "Specifies the appearance options of subvalue indicators." }, "subvalues": { "ItemPrimitiveTypes": [ @@ -19395,70 +18586,64 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "subvalue", - "DocID": "BaseGauge.Options.subvalues" + "Description": "Specifies a set of subvalues to be designated by the subvalue indicators." }, "theme": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title", + "Description": "Configures the widget's title.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.title.font" + "Description": "Specifies font options for the title." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.horizontalAlignment" + "Description": "Specifies the title's alignment in a horizontal direction." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin", + "Description": "Generates space around the title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.bottom" + "Description": "Specifies the bottom margin of the title." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.left" + "Description": "Specifies the left margin of the title." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.right" + "Description": "Specifies the right margin of the title." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.top" + "Description": "Specifies the top margin of the title." } } }, @@ -19466,13 +18651,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle", + "Description": "Configures the widget's subtitle.", "Options": { "font": { "PrimitiveTypes": [ @@ -19481,38 +18666,31 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseWidget.Options.title.subtitle.font" + "Description": "Specifies font options for the subtitle." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.subtitle.offset" + "Description": "Specifies the distance between the title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.text" + "Description": "Specifies text for the subtitle." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.textOverflow" + "Description": "Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.wordWrap" + "Description": "Specifies how to wrap the subtitle if it does not fit into a single line." } } }, @@ -19520,69 +18698,69 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.text" + "Description": "Specifies the title's text." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.textOverflow" + "Description": "Specifies what to do with the title when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.verticalAlignment" + "Description": "Specifies the title's alignment in a vertical direction." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.wordWrap" + "Description": "Specifies how to wrap the title if it does not fit into a single line." } } }, "tooltip": { - "DocID": "BaseGauge.Options.tooltip", + "Description": "Configures tooltips.", "Options": { "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.arrowLength" + "Description": "Specifies the length of a tooltip's arrow in pixels." }, "border": { - "DocID": "BaseWidget.Options.tooltip.border", + "Description": "Configures a tooltip's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.color" + "Description": "Colors a tooltip's border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.dashStyle" + "Description": "Specifies the dash style of a tooltip's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.opacity" + "Description": "Specifies the transparency of a tooltip's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.border.visible" + "Description": "Specifies whether a tooltip's border is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.width" + "Description": "Specifies the width of a tooltip's border in pixels." } } }, @@ -19590,7 +18768,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.color" + "Description": "Colors all tooltips." }, "container": { "PrimitiveTypes": [ @@ -19598,115 +18776,103 @@ "JQuery", "string" ], - "DocID": "BaseWidget.Options.tooltip.container" + "Description": "Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "BaseGauge.Options.tooltip.contentTemplate" + "Description": "Specifies a custom template for a tooltip." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.cornerRadius" + "Description": "Makes all the tooltip's corners rounded." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseGauge.Options.tooltip.customizeTooltip" + "Description": "Allows you to change the appearance of specified tooltips." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.enabled" + "Description": "Enables tooltips." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.font" + "Description": "Specifies tooltips' font options." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.format" + "Description": "Formats a value before it is displayed it in a tooltip." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.opacity" + "Description": "Specifies tooltips' transparency." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between a tooltip's left/right border and its text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text." }, "shadow": { - "DocID": "BaseWidget.Options.tooltip.shadow", + "Description": "Configures a tooltip's shadow.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.blur" + "Description": "Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.shadow.color" + "Description": "Colors a tooltip's shadow." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetX" + "Description": "Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetY" + "Description": "Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.opacity" + "Description": "Specifies the transparency of a tooltip's shadow." } } }, @@ -19714,7 +18880,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.zIndex" + "Description": "Specifies a tooltip's z-index." } } }, @@ -19723,56 +18889,56 @@ "number" ], "IsChangeable": true, - "DocID": "BaseGauge.Options.value" + "Description": "Specifies the main value on a gauge." }, "valueIndicator": { "ComplexTypes": [ "GaugeIndicator" ], - "DocID": "dxLinearGauge.Options.valueIndicator" + "Description": "Specifies the appearance options of the value indicator." } } }, "dxList": { - "DocID": "dxList", + "Description": "The List is a widget that represents a collection of items in a scrollable list.", "Module": "ui/list", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "allowItemDeleting": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.allowItemDeleting" + "Description": "Specifies whether or not an end user can delete list items." }, "allowItemReordering": { "PrimitiveTypes": [ "boolean" ], "IsDeprecated": true, - "DocID": "dxList.Options.allowItemReordering" + "Description": "Use the itemDragging option instead." }, "bounceEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.bounceEnabled" + "Description": "A Boolean value specifying whether to enable or disable the bounce-back effect." }, "collapsibleGroups": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.collapsibleGroups" + "Description": "Specifies whether or not an end-user can collapse groups." }, "dataSource": { "PrimitiveTypes": [ @@ -19788,21 +18954,14 @@ "ItemComplexTypes": [ "ListItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxList.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "displayExpr": { "PrimitiveTypes": [ @@ -19810,32 +18969,32 @@ "string" ], "IsFunc": true, - "DocID": "dxList.Options.displayExpr" + "Description": "Specifies the data field whose values should be displayed. Defaults to \"text\" when the data source contains objects." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "grouped": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.grouped" + "Description": "Specifies whether data items should be grouped." }, "groupTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxList.Options.groupTemplate" + "Description": "Specifies a custom template for group captions." }, "height": { "PrimitiveTypes": [ @@ -19844,52 +19003,46 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "indicateLoading": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.indicateLoading" + "Description": "Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data." }, "itemDeleteMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxList.Options.itemDeleteMode" + "Description": "Specifies the way a user can delete items from the list." }, "itemDragging": { "PrimitiveTypes": [ - "dxSortableOptions" + "DevExpress.ui.dxSortableOptions" ], "ComplexTypes": [ "dxSortableOptions" ], - "TypeImports": [ - { - "Name": "dxSortableOptions", - "Path": "ui/sortable" - } - ], - "DocID": "dxList.Options.itemDragging" + "Description": "Configures item reordering using drag and drop gestures." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -19899,62 +19052,62 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxList.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "badge": { "PrimitiveTypes": [ "string" ], - "DocID": "dxListItem.badge" + "Description": "Specifies the text of a badge displayed for the list item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxListItem.icon" + "Description": "Specifies the list item's icon." }, "key": { "PrimitiveTypes": [ "string" ], - "DocID": "dxListItem.key" + "Description": "Specifies the name of the list items group in a grouped list." }, "showChevron": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxListItem.showChevron" + "Description": "Specifies whether or not to display a chevron for the list item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -19963,7 +19116,7 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "keyExpr": { "PrimitiveTypes": [ @@ -19971,7 +19124,7 @@ "string" ], "IsFunc": true, - "DocID": "CollectionWidget.Options.keyExpr" + "Description": "Specifies the key property that provides key values to access data items. Each key value must be unique." }, "menuItems": { "ItemPrimitiveTypes": [ @@ -19979,20 +19132,20 @@ ], "IsCollection": true, "SingularName": "menuItem", - "DocID": "dxList.Options.menuItems", + "Description": "Specifies the array of items for a context menu called for a list item.", "Options": { "action": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxList.Options.menuItems.action" + "Description": "Holds on a function called when the item is clicked." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxList.Options.menuItems.text" + "Description": "Specifies the menu item text." } } }, @@ -20000,19 +19153,19 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxList.Options.menuMode" + "Description": "Specifies whether an item context menu is shown when a user holds or swipes an item." }, "nextButtonText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxList.Options.nextButtonText" + "Description": "The text displayed on the button used to load the next page from the data source." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidget.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onContentReady": { "PrimitiveTypes": [ @@ -20020,7 +19173,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -20028,7 +19181,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onGroupRendered": { "PrimitiveTypes": [ @@ -20036,7 +19189,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxList.Options.onGroupRendered" + "Description": "A function that is executed when a group element is rendered." }, "onInitialized": { "PrimitiveTypes": [ @@ -20044,7 +19197,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -20053,7 +19206,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxList.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -20061,7 +19214,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxList.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemDeleted": { "PrimitiveTypes": [ @@ -20069,7 +19222,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxList.Options.onItemDeleted" + "Description": "A function that is executed after a list item is deleted from the data source." }, "onItemDeleting": { "PrimitiveTypes": [ @@ -20077,7 +19230,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxList.Options.onItemDeleting" + "Description": "A function that is executed before a collection item is deleted from the data source." }, "onItemHold": { "PrimitiveTypes": [ @@ -20085,7 +19238,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxList.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -20093,7 +19246,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onItemReordered": { "PrimitiveTypes": [ @@ -20101,7 +19254,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxList.Options.onItemReordered" + "Description": "A function that is executed after a list item is moved to another position." }, "onItemSwipe": { "PrimitiveTypes": [ @@ -20109,7 +19262,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxList.Options.onItemSwipe" + "Description": "A function that is executed when a list item is swiped." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -20117,7 +19270,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPageLoading": { "PrimitiveTypes": [ @@ -20125,7 +19278,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxList.Options.onPageLoading" + "Description": "A function that is executed before the next page is loaded." }, "onPullRefresh": { "PrimitiveTypes": [ @@ -20133,7 +19286,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxList.Options.onPullRefresh" + "Description": "A function that is executed when the \"pull to refresh\" gesture is performed. Supported in mobile themes only." }, "onScroll": { "PrimitiveTypes": [ @@ -20141,7 +19294,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxList.Options.onScroll" + "Description": "A function that is executed on each scroll gesture." }, "onSelectAllValueChanged": { "PrimitiveTypes": [ @@ -20149,7 +19302,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxList.Options.onSelectAllValueChanged" + "Description": "A function that is executed when the \"Select All\" check box value is changed. Applies only if the selectionMode is \"all\"." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -20157,131 +19310,123 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onSelectionChanged" + "Description": "A function that is executed when a collection item is selected or selection is canceled." }, "pageLoadingText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxList.Options.pageLoadingText" + "Description": "Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom." }, "pageLoadMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxList.Options.pageLoadMode" + "Description": "Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the \"next\" button is clicked." }, "pulledDownText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxList.Options.pulledDownText" + "Description": "Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold." }, "pullingDownText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxList.Options.pullingDownText" + "Description": "Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold." }, "pullRefreshEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.pullRefreshEnabled" + "Description": "A Boolean value specifying whether or not the widget supports the \"pull down to refresh\" gesture." }, "refreshingText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxList.Options.refreshingText" + "Description": "Specifies the text displayed in the pullDown panel while the list is being refreshed." }, "repaintChangesOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.repaintChangesOnly" + "Description": "Specifies whether to repaint only those elements whose data changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scrollByContent": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.scrollByContent" + "Description": "A Boolean value specifying if the list is scrolled by content." }, "scrollByThumb": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.scrollByThumb" + "Description": "A Boolean value specifying if the list is scrolled using the scrollbar." }, "scrollingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.scrollingEnabled" + "Description": "A Boolean value specifying whether to enable or disable list scrolling." }, "searchEditorOptions": { "PrimitiveTypes": [ - "dxTextBoxOptions" + "DevExpress.ui.dxTextBoxOptions" ], "ComplexTypes": [ "dxTextBoxOptions" ], - "TypeImports": [ - { - "Name": "dxTextBoxOptions", - "Path": "ui/text_box" - } - ], - "DocID": "SearchBoxMixin.Options.searchEditorOptions" + "Description": "Configures the search panel." }, "searchEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "SearchBoxMixin.Options.searchEnabled" + "Description": "Specifies whether the search panel is visible." }, "searchExpr": { "PrimitiveTypes": [ - "Function", - "string" + "Function" ], "ItemPrimitiveTypes": [ - "Function", - "string" + "Function" ], "IsCollection": true, "SingularName": "searchExpr", - "DocID": "SearchBoxMixin.Options.searchExpr" + "Description": "Specifies a data object's field name or an expression whose value is compared to the search string." }, "searchMode": { "PrimitiveTypes": [ "string" ], - "DocID": "SearchBoxMixin.Options.searchMode" + "Description": "Specifies a comparison operation used to search widget items." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "SearchBoxMixin.Options.searchTimeout" + "Description": "Specifies a delay in milliseconds between when a user finishes typing, and the search is executed." }, "searchValue": { "PrimitiveTypes": [ "string" ], - "DocID": "SearchBoxMixin.Options.searchValue" + "Description": "Specifies the current search string." }, "selectAllMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxList.Options.selectAllMode" + "Description": "Specifies the mode in which all items are selected." }, "selectedItemKeys": { "ItemPrimitiveTypes": [ @@ -20290,7 +19435,7 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "selectedItemKey", - "DocID": "CollectionWidget.Options.selectedItemKeys" + "Description": "Specifies an array of currently selected item keys." }, "selectedItems": { "ItemPrimitiveTypes": [ @@ -20299,43 +19444,43 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "selectedItem", - "DocID": "CollectionWidget.Options.selectedItems" + "Description": "An array of currently selected item objects." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxList.Options.selectionMode" + "Description": "Specifies item selection mode." }, "showScrollbar": { "PrimitiveTypes": [ "string" ], - "DocID": "dxList.Options.showScrollbar" + "Description": "Specifies when the widget shows the scrollbar." }, "showSelectionControls": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.showSelectionControls" + "Description": "Specifies whether or not to display controls used to select list items." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "useNativeScrolling": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxList.Options.useNativeScrolling" + "Description": "Specifies whether or not the widget uses native scrolling." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -20344,19 +19489,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxLoadIndicator": { - "DocID": "dxLoadIndicator", + "Description": "The LoadIndicator is a UI element notifying the viewer that a process is in progress.", "Module": "ui/load_indicator", "Options": { "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -20365,19 +19510,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "indicatorSrc": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLoadIndicator.Options.indicatorSrc" + "Description": "Specifies the path to an image used as the indicator." }, "onContentReady": { "PrimitiveTypes": [ @@ -20385,7 +19530,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -20393,7 +19538,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -20401,7 +19546,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -20409,19 +19554,19 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -20430,46 +19575,34 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxLoadPanel": { - "DocID": "dxLoadPanel", + "Description": "The LoadPanel is an overlay widget notifying the viewer that loading is in progress.", "Module": "ui/load_panel", "Options": { "animation": { - "DocID": "dxLoadPanel.Options.animation", + "Description": "Configures widget visibility animations. This object contains two fields: show and hide.", "Options": { "hide": { "PrimitiveTypes": [ - "animationConfig" + "DevExpress.animationConfig" ], "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "animationConfig", - "Path": "animation/fx" - } - ], - "DocID": "dxLoadPanel.Options.animation.hide" + "Description": "An object that defines the animation options used when the widget is being hidden." }, "show": { "PrimitiveTypes": [ - "animationConfig" + "DevExpress.animationConfig" ], "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "animationConfig", - "Path": "animation/fx" - } - ], - "DocID": "dxLoadPanel.Options.animation.show" + "Description": "An object that defines the animation options used when the widget is being shown." } } }, @@ -20479,7 +19612,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxOverlay.Options.closeOnOutsideClick" + "Description": "Specifies whether to close the widget if a user clicks outside it." }, "container": { "PrimitiveTypes": [ @@ -20487,31 +19620,31 @@ "JQuery", "string" ], - "DocID": "dxLoadPanel.Options.container" + "Description": "Specifies the widget's container." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxOverlay.Options.deferRendering" + "Description": "Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately." }, "delay": { "PrimitiveTypes": [ "number" ], - "DocID": "dxLoadPanel.Options.delay" + "Description": "The delay in milliseconds after which the load panel is displayed." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLoadPanel.Options.focusStateEnabled" + "Description": "Specifies whether or not the widget can be focused." }, "height": { "PrimitiveTypes": [ @@ -20520,25 +19653,25 @@ "string" ], "IsFunc": true, - "DocID": "dxLoadPanel.Options.height" + "Description": "Specifies the widget's height in pixels." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "indicatorSrc": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLoadPanel.Options.indicatorSrc" + "Description": "A URL pointing to an image to be used as a load indicator." }, "maxHeight": { "PrimitiveTypes": [ @@ -20547,7 +19680,7 @@ "string" ], "IsFunc": true, - "DocID": "dxLoadPanel.Options.maxHeight" + "Description": "Specifies the maximum height the widget can reach while resizing." }, "maxWidth": { "PrimitiveTypes": [ @@ -20556,13 +19689,13 @@ "string" ], "IsFunc": true, - "DocID": "dxLoadPanel.Options.maxWidth" + "Description": "Specifies the maximum width the widget can reach while resizing." }, "message": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLoadPanel.Options.message" + "Description": "Specifies the text displayed in the load panel. Ignored in the Material Design theme." }, "minHeight": { "PrimitiveTypes": [ @@ -20571,7 +19704,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.minHeight" + "Description": "Specifies the minimum height the widget can reach while resizing." }, "minWidth": { "PrimitiveTypes": [ @@ -20580,7 +19713,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.minWidth" + "Description": "Specifies the minimum width the widget can reach while resizing." }, "onContentReady": { "PrimitiveTypes": [ @@ -20588,7 +19721,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -20596,7 +19729,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onHidden": { "PrimitiveTypes": [ @@ -20604,7 +19737,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onHidden" + "Description": "A function that is executed after the widget is hidden." }, "onHiding": { "PrimitiveTypes": [ @@ -20612,7 +19745,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onHiding" + "Description": "A function that is executed before the widget is hidden." }, "onInitialized": { "PrimitiveTypes": [ @@ -20620,7 +19753,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -20628,7 +19761,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onShowing": { "PrimitiveTypes": [ @@ -20636,7 +19769,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onShowing" + "Description": "A function that is executed before the widget is displayed." }, "onShown": { "PrimitiveTypes": [ @@ -20644,7 +19777,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onShown" + "Description": "A function that is executed after the widget is displayed." }, "position": { "PrimitiveTypes": [ @@ -20655,53 +19788,46 @@ "ComplexTypes": [ "PositionConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsFunc": true, "IsChangeable": true, - "DocID": "dxLoadPanel.Options.position" + "Description": "Positions the widget." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "shading": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxOverlay.Options.shading" + "Description": "Specifies whether to shade the background when the widget is active." }, "shadingColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLoadPanel.Options.shadingColor" + "Description": "Specifies the shading color. Applies only if shading is enabled." }, "showIndicator": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLoadPanel.Options.showIndicator" + "Description": "A Boolean value specifying whether or not to show a load indicator." }, "showPane": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLoadPanel.Options.showPane" + "Description": "A Boolean value specifying whether or not to show the pane behind the load indicator." }, "visible": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxOverlay.Options.visible" + "Description": "A Boolean value specifying whether or not the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -20710,12 +19836,12 @@ "string" ], "IsFunc": true, - "DocID": "dxLoadPanel.Options.width" + "Description": "Specifies the widget's width in pixels." } } }, "dxLookup": { - "DocID": "dxLookup", + "Description": "The Lookup is a widget that allows an end user to search for an item in a collection shown in a drop-down menu.", "Module": "ui/lookup", "IsEditor": true, "Options": { @@ -20723,16 +19849,16 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "animation": { - "DocID": "dxLookup.Options.animation", + "Description": "Configures widget visibility animations. This object contains two fields: show and hide.", "Options": { "hide": { "PrimitiveTypes": [ @@ -20741,14 +19867,7 @@ "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxLookup.Options.animation.hide" + "Description": "An object that defines the animation options used when the widget is being hidden." }, "show": { "PrimitiveTypes": [ @@ -20757,14 +19876,7 @@ "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxLookup.Options.animation.show" + "Description": "An object that defines the animation options used when the widget is being shown." } } }, @@ -20772,31 +19884,31 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.applyButtonText" + "Description": "The text displayed on the Apply button." }, "applyValueMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.applyValueMode" + "Description": "Specifies the way an end-user applies the selected value." }, "cancelButtonText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.cancelButtonText" + "Description": "The text displayed on the Cancel button." }, "cleanSearchOnOpening": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.cleanSearchOnOpening" + "Description": "Specifies whether or not the widget cleans the search box when the popup window is displayed." }, "clearButtonText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.clearButtonText" + "Description": "The text displayed on the Clear button." }, "closeOnOutsideClick": { "PrimitiveTypes": [ @@ -20804,7 +19916,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxLookup.Options.closeOnOutsideClick" + "Description": "Specifies whether to close the drop-down menu if a user clicks outside it." }, "dataSource": { "PrimitiveTypes": [ @@ -20816,27 +19928,20 @@ "DevExpress.ui.CollectionWidgetItem", "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "DataExpressionMixin.Options.dataSource" + "Description": "Binds the widget to data." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.deferRendering" + "Description": "Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "displayExpr": { "PrimitiveTypes": [ @@ -20844,52 +19949,52 @@ "string" ], "IsFunc": true, - "DocID": "DataExpressionMixin.Options.displayExpr" + "Description": "Specifies the data field whose values should be displayed." }, "displayValue": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxDropDownList.Options.displayValue" + "Description": "Returns the value currently displayed by the widget." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "fieldTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxLookup.Options.fieldTemplate" + "Description": "Specifies a custom template for the input field." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "fullScreen": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.fullScreen" + "Description": "A Boolean value specifying whether or not to display the lookup in full-screen mode." }, "grouped": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.grouped" + "Description": "A Boolean value specifying whether or not to group widget items." }, "groupTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxLookup.Options.groupTemplate" + "Description": "Specifies a custom template for group captions." }, "height": { "PrimitiveTypes": [ @@ -20898,37 +20003,37 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "inputAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTextEditor.Options.inputAttr" + "Description": "Specifies the attributes to be passed on to the underlying HTML element." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "itemCenteringEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.itemCenteringEnabled" + "Description": "" }, "items": { "ItemPrimitiveTypes": [ @@ -20936,38 +20041,38 @@ ], "IsCollection": true, "SingularName": "item", - "DocID": "DataExpressionMixin.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -20976,31 +20081,31 @@ "any" ], "IsTemplate": true, - "DocID": "DataExpressionMixin.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "minSearchLength": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDropDownList.Options.minSearchLength" + "Description": "The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "nextButtonText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.nextButtonText" + "Description": "The text displayed on the button used to load the next page from the data source." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownList.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onClosed": { "PrimitiveTypes": [ @@ -21008,7 +20113,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onClosed" + "Description": "A function that is executed once the drop-down editor is closed." }, "onContentReady": { "PrimitiveTypes": [ @@ -21016,7 +20121,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -21024,7 +20129,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -21032,7 +20137,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -21040,7 +20145,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownList.Options.onItemClick" + "Description": "A function that is executed when a list item is clicked or tapped." }, "onOpened": { "PrimitiveTypes": [ @@ -21048,7 +20153,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onOpened" + "Description": "A function that is executed once the drop-down editor is opened." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -21056,7 +20161,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPageLoading": { "PrimitiveTypes": [ @@ -21064,7 +20169,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxLookup.Options.onPageLoading" + "Description": "A function that is executed before the next page is loaded." }, "onPullRefresh": { "PrimitiveTypes": [ @@ -21072,7 +20177,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxLookup.Options.onPullRefresh" + "Description": "A function that is executed when the \"pull to refresh\" gesture is performed on the drop-down item list. Supported in mobile themes only." }, "onScroll": { "PrimitiveTypes": [ @@ -21080,7 +20185,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxLookup.Options.onScroll" + "Description": "A function that is executed on each scroll gesture performed on the drop-down item list." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -21088,7 +20193,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownList.Options.onSelectionChanged" + "Description": "A function that is executed when a list item is selected or selection is canceled." }, "onTitleRendered": { "PrimitiveTypes": [ @@ -21096,7 +20201,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxLookup.Options.onTitleRendered" + "Description": "A function that is executed when the drop-down list's title is rendered." }, "onValueChanged": { "PrimitiveTypes": [ @@ -21104,32 +20209,32 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxLookup.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "opened": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxDropDownEditor.Options.opened" + "Description": "Specifies whether or not the drop-down editor is displayed." }, "pageLoadingText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.pageLoadingText" + "Description": "Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom." }, "pageLoadMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.pageLoadMode" + "Description": "Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the \"next\" button is clicked." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.placeholder" + "Description": "The text displayed by the widget when nothing is selected." }, "popupHeight": { "PrimitiveTypes": [ @@ -21138,7 +20243,7 @@ "string" ], "IsFunc": true, - "DocID": "dxLookup.Options.popupHeight" + "Description": "Specifies the popup element's height. Applies only if fullScreen is false." }, "popupWidth": { "PrimitiveTypes": [ @@ -21147,176 +20252,168 @@ "string" ], "IsFunc": true, - "DocID": "dxLookup.Options.popupWidth" + "Description": "Specifies the popup element's width. Applies only if fullScreen is false." }, "position": { "PrimitiveTypes": [ - "positionConfig" + "DevExpress.positionConfig" ], "ComplexTypes": [ "PositionConfig" ], - "TypeImports": [ - { - "Name": "positionConfig", - "Path": "animation/position" - } - ], - "DocID": "dxLookup.Options.position" + "Description": "An object defining widget positioning options." }, "pulledDownText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.pulledDownText" + "Description": "Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold." }, "pullingDownText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.pullingDownText" + "Description": "Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold." }, "pullRefreshEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.pullRefreshEnabled" + "Description": "A Boolean value specifying whether or not the widget supports the \"pull down to refresh\" gesture." }, "refreshingText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.refreshingText" + "Description": "Specifies the text displayed in the pullDown panel while the widget is being refreshed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "searchEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.searchEnabled" + "Description": "Specifies whether the search box is visible." }, "searchExpr": { "PrimitiveTypes": [ - "Function", - "string" + "Function" ], "ItemPrimitiveTypes": [ - "Function", - "string" + "Function" ], "IsCollection": true, "SingularName": "searchExpr", - "DocID": "dxDropDownList.Options.searchExpr" + "Description": "Specifies the name of a data source item field or an expression whose value is compared to the search criterion." }, "searchMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownList.Options.searchMode" + "Description": "Specifies a comparison operation used to search widget items." }, "searchPlaceholder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.searchPlaceholder" + "Description": "The text that is provided as a hint in the lookup's search bar." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDropDownList.Options.searchTimeout" + "Description": "Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed." }, "selectedItem": { "PrimitiveTypes": [ "any" ], "IsReadonly": true, - "DocID": "dxDropDownList.Options.selectedItem" + "Description": "Gets the currently selected item." }, "shading": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.shading" + "Description": "Specifies whether to shade the container when the lookup is active. Applies only if usePopover is false." }, "showCancelButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.showCancelButton" + "Description": "Specifies whether to display the Cancel button in the lookup window." }, "showClearButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.showClearButton" + "Description": "Specifies whether or not to display the Clear button in the lookup window." }, "showDataBeforeSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownList.Options.showDataBeforeSearch" + "Description": "Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value." }, "showPopupTitle": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.showPopupTitle" + "Description": "A Boolean value specifying whether or not to display the title in the popup window." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.stylingMode" + "Description": "Specifies how the widget's text field is styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "text": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxTextEditor.Options.text" + "Description": "The read-only option that holds the text displayed by the widget input element." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "dxLookup.Options.title" + "Description": "The title of the lookup window." }, "titleTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxLookup.Options.titleTemplate" + "Description": "Specifies a custom template for the title." }, "useNativeScrolling": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.useNativeScrolling" + "Description": "Specifies whether or not the widget uses native scrolling." }, "usePopover": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxLookup.Options.usePopover" + "Description": "Specifies whether or not to show lookup contents in a Popover widget." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -21324,32 +20421,32 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "dxDropDownList.Options.value" + "Description": "Specifies the currently selected value. May be an object if dataSource contains objects and valueExpr is not set." }, "valueChangeEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownList.Options.valueChangeEvent" + "Description": "Specifies the DOM events after which the widget's value should be updated." }, "valueExpr": { "PrimitiveTypes": [ @@ -21357,13 +20454,13 @@ "string" ], "IsFunc": true, - "DocID": "DataExpressionMixin.Options.valueExpr" + "Description": "Specifies which data field provides unique values to the widget's value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -21372,37 +20469,37 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." }, "wrapItemText": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownList.Options.wrapItemText" + "Description": "Specifies whether text that exceeds the drop-down list width should be wrapped." } } }, "dxMap": { - "DocID": "dxMap", + "Description": "The Map is an interactive widget that displays a geographic map with markers and routes.", "Module": "ui/map", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "autoAdjust": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMap.Options.autoAdjust" + "Description": "Specifies whether the widget automatically adjusts center and zoom option values when adding a new marker or route, or if a new widget contains markers or routes by default." }, "center": { "PrimitiveTypes": [ @@ -21414,19 +20511,19 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "center", - "DocID": "dxMap.Options.center", + "Description": "An object, a string, or an array specifying which part of the map is displayed at the widget's center using coordinates. The widget can change this value if autoAdjust is enabled.", "Options": { "lat": { "PrimitiveTypes": [ "number" ], - "DocID": "MapLocation.lat" + "Description": "The latitude location of the widget." }, "lng": { "PrimitiveTypes": [ "number" ], - "DocID": "MapLocation.lng" + "Description": "The longitude location of the widget." } } }, @@ -21434,25 +20531,25 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMap.Options.controls" + "Description": "Specifies whether or not map widget controls are available." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMap.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -21461,43 +20558,43 @@ "string" ], "IsFunc": true, - "DocID": "dxMap.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "key": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMap.Options.key", + "Description": "A key used to authenticate the application within the required map provider.", "Options": { "bing": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMap.Options.key.bing" + "Description": "A key used to authenticate the application within the \"Bing\" map provider." }, "google": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMap.Options.key.google" + "Description": "A key used to authenticate the application within the \"Google\" map provider." }, "googleStatic": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMap.Options.key.googleStatic" + "Description": "A key used to authenticate the application within the \"Google Static\" map provider." } } }, @@ -21505,7 +20602,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxMap.Options.markerIconSrc" + "Description": "A URL pointing to the custom icon to be used for map markers." }, "markers": { "ItemPrimitiveTypes": [ @@ -21514,13 +20611,13 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "marker", - "DocID": "dxMap.Options.markers", + "Description": "An array of markers displayed on a map.", "Options": { "iconSrc": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMap.Options.markers.iconSrc" + "Description": "A URL pointing to the custom icon to be used for the marker." }, "location": { "PrimitiveTypes": [ @@ -21531,19 +20628,19 @@ ], "IsCollection": true, "SingularName": "location", - "DocID": "dxMap.Options.markers.location", + "Description": "Specifies the marker location.", "Options": { "lat": { "PrimitiveTypes": [ "number" ], - "DocID": "MapLocation.lat" + "Description": "The latitude location of the widget." }, "lng": { "PrimitiveTypes": [ "number" ], - "DocID": "MapLocation.lng" + "Description": "The longitude location of the widget." } } }, @@ -21553,25 +20650,25 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxMap.Options.markers.onClick" + "Description": "A callback function performed when the marker is clicked." }, "tooltip": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMap.Options.markers.tooltip", + "Description": "A tooltip to be used for the marker.", "Options": { "isShown": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMap.Options.markers.tooltip.isShown" + "Description": "Specifies whether a tooltip is visible by default or not." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMap.Options.markers.tooltip.text" + "Description": "Specifies the tooltip text." } } } @@ -21584,7 +20681,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxMap.Options.onClick" + "Description": "A function that is executed when any location on the map is clicked or tapped." }, "onDisposing": { "PrimitiveTypes": [ @@ -21592,7 +20689,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -21600,7 +20697,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onMarkerAdded": { "PrimitiveTypes": [ @@ -21608,7 +20705,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxMap.Options.onMarkerAdded" + "Description": "A function that is executed when a marker is created on the map." }, "onMarkerRemoved": { "PrimitiveTypes": [ @@ -21616,7 +20713,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxMap.Options.onMarkerRemoved" + "Description": "A function that is executed when a marker is removed from the map." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -21624,7 +20721,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onReady": { "PrimitiveTypes": [ @@ -21632,7 +20729,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxMap.Options.onReady" + "Description": "A function that is executed when the map is ready." }, "onRouteAdded": { "PrimitiveTypes": [ @@ -21640,7 +20737,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxMap.Options.onRouteAdded" + "Description": "A function that is executed when a route is created on the map." }, "onRouteRemoved": { "PrimitiveTypes": [ @@ -21648,13 +20745,13 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxMap.Options.onRouteRemoved" + "Description": "A function that is executed when a route is removed from the map." }, "provider": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMap.Options.provider" + "Description": "The name of the current map data provider." }, "routes": { "ItemPrimitiveTypes": [ @@ -21663,13 +20760,13 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "route", - "DocID": "dxMap.Options.routes", + "Description": "An array of routes shown on the map.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMap.Options.routes.color" + "Description": "Specifies the color of the line displaying the route." }, "locations": { "ItemPrimitiveTypes": [ @@ -21677,19 +20774,19 @@ ], "IsCollection": true, "SingularName": "location", - "DocID": "dxMap.Options.routes.locations", + "Description": "Contains an array of objects making up the route.", "Options": { "lat": { "PrimitiveTypes": [ "number" ], - "DocID": "MapLocation.lat" + "Description": "The latitude location of the widget." }, "lng": { "PrimitiveTypes": [ "number" ], - "DocID": "MapLocation.lng" + "Description": "The longitude location of the widget." } } }, @@ -21697,19 +20794,19 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxMap.Options.routes.mode" + "Description": "Specifies a transportation mode to be used in the displayed route." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxMap.Options.routes.opacity" + "Description": "Specifies the opacity of the line displaying the route." }, "weight": { "PrimitiveTypes": [ "number" ], - "DocID": "dxMap.Options.routes.weight" + "Description": "Specifies the thickness of the line displaying the route in pixels." } } }, @@ -21717,25 +20814,25 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMap.Options.type" + "Description": "The type of a map to display." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -21744,41 +20841,41 @@ "string" ], "IsFunc": true, - "DocID": "dxMap.Options.width" + "Description": "Specifies the widget's width." }, "zoom": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "dxMap.Options.zoom" + "Description": "The map's zoom level. The widget can change this value if autoAdjust is enabled." } } }, "dxMenu": { - "DocID": "dxMenu", + "Description": "The Menu widget is a panel with clickable items. A click on an item opens a drop-down menu, which can contain several submenus.", "Module": "ui/menu", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBase.Options.activeStateEnabled" + "Description": "A Boolean value specifying whether or not the widget changes its state when interacting with a user." }, "adaptivityEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenu.Options.adaptivityEnabled" + "Description": "Specifies whether adaptive widget rendering is enabled on small screens. Applies only if the orientation is \"horizontal\"." }, "animation": { - "DocID": "dxMenuBase.Options.animation", + "Description": "Configures widget visibility animations. This object contains two fields: show and hide.", "Options": { "hide": { "PrimitiveTypes": [ @@ -21787,14 +20884,7 @@ "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxMenuBase.Options.animation.hide" + "Description": "An object that defines the animation options used when the widget is being hidden." }, "show": { "PrimitiveTypes": [ @@ -21803,14 +20893,7 @@ "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxMenuBase.Options.animation.show" + "Description": "An object that defines the animation options used when the widget is being shown." } } }, @@ -21818,7 +20901,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBase.Options.cssClass" + "Description": "Specifies the name of the CSS class to be applied to the root menu level and all submenus." }, "dataSource": { "PrimitiveTypes": [ @@ -21832,21 +20915,14 @@ "ItemComplexTypes": [ "MenuItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxMenu.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "disabledExpr": { "PrimitiveTypes": [ @@ -21854,7 +20930,7 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.disabledExpr" + "Description": "Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled." }, "displayExpr": { "PrimitiveTypes": [ @@ -21862,19 +20938,19 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.displayExpr" + "Description": "Specifies the data field whose values should be displayed." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "HierarchicalCollectionWidget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -21883,25 +20959,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hideSubmenuOnMouseLeave": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenu.Options.hideSubmenuOnMouseLeave" + "Description": "Specifies whether or not the submenu is hidden when the mouse pointer leaves it." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "HierarchicalCollectionWidget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "items": { "ItemPrimitiveTypes": [ @@ -21910,17 +20986,10 @@ "ItemComplexTypes": [ "MenuItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxMenu.Options.items" + "Description": "Holds an array of menu items." }, "itemsExpr": { "PrimitiveTypes": [ @@ -21928,14 +20997,14 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.itemsExpr" + "Description": "Specifies which data field contains nested items." }, "itemTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "onContentReady": { "PrimitiveTypes": [ @@ -21943,7 +21012,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -21951,7 +21020,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -21959,7 +21028,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -21968,7 +21037,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -21976,7 +21045,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemRendered": { "PrimitiveTypes": [ @@ -21984,7 +21053,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -21992,7 +21061,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -22000,7 +21069,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onSelectionChanged" + "Description": "A function that is executed when a collection item is selected or selection is canceled." }, "onSubmenuHidden": { "PrimitiveTypes": [ @@ -22008,7 +21077,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxMenu.Options.onSubmenuHidden" + "Description": "A function that is executed after a submenu is hidden." }, "onSubmenuHiding": { "PrimitiveTypes": [ @@ -22016,7 +21085,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxMenu.Options.onSubmenuHiding" + "Description": "A function that is executed before a submenu is hidden." }, "onSubmenuShowing": { "PrimitiveTypes": [ @@ -22024,7 +21093,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxMenu.Options.onSubmenuShowing" + "Description": "A function that is executed before a submenu is displayed." }, "onSubmenuShown": { "PrimitiveTypes": [ @@ -22032,25 +21101,25 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxMenu.Options.onSubmenuShown" + "Description": "A function that is executed after a submenu is displayed." }, "orientation": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMenu.Options.orientation" + "Description": "Specifies whether the menu has horizontal or vertical orientation." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectByClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBase.Options.selectByClick" + "Description": "Specifies whether or not an item becomes selected if a user clicks it." }, "selectedExpr": { "PrimitiveTypes": [ @@ -22058,44 +21127,44 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.selectedExpr" + "Description": "Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected." }, "selectedItem": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "CollectionWidget.Options.selectedItem" + "Description": "The selected item object." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBase.Options.selectionMode" + "Description": "Specifies the selection mode supported by the menu." }, "showFirstSubmenuMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMenu.Options.showFirstSubmenuMode", + "Description": "Specifies options for showing and hiding the first level submenu.", "Options": { "delay": { "PrimitiveTypes": [ "number" ], - "DocID": "dxMenu.Options.showFirstSubmenuMode.delay", + "Description": "Specifies the delay in submenu showing and hiding.", "Options": { "hide": { "PrimitiveTypes": [ "number" ], - "DocID": "dxMenu.Options.showFirstSubmenuMode.delay.hide" + "Description": "The time span after which the submenu is hidden." }, "show": { "PrimitiveTypes": [ "number" ], - "DocID": "dxMenu.Options.showFirstSubmenuMode.delay.show" + "Description": "The time span after which the submenu is shown." } } }, @@ -22103,7 +21172,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxMenu.Options.showFirstSubmenuMode.name" + "Description": "Specifies the mode name." } } }, @@ -22111,25 +21180,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBase.Options.showSubmenuMode", + "Description": "Specifies options of submenu showing and hiding.", "Options": { "delay": { "PrimitiveTypes": [ "number" ], - "DocID": "dxMenuBase.Options.showSubmenuMode.delay", + "Description": "Specifies the delay of submenu show and hiding.", "Options": { "hide": { "PrimitiveTypes": [ "number" ], - "DocID": "dxMenuBase.Options.showSubmenuMode.delay.hide" + "Description": "The time span after which the submenu is hidden." }, "show": { "PrimitiveTypes": [ "number" ], - "DocID": "dxMenuBase.Options.showSubmenuMode.delay.show" + "Description": "The time span after which the submenu is shown." } } }, @@ -22137,7 +21206,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBase.Options.showSubmenuMode.name" + "Description": "Specifies the mode name." } } }, @@ -22145,19 +21214,19 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxMenu.Options.submenuDirection" + "Description": "Specifies the direction at which the submenus are displayed." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -22166,31 +21235,31 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxMultiView": { - "DocID": "dxMultiView", + "Description": "The MultiView is a widget that contains several views. An end user navigates through the views by swiping them in the horizontal direction.", "Module": "ui/multi_view", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "animationEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMultiView.Options.animationEnabled" + "Description": "Specifies whether or not to animate the displayed item change." }, "dataSource": { "PrimitiveTypes": [ @@ -22206,39 +21275,32 @@ "ItemComplexTypes": [ "MultiViewItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxMultiView.Options.dataSource" + "Description": "Binds the widget to data." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMultiView.Options.deferRendering" + "Description": "Specifies whether to render the view's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMultiView.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -22247,25 +21309,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -22275,32 +21337,32 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxMultiView.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." } } }, @@ -22309,19 +21371,19 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "loop": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMultiView.Options.loop" + "Description": "A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidget.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onContentReady": { "PrimitiveTypes": [ @@ -22329,7 +21391,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -22337,7 +21399,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -22345,7 +21407,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -22354,7 +21416,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -22362,7 +21424,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemHold": { "PrimitiveTypes": [ @@ -22370,7 +21432,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -22378,7 +21440,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -22386,7 +21448,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -22394,45 +21456,45 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onSelectionChanged" + "Description": "A function that is executed when a collection item is selected or selection is canceled." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectedIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "dxMultiView.Options.selectedIndex" + "Description": "The index of the currently displayed item." }, "selectedItem": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "CollectionWidget.Options.selectedItem" + "Description": "The selected item object." }, "swipeEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMultiView.Options.swipeEnabled" + "Description": "A Boolean value specifying whether or not to allow users to change the selected index by swiping." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -22441,19 +21503,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxNavBar": { - "DocID": "dxNavBar", + "Description": "The NavBar is a widget that navigates the application views.", "Module": "ui/nav_bar", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "dataSource": { "PrimitiveTypes": [ @@ -22469,33 +21531,26 @@ "ItemComplexTypes": [ "TabsItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxTabs.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabs.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -22504,25 +21559,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabs.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -22532,50 +21587,50 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxTabs.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "badge": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabsItem.badge" + "Description": "Specifies a badge text for the tab." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabsItem.icon" + "Description": "Specifies the icon to be displayed on the tab." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -22584,7 +21639,7 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "keyExpr": { "PrimitiveTypes": [ @@ -22592,13 +21647,13 @@ "string" ], "IsFunc": true, - "DocID": "CollectionWidget.Options.keyExpr" + "Description": "Specifies the key property that provides key values to access data items. Each key value must be unique." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidget.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onContentReady": { "PrimitiveTypes": [ @@ -22606,7 +21661,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -22614,7 +21669,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -22622,7 +21677,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -22631,7 +21686,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -22639,7 +21694,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemHold": { "PrimitiveTypes": [ @@ -22647,7 +21702,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -22655,7 +21710,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -22663,7 +21718,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -22671,39 +21726,39 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onSelectionChanged" + "Description": "A function that is executed when a collection item is selected or selection is canceled." }, "repaintChangesOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabs.Options.repaintChangesOnly" + "Description": "Specifies whether to repaint only those elements whose data changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scrollByContent": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxNavBar.Options.scrollByContent" + "Description": "Specifies whether or not an end-user can scroll tabs by swiping." }, "selectedIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "CollectionWidget.Options.selectedIndex" + "Description": "The index of the currently selected widget item." }, "selectedItem": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "CollectionWidget.Options.selectedItem" + "Description": "The selected item object." }, "selectedItemKeys": { "ItemPrimitiveTypes": [ @@ -22712,7 +21767,7 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "selectedItemKey", - "DocID": "CollectionWidget.Options.selectedItemKeys" + "Description": "Specifies an array of currently selected item keys." }, "selectedItems": { "ItemPrimitiveTypes": [ @@ -22723,25 +21778,25 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "selectedItem", - "DocID": "dxTabs.Options.selectedItems" + "Description": "An array of currently selected item objects." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabs.Options.selectionMode" + "Description": "Specifies whether the widget enables an end-user to select only a single item or multiple items." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -22750,12 +21805,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxNumberBox": { - "DocID": "dxNumberBox", + "Description": "The NumberBox is a widget that displays a numeric value and allows a user to modify it by typing in a value, and incrementing or decrementing it using the keyboard or mouse.", "Module": "ui/number_box", "IsEditor": true, "Options": { @@ -22763,13 +21818,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "buttons": { "ItemPrimitiveTypes": [ @@ -22779,50 +21834,37 @@ "ItemComplexTypes": [ "TextEditorButton" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "button", - "DocID": "dxNumberBox.Options.buttons" + "Description": "Allows you to add custom buttons to the input text field." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxNumberBox.Options.format" + "Description": "Specifies the value's display format and controls user input accordingly." }, "height": { "PrimitiveTypes": [ @@ -22831,61 +21873,61 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "inputAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTextEditor.Options.inputAttr" + "Description": "Specifies the attributes to be passed on to the underlying HTML element." }, "invalidValueMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxNumberBox.Options.invalidValueMessage" + "Description": "Specifies the text of the message displayed if the specified value is not a number." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "max": { "PrimitiveTypes": [ "number" ], - "DocID": "dxNumberBox.Options.max" + "Description": "The maximum value accepted by the number box." }, "min": { "PrimitiveTypes": [ "number" ], - "DocID": "dxNumberBox.Options.min" + "Description": "The minimum value accepted by the number box." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxNumberBox.Options.mode" + "Description": "Specifies the value to be passed to the type attribute of the underlying `` element." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "onChange": { "PrimitiveTypes": [ @@ -22893,7 +21935,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onChange" + "Description": "A function that is executed when the widget loses focus after the text field's content was changed using the keyboard." }, "onContentReady": { "PrimitiveTypes": [ @@ -22901,7 +21943,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onCopy": { "PrimitiveTypes": [ @@ -22909,7 +21951,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCopy" + "Description": "A function that is executed when the widget's input has been copied." }, "onCut": { "PrimitiveTypes": [ @@ -22917,7 +21959,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCut" + "Description": "A function that is executed when the widget's input has been cut." }, "onDisposing": { "PrimitiveTypes": [ @@ -22925,7 +21967,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEnterKey": { "PrimitiveTypes": [ @@ -22933,7 +21975,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onEnterKey" + "Description": "A function that is executed when the Enter key has been pressed while the widget is focused." }, "onFocusIn": { "PrimitiveTypes": [ @@ -22941,7 +21983,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusIn" + "Description": "A function that is executed when the widget gets focus." }, "onFocusOut": { "PrimitiveTypes": [ @@ -22949,7 +21991,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusOut" + "Description": "A function that is executed when the widget loses focus." }, "onInitialized": { "PrimitiveTypes": [ @@ -22957,7 +21999,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onInput": { "PrimitiveTypes": [ @@ -22965,7 +22007,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onInput" + "Description": "A function that is executed each time the widget's input is changed while the widget is focused." }, "onKeyDown": { "PrimitiveTypes": [ @@ -22973,7 +22015,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyDown" + "Description": "A function that is executed when a user is pressing a key on the keyboard." }, "onKeyPress": { "PrimitiveTypes": [ @@ -22981,7 +22023,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyPress" + "Description": "A function that is executed when a user presses a key on the keyboard." }, "onKeyUp": { "PrimitiveTypes": [ @@ -22989,7 +22031,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyUp" + "Description": "A function that is executed when a user releases a key on the keyboard." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -22997,7 +22039,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPaste": { "PrimitiveTypes": [ @@ -23005,7 +22047,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onPaste" + "Description": "A function that is executed when the widget's input has been pasted." }, "onValueChanged": { "PrimitiveTypes": [ @@ -23013,74 +22055,74 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.placeholder" + "Description": "The text displayed by the widget when the widget value is empty." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showClearButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.showClearButton" + "Description": "Specifies whether to display the Clear button in the widget." }, "showSpinButtons": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxNumberBox.Options.showSpinButtons" + "Description": "Specifies whether to show the buttons that change the value by a step." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxNumberBox.Options.step" + "Description": "Specifies how much the widget's value changes when using the spin buttons, Up/Down arrow keys, or mouse wheel." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.stylingMode" + "Description": "Specifies how the widget's text field is styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "text": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxTextEditor.Options.text" + "Description": "The read-only option that holds the text displayed by the widget input element." }, "useLargeSpinButtons": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxNumberBox.Options.useLargeSpinButtons" + "Description": "Specifies whether to use touch friendly spin buttons. Applies only if showSpinButtons is true." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -23088,38 +22130,38 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "dxNumberBox.Options.value" + "Description": "The current number box value." }, "valueChangeEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.valueChangeEvent" + "Description": "Specifies the DOM events after which the widget's value should be updated." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -23128,34 +22170,34 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxPieChart": { - "DocID": "dxPieChart", + "Description": "The PieChart is a widget that visualizes data as a circle divided into sectors that each represents a portion of the whole.", "Module": "viz/pie_chart", "Options": { "adaptiveLayout": { - "DocID": "dxPieChart.Options.adaptiveLayout", + "Description": "Specifies adaptive layout options.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseChart.Options.adaptiveLayout.height" + "Description": "Specifies the minimum container height at which the layout begins to adapt." }, "keepLabels": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChart.Options.adaptiveLayout.keepLabels" + "Description": "Specifies whether point labels should be kept when the widget adapts the layout." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseChart.Options.adaptiveLayout.width" + "Description": "Specifies the minimum container width at which the layout begins to adapt." } } }, @@ -23163,31 +22205,31 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseChart.Options.animation", + "Description": "Specifies animation options.", "Options": { "duration": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseChart.Options.animation.duration" + "Description": "Specifies how long the animation runs in milliseconds." }, "easing": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseChart.Options.animation.easing" + "Description": "Specifies the easing function of the animation." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseChart.Options.animation.enabled" + "Description": "Enables the animation in the widget." }, "maxPointCountSupported": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseChart.Options.animation.maxPointCountSupported" + "Description": "Specifies how many series points the widget should have before the animation will be disabled." } } }, @@ -23196,7 +22238,7 @@ "any" ], "IsTemplate": true, - "DocID": "dxPieChart.Options.centerTemplate" + "Description": "Specifies a custom template for content in the pie's center." }, "commonSeriesSettings": { "PrimitiveTypes": [ @@ -23205,21 +22247,21 @@ "ComplexTypes": [ "PieChartCommonSeriesSettings" ], - "DocID": "dxPieChart.Options.commonSeriesSettings" + "Description": "An object defining the configuration options that are common for all series of the PieChart widget." }, "customizeLabel": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseChart.Options.customizeLabel" + "Description": "Customizes the appearance of an individual point label." }, "customizePoint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseChart.Options.customizePoint" + "Description": "Customizes the appearance of an individual series point." }, "dataSource": { "PrimitiveTypes": [ @@ -23230,54 +22272,47 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "BaseChart.Options.dataSource" + "Description": "Binds the widget to data." }, "diameter": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChart.Options.diameter" + "Description": "Specifies the diameter of the pie." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "export": { - "DocID": "BaseWidget.Options.export", + "Description": "Configures the exporting and printing features.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.backgroundColor" + "Description": "Specifies the color that will fill transparent regions in the resulting file or document." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.enabled" + "Description": "Enables the client-side exporting in the widget." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.fileName" + "Description": "Specifies a default name for the file to which the widget will be exported." }, "formats": { "ItemPrimitiveTypes": [ @@ -23285,33 +22320,33 @@ ], "IsCollection": true, "SingularName": "format", - "DocID": "BaseWidget.Options.export.formats" + "Description": "Specifies a set of export formats." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.export.margin" + "Description": "Adds an empty space around the exported widget; measured in pixels." }, "printingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.printingEnabled" + "Description": "Enables the printing feature in the widget. Applies only if the export.enabled option is true." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "BaseWidget.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." }, "svgToCanvas": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseWidget.Options.export.svgToCanvas" + "Description": "A function that renders SVG markup on the HTML canvas. Required to export custom SVG elements (for example, markerTemplate)." } } }, @@ -23319,55 +22354,55 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChart.Options.innerRadius" + "Description": "Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1." }, "legend": { - "DocID": "dxPieChart.Options.legend", + "Description": "Specifies PieChart legend options.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.backgroundColor" + "Description": "Colors the legend's background." }, "border": { - "DocID": "BaseLegend.border", + "Description": "Configures the legend's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.border.color" + "Description": "Colors the legend's border." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.cornerRadius" + "Description": "Makes all the legend's corners rounded." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.border.dashStyle" + "Description": "Sets a dash style for the legend's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.opacity" + "Description": "Specifies the transparency of the legend's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseLegend.border.visible" + "Description": "Shows the legend's border." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.width" + "Description": "Specifies the width of the legend's border in pixels." } } }, @@ -23375,103 +22410,97 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.columnCount" + "Description": "Arranges legend items into several columns." }, "columnItemSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.columnItemSpacing" + "Description": "Specifies an empty space between item columns in pixels." }, "customizeHint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPieChart.Options.legend.customizeHint" + "Description": "Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item." }, "customizeItems": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPieChart.Options.legend.customizeItems" + "Description": "Allows you to change the order, text, and visibility of legend items." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPieChart.Options.legend.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed by a legend item." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseLegend.font" + "Description": "Specifies the legend items' font options." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.horizontalAlignment" + "Description": "Along with verticalAlignment, specifies the legend's position." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChart.Options.legend.hoverMode" + "Description": "Specifies what chart elements to highlight when a corresponding item in the legend is hovered over." }, "itemsAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.itemsAlignment" + "Description": "Aligns items in the last column or row (depending on the legend's orientation). Applies when legend items are not divided into columns or rows equally." }, "itemTextPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.itemTextPosition" + "Description": "Specifies the text's position relative to the marker in a legend item." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin", + "Description": "Generates an empty space, measured in pixels, around the legend.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.bottom" + "Description": "Specifies the legend's bottom margin in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.left" + "Description": "Specifies the legend's left margin in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.right" + "Description": "Specifies the legend's right margin in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.top" + "Description": "Specifies the legend's top margin in pixels." } } }, @@ -23479,50 +22508,50 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.markerSize" + "Description": "Specifies the marker's size in a legend item in pixels." }, "markerTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxPieChart.Options.legend.markerTemplate" + "Description": "Specifies an SVG element that serves as a custom legend item marker." }, "orientation": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.orientation" + "Description": "Arranges legend items vertically (in a column) or horizontally (in a row). The default value is \"horizontal\" if the legend.horizontalAlignment is \"center\". Otherwise, it is \"vertical\"." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between the legend's left/right border and its items." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between the legend's top/bottom border and its items." }, "rowCount": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.rowCount" + "Description": "Arranges legend items in several rows." }, "rowItemSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.rowItemSpacing" + "Description": "Specifies an empty space between item rows in pixels." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title", + "Description": "Configures the legend title.", "Options": { "font": { "PrimitiveTypes": [ @@ -23531,47 +22560,40 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseLegend.title.font" + "Description": "Specifies the legend title's font options." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.horizontalAlignment" + "Description": "Along with verticalAlignment, specifies the legend title's position." }, "margin": { - "DocID": "BaseLegend.title.margin", + "Description": "Generates space around the legend title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.bottom" + "Description": "Specifies the legend title's bottom margin." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.left" + "Description": "Specifies the legend title's left margin." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.right" + "Description": "Specifies the legend title's right margin." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.top" + "Description": "Specifies the legend title's top margin." } } }, @@ -23579,13 +22601,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the legend title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.subtitle", + "Description": "Configures the legend subtitle. The subtitle appears only if the title is specified.", "Options": { "font": { "PrimitiveTypes": [ @@ -23594,26 +22616,19 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseLegend.title.subtitle.font" + "Description": "Specifies the legend subtitle's font options." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.subtitle.offset" + "Description": "Specifies the distance between the legend's title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.subtitle.text" + "Description": "Specifies the subtitle's text." } } }, @@ -23621,13 +22636,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.text" + "Description": "Specifies the legend title's text." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.verticalAlignment" + "Description": "Specifies the legend title's vertical alignment." } } }, @@ -23635,87 +22650,81 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.verticalAlignment" + "Description": "Along with horizontalAlignment, specifies the legend's position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseLegend.visible" + "Description": "Specifies the legend's visibility." } } }, "loadingIndicator": { - "DocID": "BaseWidget.Options.loadingIndicator", + "Description": "Configures the loading indicator.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.backgroundColor" + "Description": "Colors the background of the loading indicator." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.loadingIndicator.enabled" + "Description": "Specifies whether the loading indicator should be displayed and hidden automatically." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.loadingIndicator.font" + "Description": "Specifies font options for the loading indicator." }, "show": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "BaseWidget.Options.loadingIndicator.show" + "Description": "Allows you to change the loading indicator's visibility." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.text" + "Description": "Specifies the text to be displayed by the loading indicator." } } }, "margin": { - "DocID": "BaseWidget.Options.margin", + "Description": "Generates space around the widget.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.bottom" + "Description": "Specifies the bottom margin of the widget in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.left" + "Description": "Specifies the left margin of the widget in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.right" + "Description": "Specifies the right margin of the widget in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.top" + "Description": "Specifies the top margin of the widget in pixels." } } }, @@ -23723,7 +22732,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChart.Options.minDiameter" + "Description": "Specifies the minimum diameter of the pie." }, "onDisposing": { "PrimitiveTypes": [ @@ -23731,7 +22740,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDone": { "PrimitiveTypes": [ @@ -23739,7 +22748,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onDone" + "Description": "A function that is executed when all series are ready." }, "onDrawn": { "PrimitiveTypes": [ @@ -23747,7 +22756,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onExported": { "PrimitiveTypes": [ @@ -23755,7 +22764,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -23763,7 +22772,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -23771,7 +22780,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -23779,7 +22788,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -23787,7 +22796,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onLegendClick": { "PrimitiveTypes": [ @@ -23796,7 +22805,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPieChart.Options.onLegendClick" + "Description": "A function that is executed when a legend item is clicked or tapped." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -23804,7 +22813,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPointClick": { "PrimitiveTypes": [ @@ -23813,7 +22822,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onPointClick" + "Description": "A function that is executed when a series point is clicked or tapped." }, "onPointHoverChanged": { "PrimitiveTypes": [ @@ -23821,7 +22830,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onPointHoverChanged" + "Description": "A function that is executed after the pointer enters or leaves a series point." }, "onPointSelectionChanged": { "PrimitiveTypes": [ @@ -23829,7 +22838,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onPointSelectionChanged" + "Description": "A function that is executed when a series point is selected or selection is canceled." }, "onTooltipHidden": { "PrimitiveTypes": [ @@ -23837,7 +22846,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onTooltipHidden" + "Description": "A function that is executed when a tooltip becomes hidden." }, "onTooltipShown": { "PrimitiveTypes": [ @@ -23845,7 +22854,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onTooltipShown" + "Description": "A function that is executed when a tooltip appears." }, "palette": { "PrimitiveTypes": [ @@ -23856,49 +22865,49 @@ ], "IsCollection": true, "SingularName": "palette", - "DocID": "dxPieChart.Options.palette" + "Description": "Sets the palette to be used to colorize series and their elements." }, "paletteExtensionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseChart.Options.paletteExtensionMode" + "Description": "Specifies what to do with colors in the palette when their number is less than the number of series (in the Chart widget) or points in a series (in the PieChart widget)." }, "pathModified": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "pointSelectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseChart.Options.pointSelectionMode" + "Description": "Specifies whether a single point or multiple points can be selected in the chart." }, "redrawOnResize": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.redrawOnResize" + "Description": "Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates." }, "resolveLabelOverlapping": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChart.Options.resolveLabelOverlapping" + "Description": "Specifies how a chart must behave when point labels overlap." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "segmentsDirection": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChart.Options.segmentsDirection" + "Description": "Specifies the direction that the pie chart segments will occupy." }, "series": { "PrimitiveTypes": [ @@ -23915,40 +22924,40 @@ ], "IsCollection": true, "SingularName": "series", - "DocID": "dxPieChart.Options.series" + "Description": "Specifies options for the series of the PieChart widget." }, "seriesTemplate": { - "DocID": "dxPieChart.Options.seriesTemplate", + "Description": "Defines options for the series template.", "Options": { "customizeSeries": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPieChart.Options.seriesTemplate.customizeSeries" + "Description": "Specifies a callback function that returns a series object with individual series settings." }, "nameField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChart.Options.seriesTemplate.nameField" + "Description": "Specifies a data source field that represents the series name." } } }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, @@ -23956,76 +22965,70 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChart.Options.sizeGroup" + "Description": "Allows you to display several adjoining pies in the same size." }, "startAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChart.Options.startAngle" + "Description": "Specifies the angle in arc degrees from which the first segment of a pie chart should start." }, "theme": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title", + "Description": "Configures the widget's title.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.title.font" + "Description": "Specifies font options for the title." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.horizontalAlignment" + "Description": "Specifies the title's alignment in a horizontal direction." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin", + "Description": "Generates space around the title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.bottom" + "Description": "Specifies the bottom margin of the title." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.left" + "Description": "Specifies the left margin of the title." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.right" + "Description": "Specifies the right margin of the title." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.top" + "Description": "Specifies the top margin of the title." } } }, @@ -24033,13 +23036,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle", + "Description": "Configures the widget's subtitle.", "Options": { "font": { "PrimitiveTypes": [ @@ -24048,38 +23051,31 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseWidget.Options.title.subtitle.font" + "Description": "Specifies font options for the subtitle." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.subtitle.offset" + "Description": "Specifies the distance between the title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.text" + "Description": "Specifies text for the subtitle." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.textOverflow" + "Description": "Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.wordWrap" + "Description": "Specifies how to wrap the subtitle if it does not fit into a single line." } } }, @@ -24087,85 +23083,79 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.text" + "Description": "Specifies the title's text." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.textOverflow" + "Description": "Specifies what to do with the title when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.verticalAlignment" + "Description": "Specifies the title's alignment in a vertical direction." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.wordWrap" + "Description": "Specifies how to wrap the title if it does not fit into a single line." } } }, "tooltip": { - "DocID": "BaseChart.Options.tooltip", + "Description": "Configures tooltips.", "Options": { "argumentFormat": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseChart.Options.tooltip.argumentFormat" + "Description": "Formats the point argument before it is displayed in the tooltip. To format the point value, use the format option." }, "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.arrowLength" + "Description": "Specifies the length of a tooltip's arrow in pixels." }, "border": { - "DocID": "BaseWidget.Options.tooltip.border", + "Description": "Configures a tooltip's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.color" + "Description": "Colors a tooltip's border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.dashStyle" + "Description": "Specifies the dash style of a tooltip's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.opacity" + "Description": "Specifies the transparency of a tooltip's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.border.visible" + "Description": "Specifies whether a tooltip's border is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.width" + "Description": "Specifies the width of a tooltip's border in pixels." } } }, @@ -24173,7 +23163,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.color" + "Description": "Colors all tooltips." }, "container": { "PrimitiveTypes": [ @@ -24181,115 +23171,103 @@ "JQuery", "string" ], - "DocID": "BaseWidget.Options.tooltip.container" + "Description": "Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "BaseChart.Options.tooltip.contentTemplate" + "Description": "Specifies a custom template for a tooltip." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.cornerRadius" + "Description": "Makes all the tooltip's corners rounded." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseChart.Options.tooltip.customizeTooltip" + "Description": "Allows you to change tooltip appearance." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.enabled" + "Description": "Enables tooltips." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.font" + "Description": "Specifies tooltips' font options." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.format" + "Description": "Formats a value before it is displayed it in a tooltip." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.opacity" + "Description": "Specifies tooltips' transparency." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between a tooltip's left/right border and its text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text." }, "shadow": { - "DocID": "BaseWidget.Options.tooltip.shadow", + "Description": "Configures a tooltip's shadow.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.blur" + "Description": "Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.shadow.color" + "Description": "Colors a tooltip's shadow." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetX" + "Description": "Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetY" + "Description": "Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.opacity" + "Description": "Specifies the transparency of a tooltip's shadow." } } }, @@ -24297,13 +23275,13 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseChart.Options.tooltip.shared" + "Description": "Specifies whether the tooltip is shared across all series points with the same argument." }, "zIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.zIndex" + "Description": "Specifies a tooltip's z-index." } } }, @@ -24311,43 +23289,43 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChart.Options.type" + "Description": "Specifies the type of the pie chart series." } } }, "dxPivotGrid": { - "DocID": "dxPivotGrid", + "Description": "The PivotGrid is a widget that allows you to display and analyze multi-dimensional data from a local storage or an OLAP cube.", "Module": "ui/pivot_grid", "Options": { "allowExpandAll": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.allowExpandAll" + "Description": "Allows an end-user to expand/collapse all header items within a header level." }, "allowFiltering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.allowFiltering" + "Description": "Allows a user to filter fields by selecting or deselecting values in the popup menu." }, "allowSorting": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.allowSorting" + "Description": "Allows an end-user to change sorting options." }, "allowSortingBySummary": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.allowSortingBySummary" + "Description": "Allows an end-user to sort columns by summary values." }, "dataFieldArea": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.dataFieldArea" + "Description": "Specifies the area to which data field headers must belong." }, "dataSource": { "PrimitiveTypes": [ @@ -24357,130 +23335,123 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxPivotGrid.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "export": { - "DocID": "dxPivotGrid.Options.export", + "Description": "Configures client-side exporting.", "Options": { "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.export.enabled" + "Description": "Enables client-side exporting." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.export.fileName" + "Description": "Specifies a default name for the file to which grid data is exported." }, "ignoreExcelErrors": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.export.ignoreExcelErrors" + "Description": "Specifies whether Excel should hide warnings if there are errors in the exported document." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "dxPivotGrid.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." } } }, "fieldChooser": { - "DocID": "dxPivotGrid.Options.fieldChooser", + "Description": "The Field Chooser configuration options.", "Options": { "allowSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.fieldChooser.allowSearch" + "Description": "Specifies whether the field chooser allows searching in the \"All Fields\" section." }, "applyChangesMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.fieldChooser.applyChangesMode" + "Description": "Specifies when to apply changes made in the field chooser to the PivotGrid." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.fieldChooser.enabled" + "Description": "Enables or disables the field chooser." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGrid.Options.fieldChooser.height" + "Description": "Specifies the field chooser height." }, "layout": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxPivotGrid.Options.fieldChooser.layout" + "Description": "Specifies the field chooser layout." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGrid.Options.fieldChooser.searchTimeout" + "Description": "Specifies a delay in milliseconds between when a user finishes typing in the field chooser's search panel, and when the search is executed." }, "texts": { - "DocID": "dxPivotGrid.Options.fieldChooser.texts", + "Description": "Strings that can be changed or localized in the pivot grid's integrated Field Chooser.", "Options": { "allFields": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.fieldChooser.texts.allFields" + "Description": "The string to display instead of All Fields." }, "columnFields": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.fieldChooser.texts.columnFields" + "Description": "The string to display instead of Column Fields." }, "dataFields": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.fieldChooser.texts.dataFields" + "Description": "The string to display instead of Data Fields." }, "filterFields": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.fieldChooser.texts.filterFields" + "Description": "The string to display instead of Filter Fields." }, "rowFields": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.fieldChooser.texts.rowFields" + "Description": "The string to display instead of Row Fields." } } }, @@ -24488,75 +23459,75 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.fieldChooser.title" + "Description": "Specifies the text to display as a title of the field chooser popup window." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGrid.Options.fieldChooser.width" + "Description": "Specifies the field chooser width." } } }, "fieldPanel": { - "DocID": "dxPivotGrid.Options.fieldPanel", + "Description": "Configures the field panel.", "Options": { "allowFieldDragging": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.fieldPanel.allowFieldDragging" + "Description": "Makes fields on the field panel draggable." }, "showColumnFields": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.fieldPanel.showColumnFields" + "Description": "Shows/hides column fields on the field panel." }, "showDataFields": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.fieldPanel.showDataFields" + "Description": "Shows/hides data fields on the field panel." }, "showFilterFields": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.fieldPanel.showFilterFields" + "Description": "Shows/hides filter fields on the field panel." }, "showRowFields": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.fieldPanel.showRowFields" + "Description": "Shows/hides row fields on the field panel." }, "texts": { - "DocID": "dxPivotGrid.Options.fieldPanel.texts", + "Description": "Specifies the placeholders of the field areas.", "Options": { "columnFieldArea": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.fieldPanel.texts.columnFieldArea" + "Description": "Specifies the placeholder of the column field area." }, "dataFieldArea": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.fieldPanel.texts.dataFieldArea" + "Description": "Specifies the placeholder of the data field area." }, "filterFieldArea": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.fieldPanel.texts.filterFieldArea" + "Description": "Specifies the placeholder of the filter field area." }, "rowFieldArea": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.fieldPanel.texts.rowFieldArea" + "Description": "Specifies the placeholder of the row field area." } } }, @@ -24564,57 +23535,57 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.fieldPanel.visible" + "Description": "Shows/hides the field panel." } } }, "headerFilter": { - "DocID": "dxPivotGrid.Options.headerFilter", + "Description": "Configures the header filter feature.", "Options": { "allowSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.headerFilter.allowSearch" + "Description": "Specifies whether searching is enabled in the header filter." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGrid.Options.headerFilter.height" + "Description": "Specifies the height of the popup menu containing filtering values." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGrid.Options.headerFilter.searchTimeout" + "Description": "Specifies a delay in milliseconds between when a user finishes typing in the header filter's search panel, and when the search is executed." }, "showRelevantValues": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.headerFilter.showRelevantValues" + "Description": "Specifies whether to show all field values or only those that satisfy the other applied filters." }, "texts": { - "DocID": "dxPivotGrid.Options.headerFilter.texts", + "Description": "Configures the texts of the popup menu's elements.", "Options": { "cancel": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.headerFilter.texts.cancel" + "Description": "Specifies the text of the button that closes the popup menu without applying a filter." }, "emptyValue": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.headerFilter.texts.emptyValue" + "Description": "Specifies the name of the item that represents empty values in the popup menu." }, "ok": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.headerFilter.texts.ok" + "Description": "Specifies the text of the button that applies a filter." } } }, @@ -24622,7 +23593,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGrid.Options.headerFilter.width" + "Description": "Specifies the width of the popup menu containing filtering values." } } }, @@ -24633,64 +23604,64 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hideEmptySummaryCells": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.hideEmptySummaryCells" + "Description": "Specifies whether or not to hide rows and columns with no data." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "loadPanel": { - "DocID": "dxPivotGrid.Options.loadPanel", + "Description": "Specifies options configuring the load panel.", "Options": { "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.loadPanel.enabled" + "Description": "Enables or disables the load panel." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGrid.Options.loadPanel.height" + "Description": "Specifies the height of the load panel." }, "indicatorSrc": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.loadPanel.indicatorSrc" + "Description": "Specifies the URL pointing to an image that will be used as a load indicator." }, "showIndicator": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.loadPanel.showIndicator" + "Description": "Specifies whether or not to show a load indicator." }, "showPane": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.loadPanel.showPane" + "Description": "Specifies whether or not to show load panel background." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.loadPanel.text" + "Description": "Specifies the text to display inside a load panel." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGrid.Options.loadPanel.width" + "Description": "Specifies the width of the load panel." } } }, @@ -24700,7 +23671,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPivotGrid.Options.onCellClick" + "Description": "A function that is executed when a pivot grid cell is clicked or tapped." }, "onCellPrepared": { "PrimitiveTypes": [ @@ -24708,7 +23679,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPivotGrid.Options.onCellPrepared" + "Description": "A function that is executed after a pivot grid cell is created." }, "onContentReady": { "PrimitiveTypes": [ @@ -24716,7 +23687,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onContextMenuPreparing": { "PrimitiveTypes": [ @@ -24724,7 +23695,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPivotGrid.Options.onContextMenuPreparing" + "Description": "A function that is executed before the context menu is rendered." }, "onDisposing": { "PrimitiveTypes": [ @@ -24732,7 +23703,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onExported": { "PrimitiveTypes": [ @@ -24740,7 +23711,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPivotGrid.Options.onExported" + "Description": "A function that is executed after data is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -24748,7 +23719,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPivotGrid.Options.onExporting" + "Description": "A function that is executed before data is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -24756,7 +23727,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPivotGrid.Options.onFileSaving" + "Description": "A function that is executed before a file with exported data is saved to the user's local storage." }, "onInitialized": { "PrimitiveTypes": [ @@ -24764,7 +23735,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -24772,35 +23743,35 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "rowHeaderLayout": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.rowHeaderLayout" + "Description": "Specifies the layout of items in the row header." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scrolling": { - "DocID": "dxPivotGrid.Options.scrolling", + "Description": "A configuration object specifying scrolling options.", "Options": { "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.scrolling.mode" + "Description": "Specifies the scrolling mode." }, "useNative": { "PrimitiveTypes": [ "boolean", "string" ], - "DocID": "dxPivotGrid.Options.scrolling.useNative" + "Description": "Specifies whether or not the widget uses native scrolling." } } }, @@ -24808,78 +23779,78 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.showBorders" + "Description": "Specifies whether the outer borders of the grid are visible or not." }, "showColumnGrandTotals": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.showColumnGrandTotals" + "Description": "Specifies whether to display the Grand Total column." }, "showColumnTotals": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.showColumnTotals" + "Description": "Specifies whether to display the Total columns." }, "showRowGrandTotals": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.showRowGrandTotals" + "Description": "Specifies whether to display the Grand Total row." }, "showRowTotals": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.showRowTotals" + "Description": "Specifies whether to display the Total rows. Applies only if rowHeaderLayout is \"standard\"." }, "showTotalsPrior": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.showTotalsPrior" + "Description": "Specifies where to show the total rows or columns. Applies only if rowHeaderLayout is \"standard\"." }, "stateStoring": { - "DocID": "dxPivotGrid.Options.stateStoring", + "Description": "A configuration object specifying options related to state storing.", "Options": { "customLoad": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPivotGrid.Options.stateStoring.customLoad" + "Description": "Specifies a function that is executed on state loading. Applies only if the type is \"custom\"." }, "customSave": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPivotGrid.Options.stateStoring.customSave" + "Description": "Specifies a function that is executed on state saving. Applies only if the type is \"custom\"." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.stateStoring.enabled" + "Description": "Specifies whether or not a grid saves its state." }, "savingTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGrid.Options.stateStoring.savingTimeout" + "Description": "Specifies the delay between the last change of a grid state and the operation of saving this state in milliseconds." }, "storageKey": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.stateStoring.storageKey" + "Description": "Specifies a unique key to be used for storing the grid state." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.stateStoring.type" + "Description": "Specifies the type of storage to be used for state storing." } } }, @@ -24887,76 +23858,76 @@ "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "texts": { - "DocID": "dxPivotGrid.Options.texts", + "Description": "Strings that can be changed or localized in the PivotGrid widget.", "Options": { "collapseAll": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.texts.collapseAll" + "Description": "The string to display as a Collapse All context menu item." }, "dataNotAvailable": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.texts.dataNotAvailable" + "Description": "Specifies text displayed in a cell when its data is unavailable for some reason." }, "expandAll": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.texts.expandAll" + "Description": "The string to display as an Expand All context menu item." }, "exportToExcel": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.texts.exportToExcel" + "Description": "The string to display as an Export to Excel file context menu item." }, "grandTotal": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.texts.grandTotal" + "Description": "The string to display as a header of the Grand Total row and column." }, "noData": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.texts.noData" + "Description": "Specifies the text displayed when a pivot grid does not contain any fields." }, "removeAllSorting": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.texts.removeAllSorting" + "Description": "The string to display as a Remove All Sorting context menu item." }, "showFieldChooser": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.texts.showFieldChooser" + "Description": "The string to display as a Show Field Chooser context menu item." }, "sortColumnBySummary": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.texts.sortColumnBySummary" + "Description": "The string to display as a Sort Column by Summary Value context menu item." }, "sortRowBySummary": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.texts.sortRowBySummary" + "Description": "The string to display as a Sort Row by Summary Value context menu item." }, "total": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGrid.Options.texts.total" + "Description": "The string to display as a header of the Total row and column." } } }, @@ -24964,7 +23935,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -24973,123 +23944,116 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." }, "wordWrapEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGrid.Options.wordWrapEnabled" + "Description": "Specifies whether long text in header items should be wrapped." } } }, "dxPivotGridFieldChooser": { - "DocID": "dxPivotGridFieldChooser", + "Description": "A complementary widget for the PivotGrid that allows you to manage data displayed in the PivotGrid. The field chooser is already integrated in the PivotGrid and can be invoked using the context menu. If you need to continuously display the field chooser near the PivotGrid widget, use the PivotGridFieldChooser widget.", "Module": "ui/pivot_grid_field_chooser", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "allowSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGridFieldChooser.Options.allowSearch" + "Description": "Specifies whether the field chooser allows searching in the \"All Fields\" section." }, "applyChangesMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGridFieldChooser.Options.applyChangesMode" + "Description": "Specifies when to apply changes made in the widget to the PivotGrid." }, "dataSource": { "PrimitiveTypes": [ "DevExpress.data.PivotGridDataSource" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxPivotGridFieldChooser.Options.dataSource" + "Description": "The data source of a PivotGrid widget." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "headerFilter": { - "DocID": "dxPivotGridFieldChooser.Options.headerFilter", + "Description": "Configures the header filter feature.", "Options": { "allowSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGridFieldChooser.Options.headerFilter.allowSearch" + "Description": "Specifies whether searching is enabled in the header filter." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGridFieldChooser.Options.headerFilter.height" + "Description": "Specifies the height of the popup menu containing filtering values." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGridFieldChooser.Options.headerFilter.searchTimeout" + "Description": "Specifies a delay in milliseconds between when a user finishes typing in the header filter's search panel, and when the search is executed." }, "showRelevantValues": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPivotGridFieldChooser.Options.headerFilter.showRelevantValues" + "Description": "Specifies whether to show all field values or only those that satisfy the other applied filters." }, "texts": { - "DocID": "dxPivotGridFieldChooser.Options.headerFilter.texts", + "Description": "Configures the texts of the popup menu's elements.", "Options": { "cancel": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGridFieldChooser.Options.headerFilter.texts.cancel" + "Description": "Specifies the text of the button that closes the popup menu without applying a filter." }, "emptyValue": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGridFieldChooser.Options.headerFilter.texts.emptyValue" + "Description": "Specifies the name of the item that represents empty values in the popup menu." }, "ok": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGridFieldChooser.Options.headerFilter.texts.ok" + "Description": "Specifies the text of the button that applies a filter." } } }, @@ -25097,7 +24061,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGridFieldChooser.Options.headerFilter.width" + "Description": "Specifies the width of the popup menu containing filtering values." } } }, @@ -25108,26 +24072,26 @@ "string" ], "IsFunc": true, - "DocID": "dxPivotGridFieldChooser.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "layout": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxPivotGridFieldChooser.Options.layout" + "Description": "Specifies the field chooser layout." }, "onContentReady": { "PrimitiveTypes": [ @@ -25135,7 +24099,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onContextMenuPreparing": { "PrimitiveTypes": [ @@ -25143,7 +24107,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPivotGridFieldChooser.Options.onContextMenuPreparing" + "Description": "A function that is executed before the context menu is rendered." }, "onDisposing": { "PrimitiveTypes": [ @@ -25151,7 +24115,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -25159,7 +24123,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -25167,64 +24131,64 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPivotGridFieldChooser.Options.searchTimeout" + "Description": "Specifies a delay in milliseconds between when a user finishes typing in the field chooser's search panel, and when the search is executed." }, "state": { "PrimitiveTypes": [ "any" ], - "DocID": "dxPivotGridFieldChooser.Options.state" + "Description": "The widget's state." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "texts": { - "DocID": "dxPivotGridFieldChooser.Options.texts", + "Description": "Strings that can be changed or localized in the PivotGridFieldChooser widget.", "Options": { "allFields": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGridFieldChooser.Options.texts.allFields" + "Description": "The string to display instead of All Fields." }, "columnFields": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGridFieldChooser.Options.texts.columnFields" + "Description": "The string to display instead of Column Fields." }, "dataFields": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGridFieldChooser.Options.texts.dataFields" + "Description": "The string to display instead of Data Fields." }, "filterFields": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGridFieldChooser.Options.texts.filterFields" + "Description": "The string to display instead of Filter Fields." }, "rowFields": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPivotGridFieldChooser.Options.texts.rowFields" + "Description": "The string to display instead of Row Fields." } } }, @@ -25232,7 +24196,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -25241,34 +24205,34 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxPolarChart": { - "DocID": "dxPolarChart", + "Description": "The PolarChart is a widget that visualizes data in a polar coordinate system.", "Module": "viz/polar_chart", "Options": { "adaptiveLayout": { - "DocID": "dxPolarChart.Options.adaptiveLayout", + "Description": "Specifies adaptive layout options.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.adaptiveLayout.height" + "Description": "Specifies the minimum container height at which the layout begins to adapt." }, "keepLabels": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseChart.Options.adaptiveLayout.keepLabels" + "Description": "Specifies whether point labels should be kept when the widget adapts the layout." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.adaptiveLayout.width" + "Description": "Specifies the minimum container width at which the layout begins to adapt." } } }, @@ -25276,54 +24240,54 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseChart.Options.animation", + "Description": "Specifies animation options.", "Options": { "duration": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseChart.Options.animation.duration" + "Description": "Specifies how long the animation runs in milliseconds." }, "easing": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseChart.Options.animation.easing" + "Description": "Specifies the easing function of the animation." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseChart.Options.animation.enabled" + "Description": "Enables the animation in the widget." }, "maxPointCountSupported": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseChart.Options.animation.maxPointCountSupported" + "Description": "Specifies how many series points the widget should have before the animation will be disabled." } } }, "argumentAxis": { - "DocID": "dxPolarChart.Options.argumentAxis", + "Description": "Specifies argument axis options for the PolarChart widget.", "Options": { "allowDecimals": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.allowDecimals" + "Description": "Specifies whether to allow decimal values on the axis. When false, the axis contains integer values only." }, "argumentType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.argumentAxis.argumentType" + "Description": "Specifies the desired type of axis values." }, "axisDivisionFactor": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.argumentAxis.axisDivisionFactor" + "Description": "Specifies the minimum distance between two neighboring major ticks in pixels. Applies only to the axes of the \"continuous\" and \"logarithmic\" types." }, "categories": { "ItemPrimitiveTypes": [ @@ -25333,13 +24297,13 @@ ], "IsCollection": true, "SingularName": "category", - "DocID": "dxPolarChart.Options.argumentAxis.categories" + "Description": "Specifies the order of categories on an axis of the \"discrete\" type." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.color" + "Description": "Specifies the color of the line that represents an axis." }, "constantLines": { "ItemPrimitiveTypes": [ @@ -25347,61 +24311,55 @@ ], "IsCollection": true, "SingularName": "constantLine", - "DocID": "dxPolarChart.Options.argumentAxis.constantLines", + "Description": "Defines an array of the argument axis constant lines.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.color" + "Description": "Specifies a color for a constant line." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.dashStyle" + "Description": "Specifies a dash style for a constant line." }, "displayBehindSeries": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.argumentAxis.constantLines.displayBehindSeries" + "Description": "Specifies whether to display the constant line behind or in front of the series." }, "extendAxis": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.argumentAxis.constantLines.extendAxis" + "Description": "Specifies whether to extend the axis to display the constant line." }, "label": { - "DocID": "dxPolarChart.Options.argumentAxis.constantLines.label", + "Description": "An object defining constant line label options.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label.font" + "Description": "Specifies font options for a constant line label." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.argumentAxis.constantLines.label.text" + "Description": "Specifies the text to be displayed in a constant line label." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label.visible" + "Description": "Indicates whether or not to display labels for the axis constant lines." } } }, @@ -25411,54 +24369,48 @@ "number", "string" ], - "DocID": "dxPolarChart.Options.argumentAxis.constantLines.value" + "Description": "Specifies a value to be displayed by a constant line." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.width" + "Description": "Specifies a constant line width in pixels." } } }, "constantLineStyle": { - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle", + "Description": "Specifies the appearance of all the widget's constant lines.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.color" + "Description": "Specifies a color for a constant line." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.dashStyle" + "Description": "Specifies a dash style for a constant line." }, "label": { - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label", + "Description": "An object defining constant line label options.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label.font" + "Description": "Specifies font options for a constant line label." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label.visible" + "Description": "Indicates whether or not to display labels for the axis constant lines." } } }, @@ -25466,7 +24418,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.width" + "Description": "Specifies a constant line width in pixels." } } }, @@ -25474,46 +24426,46 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.discreteAxisDivisionMode" + "Description": "Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels." }, "endOnTick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.endOnTick" + "Description": "Specifies whether to force the axis to start and end on ticks." }, "firstPointOnStartAngle": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.argumentAxis.firstPointOnStartAngle" + "Description": "Specifies whether or not to display the first point at the angle specified by the startAngle option." }, "grid": { - "DocID": "dxPolarChart.Options.commonAxisSettings.grid", + "Description": "An object defining the configuration options for the grid lines of an axis in the PolarChart widget.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.grid.color" + "Description": "Specifies a color for grid lines." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.grid.opacity" + "Description": "Specifies an opacity for grid lines." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.grid.visible" + "Description": "Indicates whether or not the grid lines of an axis are visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.grid.width" + "Description": "Specifies the width of grid lines." } } }, @@ -25521,79 +24473,67 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.argumentAxis.hoverMode" + "Description": "Specifies the elements that will be highlighted when the argument axis is hovered over." }, "inverted": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.inverted" + "Description": "Indicates whether or not an axis is inverted." }, "label": { - "DocID": "dxPolarChart.Options.argumentAxis.label", + "Description": "Specifies options for argument axis labels.", "Options": { "customizeHint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPolarChart.Options.argumentAxis.label.customizeHint" + "Description": "Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the argument axis." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPolarChart.Options.argumentAxis.label.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed by argument axis labels." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.label.font" + "Description": "Specifies font options for axis labels." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxPolarChart.Options.argumentAxis.label.format" + "Description": "Formats a value before it is displayed in an axis label." }, "indentFromAxis": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.label.indentFromAxis" + "Description": "Specifies the spacing between an axis and its labels in pixels." }, "overlappingBehavior": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.label.overlappingBehavior" + "Description": "Decides how to arrange axis labels when there is not enough space to keep all of them." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.label.visible" + "Description": "Indicates whether or not axis labels are visible." } } }, @@ -25601,81 +24541,81 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.argumentAxis.linearThreshold" + "Description": "Specifies a value used to calculate the range on a logarithmic axis within which the axis should be linear. Applies only if the data source contains negative values or zeroes." }, "logarithmBase": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.argumentAxis.logarithmBase" + "Description": "Specifies the value to be raised to a power when generating ticks for a logarithmic axis." }, "minorGrid": { - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid", + "Description": "Specifies the options of the minor grid.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid.color" + "Description": "Specifies a color for the lines of the minor grid." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid.opacity" + "Description": "Specifies an opacity for the lines of the minor grid." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid.visible" + "Description": "Indicates whether the minor grid is visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid.width" + "Description": "Specifies a width for the lines of the minor grid." } } }, "minorTick": { - "DocID": "dxPolarChart.Options.argumentAxis.minorTick", + "Description": "Specifies the options of the minor ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.color" + "Description": "Specifies a color for the minor ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.length" + "Description": "Specifies minor tick length." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.opacity" + "Description": "Specifies an opacity for the minor ticks." }, "shift": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.argumentAxis.minorTick.shift" + "Description": "Shifts minor ticks from the reference position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.visible" + "Description": "Indicates whether or not the minor ticks are displayed on an axis." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.width" + "Description": "Specifies minor tick width." } } }, @@ -25683,68 +24623,68 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.argumentAxis.minorTickCount" + "Description": "Specifies the number of minor ticks between two neighboring major ticks." }, "minorTickInterval": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxPolarChart.Options.argumentAxis.minorTickInterval", + "Description": "Specifies the interval between minor ticks.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -25752,25 +24692,25 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.opacity" + "Description": "Specifies the opacity of the line that represents an axis." }, "originValue": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.argumentAxis.originValue" + "Description": "Specifies the value to be used as the origin for the argument axis." }, "period": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.argumentAxis.period" + "Description": "Specifies the period of the argument values in the data source." }, "startAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.argumentAxis.startAngle" + "Description": "Specifies the angle in arc degrees to which the argument axis should be rotated. The positive values rotate the axis clockwise." }, "strips": { "ItemPrimitiveTypes": [ @@ -25778,13 +24718,13 @@ ], "IsCollection": true, "SingularName": "strip", - "DocID": "dxPolarChart.Options.argumentAxis.strips", + "Description": "Specifies options for argument axis strips.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.argumentAxis.strips.color" + "Description": "Specifies a color for a strip." }, "endValue": { "PrimitiveTypes": [ @@ -25792,31 +24732,25 @@ "number", "string" ], - "DocID": "dxPolarChart.Options.argumentAxis.strips.endValue" + "Description": "Specifies an end value for a strip." }, "label": { - "DocID": "dxPolarChart.Options.argumentAxis.strips.label", + "Description": "An object that defines the label configuration options of a strip.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.stripStyle.label.font" + "Description": "Specifies font options for a strip label." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.argumentAxis.strips.label.text" + "Description": "Specifies the text displayed in a strip." } } }, @@ -25826,73 +24760,67 @@ "number", "string" ], - "DocID": "dxPolarChart.Options.argumentAxis.strips.startValue" + "Description": "Specifies a start value for a strip." } } }, "stripStyle": { - "DocID": "dxPolarChart.Options.commonAxisSettings.stripStyle", + "Description": "An object defining configuration options for strip style.", "Options": { "label": { - "DocID": "dxPolarChart.Options.commonAxisSettings.stripStyle.label", + "Description": "An object defining the configuration options for a strip label style.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.stripStyle.label.font" + "Description": "Specifies font options for a strip label." } } } } }, "tick": { - "DocID": "dxPolarChart.Options.argumentAxis.tick", + "Description": "An object defining the configuration options for axis ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.color" + "Description": "Specifies ticks color." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.length" + "Description": "Specifies tick length." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.opacity" + "Description": "Specifies tick opacity." }, "shift": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.argumentAxis.tick.shift" + "Description": "Shifts ticks from the reference position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.visible" + "Description": "Indicates whether or not ticks are visible on an axis." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.width" + "Description": "Specifies tick width." } } }, @@ -25901,61 +24829,61 @@ "number", "string" ], - "DocID": "dxPolarChart.Options.argumentAxis.tickInterval", + "Description": "Specifies an interval between axis ticks/grid lines.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -25963,19 +24891,19 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.argumentAxis.type" + "Description": "Specifies the required type of the argument axis." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.visible" + "Description": "Indicates whether or not the line that represents an axis in a chart is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.width" + "Description": "Specifies the width of the line that represents an axis in the chart." } } }, @@ -25983,74 +24911,68 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.barGroupPadding" + "Description": "Controls the padding and consequently the angular width of a group of bars with the same argument using relative units. Ignored if the barGroupWidth option is set." }, "barGroupWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.barGroupWidth" + "Description": "Specifies a fixed angular width for groups of bars with the same argument, measured in degrees. Takes precedence over the barGroupPadding option." }, "barWidth": { "PrimitiveTypes": [ "number" ], "IsDeprecated": true, - "DocID": "dxPolarChart.Options.barWidth" + "Description": "Use CommonPolarChartSeries.barPadding instead." }, "commonAxisSettings": { - "DocID": "dxPolarChart.Options.commonAxisSettings", + "Description": "An object defining the configuration options that are common for all axes of the PolarChart widget.", "Options": { "allowDecimals": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.allowDecimals" + "Description": "Specifies whether to allow decimal values on the axis. When false, the axis contains integer values only." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.color" + "Description": "Specifies the color of the line that represents an axis." }, "constantLineStyle": { - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle", + "Description": "Specifies the appearance of all the widget's constant lines.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.color" + "Description": "Specifies a color for a constant line." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.dashStyle" + "Description": "Specifies a dash style for a constant line." }, "label": { - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label", + "Description": "An object defining constant line label options.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label.font" + "Description": "Specifies font options for a constant line label." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label.visible" + "Description": "Indicates whether or not to display labels for the axis constant lines." } } }, @@ -26058,7 +24980,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.width" + "Description": "Specifies a constant line width in pixels." } } }, @@ -26066,40 +24988,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.discreteAxisDivisionMode" + "Description": "Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels." }, "endOnTick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.endOnTick" + "Description": "Specifies whether to force the axis to start and end on ticks." }, "grid": { - "DocID": "dxPolarChart.Options.commonAxisSettings.grid", + "Description": "An object defining the configuration options for the grid lines of an axis in the PolarChart widget.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.grid.color" + "Description": "Specifies a color for grid lines." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.grid.opacity" + "Description": "Specifies an opacity for grid lines." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.grid.visible" + "Description": "Indicates whether or not the grid lines of an axis are visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.grid.width" + "Description": "Specifies the width of grid lines." } } }, @@ -26107,107 +25029,101 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.inverted" + "Description": "Indicates whether or not an axis is inverted." }, "label": { - "DocID": "dxPolarChart.Options.commonAxisSettings.label", + "Description": "An object defining the label configuration options that are common for all axes in the PolarChart widget.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.label.font" + "Description": "Specifies font options for axis labels." }, "indentFromAxis": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.label.indentFromAxis" + "Description": "Specifies the spacing between an axis and its labels in pixels." }, "overlappingBehavior": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.label.overlappingBehavior" + "Description": "Decides how to arrange axis labels when there is not enough space to keep all of them." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.label.visible" + "Description": "Indicates whether or not axis labels are visible." } } }, "minorGrid": { - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid", + "Description": "Specifies the options of the minor grid.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid.color" + "Description": "Specifies a color for the lines of the minor grid." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid.opacity" + "Description": "Specifies an opacity for the lines of the minor grid." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid.visible" + "Description": "Indicates whether the minor grid is visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid.width" + "Description": "Specifies a width for the lines of the minor grid." } } }, "minorTick": { - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick", + "Description": "Specifies the options of the minor ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.color" + "Description": "Specifies a color for the minor ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.length" + "Description": "Specifies minor tick length." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.opacity" + "Description": "Specifies an opacity for the minor ticks." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.visible" + "Description": "Indicates whether or not the minor ticks are displayed on an axis." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.width" + "Description": "Specifies minor tick width." } } }, @@ -26215,65 +25131,59 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.opacity" + "Description": "Specifies the opacity of the line that represents an axis." }, "stripStyle": { - "DocID": "dxPolarChart.Options.commonAxisSettings.stripStyle", + "Description": "An object defining configuration options for strip style.", "Options": { "label": { - "DocID": "dxPolarChart.Options.commonAxisSettings.stripStyle.label", + "Description": "An object defining the configuration options for a strip label style.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.stripStyle.label.font" + "Description": "Specifies font options for a strip label." } } } } }, "tick": { - "DocID": "dxPolarChart.Options.commonAxisSettings.tick", + "Description": "An object defining the configuration options for axis ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.color" + "Description": "Specifies ticks color." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.length" + "Description": "Specifies tick length." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.opacity" + "Description": "Specifies tick opacity." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.visible" + "Description": "Indicates whether or not ticks are visible on an axis." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.width" + "Description": "Specifies tick width." } } }, @@ -26281,13 +25191,13 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.visible" + "Description": "Indicates whether or not the line that represents an axis in a chart is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.width" + "Description": "Specifies the width of the line that represents an axis in the chart." } } }, @@ -26298,42 +25208,42 @@ "ComplexTypes": [ "PolarChartCommonSeriesSettings" ], - "DocID": "dxPolarChart.Options.commonSeriesSettings" + "Description": "An object defining the configuration options that are common for all series of the PolarChart widget." }, "containerBackgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.containerBackgroundColor" + "Description": "Specifies the color of the parent page element." }, "customizeLabel": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseChart.Options.customizeLabel" + "Description": "Customizes the appearance of an individual point label." }, "customizePoint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseChart.Options.customizePoint" + "Description": "Customizes the appearance of an individual series point." }, "dataPrepareSettings": { - "DocID": "dxPolarChart.Options.dataPrepareSettings", + "Description": "An object providing options for managing data from a data source.", "Options": { "checkTypeForAllData": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.dataPrepareSettings.checkTypeForAllData" + "Description": "Specifies whether or not to validate the values from a data source." }, "convertToAxisDataType": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.dataPrepareSettings.convertToAxisDataType" + "Description": "Specifies whether or not to convert the values from a data source into the data type of an axis." }, "sortingMethod": { "PrimitiveTypes": [ @@ -26341,7 +25251,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxPolarChart.Options.dataPrepareSettings.sortingMethod" + "Description": "Specifies how to sort the series points." } } }, @@ -26354,55 +25264,48 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "BaseChart.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "equalBarWidth": { "PrimitiveTypes": [ "boolean" ], "IsDeprecated": true, - "DocID": "dxPolarChart.Options.equalBarWidth" + "Description": "Use CommonPolarChartSeries.ignoreEmptyPoints instead." }, "export": { - "DocID": "BaseWidget.Options.export", + "Description": "Configures the exporting and printing features.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.backgroundColor" + "Description": "Specifies the color that will fill transparent regions in the resulting file or document." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.enabled" + "Description": "Enables the client-side exporting in the widget." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.fileName" + "Description": "Specifies a default name for the file to which the widget will be exported." }, "formats": { "ItemPrimitiveTypes": [ @@ -26410,83 +25313,83 @@ ], "IsCollection": true, "SingularName": "format", - "DocID": "BaseWidget.Options.export.formats" + "Description": "Specifies a set of export formats." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.export.margin" + "Description": "Adds an empty space around the exported widget; measured in pixels." }, "printingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.printingEnabled" + "Description": "Enables the printing feature in the widget. Applies only if the export.enabled option is true." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "BaseWidget.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." }, "svgToCanvas": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseWidget.Options.export.svgToCanvas" + "Description": "A function that renders SVG markup on the HTML canvas. Required to export custom SVG elements (for example, markerTemplate)." } } }, "legend": { - "DocID": "dxPolarChart.Options.legend", + "Description": "Specifies the options of a chart's legend.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.backgroundColor" + "Description": "Colors the legend's background." }, "border": { - "DocID": "BaseLegend.border", + "Description": "Configures the legend's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.border.color" + "Description": "Colors the legend's border." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.cornerRadius" + "Description": "Makes all the legend's corners rounded." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.border.dashStyle" + "Description": "Sets a dash style for the legend's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.opacity" + "Description": "Specifies the transparency of the legend's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseLegend.border.visible" + "Description": "Shows the legend's border." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.width" + "Description": "Specifies the width of the legend's border in pixels." } } }, @@ -26494,103 +25397,97 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.columnCount" + "Description": "Arranges legend items into several columns." }, "columnItemSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.columnItemSpacing" + "Description": "Specifies an empty space between item columns in pixels." }, "customizeHint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPolarChart.Options.legend.customizeHint" + "Description": "Specifies the text for a hint that appears when a user hovers the mouse pointer over a legend item." }, "customizeItems": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseChart.Options.legend.customizeItems" + "Description": "Allows you to change the order, text, and visibility of legend items." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPolarChart.Options.legend.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed by legend items." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseLegend.font" + "Description": "Specifies the legend items' font options." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.horizontalAlignment" + "Description": "Along with verticalAlignment, specifies the legend's position." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.legend.hoverMode" + "Description": "Specifies what series elements to highlight when a corresponding item in the legend is hovered over." }, "itemsAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.itemsAlignment" + "Description": "Aligns items in the last column or row (depending on the legend's orientation). Applies when legend items are not divided into columns or rows equally." }, "itemTextPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.itemTextPosition" + "Description": "Specifies the text's position relative to the marker in a legend item." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin", + "Description": "Generates an empty space, measured in pixels, around the legend.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.bottom" + "Description": "Specifies the legend's bottom margin in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.left" + "Description": "Specifies the legend's left margin in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.right" + "Description": "Specifies the legend's right margin in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.top" + "Description": "Specifies the legend's top margin in pixels." } } }, @@ -26598,50 +25495,50 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.markerSize" + "Description": "Specifies the marker's size in a legend item in pixels." }, "markerTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "BaseChart.Options.legend.markerTemplate" + "Description": "Specifies an SVG element that serves as a custom legend item marker." }, "orientation": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.orientation" + "Description": "Arranges legend items vertically (in a column) or horizontally (in a row). The default value is \"horizontal\" if the legend.horizontalAlignment is \"center\". Otherwise, it is \"vertical\"." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between the legend's left/right border and its items." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between the legend's top/bottom border and its items." }, "rowCount": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.rowCount" + "Description": "Arranges legend items in several rows." }, "rowItemSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.rowItemSpacing" + "Description": "Specifies an empty space between item rows in pixels." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title", + "Description": "Configures the legend title.", "Options": { "font": { "PrimitiveTypes": [ @@ -26650,47 +25547,40 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseLegend.title.font" + "Description": "Specifies the legend title's font options." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.horizontalAlignment" + "Description": "Along with verticalAlignment, specifies the legend title's position." }, "margin": { - "DocID": "BaseLegend.title.margin", + "Description": "Generates space around the legend title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.bottom" + "Description": "Specifies the legend title's bottom margin." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.left" + "Description": "Specifies the legend title's left margin." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.right" + "Description": "Specifies the legend title's right margin." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.top" + "Description": "Specifies the legend title's top margin." } } }, @@ -26698,13 +25588,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the legend title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.subtitle", + "Description": "Configures the legend subtitle. The subtitle appears only if the title is specified.", "Options": { "font": { "PrimitiveTypes": [ @@ -26713,26 +25603,19 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseLegend.title.subtitle.font" + "Description": "Specifies the legend subtitle's font options." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.subtitle.offset" + "Description": "Specifies the distance between the legend's title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.subtitle.text" + "Description": "Specifies the subtitle's text." } } }, @@ -26740,13 +25623,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.text" + "Description": "Specifies the legend title's text." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.verticalAlignment" + "Description": "Specifies the legend title's vertical alignment." } } }, @@ -26754,87 +25637,81 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.verticalAlignment" + "Description": "Along with horizontalAlignment, specifies the legend's position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseLegend.visible" + "Description": "Specifies the legend's visibility." } } }, "loadingIndicator": { - "DocID": "BaseWidget.Options.loadingIndicator", + "Description": "Configures the loading indicator.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.backgroundColor" + "Description": "Colors the background of the loading indicator." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.loadingIndicator.enabled" + "Description": "Specifies whether the loading indicator should be displayed and hidden automatically." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.loadingIndicator.font" + "Description": "Specifies font options for the loading indicator." }, "show": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "BaseWidget.Options.loadingIndicator.show" + "Description": "Allows you to change the loading indicator's visibility." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.text" + "Description": "Specifies the text to be displayed by the loading indicator." } } }, "margin": { - "DocID": "BaseWidget.Options.margin", + "Description": "Generates space around the widget.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.bottom" + "Description": "Specifies the bottom margin of the widget in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.left" + "Description": "Specifies the left margin of the widget in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.right" + "Description": "Specifies the right margin of the widget in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.top" + "Description": "Specifies the top margin of the widget in pixels." } } }, @@ -26842,7 +25719,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.negativesAsZeroes" + "Description": "Forces the widget to treat negative values as zeroes. Applies to stacked-like series only." }, "onArgumentAxisClick": { "PrimitiveTypes": [ @@ -26851,7 +25728,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPolarChart.Options.onArgumentAxisClick" + "Description": "A function that is executed when a label on the argument axis is clicked or tapped." }, "onDisposing": { "PrimitiveTypes": [ @@ -26859,7 +25736,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDone": { "PrimitiveTypes": [ @@ -26867,7 +25744,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onDone" + "Description": "A function that is executed when all series are ready." }, "onDrawn": { "PrimitiveTypes": [ @@ -26875,7 +25752,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onExported": { "PrimitiveTypes": [ @@ -26883,7 +25760,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -26891,7 +25768,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -26899,7 +25776,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -26907,7 +25784,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -26915,7 +25792,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onLegendClick": { "PrimitiveTypes": [ @@ -26924,7 +25801,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPolarChart.Options.onLegendClick" + "Description": "A function that is executed when a legend item is clicked or tapped." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -26932,7 +25809,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPointClick": { "PrimitiveTypes": [ @@ -26941,7 +25818,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onPointClick" + "Description": "A function that is executed when a series point is clicked or tapped." }, "onPointHoverChanged": { "PrimitiveTypes": [ @@ -26949,7 +25826,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onPointHoverChanged" + "Description": "A function that is executed after the pointer enters or leaves a series point." }, "onPointSelectionChanged": { "PrimitiveTypes": [ @@ -26957,7 +25834,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onPointSelectionChanged" + "Description": "A function that is executed when a series point is selected or selection is canceled." }, "onSeriesClick": { "PrimitiveTypes": [ @@ -26966,7 +25843,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPolarChart.Options.onSeriesClick" + "Description": "A function that is executed when a series is clicked or tapped." }, "onSeriesHoverChanged": { "PrimitiveTypes": [ @@ -26974,7 +25851,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPolarChart.Options.onSeriesHoverChanged" + "Description": "A function that is executed after the pointer enters or leaves a series." }, "onSeriesSelectionChanged": { "PrimitiveTypes": [ @@ -26982,7 +25859,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPolarChart.Options.onSeriesSelectionChanged" + "Description": "A function that is executed when a series is selected or selection is canceled." }, "onTooltipHidden": { "PrimitiveTypes": [ @@ -26990,7 +25867,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onTooltipHidden" + "Description": "A function that is executed when a tooltip becomes hidden." }, "onTooltipShown": { "PrimitiveTypes": [ @@ -26998,7 +25875,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseChart.Options.onTooltipShown" + "Description": "A function that is executed when a tooltip appears." }, "onZoomEnd": { "PrimitiveTypes": [ @@ -27006,7 +25883,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPolarChart.Options.onZoomEnd" + "Description": "A function that is executed when zooming or panning ends." }, "onZoomStart": { "PrimitiveTypes": [ @@ -27014,7 +25891,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPolarChart.Options.onZoomStart" + "Description": "A function that is executed when zooming or panning begins." }, "palette": { "PrimitiveTypes": [ @@ -27025,43 +25902,43 @@ ], "IsCollection": true, "SingularName": "palette", - "DocID": "BaseChart.Options.palette" + "Description": "Sets the palette to be used for colorizing series and their elements." }, "paletteExtensionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseChart.Options.paletteExtensionMode" + "Description": "Specifies what to do with colors in the palette when their number is less than the number of series (in the Chart widget) or points in a series (in the PieChart widget)." }, "pathModified": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "pointSelectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseChart.Options.pointSelectionMode" + "Description": "Specifies whether a single point or multiple points can be selected in the chart." }, "redrawOnResize": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.redrawOnResize" + "Description": "Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates." }, "resolveLabelOverlapping": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.resolveLabelOverlapping" + "Description": "Specifies how the chart must behave when series point labels overlap." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "series": { "PrimitiveTypes": [ @@ -27078,46 +25955,46 @@ ], "IsCollection": true, "SingularName": "series", - "DocID": "dxPolarChart.Options.series" + "Description": "Specifies options for PolarChart widget series." }, "seriesSelectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.seriesSelectionMode" + "Description": "Specifies whether a single series or multiple series can be selected in the chart." }, "seriesTemplate": { - "DocID": "dxPolarChart.Options.seriesTemplate", + "Description": "Defines options for the series template.", "Options": { "customizeSeries": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPolarChart.Options.seriesTemplate.customizeSeries" + "Description": "Specifies a callback function that returns a series object with individual series settings." }, "nameField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.seriesTemplate.nameField" + "Description": "Specifies a data source field that represents the series name." } } }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, @@ -27125,64 +26002,58 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title", + "Description": "Configures the widget's title.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.title.font" + "Description": "Specifies font options for the title." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.horizontalAlignment" + "Description": "Specifies the title's alignment in a horizontal direction." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin", + "Description": "Generates space around the title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.bottom" + "Description": "Specifies the bottom margin of the title." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.left" + "Description": "Specifies the left margin of the title." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.right" + "Description": "Specifies the right margin of the title." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.top" + "Description": "Specifies the top margin of the title." } } }, @@ -27190,13 +26061,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle", + "Description": "Configures the widget's subtitle.", "Options": { "font": { "PrimitiveTypes": [ @@ -27205,38 +26076,31 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseWidget.Options.title.subtitle.font" + "Description": "Specifies font options for the subtitle." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.subtitle.offset" + "Description": "Specifies the distance between the title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.text" + "Description": "Specifies text for the subtitle." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.textOverflow" + "Description": "Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.wordWrap" + "Description": "Specifies how to wrap the subtitle if it does not fit into a single line." } } }, @@ -27244,85 +26108,79 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.text" + "Description": "Specifies the title's text." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.textOverflow" + "Description": "Specifies what to do with the title when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.verticalAlignment" + "Description": "Specifies the title's alignment in a vertical direction." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.wordWrap" + "Description": "Specifies how to wrap the title if it does not fit into a single line." } } }, "tooltip": { - "DocID": "dxPolarChart.Options.tooltip", + "Description": "Configures tooltips.", "Options": { "argumentFormat": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseChart.Options.tooltip.argumentFormat" + "Description": "Formats the point argument before it is displayed in the tooltip. To format the point value, use the format option." }, "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.arrowLength" + "Description": "Specifies the length of a tooltip's arrow in pixels." }, "border": { - "DocID": "BaseWidget.Options.tooltip.border", + "Description": "Configures a tooltip's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.color" + "Description": "Colors a tooltip's border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.dashStyle" + "Description": "Specifies the dash style of a tooltip's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.opacity" + "Description": "Specifies the transparency of a tooltip's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.border.visible" + "Description": "Specifies whether a tooltip's border is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.width" + "Description": "Specifies the width of a tooltip's border in pixels." } } }, @@ -27330,7 +26188,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.color" + "Description": "Colors all tooltips." }, "container": { "PrimitiveTypes": [ @@ -27338,115 +26196,103 @@ "JQuery", "string" ], - "DocID": "BaseWidget.Options.tooltip.container" + "Description": "Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "BaseChart.Options.tooltip.contentTemplate" + "Description": "Specifies a custom template for a tooltip." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.cornerRadius" + "Description": "Makes all the tooltip's corners rounded." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseChart.Options.tooltip.customizeTooltip" + "Description": "Allows you to change tooltip appearance." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.enabled" + "Description": "Enables tooltips." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.font" + "Description": "Specifies tooltips' font options." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.format" + "Description": "Formats a value before it is displayed it in a tooltip." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.opacity" + "Description": "Specifies tooltips' transparency." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between a tooltip's left/right border and its text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text." }, "shadow": { - "DocID": "BaseWidget.Options.tooltip.shadow", + "Description": "Configures a tooltip's shadow.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.blur" + "Description": "Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.shadow.color" + "Description": "Colors a tooltip's shadow." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetX" + "Description": "Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetY" + "Description": "Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.opacity" + "Description": "Specifies the transparency of a tooltip's shadow." } } }, @@ -27454,13 +26300,13 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.tooltip.shared" + "Description": "Specifies the kind of information to display in a tooltip." }, "zIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.zIndex" + "Description": "Specifies a tooltip's z-index." } } }, @@ -27468,22 +26314,22 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.useSpiderWeb" + "Description": "Indicates whether or not to display a \"spider web\"." }, "valueAxis": { - "DocID": "dxPolarChart.Options.valueAxis", + "Description": "Specifies value axis options for the PolarChart widget.", "Options": { "allowDecimals": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.allowDecimals" + "Description": "Specifies whether to allow decimal values on the axis. When false, the axis contains integer values only." }, "axisDivisionFactor": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.valueAxis.axisDivisionFactor" + "Description": "Specifies a coefficient for dividing the value axis." }, "categories": { "ItemPrimitiveTypes": [ @@ -27493,13 +26339,13 @@ ], "IsCollection": true, "SingularName": "category", - "DocID": "dxPolarChart.Options.valueAxis.categories" + "Description": "Specifies the order of categories on an axis of the \"discrete\" type." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.color" + "Description": "Specifies the color of the line that represents an axis." }, "constantLines": { "ItemPrimitiveTypes": [ @@ -27507,61 +26353,55 @@ ], "IsCollection": true, "SingularName": "constantLine", - "DocID": "dxPolarChart.Options.valueAxis.constantLines", + "Description": "Defines an array of the value axis constant lines.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.color" + "Description": "Specifies a color for a constant line." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.dashStyle" + "Description": "Specifies a dash style for a constant line." }, "displayBehindSeries": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.valueAxis.constantLines.displayBehindSeries" + "Description": "Specifies whether to display the constant line behind or in front of the series." }, "extendAxis": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.valueAxis.constantLines.extendAxis" + "Description": "Specifies whether to extend the axis to display the constant line." }, "label": { - "DocID": "dxPolarChart.Options.valueAxis.constantLines.label", + "Description": "An object defining constant line label options.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label.font" + "Description": "Specifies font options for a constant line label." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.valueAxis.constantLines.label.text" + "Description": "Specifies the text to be displayed in a constant line label." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label.visible" + "Description": "Indicates whether or not to display labels for the axis constant lines." } } }, @@ -27571,54 +26411,48 @@ "number", "string" ], - "DocID": "dxPolarChart.Options.valueAxis.constantLines.value" + "Description": "Specifies a value to be displayed by a constant line." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.width" + "Description": "Specifies a constant line width in pixels." } } }, "constantLineStyle": { - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle", + "Description": "Specifies the appearance of all the widget's constant lines.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.color" + "Description": "Specifies a color for a constant line." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.dashStyle" + "Description": "Specifies a dash style for a constant line." }, "label": { - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label", + "Description": "An object defining constant line label options.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label.font" + "Description": "Specifies font options for a constant line label." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.label.visible" + "Description": "Indicates whether or not to display labels for the axis constant lines." } } }, @@ -27626,7 +26460,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.constantLineStyle.width" + "Description": "Specifies a constant line width in pixels." } } }, @@ -27634,40 +26468,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.discreteAxisDivisionMode" + "Description": "Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels." }, "endOnTick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.valueAxis.endOnTick" + "Description": "Specifies whether to force the axis to start and end on ticks." }, "grid": { - "DocID": "dxPolarChart.Options.commonAxisSettings.grid", + "Description": "An object defining the configuration options for the grid lines of an axis in the PolarChart widget.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.grid.color" + "Description": "Specifies a color for grid lines." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.grid.opacity" + "Description": "Specifies an opacity for grid lines." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.grid.visible" + "Description": "Indicates whether or not the grid lines of an axis are visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.grid.width" + "Description": "Specifies the width of grid lines." } } }, @@ -27675,73 +26509,61 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.inverted" + "Description": "Indicates whether or not an axis is inverted." }, "label": { - "DocID": "dxPolarChart.Options.valueAxis.label", + "Description": "Specifies options for value axis labels.", "Options": { "customizeHint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPolarChart.Options.valueAxis.label.customizeHint" + "Description": "Specifies the text for a hint that appears when a user hovers the mouse pointer over a label on the value axis." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxPolarChart.Options.valueAxis.label.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed in value axis labels." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.label.font" + "Description": "Specifies font options for axis labels." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxPolarChart.Options.valueAxis.label.format" + "Description": "Formats a value before it is displayed in an axis label." }, "indentFromAxis": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.label.indentFromAxis" + "Description": "Specifies the spacing between an axis and its labels in pixels." }, "overlappingBehavior": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.label.overlappingBehavior" + "Description": "Decides how to arrange axis labels when there is not enough space to keep all of them." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.label.visible" + "Description": "Indicates whether or not axis labels are visible." } } }, @@ -27749,81 +26571,81 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.valueAxis.linearThreshold" + "Description": "Specifies a value used to calculate the range on a logarithmic axis within which the axis should be linear. Applies only if the data source contains negative values or zeroes." }, "logarithmBase": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.valueAxis.logarithmBase" + "Description": "Specifies the value to be raised to a power when generating ticks for a logarithmic axis." }, "maxValueMargin": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.valueAxis.maxValueMargin" + "Description": "Specifies a coefficient that determines the spacing between the maximum series point and the axis." }, "minorGrid": { - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid", + "Description": "Specifies the options of the minor grid.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid.color" + "Description": "Specifies a color for the lines of the minor grid." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid.opacity" + "Description": "Specifies an opacity for the lines of the minor grid." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid.visible" + "Description": "Indicates whether the minor grid is visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorGrid.width" + "Description": "Specifies a width for the lines of the minor grid." } } }, "minorTick": { - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick", + "Description": "Specifies the options of the minor ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.color" + "Description": "Specifies a color for the minor ticks." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.length" + "Description": "Specifies minor tick length." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.opacity" + "Description": "Specifies an opacity for the minor ticks." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.visible" + "Description": "Indicates whether or not the minor ticks are displayed on an axis." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.minorTick.width" + "Description": "Specifies minor tick width." } } }, @@ -27831,68 +26653,68 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.valueAxis.minorTickCount" + "Description": "Specifies the number of minor ticks between two neighboring major ticks." }, "minorTickInterval": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxPolarChart.Options.valueAxis.minorTickInterval", + "Description": "Specifies the interval between minor ticks.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -27900,68 +26722,68 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.valueAxis.minValueMargin" + "Description": "Specifies a coefficient that determines the spacing between the minimum series point and the axis." }, "minVisualRangeLength": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxPolarChart.Options.valueAxis.minVisualRangeLength", + "Description": "Specifies the minimum length of the visual range.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -27969,13 +26791,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.opacity" + "Description": "Specifies the opacity of the line that represents an axis." }, "showZero": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.valueAxis.showZero" + "Description": "Specifies whether or not to indicate a zero value on the value axis." }, "strips": { "ItemPrimitiveTypes": [ @@ -27983,13 +26805,13 @@ ], "IsCollection": true, "SingularName": "strip", - "DocID": "dxPolarChart.Options.valueAxis.strips", + "Description": "Specifies options for value axis strips.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.valueAxis.strips.color" + "Description": "Specifies a color for a strip." }, "endValue": { "PrimitiveTypes": [ @@ -27997,31 +26819,25 @@ "number", "string" ], - "DocID": "dxPolarChart.Options.valueAxis.strips.endValue" + "Description": "Specifies an end value for a strip." }, "label": { - "DocID": "dxPolarChart.Options.valueAxis.strips.label", + "Description": "An object that defines the label configuration options of a strip.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.stripStyle.label.font" + "Description": "Specifies font options for a strip label." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.valueAxis.strips.label.text" + "Description": "Specifies the text displayed in a strip." } } }, @@ -28031,67 +26847,61 @@ "number", "string" ], - "DocID": "dxPolarChart.Options.valueAxis.strips.startValue" + "Description": "Specifies a start value for a strip." } } }, "stripStyle": { - "DocID": "dxPolarChart.Options.commonAxisSettings.stripStyle", + "Description": "An object defining configuration options for strip style.", "Options": { "label": { - "DocID": "dxPolarChart.Options.commonAxisSettings.stripStyle.label", + "Description": "An object defining the configuration options for a strip label style.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChart.Options.commonAxisSettings.stripStyle.label.font" + "Description": "Specifies font options for a strip label." } } } } }, "tick": { - "DocID": "dxPolarChart.Options.valueAxis.tick", + "Description": "An object defining the configuration options for axis ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.color" + "Description": "Specifies ticks color." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.length" + "Description": "Specifies tick length." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.opacity" + "Description": "Specifies tick opacity." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.valueAxis.tick.visible" + "Description": "Indicates whether or not ticks are visible on an axis." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.tick.width" + "Description": "Specifies tick width." } } }, @@ -28100,61 +26910,61 @@ "number", "string" ], - "DocID": "dxPolarChart.Options.valueAxis.tickInterval", + "Description": "Specifies an interval between axis ticks/grid lines.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -28162,25 +26972,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.valueAxis.type" + "Description": "Specifies the required type of the value axis." }, "valueMarginsEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.valueAxis.valueMarginsEnabled" + "Description": "Indicates whether to display series with indents from axis boundaries." }, "valueType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.valueAxis.valueType" + "Description": "Specifies the desired type of axis values." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.visible" + "Description": "Indicates whether or not the line that represents an axis in a chart is visible." }, "visualRange": { "PrimitiveTypes": [ @@ -28194,23 +27004,16 @@ "string", "Date" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "IsChangeable": true, "SingularName": "visualRange", - "DocID": "dxPolarChart.Options.valueAxis.visualRange" + "Description": "Defines the axis' displayed range. Cannot be wider than the wholeRange." }, "visualRangeUpdateMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChart.Options.valueAxis.visualRangeUpdateMode" + "Description": "Specifies how the axis's visual range should behave when the PolarChart data is updated." }, "wholeRange": { "PrimitiveTypes": [ @@ -28224,64 +27027,45 @@ "string", "Date" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "wholeRange", - "DocID": "dxPolarChart.Options.valueAxis.wholeRange" + "Description": "Defines the range where the axis can be zoomed." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChart.Options.commonAxisSettings.width" + "Description": "Specifies the width of the line that represents an axis in the chart." } } } } }, "dxPopover": { - "DocID": "dxPopover", + "Description": "The Popover is a widget that shows notifications within a box with an arrow pointing to a specified UI element.", "IsTranscludedContent": true, "Module": "ui/popover", "Options": { "animation": { - "DocID": "dxPopover.Options.animation", + "Description": "Configures widget visibility animations. This object contains two fields: show and hide.", "Options": { "hide": { "PrimitiveTypes": [ - "animationConfig" + "DevExpress.animationConfig" ], "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "animationConfig", - "Path": "animation/fx" - } - ], - "DocID": "dxPopover.Options.animation.hide" + "Description": "An object that defines the animation options used when the widget is being hidden." }, "show": { "PrimitiveTypes": [ - "animationConfig" + "DevExpress.animationConfig" ], "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "animationConfig", - "Path": "animation/fx" - } - ], - "DocID": "dxPopover.Options.animation.show" + "Description": "An object that defines the animation options used when the widget is being shown." } } }, @@ -28291,7 +27075,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxPopover.Options.closeOnOutsideClick" + "Description": "A Boolean value specifying whether or not the widget is closed if a user clicks outside of the popover window and outside the target element." }, "container": { "PrimitiveTypes": [ @@ -28299,32 +27083,32 @@ "JQuery", "string" ], - "DocID": "dxPopup.Options.container" + "Description": "Specifies the container in which to render the widget." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxOverlay.Options.contentTemplate" + "Description": "Specifies a custom template for the widget content." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxOverlay.Options.deferRendering" + "Description": "Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -28334,25 +27118,25 @@ ], "IsFunc": true, "IsChangeable": true, - "DocID": "dxPopover.Options.height" + "Description": "Specifies the widget's height." }, "hideEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopover.Options.hideEvent", + "Description": "Specifies options of popover hiding.", "Options": { "delay": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPopover.Options.hideEvent.delay" + "Description": "The delay in milliseconds after which the widget is hidden." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopover.Options.hideEvent.name" + "Description": "Specifies the event names on which the widget is hidden." } } }, @@ -28360,13 +27144,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "maxHeight": { "PrimitiveTypes": [ @@ -28375,7 +27159,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.maxHeight" + "Description": "Specifies the maximum height the widget can reach while resizing." }, "maxWidth": { "PrimitiveTypes": [ @@ -28384,7 +27168,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.maxWidth" + "Description": "Specifies the maximum width the widget can reach while resizing." }, "minHeight": { "PrimitiveTypes": [ @@ -28393,7 +27177,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.minHeight" + "Description": "Specifies the minimum height the widget can reach while resizing." }, "minWidth": { "PrimitiveTypes": [ @@ -28402,7 +27186,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.minWidth" + "Description": "Specifies the minimum width the widget can reach while resizing." }, "onContentReady": { "PrimitiveTypes": [ @@ -28410,7 +27194,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -28418,7 +27202,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onHidden": { "PrimitiveTypes": [ @@ -28426,7 +27210,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onHidden" + "Description": "A function that is executed after the widget is hidden." }, "onHiding": { "PrimitiveTypes": [ @@ -28434,7 +27218,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onHiding" + "Description": "A function that is executed before the widget is hidden." }, "onInitialized": { "PrimitiveTypes": [ @@ -28442,7 +27226,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -28450,7 +27234,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onShowing": { "PrimitiveTypes": [ @@ -28458,7 +27242,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onShowing" + "Description": "A function that is executed before the widget is displayed." }, "onShown": { "PrimitiveTypes": [ @@ -28466,7 +27250,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onShown" + "Description": "A function that is executed after the widget is displayed." }, "onTitleRendered": { "PrimitiveTypes": [ @@ -28474,7 +27258,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPopup.Options.onTitleRendered" + "Description": "A function that is executed when the widget's title is rendered." }, "position": { "PrimitiveTypes": [ @@ -28484,57 +27268,50 @@ "ComplexTypes": [ "PositionConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsChangeable": true, - "DocID": "dxPopover.Options.position" + "Description": "An object defining widget positioning options." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "shading": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopover.Options.shading" + "Description": "Specifies whether to shade the background when the widget is active." }, "shadingColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxOverlay.Options.shadingColor" + "Description": "Specifies the shading color. Applies only if shading is enabled." }, "showCloseButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopup.Options.showCloseButton" + "Description": "Specifies whether or not the widget displays the Close button." }, "showEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopover.Options.showEvent", + "Description": "Specifies options for displaying the widget.", "Options": { "delay": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPopover.Options.showEvent.delay" + "Description": "The delay in milliseconds after which the widget is displayed." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopover.Options.showEvent.name" + "Description": "Specifies the event names on which the widget is shown." } } }, @@ -28542,7 +27319,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopover.Options.showTitle" + "Description": "A Boolean value specifying whether or not to display the title in the overlay window." }, "target": { "PrimitiveTypes": [ @@ -28550,20 +27327,20 @@ "JQuery", "string" ], - "DocID": "dxPopover.Options.target" + "Description": "The target element associated with the widget." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopup.Options.title" + "Description": "The title in the overlay window." }, "titleTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxPopup.Options.titleTemplate" + "Description": "Specifies a custom template for the widget title. Does not apply if the title is defined." }, "toolbarItems": { "ItemPrimitiveTypes": [ @@ -28571,62 +27348,62 @@ ], "IsCollection": true, "SingularName": "toolbarItem", - "DocID": "dxPopup.Options.toolbarItems", + "Description": "Configures toolbar items.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopup.Options.toolbarItems.disabled" + "Description": "Specifies whether the toolbar item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopup.Options.toolbarItems.html" + "Description": "Specifies html code inserted into the toolbar item element." }, "location": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopup.Options.toolbarItems.location" + "Description": "Specifies a location for the item on the toolbar." }, "options": { "PrimitiveTypes": [ "any" ], - "DocID": "dxPopup.Options.toolbarItems.options" + "Description": "Configures the DevExtreme widget used as a toolbar item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxPopup.Options.toolbarItems.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopup.Options.toolbarItems.text" + "Description": "Specifies text displayed for the toolbar item." }, "toolbar": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopup.Options.toolbarItems.toolbar" + "Description": "Specifies whether the item is displayed on a top or bottom toolbar." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopup.Options.toolbarItems.visible" + "Description": "Specifies whether or not a widget item must be displayed." }, "widget": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopup.Options.toolbarItems.widget" + "Description": "A widget that presents a toolbar item." } } }, @@ -28635,7 +27412,7 @@ "boolean" ], "IsChangeable": true, - "DocID": "dxOverlay.Options.visible" + "Description": "A Boolean value specifying whether or not the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -28645,12 +27422,12 @@ ], "IsFunc": true, "IsChangeable": true, - "DocID": "dxPopover.Options.width" + "Description": "Specifies the widget's width." } } }, "dxPopup": { - "DocID": "dxPopup", + "Description": "The Popup widget is a pop-up window overlaying the current view.", "IsTranscludedContent": true, "Module": "ui/popup", "Options": { @@ -28658,40 +27435,28 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "animation": { - "DocID": "dxPopup.Options.animation", + "Description": "Configures widget visibility animations. This object contains two fields: show and hide.", "Options": { "hide": { "PrimitiveTypes": [ - "animationConfig" + "DevExpress.animationConfig" ], "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "animationConfig", - "Path": "animation/fx" - } - ], - "DocID": "dxPopup.Options.animation.hide" + "Description": "An object that defines the animation options used when the widget is being hidden." }, "show": { "PrimitiveTypes": [ - "animationConfig" + "DevExpress.animationConfig" ], "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "animationConfig", - "Path": "animation/fx" - } - ], - "DocID": "dxPopup.Options.animation.show" + "Description": "An object that defines the animation options used when the widget is being shown." } } }, @@ -28701,7 +27466,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxOverlay.Options.closeOnOutsideClick" + "Description": "Specifies whether to close the widget if a user clicks outside it." }, "container": { "PrimitiveTypes": [ @@ -28709,50 +27474,50 @@ "JQuery", "string" ], - "DocID": "dxPopup.Options.container" + "Description": "Specifies the container in which to render the widget." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxOverlay.Options.contentTemplate" + "Description": "Specifies a custom template for the widget content." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxOverlay.Options.deferRendering" + "Description": "Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "dragEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopup.Options.dragEnabled" + "Description": "Specifies whether or not to allow a user to drag the popup window." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopup.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "fullScreen": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopup.Options.fullScreen" + "Description": "Specifies whether to display the Popup in full-screen mode." }, "height": { "PrimitiveTypes": [ @@ -28762,19 +27527,19 @@ ], "IsFunc": true, "IsChangeable": true, - "DocID": "dxPopup.Options.height" + "Description": "Specifies the widget's height in pixels." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "maxHeight": { "PrimitiveTypes": [ @@ -28783,7 +27548,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.maxHeight" + "Description": "Specifies the maximum height the widget can reach while resizing." }, "maxWidth": { "PrimitiveTypes": [ @@ -28792,7 +27557,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.maxWidth" + "Description": "Specifies the maximum width the widget can reach while resizing." }, "minHeight": { "PrimitiveTypes": [ @@ -28801,7 +27566,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.minHeight" + "Description": "Specifies the minimum height the widget can reach while resizing." }, "minWidth": { "PrimitiveTypes": [ @@ -28810,7 +27575,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.minWidth" + "Description": "Specifies the minimum width the widget can reach while resizing." }, "onContentReady": { "PrimitiveTypes": [ @@ -28818,7 +27583,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -28826,7 +27591,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onHidden": { "PrimitiveTypes": [ @@ -28834,7 +27599,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onHidden" + "Description": "A function that is executed after the widget is hidden." }, "onHiding": { "PrimitiveTypes": [ @@ -28842,7 +27607,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onHiding" + "Description": "A function that is executed before the widget is hidden." }, "onInitialized": { "PrimitiveTypes": [ @@ -28850,7 +27615,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -28858,7 +27623,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onResize": { "PrimitiveTypes": [ @@ -28866,7 +27631,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPopup.Options.onResize" + "Description": "A function that is executed each time the widget is resized by one pixel." }, "onResizeEnd": { "PrimitiveTypes": [ @@ -28874,7 +27639,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPopup.Options.onResizeEnd" + "Description": "A function that is executed when resizing ends." }, "onResizeStart": { "PrimitiveTypes": [ @@ -28882,7 +27647,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPopup.Options.onResizeStart" + "Description": "A function that is executed when resizing starts." }, "onShowing": { "PrimitiveTypes": [ @@ -28890,7 +27655,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onShowing" + "Description": "A function that is executed before the widget is displayed." }, "onShown": { "PrimitiveTypes": [ @@ -28898,7 +27663,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onShown" + "Description": "A function that is executed after the widget is displayed." }, "onTitleRendered": { "PrimitiveTypes": [ @@ -28906,7 +27671,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxPopup.Options.onTitleRendered" + "Description": "A function that is executed when the widget's title is rendered." }, "position": { "PrimitiveTypes": [ @@ -28917,71 +27682,64 @@ "ComplexTypes": [ "PositionConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsFunc": true, "IsChangeable": true, - "DocID": "dxPopup.Options.position" + "Description": "Positions the widget." }, "resizeEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopup.Options.resizeEnabled" + "Description": "Specifies whether or not an end user can resize the widget." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "shading": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxOverlay.Options.shading" + "Description": "Specifies whether to shade the background when the widget is active." }, "shadingColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxOverlay.Options.shadingColor" + "Description": "Specifies the shading color. Applies only if shading is enabled." }, "showCloseButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopup.Options.showCloseButton" + "Description": "Specifies whether or not the widget displays the Close button." }, "showTitle": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopup.Options.showTitle" + "Description": "A Boolean value specifying whether or not to display the title in the popup window." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopup.Options.title" + "Description": "The title in the overlay window." }, "titleTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxPopup.Options.titleTemplate" + "Description": "Specifies a custom template for the widget title. Does not apply if the title is defined." }, "toolbarItems": { "ItemPrimitiveTypes": [ @@ -28989,62 +27747,62 @@ ], "IsCollection": true, "SingularName": "toolbarItem", - "DocID": "dxPopup.Options.toolbarItems", + "Description": "Configures toolbar items.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopup.Options.toolbarItems.disabled" + "Description": "Specifies whether the toolbar item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopup.Options.toolbarItems.html" + "Description": "Specifies html code inserted into the toolbar item element." }, "location": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopup.Options.toolbarItems.location" + "Description": "Specifies a location for the item on the toolbar." }, "options": { "PrimitiveTypes": [ "any" ], - "DocID": "dxPopup.Options.toolbarItems.options" + "Description": "Configures the DevExtreme widget used as a toolbar item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxPopup.Options.toolbarItems.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopup.Options.toolbarItems.text" + "Description": "Specifies text displayed for the toolbar item." }, "toolbar": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopup.Options.toolbarItems.toolbar" + "Description": "Specifies whether the item is displayed on a top or bottom toolbar." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopup.Options.toolbarItems.visible" + "Description": "Specifies whether or not a widget item must be displayed." }, "widget": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopup.Options.toolbarItems.widget" + "Description": "A widget that presents a toolbar item." } } }, @@ -29053,7 +27811,7 @@ "boolean" ], "IsChangeable": true, - "DocID": "dxOverlay.Options.visible" + "Description": "A Boolean value specifying whether or not the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -29063,25 +27821,25 @@ ], "IsFunc": true, "IsChangeable": true, - "DocID": "dxPopup.Options.width" + "Description": "Specifies the widget's width in pixels." } } }, "dxProgressBar": { - "DocID": "dxProgressBar", + "Description": "The ProgressBar is a widget that shows current progress.", "Module": "ui/progress_bar", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -29090,37 +27848,37 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "max": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTrackBar.Options.max" + "Description": "The maximum value the widget can accept." }, "min": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTrackBar.Options.min" + "Description": "The minimum value the widget can accept." }, "onComplete": { "PrimitiveTypes": [ @@ -29128,7 +27886,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxProgressBar.Options.onComplete" + "Description": "A function that is executed when the value reaches the maximum." }, "onContentReady": { "PrimitiveTypes": [ @@ -29136,7 +27894,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -29144,7 +27902,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -29152,7 +27910,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -29160,7 +27918,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onValueChanged": { "PrimitiveTypes": [ @@ -29168,25 +27926,25 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showStatus": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxProgressBar.Options.showStatus" + "Description": "Specifies whether or not the widget displays a progress status." }, "statusFormat": { "PrimitiveTypes": [ @@ -29194,13 +27952,13 @@ "string" ], "IsFunc": true, - "DocID": "dxProgressBar.Options.statusFormat" + "Description": "Specifies a format for the progress status." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -29208,32 +27966,32 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "dxProgressBar.Options.value" + "Description": "The current widget value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -29242,12 +28000,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxRadioGroup": { - "DocID": "dxRadioGroup", + "Description": "The RadioGroup is a widget that contains a set of radio buttons and allows an end user to make a single selection from the set.", "Module": "ui/radio_group", "IsEditor": true, "Options": { @@ -29255,13 +28013,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRadioGroup.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "dataSource": { "PrimitiveTypes": [ @@ -29273,21 +28031,14 @@ "DevExpress.ui.CollectionWidgetItem", "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "DataExpressionMixin.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "displayExpr": { "PrimitiveTypes": [ @@ -29295,19 +28046,19 @@ "string" ], "IsFunc": true, - "DocID": "DataExpressionMixin.Options.displayExpr" + "Description": "Specifies the data field whose values should be displayed." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRadioGroup.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -29316,25 +28067,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRadioGroup.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "items": { "ItemPrimitiveTypes": [ @@ -29342,38 +28093,38 @@ ], "IsCollection": true, "SingularName": "item", - "DocID": "DataExpressionMixin.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -29382,19 +28133,19 @@ "any" ], "IsTemplate": true, - "DocID": "DataExpressionMixin.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "layout": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRadioGroup.Options.layout" + "Description": "Specifies the radio group layout." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRadioGroup.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "onContentReady": { "PrimitiveTypes": [ @@ -29402,7 +28153,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -29410,7 +28161,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -29418,7 +28169,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -29426,7 +28177,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onValueChanged": { "PrimitiveTypes": [ @@ -29434,31 +28185,31 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -29466,26 +28217,26 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "dxRadioGroup.Options.value" + "Description": "Specifies the widget's value." }, "valueExpr": { "PrimitiveTypes": [ @@ -29493,13 +28244,13 @@ "string" ], "IsFunc": true, - "DocID": "DataExpressionMixin.Options.valueExpr" + "Description": "Specifies which data field provides unique values to the widget's value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -29508,37 +28259,37 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxRangeSelector": { - "DocID": "dxRangeSelector", + "Description": "The RangeSelector is a widget that allows a user to select a range of values on a scale.", "Module": "viz/range_selector", "Options": { "background": { - "DocID": "dxRangeSelector.Options.background", + "Description": "Specifies the options for the range selector's background.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.background.color" + "Description": "Specifies the background color for the RangeSelector." }, "image": { - "DocID": "dxRangeSelector.Options.background.image", + "Description": "Specifies image options.", "Options": { "location": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.background.image.location" + "Description": "Specifies a location for the image in the background of a range selector." }, "url": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.background.image.url" + "Description": "Specifies the image's URL." } } }, @@ -29546,78 +28297,78 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.background.visible" + "Description": "Indicates whether or not the background (background color and/or image) is visible." } } }, "behavior": { - "DocID": "dxRangeSelector.Options.behavior", + "Description": "Specifies the RangeSelector's behavior options.", "Options": { "allowSlidersSwap": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.behavior.allowSlidersSwap" + "Description": "Indicates whether or not you can swap sliders." }, "animationEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.behavior.animationEnabled" + "Description": "Indicates whether or not animation is enabled." }, "callValueChanged": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.behavior.callValueChanged" + "Description": "Specifies when to call the onValueChanged function." }, "manualRangeSelectionEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.behavior.manualRangeSelectionEnabled" + "Description": "Indicates whether or not an end user can specify the range using a mouse, without the use of sliders." }, "moveSelectedRangeByClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.behavior.moveSelectedRangeByClick" + "Description": "Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking." }, "snapToTicks": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.behavior.snapToTicks" + "Description": "Indicates whether to snap a slider to ticks." } } }, "chart": { - "DocID": "dxRangeSelector.Options.chart", + "Description": "Specifies the options required to display a chart as the range selector's background.", "Options": { "barGroupPadding": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.chart.barGroupPadding" + "Description": "Controls the padding and consequently the width of a group of bars with the same argument using relative units. Ignored if the barGroupWidth option is set." }, "barGroupWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.chart.barGroupWidth" + "Description": "Specifies a fixed width for groups of bars with the same argument, measured in pixels. Takes precedence over the barGroupPadding option." }, "barWidth": { "PrimitiveTypes": [ "number" ], "IsDeprecated": true, - "DocID": "dxRangeSelector.Options.chart.barWidth" + "Description": "Use CommonSeries.barPadding instead." }, "bottomIndent": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.chart.bottomIndent" + "Description": "Specifies an indent from the background's bottom to the lowest chart point. Accepts values from 0 to 1." }, "commonSeriesSettings": { "PrimitiveTypes": [ @@ -29626,22 +28377,22 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "dxRangeSelector.Options.chart.commonSeriesSettings" + "Description": "An object defining the common configuration options for the chart’s series." }, "dataPrepareSettings": { - "DocID": "dxRangeSelector.Options.chart.dataPrepareSettings", + "Description": "An object providing options for managing data from a data source.", "Options": { "checkTypeForAllData": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.chart.dataPrepareSettings.checkTypeForAllData" + "Description": "Specifies whether or not to validate values from a data source." }, "convertToAxisDataType": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.chart.dataPrepareSettings.convertToAxisDataType" + "Description": "Specifies whether or not to convert the values from a data source into the data type of an axis." }, "sortingMethod": { "PrimitiveTypes": [ @@ -29649,7 +28400,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxRangeSelector.Options.chart.dataPrepareSettings.sortingMethod" + "Description": "Specifies how to sort series points." } } }, @@ -29658,25 +28409,25 @@ "boolean" ], "IsDeprecated": true, - "DocID": "dxRangeSelector.Options.chart.equalBarWidth" + "Description": "Use CommonSeries.ignoreEmptyPoints instead." }, "maxBubbleSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.chart.maxBubbleSize" + "Description": "Specifies a coefficient that determines the diameter of the largest bubble." }, "minBubbleSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.chart.minBubbleSize" + "Description": "Specifies the diameter of the smallest bubble measured in pixels." }, "negativesAsZeroes": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.chart.negativesAsZeroes" + "Description": "Forces the widget to treat negative values as zeroes. Applies to stacked-like series only." }, "palette": { "PrimitiveTypes": [ @@ -29687,13 +28438,13 @@ ], "IsCollection": true, "SingularName": "palette", - "DocID": "dxRangeSelector.Options.chart.palette" + "Description": "Sets the palette to be used to colorize series in the chart." }, "paletteExtensionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.chart.paletteExtensionMode" + "Description": "Specifies what to do with colors in the palette when their number is less than the number of series in the chart." }, "series": { "PrimitiveTypes": [ @@ -29710,23 +28461,23 @@ ], "IsCollection": true, "SingularName": "series", - "DocID": "dxRangeSelector.Options.chart.series" + "Description": "An object defining the chart’s series." }, "seriesTemplate": { - "DocID": "dxRangeSelector.Options.chart.seriesTemplate", + "Description": "Defines options for the series template.", "Options": { "customizeSeries": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxRangeSelector.Options.chart.seriesTemplate.customizeSeries" + "Description": "Specifies a callback function that returns a series object with individual series settings." }, "nameField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.chart.seriesTemplate.nameField" + "Description": "Specifies a data source field that represents the series name." } } }, @@ -29734,53 +28485,53 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.chart.topIndent" + "Description": "Specifies an indent from the background's top to the topmost chart point. Accepts values from 0 to 1." }, "useAggregation": { "PrimitiveTypes": [ "boolean" ], "IsDeprecated": true, - "DocID": "dxRangeSelector.Options.chart.useAggregation" + "Description": "Use CommonSeries.aggregation.enabled instead." }, "valueAxis": { - "DocID": "dxRangeSelector.Options.chart.valueAxis", + "Description": "Configures the chart value axis.", "Options": { "inverted": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.chart.valueAxis.inverted" + "Description": "Indicates whether or not the chart's value axis must be inverted." }, "logarithmBase": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.chart.valueAxis.logarithmBase" + "Description": "Specifies the value to be raised to a power when generating ticks for a logarithmic value axis." }, "max": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.chart.valueAxis.max" + "Description": "Specifies the maximum value of the chart's value axis." }, "min": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.chart.valueAxis.min" + "Description": "Specifies the minimum value of the chart's value axis." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.chart.valueAxis.type" + "Description": "Specifies the type of the value axis." }, "valueType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.chart.valueAxis.valueType" + "Description": "Specifies the desired type of axis values." } } } @@ -29790,7 +28541,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.containerBackgroundColor" + "Description": "Specifies the color of the parent page element." }, "dataSource": { "PrimitiveTypes": [ @@ -29801,54 +28552,47 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxRangeSelector.Options.dataSource" + "Description": "Specifies a data source for the scale values and for the chart at the background." }, "dataSourceField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.dataSourceField" + "Description": "Specifies the data source field that provides data for the scale." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "export": { - "DocID": "BaseWidget.Options.export", + "Description": "Configures the exporting and printing features.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.backgroundColor" + "Description": "Specifies the color that will fill transparent regions in the resulting file or document." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.enabled" + "Description": "Enables the client-side exporting in the widget." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.fileName" + "Description": "Specifies a default name for the file to which the widget will be exported." }, "formats": { "ItemPrimitiveTypes": [ @@ -29856,124 +28600,118 @@ ], "IsCollection": true, "SingularName": "format", - "DocID": "BaseWidget.Options.export.formats" + "Description": "Specifies a set of export formats." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.export.margin" + "Description": "Adds an empty space around the exported widget; measured in pixels." }, "printingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.printingEnabled" + "Description": "Enables the printing feature in the widget. Applies only if the export.enabled option is true." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "BaseWidget.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." }, "svgToCanvas": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseWidget.Options.export.svgToCanvas" + "Description": "A function that renders SVG markup on the HTML canvas. Required to export custom SVG elements (for example, markerTemplate)." } } }, "indent": { - "DocID": "dxRangeSelector.Options.indent", + "Description": "Range selector's indent options.", "Options": { "left": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.indent.left" + "Description": "Specifies range selector's left indent." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.indent.right" + "Description": "Specifies range selector's right indent." } } }, "loadingIndicator": { - "DocID": "BaseWidget.Options.loadingIndicator", + "Description": "Configures the loading indicator.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.backgroundColor" + "Description": "Colors the background of the loading indicator." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.loadingIndicator.enabled" + "Description": "Specifies whether the loading indicator should be displayed and hidden automatically." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.loadingIndicator.font" + "Description": "Specifies font options for the loading indicator." }, "show": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "BaseWidget.Options.loadingIndicator.show" + "Description": "Allows you to change the loading indicator's visibility." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.text" + "Description": "Specifies the text to be displayed by the loading indicator." } } }, "margin": { - "DocID": "BaseWidget.Options.margin", + "Description": "Generates space around the widget.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.bottom" + "Description": "Specifies the bottom margin of the widget in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.left" + "Description": "Specifies the left margin of the widget in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.right" + "Description": "Specifies the right margin of the widget in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.top" + "Description": "Specifies the top margin of the widget in pixels." } } }, @@ -29983,7 +28721,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDrawn": { "PrimitiveTypes": [ @@ -29991,7 +28729,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onExported": { "PrimitiveTypes": [ @@ -29999,7 +28737,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -30007,7 +28745,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -30015,7 +28753,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -30023,7 +28761,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -30031,7 +28769,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -30039,7 +28777,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onValueChanged": { "PrimitiveTypes": [ @@ -30047,101 +28785,101 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxRangeSelector.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "pathModified": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "redrawOnResize": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.redrawOnResize" + "Description": "Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scale": { - "DocID": "dxRangeSelector.Options.scale", + "Description": "Specifies options of the range selector's scale.", "Options": { "aggregateByCategory": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.scale.aggregateByCategory" + "Description": "Aggregates series points that fall into the same category." }, "aggregationGroupWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.aggregationGroupWidth" + "Description": "Specifies the length of aggregation intervals in pixels. Does not apply if aggregateByCategory is true. May be ignored in favor of the aggregationInterval option." }, "aggregationInterval": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxRangeSelector.Options.scale.aggregationInterval", + "Description": "Specifies the length of aggregation intervals in scale units. Applies only to the scale of the continuous or logarithmic type.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -30149,7 +28887,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.scale.allowDecimals" + "Description": "Specifies whether to allow decimal values on the scale. When false, the scale contains integer values only." }, "breaks": { "ItemPrimitiveTypes": [ @@ -30158,37 +28896,30 @@ "ItemComplexTypes": [ "VizScaleBreak" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "break", - "DocID": "dxRangeSelector.Options.scale.breaks" + "Description": "Declares a scale break collection. Applies only if the scale's type is \"continuous\" or \"logarithmic\"." }, "breakStyle": { - "DocID": "dxRangeSelector.Options.scale.breakStyle", + "Description": "Configures the scale breaks' appearance.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.scale.breakStyle.color" + "Description": "Specifies the scale breaks' color." }, "line": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.scale.breakStyle.line" + "Description": "Specifies the scale breaks' line style." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.breakStyle.width" + "Description": "Specifies the scale breaks' width in pixels." } } }, @@ -30200,13 +28931,13 @@ ], "IsCollection": true, "SingularName": "category", - "DocID": "dxRangeSelector.Options.scale.categories" + "Description": "Specifies the order of arguments on a discrete scale." }, "endOnTick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.scale.endOnTick" + "Description": "Specifies whether to force the scale to start and end on ticks." }, "endValue": { "PrimitiveTypes": [ @@ -30214,7 +28945,7 @@ "number", "string" ], - "DocID": "dxRangeSelector.Options.scale.endValue" + "Description": "Specifies the scale's end value." }, "holidays": { "ItemPrimitiveTypes": [ @@ -30224,17 +28955,17 @@ ], "IsCollection": true, "SingularName": "holiday", - "DocID": "dxRangeSelector.Options.scale.holidays" + "Description": "Days to be excluded from the scale when workdaysOnly is true." }, "label": { - "DocID": "dxRangeSelector.Options.scale.label", + "Description": "Specifies common options for scale labels.", "Options": { "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxRangeSelector.Options.scale.label.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed in scale labels." }, "font": { "PrimitiveTypes": [ @@ -30243,14 +28974,7 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxRangeSelector.Options.scale.label.font" + "Description": "Specifies font options for the text displayed in the range selector's scale labels." }, "format": { "PrimitiveTypes": [ @@ -30260,32 +28984,25 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxRangeSelector.Options.scale.label.format" + "Description": "Formats a value before it is displayed in a scale label." }, "overlappingBehavior": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.scale.label.overlappingBehavior" + "Description": "Decides how to arrange scale labels when there is not enough space to keep all of them." }, "topIndent": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.label.topIndent" + "Description": "Specifies a spacing between scale labels and the background bottom edge." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.scale.label.visible" + "Description": "Specifies whether or not the scale's labels are visible." } } }, @@ -30293,26 +29010,26 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.linearThreshold" + "Description": "Specifies a value used to calculate the range on a logarithmic scale within which the scale should be linear. Applies only if the data source contains negative values or zeroes." }, "logarithmBase": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.logarithmBase" + "Description": "Specifies the value to be raised to a power when generating ticks for a logarithmic scale." }, "marker": { - "DocID": "dxRangeSelector.Options.scale.marker", + "Description": "Specifies options for the date-time scale's markers.", "Options": { "label": { - "DocID": "dxRangeSelector.Options.scale.marker.label", + "Description": "Defines the options that can be set for the text that is displayed by the scale markers.", "Options": { "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxRangeSelector.Options.scale.marker.label.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed in scale markers." }, "format": { "PrimitiveTypes": [ @@ -30322,14 +29039,7 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxRangeSelector.Options.scale.marker.label.format" + "Description": "Formats a value before it is displayed in a scale marker." } } }, @@ -30337,31 +29047,31 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.marker.separatorHeight" + "Description": "Specifies the height of the marker's separator." }, "textLeftIndent": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.marker.textLeftIndent" + "Description": "Specifies the space between the marker label and the marker separator." }, "textTopIndent": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.marker.textTopIndent" + "Description": "Specifies the space between the marker's label and the top edge of the marker's separator." }, "topIndent": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.marker.topIndent" + "Description": "Specified the indent between the marker and the scale labels." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.scale.marker.visible" + "Description": "Indicates whether scale markers are visible." } } }, @@ -30370,90 +29080,90 @@ "number", "string" ], - "DocID": "dxRangeSelector.Options.scale.maxRange", + "Description": "Specifies the maximum range that can be selected.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, "minorTick": { - "DocID": "dxRangeSelector.Options.scale.minorTick", + "Description": "Specifies options of the range selector's minor ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.scale.minorTick.color" + "Description": "Specifies the color of the scale's minor ticks." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.minorTick.opacity" + "Description": "Specifies the opacity of the scale's minor ticks." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.scale.minorTick.visible" + "Description": "Indicates whether scale minor ticks are visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.minorTick.width" + "Description": "Specifies the width of the scale's minor ticks." } } }, @@ -30461,68 +29171,68 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.minorTickCount" + "Description": "Specifies the number of minor ticks between neighboring major ticks." }, "minorTickInterval": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxRangeSelector.Options.scale.minorTickInterval", + "Description": "Specifies an interval between minor ticks.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -30531,61 +29241,61 @@ "number", "string" ], - "DocID": "dxRangeSelector.Options.scale.minRange", + "Description": "Specifies the minimum range that can be selected.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -30593,13 +29303,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.placeholderHeight" + "Description": "Specifies the height of the space reserved for the scale in pixels." }, "showCustomBoundaryTicks": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.scale.showCustomBoundaryTicks" + "Description": "Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values." }, "singleWorkdays": { "ItemPrimitiveTypes": [ @@ -30609,7 +29319,7 @@ ], "IsCollection": true, "SingularName": "singleWorkday", - "DocID": "dxRangeSelector.Options.scale.singleWorkdays" + "Description": "Days to be included in the scale when workdaysOnly is true." }, "startValue": { "PrimitiveTypes": [ @@ -30617,28 +29327,28 @@ "number", "string" ], - "DocID": "dxRangeSelector.Options.scale.startValue" + "Description": "Specifies the scale's start value." }, "tick": { - "DocID": "dxRangeSelector.Options.scale.tick", + "Description": "Specifies options defining the appearance of scale ticks.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.scale.tick.color" + "Description": "Specifies the color of scale ticks (both major and minor ticks)." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.tick.opacity" + "Description": "Specifies the opacity of scale ticks (both major and minor ticks)." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.scale.tick.width" + "Description": "Specifies the width of the scale's ticks (both major and minor ticks)." } } }, @@ -30647,61 +29357,61 @@ "number", "string" ], - "DocID": "dxRangeSelector.Options.scale.tickInterval", + "Description": "Specifies an interval between axis ticks.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -30709,19 +29419,19 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.scale.type" + "Description": "Specifies the type of the scale." }, "valueType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.scale.valueType" + "Description": "Specifies the type of values on the scale." }, "workdaysOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.scale.workdaysOnly" + "Description": "Leaves only workdays on the scale: the work week days plus single workdays minus holidays. Applies only if the scale's valueType is \"datetime\"." }, "workWeek": { "ItemPrimitiveTypes": [ @@ -30729,7 +29439,7 @@ ], "IsCollection": true, "SingularName": "workWeek", - "DocID": "dxRangeSelector.Options.scale.workWeek" + "Description": "Specifies which days are workdays. The array can contain values from 0 (Sunday) to 6 (Saturday). Applies only if workdaysOnly is true." } } }, @@ -30737,86 +29447,86 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.selectedRangeColor" + "Description": "Specifies the color of the selected range." }, "selectedRangeUpdateMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.selectedRangeUpdateMode" + "Description": "Specifies how the selected range should behave when data is updated. Applies only when the RangeSelector is bound to a data source." }, "shutter": { - "DocID": "dxRangeSelector.Options.shutter", + "Description": "Specifies range selector shutter options.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.shutter.color" + "Description": "Specifies shutter color." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.shutter.opacity" + "Description": "Specifies the opacity of the color of shutters." } } }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, "sliderHandle": { - "DocID": "dxRangeSelector.Options.sliderHandle", + "Description": "Specifies the appearance of the range selector's slider handles.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.sliderHandle.color" + "Description": "Specifies the color of the slider handles." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.sliderHandle.opacity" + "Description": "Specifies the opacity of the slider handles." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.sliderHandle.width" + "Description": "Specifies the width of the slider handles." } } }, "sliderMarker": { - "DocID": "dxRangeSelector.Options.sliderMarker", + "Description": "Defines the options of the range selector slider markers.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.sliderMarker.color" + "Description": "Specifies the color of the slider markers." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxRangeSelector.Options.sliderMarker.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed by slider markers." }, "font": { "PrimitiveTypes": [ @@ -30825,14 +29535,7 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxRangeSelector.Options.sliderMarker.font" + "Description": "Specifies font options for the text displayed by the range selector slider markers." }, "format": { "PrimitiveTypes": [ @@ -30842,44 +29545,37 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxRangeSelector.Options.sliderMarker.format" + "Description": "Formats a value before it is displayed in a slider marker." }, "invalidRangeColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSelector.Options.sliderMarker.invalidRangeColor" + "Description": "Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.sliderMarker.paddingLeftRight" + "Description": "Specifies the empty space between the marker's left and right borders and the marker's text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.sliderMarker.paddingTopBottom" + "Description": "Specifies the empty space between the marker's top and bottom borders and the marker's text." }, "placeholderHeight": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSelector.Options.sliderMarker.placeholderHeight" + "Description": "Specifies the placeholder height of the slider marker." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxRangeSelector.Options.sliderMarker.visible" + "Description": "Indicates whether or not the slider markers are visible." } } }, @@ -30887,64 +29583,58 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title", + "Description": "Configures the widget's title.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.title.font" + "Description": "Specifies font options for the title." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.horizontalAlignment" + "Description": "Specifies the title's alignment in a horizontal direction." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin", + "Description": "Generates space around the title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.bottom" + "Description": "Specifies the bottom margin of the title." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.left" + "Description": "Specifies the left margin of the title." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.right" + "Description": "Specifies the right margin of the title." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.top" + "Description": "Specifies the top margin of the title." } } }, @@ -30952,13 +29642,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle", + "Description": "Configures the widget's subtitle.", "Options": { "font": { "PrimitiveTypes": [ @@ -30967,38 +29657,31 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseWidget.Options.title.subtitle.font" + "Description": "Specifies font options for the subtitle." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.subtitle.offset" + "Description": "Specifies the distance between the title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.text" + "Description": "Specifies text for the subtitle." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.textOverflow" + "Description": "Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.wordWrap" + "Description": "Specifies how to wrap the subtitle if it does not fit into a single line." } } }, @@ -31006,25 +29689,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.text" + "Description": "Specifies the title's text." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.textOverflow" + "Description": "Specifies what to do with the title when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.verticalAlignment" + "Description": "Specifies the title's alignment in a vertical direction." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.wordWrap" + "Description": "Specifies how to wrap the title if it does not fit into a single line." } } }, @@ -31040,22 +29723,15 @@ "string", "Date" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "IsChangeable": true, "SingularName": "value", - "DocID": "dxRangeSelector.Options.value" + "Description": "The selected range (initial or current). Equals the entire scale when not set." } } }, "dxRangeSlider": { - "DocID": "dxRangeSlider", + "Description": "The RangeSlider is a widget that allows an end user to choose a range of numeric values.", "Module": "ui/range_slider", "IsEditor": true, "Options": { @@ -31063,43 +29739,43 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSliderBase.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "end": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSlider.Options.end" + "Description": "The right edge of the interval currently selected using the range slider." }, "endName": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSlider.Options.endName" + "Description": "The value to be assigned to the name attribute of the underlying `` element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSliderBase.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -31108,34 +29784,34 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSliderBase.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "keyStep": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSliderBase.Options.keyStep" + "Description": "Specifies the step by which a handle moves when a user presses Page Up or Page Down." }, "label": { - "DocID": "dxSliderBase.Options.label", + "Description": "Configures the labels displayed at the min and max values.", "Options": { "format": { "PrimitiveTypes": [ @@ -31145,26 +29821,19 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxSliderBase.Options.label.format" + "Description": "Formats a value before it is displayed in a label." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSliderBase.Options.label.position" + "Description": "Specifies whether labels are over or under the scale." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSliderBase.Options.label.visible" + "Description": "Specifies whether slider labels are visible." } } }, @@ -31172,13 +29841,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxTrackBar.Options.max" + "Description": "The maximum value the widget can accept." }, "min": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTrackBar.Options.min" + "Description": "The minimum value the widget can accept." }, "onContentReady": { "PrimitiveTypes": [ @@ -31186,7 +29855,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -31194,7 +29863,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -31202,7 +29871,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -31210,7 +29879,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onValueChanged": { "PrimitiveTypes": [ @@ -31218,58 +29887,58 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxRangeSlider.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showRange": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSliderBase.Options.showRange" + "Description": "Specifies whether to highlight the selected range." }, "start": { "PrimitiveTypes": [ "number" ], - "DocID": "dxRangeSlider.Options.start" + "Description": "The left edge of the interval currently selected using the range slider." }, "startName": { "PrimitiveTypes": [ "string" ], - "DocID": "dxRangeSlider.Options.startName" + "Description": "The value to be assigned to the name attribute of the underlying `` element." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSliderBase.Options.step" + "Description": "Specifies the step by which the widget's value changes when a user drags a handler." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "tooltip": { - "DocID": "dxSliderBase.Options.tooltip", + "Description": "Configures a tooltip.", "Options": { "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSliderBase.Options.tooltip.enabled" + "Description": "Specifies whether a tooltip is enabled." }, "format": { "PrimitiveTypes": [ @@ -31279,26 +29948,19 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxSliderBase.Options.tooltip.format" + "Description": "Specifies a tooltip's display format." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSliderBase.Options.tooltip.position" + "Description": "Specifies whether a tooltip is over or under the slider." }, "showMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSliderBase.Options.tooltip.showMode" + "Description": "Specifies when the widget shows a tooltip." } } }, @@ -31306,7 +29968,7 @@ "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -31314,19 +29976,19 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "ItemPrimitiveTypes": [ @@ -31335,13 +29997,13 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "value", - "DocID": "dxRangeSlider.Options.value" + "Description": "Specifies the widget's value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -31350,12 +30012,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxRecurrenceEditor": { - "DocID": "dxRecurrenceEditor", + "Description": "A base class for editors.", "Module": "ui/recurrence_editor", "IsEditor": true, "Options": { @@ -31363,31 +30025,31 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -31396,25 +30058,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "onContentReady": { "PrimitiveTypes": [ @@ -31422,7 +30084,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -31430,7 +30092,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -31438,7 +30100,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -31446,7 +30108,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onValueChanged": { "PrimitiveTypes": [ @@ -31454,31 +30116,31 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -31486,32 +30148,32 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "dxRecurrenceEditor.Options.value" + "Description": "Specifies the widget's value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -31520,12 +30182,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxResizable": { - "DocID": "dxResizable", + "Description": "The Resizable widget enables its content to be resizable in the UI.", "IsTranscludedContent": true, "Module": "ui/resizable", "Options": { @@ -31533,13 +30195,13 @@ "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "handles": { "PrimitiveTypes": [ "string" ], - "DocID": "dxResizable.Options.handles" + "Description": "Specifies which borders of the widget element are used as a handle." }, "height": { "PrimitiveTypes": [ @@ -31549,31 +30211,31 @@ ], "IsFunc": true, "IsChangeable": true, - "DocID": "dxResizable.Options.height" + "Description": "Specifies the widget's height." }, "maxHeight": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResizable.Options.maxHeight" + "Description": "Specifies the upper height boundary for resizing." }, "maxWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResizable.Options.maxWidth" + "Description": "Specifies the upper width boundary for resizing." }, "minHeight": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResizable.Options.minHeight" + "Description": "Specifies the lower height boundary for resizing." }, "minWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResizable.Options.minWidth" + "Description": "Specifies the lower width boundary for resizing." }, "onDisposing": { "PrimitiveTypes": [ @@ -31581,7 +30243,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -31589,7 +30251,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -31597,7 +30259,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onResize": { "PrimitiveTypes": [ @@ -31605,7 +30267,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxResizable.Options.onResize" + "Description": "A function that is executed each time the widget is resized by one pixel." }, "onResizeEnd": { "PrimitiveTypes": [ @@ -31613,7 +30275,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxResizable.Options.onResizeEnd" + "Description": "A function that is executed when resizing ends." }, "onResizeStart": { "PrimitiveTypes": [ @@ -31621,13 +30283,13 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxResizable.Options.onResizeStart" + "Description": "A function that is executed when resizing starts." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "width": { "PrimitiveTypes": [ @@ -31637,12 +30299,12 @@ ], "IsFunc": true, "IsChangeable": true, - "DocID": "dxResizable.Options.width" + "Description": "Specifies the widget's width." } } }, "dxResponsiveBox": { - "DocID": "dxResponsiveBox", + "Description": "The ResponsiveBox widget allows you to create an application or a website with a layout adapted to different screen sizes.", "Module": "ui/responsive_box", "Options": { "cols": { @@ -31651,32 +30313,32 @@ ], "IsCollection": true, "SingularName": "col", - "DocID": "dxResponsiveBox.Options.cols", + "Description": "Specifies the collection of columns for the grid used to position layout elements.", "Options": { "baseSize": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxResponsiveBox.Options.cols.baseSize" + "Description": "The column's base width. Calculated automatically when the singleColumnScreen option arranges all elements in a single column." }, "ratio": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResponsiveBox.Options.cols.ratio" + "Description": "The column width ratio." }, "screen": { "PrimitiveTypes": [ "string" ], - "DocID": "dxResponsiveBox.Options.cols.screen" + "Description": "Decides on which screens the current column is rendered." }, "shrink": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResponsiveBox.Options.cols.shrink" + "Description": "A factor that defines how much a column width shrinks relative to the rest of the columns in the container." } } }, @@ -31694,27 +30356,20 @@ "ItemComplexTypes": [ "ResponsiveBoxItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxResponsiveBox.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -31723,19 +30378,19 @@ "string" ], "IsFunc": true, - "DocID": "dxResponsiveBox.Options.height" + "Description": "Specifies the widget's height." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -31745,19 +30400,19 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxResponsiveBox.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "location": { "ItemPrimitiveTypes": [ @@ -31765,37 +30420,37 @@ ], "IsCollection": true, "SingularName": "location", - "DocID": "dxResponsiveBoxItem.location", + "Description": "Specifies the item location and size against the widget grid.", "Options": { "col": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResponsiveBoxItem.location.col" + "Description": "Specifies which column the element should occupy. Accepts an index from the cols array." }, "colspan": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResponsiveBoxItem.location.colspan" + "Description": "Specifies how many columns the element should span." }, "row": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResponsiveBoxItem.location.row" + "Description": "Specifies which row the element should occupy. Accepts an index from the rows array." }, "rowspan": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResponsiveBoxItem.location.rowspan" + "Description": "Specifies how many rows the element should span." }, "screen": { "PrimitiveTypes": [ "string" ], - "DocID": "dxResponsiveBoxItem.location.screen" + "Description": "Decides on which screens the current location settings should be applied to the element." } } }, @@ -31804,19 +30459,19 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -31825,7 +30480,7 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "onContentReady": { "PrimitiveTypes": [ @@ -31833,7 +30488,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -31841,7 +30496,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -31849,7 +30504,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -31858,7 +30513,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -31866,7 +30521,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemHold": { "PrimitiveTypes": [ @@ -31874,7 +30529,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -31882,7 +30537,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -31890,7 +30545,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "rows": { "ItemPrimitiveTypes": [ @@ -31898,32 +30553,32 @@ ], "IsCollection": true, "SingularName": "row", - "DocID": "dxResponsiveBox.Options.rows", + "Description": "Specifies the collection of rows for the grid used to position layout elements.", "Options": { "baseSize": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxResponsiveBox.Options.rows.baseSize" + "Description": "The row's base height. Calculated automatically when the singleColumnScreen option arranges all elements in a single column." }, "ratio": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResponsiveBox.Options.rows.ratio" + "Description": "The row height ratio." }, "screen": { "PrimitiveTypes": [ "string" ], - "DocID": "dxResponsiveBox.Options.rows.screen" + "Description": "Decides on which screens the current row is rendered." }, "shrink": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResponsiveBox.Options.rows.shrink" + "Description": "A factor that defines how much a row height shrinks relative to the rest of the rows in the container." } } }, @@ -31931,26 +30586,26 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "screenByWidth": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxResponsiveBox.Options.screenByWidth" + "Description": "Specifies the function returning the size qualifier depending on the screen's width." }, "singleColumnScreen": { "PrimitiveTypes": [ "string" ], - "DocID": "dxResponsiveBox.Options.singleColumnScreen" + "Description": "Specifies on which screens all layout elements should be arranged in a single column. Accepts a single or several size qualifiers separated by a space." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -31959,34 +30614,34 @@ "string" ], "IsFunc": true, - "DocID": "dxResponsiveBox.Options.width" + "Description": "Specifies the widget's width." } } }, "dxSankey": { - "DocID": "dxSankey", + "Description": "The Sankey is a widget that visualizes the flow magnitude between value sets. The values being connected are called nodes; the connections - links. The higher the flow magnitude, the wider the link is.", "Module": "viz/sankey", "Options": { "adaptiveLayout": { - "DocID": "dxSankey.Options.adaptiveLayout", + "Description": "Specifies adaptive layout options.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.adaptiveLayout.height" + "Description": "Specifies the minimum container height at which the layout begins to adapt." }, "keepLabels": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSankey.Options.adaptiveLayout.keepLabels" + "Description": "Specifies whether node labels should be kept when the widget adapts the layout." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.adaptiveLayout.width" + "Description": "Specifies the minimum container width at which the layout begins to adapt." } } }, @@ -31999,7 +30654,7 @@ ], "IsCollection": true, "SingularName": "alignment", - "DocID": "dxSankey.Options.alignment" + "Description": "Aligns node columns vertically." }, "dataSource": { "PrimitiveTypes": [ @@ -32010,48 +30665,41 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxSankey.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "export": { - "DocID": "BaseWidget.Options.export", + "Description": "Configures the exporting and printing features.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.backgroundColor" + "Description": "Specifies the color that will fill transparent regions in the resulting file or document." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.enabled" + "Description": "Enables the client-side exporting in the widget." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.fileName" + "Description": "Specifies a default name for the file to which the widget will be exported." }, "formats": { "ItemPrimitiveTypes": [ @@ -32059,33 +30707,33 @@ ], "IsCollection": true, "SingularName": "format", - "DocID": "BaseWidget.Options.export.formats" + "Description": "Specifies a set of export formats." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.export.margin" + "Description": "Adds an empty space around the exported widget; measured in pixels." }, "printingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.printingEnabled" + "Description": "Enables the printing feature in the widget. Applies only if the export.enabled option is true." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "BaseWidget.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." }, "svgToCanvas": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseWidget.Options.export.svgToCanvas" + "Description": "A function that renders SVG markup on the HTML canvas. Required to export custom SVG elements (for example, markerTemplate)." } } }, @@ -32093,31 +30741,31 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSankey.Options.hoverEnabled" + "Description": "Specifies whether nodes and links change their style when they are hovered over or pressed." }, "label": { - "DocID": "dxSankey.Options.label", + "Description": "Configures sankey nodes' labels.", "Options": { "border": { - "DocID": "dxSankey.Options.label.border", + "Description": "Configures the labels' borders.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.label.border.color" + "Description": "Colors the labels' borders." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSankey.Options.label.border.visible" + "Description": "Specifies whether the borders are visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.label.border.width" + "Description": "Sets the borders' width in pixels." } } }, @@ -32126,7 +30774,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxSankey.Options.label.customizeText" + "Description": "Customizes the labels' texts." }, "font": { "PrimitiveTypes": [ @@ -32135,59 +30783,52 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxSankey.Options.label.font" + "Description": "Specifies the labels' font options." }, "horizontalOffset": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.label.horizontalOffset" + "Description": "Moves the labels horizontally from their initial positions." }, "overlappingBehavior": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.label.overlappingBehavior" + "Description": "Specifies how to arrange labels when there is insufficient space to display them all." }, "shadow": { - "DocID": "dxSankey.Options.label.shadow", + "Description": "Configures the labels' shadows.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.label.shadow.blur" + "Description": "Specifies the shadows' blur distance. A larger value increases the blur distance." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.label.shadow.color" + "Description": "Colors the labels' shadows." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.label.shadow.offsetX" + "Description": "Moves the shadows horizontally from their initial positions." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.label.shadow.offsetY" + "Description": "Moves the shadows vertically from their initial positions." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.label.shadow.opacity" + "Description": "Specifies the shadows' transparency." } } }, @@ -32195,45 +30836,45 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSankey.Options.label.useNodeColors" + "Description": "Specifies whether to color labels in the nodes' colors." }, "verticalOffset": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.label.verticalOffset" + "Description": "Moves the labels vertically from their initial positions." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSankey.Options.label.visible" + "Description": "Specifies whether the labels are visible." } } }, "link": { - "DocID": "dxSankey.Options.link", + "Description": "Configures sankey links' appearance.", "Options": { "border": { - "DocID": "dxSankey.Options.link.border", + "Description": "Configures the links' borders.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.link.border.color" + "Description": "Colors the links' borders." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSankey.Options.link.border.visible" + "Description": "Specifies whether the borders are visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.link.border.width" + "Description": "Sets the borders' width in pixels." } } }, @@ -32241,37 +30882,37 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.link.color" + "Description": "Colors the sankey links. Applies only if colorMode is \"none\"." }, "colorMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.link.colorMode" + "Description": "Specifies how to color links." }, "hoverStyle": { - "DocID": "dxSankey.Options.link.hoverStyle", + "Description": "Configures the appearance a link changes to when it is hovered over or pressed.", "Options": { "border": { - "DocID": "dxSankey.Options.link.hoverStyle.border", + "Description": "Configures the appearance a link's border changes to when the link is hovered over or pressed.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.link.hoverStyle.border.color" + "Description": "Specifies the color a link's border changes to when the link is hovered over or pressed." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSankey.Options.link.hoverStyle.border.visible" + "Description": "Specifies whether a link's border is visible when the link is hovered over or pressed." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.link.hoverStyle.border.width" + "Description": "Specifies the width a link's border changes to when the link is hovered over or pressed." } } }, @@ -32279,34 +30920,34 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.link.hoverStyle.color" + "Description": "Specifies the color a link changes to when it is hovered over or pressed." }, "hatching": { - "DocID": "dxSankey.Options.link.hoverStyle.hatching", + "Description": "Applies hatching to a link when it is hovered over or pressed.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.link.hoverStyle.hatching.direction" + "Description": "Specifies hatching lines' direction." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.link.hoverStyle.hatching.opacity" + "Description": "Specifies hatching lines' transparency." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.link.hoverStyle.hatching.step" + "Description": "Specifies the distance in pixels between two hatching lines." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.link.hoverStyle.hatching.width" + "Description": "Specifies hatching lines' width." } } }, @@ -32314,7 +30955,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.link.hoverStyle.opacity" + "Description": "Specifies the transparency a link changes to when it is hovered over or pressed." } } }, @@ -32322,107 +30963,101 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.link.opacity" + "Description": "Specifies the links' transparency." } } }, "loadingIndicator": { - "DocID": "BaseWidget.Options.loadingIndicator", + "Description": "Configures the loading indicator.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.backgroundColor" + "Description": "Colors the background of the loading indicator." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.loadingIndicator.enabled" + "Description": "Specifies whether the loading indicator should be displayed and hidden automatically." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.loadingIndicator.font" + "Description": "Specifies font options for the loading indicator." }, "show": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "BaseWidget.Options.loadingIndicator.show" + "Description": "Allows you to change the loading indicator's visibility." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.text" + "Description": "Specifies the text to be displayed by the loading indicator." } } }, "margin": { - "DocID": "BaseWidget.Options.margin", + "Description": "Generates space around the widget.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.bottom" + "Description": "Specifies the bottom margin of the widget in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.left" + "Description": "Specifies the left margin of the widget in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.right" + "Description": "Specifies the right margin of the widget in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.top" + "Description": "Specifies the top margin of the widget in pixels." } } }, "node": { - "DocID": "dxSankey.Options.node", + "Description": "Configures sankey nodes' appearance.", "Options": { "border": { - "DocID": "dxSankey.Options.node.border", + "Description": "Configures the nodes' borders.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.node.border.color" + "Description": "Colors the nodes' borders." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSankey.Options.node.border.visible" + "Description": "Specifies whether the borders are visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.node.border.width" + "Description": "Sets the borders' width in pixels." } } }, @@ -32430,31 +31065,31 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.node.color" + "Description": "Colors the sankey nodes." }, "hoverStyle": { - "DocID": "dxSankey.Options.node.hoverStyle", + "Description": "Configures the appearance a node changes to when it is hovered over or pressed.", "Options": { "border": { - "DocID": "dxSankey.Options.node.hoverStyle.border", + "Description": "Configures the appearance a node's border changes to when the node is hovered over or pressed.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.node.hoverStyle.border.color" + "Description": "Specifies the color a node's border changes to when the node is hovered over or pressed." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSankey.Options.node.hoverStyle.border.visible" + "Description": "Specifies whether a node's border is visible when the node is hovered over or pressed." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.node.hoverStyle.border.width" + "Description": "Specifies the width a node's border changes to when the node is hovered over or pressed." } } }, @@ -32462,34 +31097,34 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.node.hoverStyle.color" + "Description": "Specifies the color a node changes to when it is hovered over or pressed." }, "hatching": { - "DocID": "dxSankey.Options.node.hoverStyle.hatching", + "Description": "Applies hatching to a node when it is hovered over or pressed.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.node.hoverStyle.hatching.direction" + "Description": "Specifies hatching lines' direction." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.node.hoverStyle.hatching.opacity" + "Description": "Specifies hatching lines' transparency." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.node.hoverStyle.hatching.step" + "Description": "Specifies the distance in pixels between two hatching lines." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.node.hoverStyle.hatching.width" + "Description": "Specifies hatching lines' width." } } }, @@ -32497,7 +31132,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.node.hoverStyle.opacity" + "Description": "Specifies the transparency a node changes to when it is hovered over or pressed." } } }, @@ -32505,19 +31140,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.node.opacity" + "Description": "Specifies the nodes' transparency." }, "padding": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.node.padding" + "Description": "Specifies the vertical distance, in pixels, between two nodes." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSankey.Options.node.width" + "Description": "Specifies the nodes' width in pixels." } } }, @@ -32527,7 +31162,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDrawn": { "PrimitiveTypes": [ @@ -32535,7 +31170,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onExported": { "PrimitiveTypes": [ @@ -32543,7 +31178,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -32551,7 +31186,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -32559,7 +31194,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -32567,7 +31202,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -32575,7 +31210,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onLinkClick": { "PrimitiveTypes": [ @@ -32584,7 +31219,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSankey.Options.onLinkClick" + "Description": "A function that is executed when a sankey link is clicked or tapped." }, "onLinkHoverChanged": { "PrimitiveTypes": [ @@ -32592,7 +31227,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSankey.Options.onLinkHoverChanged" + "Description": "A function that is executed after the pointer enters or leaves a sankey link." }, "onNodeClick": { "PrimitiveTypes": [ @@ -32601,7 +31236,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSankey.Options.onNodeClick" + "Description": "A function that is executed when a sankey node is clicked or tapped." }, "onNodeHoverChanged": { "PrimitiveTypes": [ @@ -32609,7 +31244,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSankey.Options.onNodeHoverChanged" + "Description": "A function that is executed after the pointer enters or leaves a sankey node." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -32617,7 +31252,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "palette": { "PrimitiveTypes": [ @@ -32628,46 +31263,46 @@ ], "IsCollection": true, "SingularName": "palette", - "DocID": "dxSankey.Options.palette" + "Description": "Sets the palette to be used to colorize sankey nodes." }, "paletteExtensionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.paletteExtensionMode" + "Description": "Specifies how to extend the palette when it contains less colors than the number of sankey nodes." }, "pathModified": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "redrawOnResize": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.redrawOnResize" + "Description": "Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, @@ -32675,82 +31310,76 @@ "PrimitiveTypes": [ "any" ], - "DocID": "dxSankey.Options.sortData" + "Description": "Specifies nodes' sorting order in their columns." }, "sourceField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.sourceField" + "Description": "Specifies which data source field provides links' source nodes." }, "targetField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.targetField" + "Description": "Specifies which data source field provides links' target nodes." }, "theme": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title", + "Description": "Configures the widget's title.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.title.font" + "Description": "Specifies font options for the title." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.horizontalAlignment" + "Description": "Specifies the title's alignment in a horizontal direction." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin", + "Description": "Generates space around the title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.bottom" + "Description": "Specifies the bottom margin of the title." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.left" + "Description": "Specifies the left margin of the title." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.right" + "Description": "Specifies the right margin of the title." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.top" + "Description": "Specifies the top margin of the title." } } }, @@ -32758,13 +31387,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle", + "Description": "Configures the widget's subtitle.", "Options": { "font": { "PrimitiveTypes": [ @@ -32773,38 +31402,31 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseWidget.Options.title.subtitle.font" + "Description": "Specifies font options for the subtitle." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.subtitle.offset" + "Description": "Specifies the distance between the title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.text" + "Description": "Specifies text for the subtitle." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.textOverflow" + "Description": "Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.wordWrap" + "Description": "Specifies how to wrap the subtitle if it does not fit into a single line." } } }, @@ -32812,69 +31434,69 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.text" + "Description": "Specifies the title's text." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.textOverflow" + "Description": "Specifies what to do with the title when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.verticalAlignment" + "Description": "Specifies the title's alignment in a vertical direction." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.wordWrap" + "Description": "Specifies how to wrap the title if it does not fit into a single line." } } }, "tooltip": { - "DocID": "dxSankey.Options.tooltip", + "Description": "Configures tooltips - small pop-up rectangles that display information about a data-visualizing widget element being pressed or hovered over with the mouse pointer.", "Options": { "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.arrowLength" + "Description": "Specifies the length of a tooltip's arrow in pixels." }, "border": { - "DocID": "BaseWidget.Options.tooltip.border", + "Description": "Configures a tooltip's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.color" + "Description": "Colors a tooltip's border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.dashStyle" + "Description": "Specifies the dash style of a tooltip's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.opacity" + "Description": "Specifies the transparency of a tooltip's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.border.visible" + "Description": "Specifies whether a tooltip's border is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.width" + "Description": "Specifies the width of a tooltip's border in pixels." } } }, @@ -32882,7 +31504,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.color" + "Description": "Colors all tooltips." }, "container": { "PrimitiveTypes": [ @@ -32890,129 +31512,117 @@ "JQuery", "string" ], - "DocID": "BaseWidget.Options.tooltip.container" + "Description": "Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.cornerRadius" + "Description": "Makes all the tooltip's corners rounded." }, "customizeLinkTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxSankey.Options.tooltip.customizeLinkTooltip" + "Description": "Customizes link tooltips' appearance." }, "customizeNodeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxSankey.Options.tooltip.customizeNodeTooltip" + "Description": "Customizes node tooltips' appearance." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSankey.Options.tooltip.enabled" + "Description": "Enables tooltips." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.font" + "Description": "Specifies tooltips' font options." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.format" + "Description": "Formats a value before it is displayed it in a tooltip." }, "linkTooltipTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSankey.Options.tooltip.linkTooltipTemplate" + "Description": "Specifies a custom template for a link's tooltip." }, "nodeTooltipTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSankey.Options.tooltip.nodeTooltipTemplate" + "Description": "Specifies a custom template for a node's tooltip." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.opacity" + "Description": "Specifies tooltips' transparency." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between a tooltip's left/right border and its text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text." }, "shadow": { - "DocID": "BaseWidget.Options.tooltip.shadow", + "Description": "Configures a tooltip's shadow.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.blur" + "Description": "Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.shadow.color" + "Description": "Colors a tooltip's shadow." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetX" + "Description": "Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetY" + "Description": "Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.opacity" + "Description": "Specifies the transparency of a tooltip's shadow." } } }, @@ -33020,7 +31630,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.zIndex" + "Description": "Specifies a tooltip's z-index." } } }, @@ -33028,59 +31638,59 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxSankey.Options.weightField" + "Description": "Specifies which data source field provides links' weights." } } }, "dxScheduler": { - "DocID": "dxScheduler", + "Description": "The Scheduler is a widget that represents scheduled data and allows a user to manage and edit it.", "Module": "ui/scheduler", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "adaptivityEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.adaptivityEnabled" + "Description": "Specifies whether the widget adapts to small screens." }, "allDayExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.allDayExpr" + "Description": "Specifies the name of the data source item field whose value defines whether or not the corresponding appointment is an all-day appointment." }, "appointmentCollectorTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.appointmentCollectorTemplate" + "Description": "Specifies a custom template for cell overflow indicators." }, "appointmentDragging": { - "DocID": "dxScheduler.Options.appointmentDragging", + "Description": "Configures appointment reordering using drag and drop gestures.", "Options": { "autoScroll": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.appointmentDragging.autoScroll" + "Description": "Enables automatic scrolling while dragging an appointment beyond the viewport." }, "data": { "PrimitiveTypes": [ "any" ], - "DocID": "dxScheduler.Options.appointmentDragging.data" + "Description": "A container for custom data." }, "group": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.appointmentDragging.group" + "Description": "Allows you to group several widgets so that users can drag and drop appointments between them." }, "onAdd": { "PrimitiveTypes": [ @@ -33088,7 +31698,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.appointmentDragging.onAdd" + "Description": "A function that is called when a new appointment is added." }, "onDragEnd": { "PrimitiveTypes": [ @@ -33096,7 +31706,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.appointmentDragging.onDragEnd" + "Description": "A function that is called when the dragged appointment's position is changed." }, "onDragMove": { "PrimitiveTypes": [ @@ -33104,7 +31714,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.appointmentDragging.onDragMove" + "Description": "A function that is called every time a draggable appointment is moved." }, "onDragStart": { "PrimitiveTypes": [ @@ -33112,7 +31722,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.appointmentDragging.onDragStart" + "Description": "A function that is called when the drag gesture is initialized." }, "onRemove": { "PrimitiveTypes": [ @@ -33120,19 +31730,19 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.appointmentDragging.onRemove" + "Description": "A function that is called when a draggable appointment is removed." }, "scrollSensitivity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxScheduler.Options.appointmentDragging.scrollSensitivity" + "Description": "Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true." }, "scrollSpeed": { "PrimitiveTypes": [ "number" ], - "DocID": "dxScheduler.Options.appointmentDragging.scrollSpeed" + "Description": "Specifies the scrolling speed when dragging an appointment beyond the viewport. Applies only if autoScroll is true." } } }, @@ -33141,26 +31751,26 @@ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.appointmentTemplate" + "Description": "Specifies a custom template for appointments." }, "appointmentTooltipTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.appointmentTooltipTemplate" + "Description": "Specifies a custom template for tooltips displayed when users click an appointment or cell overflow indicator." }, "cellDuration": { "PrimitiveTypes": [ "number" ], - "DocID": "dxScheduler.Options.cellDuration" + "Description": "Specifies cell duration in minutes." }, "crossScrollingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.crossScrollingEnabled" + "Description": "Specifies whether or not an end-user can scroll the view in both directions at the same time." }, "currentDate": { "PrimitiveTypes": [ @@ -33169,28 +31779,28 @@ "string" ], "IsChangeable": true, - "DocID": "dxScheduler.Options.currentDate" + "Description": "Specifies a date displayed on the current scheduler view by default." }, "currentView": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "dxScheduler.Options.currentView" + "Description": "Specifies the currently displayed view. Accepts the view's name or type." }, "customizeDateNavigatorText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxScheduler.Options.customizeDateNavigatorText" + "Description": "Customizes the date navigator's text." }, "dataCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.dataCellTemplate" + "Description": "Specifies a custom template for table cells." }, "dataSource": { "PrimitiveTypes": [ @@ -33204,40 +31814,33 @@ "ItemComplexTypes": [ "SchedulerAppointment" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxScheduler.Options.dataSource" + "Description": "Binds the widget to data." }, "dateCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.dateCellTemplate" + "Description": "Specifies a custom template for day scale items." }, "dateSerializationFormat": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.dateSerializationFormat" + "Description": "Specifies the date-time values' serialization format. Use it only if you do not specify the dataSource at design time." }, "descriptionExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.descriptionExpr" + "Description": "Specifies the name of the data source item field whose value holds the description of the corresponding appointment." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "dropDownAppointmentTemplate": { "PrimitiveTypes": [ @@ -33245,43 +31848,43 @@ ], "IsDeprecated": true, "IsTemplate": true, - "DocID": "dxScheduler.Options.dropDownAppointmentTemplate" + "Description": "Use the appointmentTooltipTemplate option instead." }, "editing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.editing", + "Description": "Specifies which editing operations an end-user can perform on appointments.", "Options": { "allowAdding": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.editing.allowAdding" + "Description": "Specifies whether or not an end-user can add appointments." }, "allowDeleting": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.editing.allowDeleting" + "Description": "Specifies whether or not an end-user can delete appointments." }, "allowDragging": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.editing.allowDragging" + "Description": "Specifies whether or not an end-user can drag appointments." }, "allowResizing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.editing.allowResizing" + "Description": "Specifies whether or not an end-user can change an appointment duration." }, "allowUpdating": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.editing.allowUpdating" + "Description": "Specifies whether or not an end-user can change appointment options." } } }, @@ -33289,44 +31892,44 @@ "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "endDateExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.endDateExpr" + "Description": "Specifies the name of the data source item field that defines the ending of an appointment." }, "endDateTimeZoneExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.endDateTimeZoneExpr" + "Description": "Specifies the name of the data source item field that defines the timezone of the appointment end date." }, "endDayHour": { "PrimitiveTypes": [ "number" ], - "DocID": "dxScheduler.Options.endDayHour" + "Description": "Specifies the last hour on the time scale. Accepts integer values from 0 to 24." }, "firstDayOfWeek": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxScheduler.Options.firstDayOfWeek" + "Description": "Specifies the first day of a week. Does not apply to the agenda view." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "groupByDate": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.groupByDate" + "Description": "If true, appointments are grouped by date first and then by resource; opposite if false. Applies only if appointments are grouped and groupOrientation is \"horizontal\"." }, "groups": { "ItemPrimitiveTypes": [ @@ -33334,7 +31937,7 @@ ], "IsCollection": true, "SingularName": "group", - "DocID": "dxScheduler.Options.groups" + "Description": "Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable." }, "height": { "PrimitiveTypes": [ @@ -33343,19 +31946,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "indicatorUpdateInterval": { "PrimitiveTypes": [ "number" ], - "DocID": "dxScheduler.Options.indicatorUpdateInterval" + "Description": "Specifies the time interval between when the date-time indicator changes its position, in milliseconds." }, "max": { "PrimitiveTypes": [ @@ -33363,14 +31966,14 @@ "number", "string" ], - "DocID": "dxScheduler.Options.max" + "Description": "The latest date the widget allows you to select." }, "maxAppointmentsPerCell": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxScheduler.Options.maxAppointmentsPerCell" + "Description": "Specifies the limit of full-sized appointments displayed per cell. Applies to all views except \"agenda\"." }, "min": { "PrimitiveTypes": [ @@ -33378,13 +31981,13 @@ "number", "string" ], - "DocID": "dxScheduler.Options.min" + "Description": "The earliest date the widget allows you to select." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty. Available for the Agenda view only." }, "onAppointmentAdded": { "PrimitiveTypes": [ @@ -33392,7 +31995,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onAppointmentAdded" + "Description": "A function that is executed after an appointment is added to the data source." }, "onAppointmentAdding": { "PrimitiveTypes": [ @@ -33400,7 +32003,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onAppointmentAdding" + "Description": "A function that is executed before an appointment is added to the data source." }, "onAppointmentClick": { "PrimitiveTypes": [ @@ -33409,7 +32012,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onAppointmentClick" + "Description": "A function that is executed when an appointment is clicked or tapped." }, "onAppointmentContextMenu": { "PrimitiveTypes": [ @@ -33418,7 +32021,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onAppointmentContextMenu" + "Description": "A function that is executed when a user attempts to open the browser's context menu for an appointment. Allows you to replace this context menu with a custom context menu." }, "onAppointmentDblClick": { "PrimitiveTypes": [ @@ -33427,7 +32030,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onAppointmentDblClick" + "Description": "A function that is executed when an appointment is double-clicked or double-tapped." }, "onAppointmentDeleted": { "PrimitiveTypes": [ @@ -33435,7 +32038,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onAppointmentDeleted" + "Description": "A function that is executed after an appointment is deleted from the data source." }, "onAppointmentDeleting": { "PrimitiveTypes": [ @@ -33443,7 +32046,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onAppointmentDeleting" + "Description": "A function that is executed before an appointment is deleted from the data source." }, "onAppointmentFormCreated": { "PrimitiveTypes": [ @@ -33452,7 +32055,7 @@ "IsDeprecated": true, "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onAppointmentFormCreated" + "Description": "Use the onAppointmentFormOpening option instead." }, "onAppointmentFormOpening": { "PrimitiveTypes": [ @@ -33460,7 +32063,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onAppointmentFormOpening" + "Description": "A function that is executed before an appointment details form is opened." }, "onAppointmentRendered": { "PrimitiveTypes": [ @@ -33468,7 +32071,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onAppointmentRendered" + "Description": "A function that is executed when an appointment is rendered." }, "onAppointmentUpdated": { "PrimitiveTypes": [ @@ -33476,7 +32079,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onAppointmentUpdated" + "Description": "A function that is executed after an appointment is updated in the data source." }, "onAppointmentUpdating": { "PrimitiveTypes": [ @@ -33484,7 +32087,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onAppointmentUpdating" + "Description": "A function that is executed before an appointment is updated in the data source." }, "onCellClick": { "PrimitiveTypes": [ @@ -33493,7 +32096,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onCellClick" + "Description": "A function that is executed when a view cell is clicked." }, "onCellContextMenu": { "PrimitiveTypes": [ @@ -33502,7 +32105,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScheduler.Options.onCellContextMenu" + "Description": "A function that is executed when a user attempts to open the browser's context menu for a cell. Allows you to replace this context menu with a custom context menu." }, "onContentReady": { "PrimitiveTypes": [ @@ -33510,7 +32113,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -33518,7 +32121,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -33526,7 +32129,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -33534,38 +32137,38 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "recurrenceEditMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.recurrenceEditMode" + "Description": "Specifies the edit mode for recurring appointments." }, "recurrenceExceptionExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.recurrenceExceptionExpr" + "Description": "Specifies the name of the data source item field that defines exceptions for the current recurring appointment." }, "recurrenceRuleExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.recurrenceRuleExpr" + "Description": "Specifies the name of the data source item field that defines a recurrence rule for generating recurring appointments." }, "remoteFiltering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.remoteFiltering" + "Description": "Specifies whether filtering is performed on the server or client side." }, "resourceCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.resourceCellTemplate" + "Description": "Specifies a custom template for resource headers." }, "resources": { "ItemPrimitiveTypes": [ @@ -33573,19 +32176,19 @@ ], "IsCollection": true, "SingularName": "resource", - "DocID": "dxScheduler.Options.resources", + "Description": "Specifies an array of resources available in the scheduler.", "Options": { "allowMultiple": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.resources.allowMultiple" + "Description": "Indicates whether or not several resources of this kind can be assigned to an appointment." }, "colorExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.resources.colorExpr" + "Description": "Specifies the resource object field that is used as a resource color." }, "dataSource": { "PrimitiveTypes": [ @@ -33596,15 +32199,8 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxScheduler.Options.resources.dataSource" + "Description": "Specifies available resource instances." }, "displayExpr": { "PrimitiveTypes": [ @@ -33612,25 +32208,25 @@ "string" ], "IsFunc": true, - "DocID": "dxScheduler.Options.resources.displayExpr" + "Description": "Specifies which field from the resource data objects provides values to be displayed in the resource editor." }, "fieldExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.resources.fieldExpr" + "Description": "The name of the appointment object field that specifies a resource of this kind." }, "label": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.resources.label" + "Description": "Specifies the label of the Appointment popup window field that allows end users to assign a resource of this kind." }, "useColorAsDefault": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.resources.useColorAsDefault" + "Description": "Specifies whether appointments are colored like this resource kind." }, "valueExpr": { "PrimitiveTypes": [ @@ -33638,7 +32234,7 @@ "string" ], "IsFunc": true, - "DocID": "dxScheduler.Options.resources.valueExpr" + "Description": "Specifies the resource object field that is used as a value of the Resource editor in the Appointment popup window." } } }, @@ -33646,7 +32242,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectedCellData": { "ItemPrimitiveTypes": [ @@ -33655,74 +32251,74 @@ "IsCollection": true, "IsReadonly": true, "SingularName": "selectedCellData", - "DocID": "dxScheduler.Options.selectedCellData" + "Description": "Currently selected cells' data." }, "shadeUntilCurrentTime": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.shadeUntilCurrentTime" + "Description": "Specifies whether to apply shading to cover the timetable up to the current time." }, "showAllDayPanel": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.showAllDayPanel" + "Description": "Specifies the \"All-day\" panel's visibility. Setting this option to false hides the panel along with the all-day appointments." }, "showCurrentTimeIndicator": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.showCurrentTimeIndicator" + "Description": "Specifies the current date-time indicator's visibility." }, "startDateExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.startDateExpr" + "Description": "Specifies the name of the data source item field that defines the start of an appointment." }, "startDateTimeZoneExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.startDateTimeZoneExpr" + "Description": "Specifies the name of the data source item field that defines the timezone of the appointment start date." }, "startDayHour": { "PrimitiveTypes": [ "number" ], - "DocID": "dxScheduler.Options.startDayHour" + "Description": "Specifies the first hour on the time scale. Accepts integer values from 0 to 24." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "textExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.textExpr" + "Description": "Specifies the name of the data source item field that holds the subject of an appointment." }, "timeCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.timeCellTemplate" + "Description": "Specifies a custom template for time scale items." }, "timeZone": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.timeZone" + "Description": "Specifies the widget's time zone." }, "useDropDownViewSwitcher": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.useDropDownViewSwitcher" + "Description": "Specifies whether a user can switch views using tabs or a drop-down menu." }, "views": { "PrimitiveTypes": [ @@ -33734,54 +32330,54 @@ ], "IsCollection": true, "SingularName": "view", - "DocID": "dxScheduler.Options.views", + "Description": "Specifies and configures the views to be available in the view switcher.", "Options": { "agendaDuration": { "PrimitiveTypes": [ "number" ], - "DocID": "dxScheduler.Options.views.agendaDuration" + "Description": "Specifies the number of dates that can be shown at a time in the agenda view." }, "appointmentCollectorTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.views.appointmentCollectorTemplate" + "Description": "Specifies a custom template for cell overflow indicators in this view." }, "appointmentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.views.appointmentTemplate" + "Description": "Specifies a custom template for appointments." }, "appointmentTooltipTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.views.appointmentTooltipTemplate" + "Description": "Specifies a custom template for tooltips displayed when users click an appointment or cell overflow indicator in this view." }, "cellDuration": { "PrimitiveTypes": [ "number" ], - "DocID": "dxScheduler.Options.views.cellDuration" + "Description": "The cell duration in minutes." }, "dataCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.views.dataCellTemplate" + "Description": "Specifies a custom template for table cells." }, "dateCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.views.dateCellTemplate" + "Description": "Specifies a custom template for date scale items." }, "dropDownAppointmentTemplate": { "PrimitiveTypes": [ @@ -33789,32 +32385,32 @@ ], "IsDeprecated": true, "IsTemplate": true, - "DocID": "dxScheduler.Options.views.dropDownAppointmentTemplate" + "Description": "Use the views.appointmentTooltipTemplate option instead." }, "endDayHour": { "PrimitiveTypes": [ "number" ], - "DocID": "dxScheduler.Options.views.endDayHour" + "Description": "Specifies the last hour on the view's time scale. Accepts integer values from 0 to 24." }, "firstDayOfWeek": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxScheduler.Options.views.firstDayOfWeek" + "Description": "The first day of a week. Does not apply to the agenda view." }, "groupByDate": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScheduler.Options.views.groupByDate" + "Description": "If true, appointments are grouped by date first and then by resource; opposite if false. Applies only if appointments are grouped and groupOrientation is \"horizontal\"." }, "groupOrientation": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.views.groupOrientation" + "Description": "Arranges resource headers vertically (in a column) or horizontally (in a row)." }, "groups": { "ItemPrimitiveTypes": [ @@ -33822,33 +32418,33 @@ ], "IsCollection": true, "SingularName": "group", - "DocID": "dxScheduler.Options.views.groups" + "Description": "The resource kinds by which appointments are grouped." }, "intervalCount": { "PrimitiveTypes": [ "number" ], - "DocID": "dxScheduler.Options.views.intervalCount" + "Description": "Multiplies the default view interval. Applies to all view types except \"agenda\"." }, "maxAppointmentsPerCell": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxScheduler.Options.views.maxAppointmentsPerCell" + "Description": "Specifies the limit of full-sized appointments displayed per cell. Applies to all views except \"agenda\"." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.views.name" + "Description": "A custom name for the view. This name goes to the view switcher." }, "resourceCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.views.resourceCellTemplate" + "Description": "Specifies a custom template for resource headers." }, "startDate": { "PrimitiveTypes": [ @@ -33856,26 +32452,26 @@ "number", "string" ], - "DocID": "dxScheduler.Options.views.startDate" + "Description": "Specifies the date from which to start counting the view interval. Applies to all view types except \"agenda\"." }, "startDayHour": { "PrimitiveTypes": [ "number" ], - "DocID": "dxScheduler.Options.views.startDayHour" + "Description": "Specifies the first hour on the view's time scale. Accepts integer values from 0 to 24." }, "timeCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxScheduler.Options.views.timeCellTemplate" + "Description": "Specifies a custom template for time scale items." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScheduler.Options.views.type" + "Description": "The name of the view." } } }, @@ -33883,7 +32479,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -33892,12 +32488,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxScrollView": { - "DocID": "dxScrollView", + "Description": "The ScrollView is a widget that enables a user to scroll its content.", "IsTranscludedContent": true, "Module": "ui/scroll_view", "Options": { @@ -33905,25 +32501,25 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScrollable.Options.bounceEnabled" + "Description": "A Boolean value specifying whether to enable or disable the bounce-back effect." }, "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScrollable.Options.direction" + "Description": "A string value specifying the available scrolling directions." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScrollable.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -33932,7 +32528,7 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "onDisposing": { "PrimitiveTypes": [ @@ -33940,7 +32536,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -33948,7 +32544,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -33956,7 +32552,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPullDown": { "PrimitiveTypes": [ @@ -33964,7 +32560,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScrollView.Options.onPullDown" + "Description": "A function that is executed when the \"pull to refresh\" gesture is performed. Supported in mobile themes only." }, "onReachBottom": { "PrimitiveTypes": [ @@ -33972,7 +32568,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScrollView.Options.onReachBottom" + "Description": "A function that is executed when the content is scrolled down to the bottom." }, "onScroll": { "PrimitiveTypes": [ @@ -33980,7 +32576,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScrollable.Options.onScroll" + "Description": "A function that is executed on each scroll gesture." }, "onUpdated": { "PrimitiveTypes": [ @@ -33988,61 +32584,61 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxScrollable.Options.onUpdated" + "Description": "A function that is executed each time the widget is updated." }, "pulledDownText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScrollView.Options.pulledDownText" + "Description": "Specifies the text shown in the pullDown panel when pulling the content down lowers the refresh threshold." }, "pullingDownText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScrollView.Options.pullingDownText" + "Description": "Specifies the text shown in the pullDown panel while pulling the content down to the refresh threshold." }, "reachBottomText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScrollView.Options.reachBottomText" + "Description": "Specifies the text shown in the pullDown panel displayed when content is scrolled to the bottom." }, "refreshingText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScrollView.Options.refreshingText" + "Description": "Specifies the text shown in the pullDown panel displayed when the content is being refreshed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scrollByContent": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScrollable.Options.scrollByContent" + "Description": "A Boolean value specifying whether or not an end-user can scroll the widget content swiping it up or down. Applies only if useNative is false" }, "scrollByThumb": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScrollable.Options.scrollByThumb" + "Description": "A Boolean value specifying whether or not an end-user can scroll the widget content using the scrollbar." }, "showScrollbar": { "PrimitiveTypes": [ "string" ], - "DocID": "dxScrollable.Options.showScrollbar" + "Description": "Specifies when the widget shows the scrollbar." }, "useNative": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxScrollable.Options.useNative" + "Description": "Indicates whether to use native or simulated scrolling." }, "width": { "PrimitiveTypes": [ @@ -34051,12 +32647,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxSelectBox": { - "DocID": "dxSelectBox", + "Description": "The SelectBox widget is an editor that allows an end user to select an item from a drop-down list.", "Module": "ui/select_box", "IsEditor": true, "Options": { @@ -34064,19 +32660,19 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSelectBox.Options.acceptCustomValue" + "Description": "Specifies whether the widget allows a user to enter a custom value. Requires the onCustomItemCreating handler implementation." }, "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "buttons": { "ItemPrimitiveTypes": [ @@ -34086,16 +32682,9 @@ "ItemComplexTypes": [ "TextEditorButton" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "button", - "DocID": "dxDropDownEditor.Options.buttons" + "Description": "Allows you to add custom buttons to the input text field." }, "dataSource": { "PrimitiveTypes": [ @@ -34107,27 +32696,20 @@ "DevExpress.ui.CollectionWidgetItem", "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "DataExpressionMixin.Options.dataSource" + "Description": "Binds the widget to data." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.deferRendering" + "Description": "Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "displayExpr": { "PrimitiveTypes": [ @@ -34135,53 +32717,53 @@ "string" ], "IsFunc": true, - "DocID": "DataExpressionMixin.Options.displayExpr" + "Description": "Specifies the data field whose values should be displayed." }, "displayValue": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxDropDownList.Options.displayValue" + "Description": "Returns the value currently displayed by the widget." }, "dropDownButtonTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDropDownEditor.Options.dropDownButtonTemplate" + "Description": "Specifies a custom template for the drop-down button." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "fieldTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSelectBox.Options.fieldTemplate" + "Description": "Specifies a custom template for the text field. Must contain the TextBox widget." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "grouped": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownList.Options.grouped" + "Description": "Specifies whether data items should be grouped." }, "groupTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDropDownList.Options.groupTemplate" + "Description": "Specifies a custom template for group captions." }, "height": { "PrimitiveTypes": [ @@ -34190,31 +32772,31 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "inputAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTextEditor.Options.inputAttr" + "Description": "Specifies the attributes to be passed on to the underlying HTML element." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "items": { "ItemPrimitiveTypes": [ @@ -34222,38 +32804,38 @@ ], "IsCollection": true, "SingularName": "item", - "DocID": "DataExpressionMixin.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -34262,32 +32844,32 @@ "any" ], "IsTemplate": true, - "DocID": "DataExpressionMixin.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "maxLength": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxTextBox.Options.maxLength" + "Description": "Specifies the maximum number of characters you can enter into the textbox." }, "minSearchLength": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDropDownList.Options.minSearchLength" + "Description": "The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownList.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onChange": { "PrimitiveTypes": [ @@ -34295,7 +32877,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onChange" + "Description": "A function that is executed when the widget loses focus after the text field's content was changed using the keyboard." }, "onClosed": { "PrimitiveTypes": [ @@ -34303,7 +32885,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onClosed" + "Description": "A function that is executed once the drop-down editor is closed." }, "onContentReady": { "PrimitiveTypes": [ @@ -34311,7 +32893,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onCopy": { "PrimitiveTypes": [ @@ -34319,7 +32901,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCopy" + "Description": "A function that is executed when the widget's input has been copied." }, "onCustomItemCreating": { "PrimitiveTypes": [ @@ -34327,7 +32909,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSelectBox.Options.onCustomItemCreating" + "Description": "A function that is executed when a user adds a custom item. Requires acceptCustomValue to be set to true." }, "onCut": { "PrimitiveTypes": [ @@ -34335,7 +32917,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCut" + "Description": "A function that is executed when the widget's input has been cut." }, "onDisposing": { "PrimitiveTypes": [ @@ -34343,7 +32925,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEnterKey": { "PrimitiveTypes": [ @@ -34351,7 +32933,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onEnterKey" + "Description": "A function that is executed when the Enter key has been pressed while the widget is focused." }, "onFocusIn": { "PrimitiveTypes": [ @@ -34359,7 +32941,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusIn" + "Description": "A function that is executed when the widget gets focus." }, "onFocusOut": { "PrimitiveTypes": [ @@ -34367,7 +32949,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusOut" + "Description": "A function that is executed when the widget loses focus." }, "onInitialized": { "PrimitiveTypes": [ @@ -34375,7 +32957,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onInput": { "PrimitiveTypes": [ @@ -34383,7 +32965,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onInput" + "Description": "A function that is executed each time the widget's input is changed while the widget is focused." }, "onItemClick": { "PrimitiveTypes": [ @@ -34391,7 +32973,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownList.Options.onItemClick" + "Description": "A function that is executed when a list item is clicked or tapped." }, "onKeyDown": { "PrimitiveTypes": [ @@ -34399,7 +32981,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyDown" + "Description": "A function that is executed when a user is pressing a key on the keyboard." }, "onKeyPress": { "PrimitiveTypes": [ @@ -34407,7 +32989,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyPress" + "Description": "A function that is executed when a user presses a key on the keyboard." }, "onKeyUp": { "PrimitiveTypes": [ @@ -34415,7 +32997,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyUp" + "Description": "A function that is executed when a user releases a key on the keyboard." }, "onOpened": { "PrimitiveTypes": [ @@ -34423,7 +33005,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onOpened" + "Description": "A function that is executed once the drop-down editor is opened." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -34431,7 +33013,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPaste": { "PrimitiveTypes": [ @@ -34439,7 +33021,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onPaste" + "Description": "A function that is executed when the widget's input has been pasted." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -34447,7 +33029,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownList.Options.onSelectionChanged" + "Description": "A function that is executed when a list item is selected or selection is canceled." }, "onValueChanged": { "PrimitiveTypes": [ @@ -34455,131 +33037,129 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownList.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "opened": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxDropDownEditor.Options.opened" + "Description": "Specifies whether or not the drop-down editor is displayed." }, "openOnFieldClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSelectBox.Options.openOnFieldClick" + "Description": "Specifies whether a user can open the drop-down list by clicking a text field." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSelectBox.Options.placeholder" + "Description": "The text that is provided as a hint in the select box editor." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "searchEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownList.Options.searchEnabled" + "Description": "Specifies whether to allow searching." }, "searchExpr": { "PrimitiveTypes": [ - "Function", - "string" + "Function" ], "ItemPrimitiveTypes": [ - "Function", - "string" + "Function" ], "IsCollection": true, "SingularName": "searchExpr", - "DocID": "dxDropDownList.Options.searchExpr" + "Description": "Specifies the name of a data source item field or an expression whose value is compared to the search criterion." }, "searchMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownList.Options.searchMode" + "Description": "Specifies a comparison operation used to search widget items." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDropDownList.Options.searchTimeout" + "Description": "Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed." }, "selectedItem": { "PrimitiveTypes": [ "any" ], "IsReadonly": true, - "DocID": "dxDropDownList.Options.selectedItem" + "Description": "Gets the currently selected item." }, "showClearButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.showClearButton" + "Description": "Specifies whether to display the Clear button in the widget." }, "showDataBeforeSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownList.Options.showDataBeforeSearch" + "Description": "Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value." }, "showDropDownButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSelectBox.Options.showDropDownButton" + "Description": "Specifies whether the drop-down button is visible." }, "showSelectionControls": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSelectBox.Options.showSelectionControls" + "Description": "Specifies whether or not to display selection controls." }, "spellcheck": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.spellcheck" + "Description": "Specifies whether or not the widget checks the inner text for spelling mistakes." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.stylingMode" + "Description": "Specifies how the widget's text field is styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "text": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxTextEditor.Options.text" + "Description": "The read-only option that holds the text displayed by the widget input element." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -34587,32 +33167,32 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "dxDropDownList.Options.value" + "Description": "Specifies the currently selected value. May be an object if dataSource contains objects and valueExpr is not set." }, "valueChangeEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSelectBox.Options.valueChangeEvent" + "Description": "Specifies the DOM events after which the widget's value should be updated. Applies only if acceptCustomValue is set to true." }, "valueExpr": { "PrimitiveTypes": [ @@ -34620,13 +33200,13 @@ "string" ], "IsFunc": true, - "DocID": "DataExpressionMixin.Options.valueExpr" + "Description": "Specifies which data field provides unique values to the widget's value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -34635,32 +33215,32 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." }, "wrapItemText": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownList.Options.wrapItemText" + "Description": "Specifies whether text that exceeds the drop-down list width should be wrapped." } } }, "dxSlideOut": { - "DocID": "dxSlideOut", + "Description": "The SlideOut widget is a classic slide-out menu paired with a view. An end user opens the menu by swiping away the view.", "Module": "ui/slide_out", "Options": { "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSlideOut.Options.activeStateEnabled" + "Description": "A Boolean value specifying whether or not the widget changes its state when interacting with a user." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSlideOut.Options.contentTemplate" + "Description": "Specifies a custom template for the widget content. Rendered only once - when the widget is created." }, "dataSource": { "PrimitiveTypes": [ @@ -34676,27 +33256,20 @@ "ItemComplexTypes": [ "SlideOutItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxSlideOut.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -34705,25 +33278,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -34733,45 +33306,45 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxSlideOut.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "menuTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSlideOutItem.menuTemplate" + "Description": "Specifies a template that should be used to render a menu item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -34780,45 +33353,45 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "menuGrouped": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSlideOut.Options.menuGrouped" + "Description": "A Boolean value specifying whether or not to display a grouped menu." }, "menuGroupTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSlideOut.Options.menuGroupTemplate" + "Description": "Specifies a custom template for group captions." }, "menuItemTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSlideOut.Options.menuItemTemplate" + "Description": "Specifies a custom template for menu items." }, "menuPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSlideOut.Options.menuPosition" + "Description": "Specifies the current menu position." }, "menuVisible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSlideOut.Options.menuVisible" + "Description": "Specifies whether or not the slide-out menu is displayed." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidget.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onContentReady": { "PrimitiveTypes": [ @@ -34826,7 +33399,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -34834,7 +33407,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -34842,7 +33415,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -34851,7 +33424,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -34859,7 +33432,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemHold": { "PrimitiveTypes": [ @@ -34867,7 +33440,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -34875,7 +33448,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onMenuGroupRendered": { "PrimitiveTypes": [ @@ -34883,7 +33456,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSlideOut.Options.onMenuGroupRendered" + "Description": "A function that is executed when a group menu item is rendered." }, "onMenuItemRendered": { "PrimitiveTypes": [ @@ -34891,7 +33464,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSlideOut.Options.onMenuItemRendered" + "Description": "A function that is executed when a regular menu item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -34899,7 +33472,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -34907,39 +33480,39 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onSelectionChanged" + "Description": "A function that is executed when a collection item is selected or selection is canceled." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectedIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "dxSlideOut.Options.selectedIndex" + "Description": "The index number of the currently selected item." }, "selectedItem": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "CollectionWidget.Options.selectedItem" + "Description": "The selected item object." }, "swipeEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSlideOut.Options.swipeEnabled" + "Description": "Indicates whether the menu can be shown/hidden by swiping the widget's main panel." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -34948,12 +33521,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxSlideOutView": { - "DocID": "dxSlideOutView", + "Description": "The SlideOutView widget is a classic slide-out menu paired with a view. This widget is very similar to the SlideOut with only one difference - the SlideOut always contains the List in the slide-out menu, while the SlideOutView can hold any collection there.", "IsTranscludedContent": true, "Module": "ui/slide_out_view", "Options": { @@ -34961,26 +33534,26 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSlideOutView.Options.contentTemplate" + "Description": "Specifies a custom template for the widget content." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -34989,38 +33562,38 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "menuPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSlideOutView.Options.menuPosition" + "Description": "Specifies the current menu position." }, "menuTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSlideOutView.Options.menuTemplate" + "Description": "Specifies a custom template for the menu content." }, "menuVisible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSlideOutView.Options.menuVisible" + "Description": "Specifies whether or not the menu panel is visible." }, "onDisposing": { "PrimitiveTypes": [ @@ -35028,7 +33601,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -35036,7 +33609,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -35044,25 +33617,25 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "swipeEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSlideOutView.Options.swipeEnabled" + "Description": "Specifies whether or not the menu is shown when a user swipes the widget content." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -35071,12 +33644,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxSlider": { - "DocID": "dxSlider", + "Description": "The Slider is a widget that allows an end user to set a numeric value on a continuous range of possible values.", "Module": "ui/slider", "IsEditor": true, "Options": { @@ -35084,31 +33657,31 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSliderBase.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSliderBase.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -35117,34 +33690,34 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSliderBase.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "keyStep": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSliderBase.Options.keyStep" + "Description": "Specifies the step by which a handle moves when a user presses Page Up or Page Down." }, "label": { - "DocID": "dxSliderBase.Options.label", + "Description": "Configures the labels displayed at the min and max values.", "Options": { "format": { "PrimitiveTypes": [ @@ -35154,26 +33727,19 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxSliderBase.Options.label.format" + "Description": "Formats a value before it is displayed in a label." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSliderBase.Options.label.position" + "Description": "Specifies whether labels are over or under the scale." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSliderBase.Options.label.visible" + "Description": "Specifies whether slider labels are visible." } } }, @@ -35181,19 +33747,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxTrackBar.Options.max" + "Description": "The maximum value the widget can accept." }, "min": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTrackBar.Options.min" + "Description": "The minimum value the widget can accept." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSliderBase.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "onContentReady": { "PrimitiveTypes": [ @@ -35201,7 +33767,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -35209,7 +33775,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -35217,7 +33783,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -35225,7 +33791,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onValueChanged": { "PrimitiveTypes": [ @@ -35233,46 +33799,46 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showRange": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSliderBase.Options.showRange" + "Description": "Specifies whether to highlight the selected range." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSliderBase.Options.step" + "Description": "Specifies the step by which the widget's value changes when a user drags a handler." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "tooltip": { - "DocID": "dxSliderBase.Options.tooltip", + "Description": "Configures a tooltip.", "Options": { "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSliderBase.Options.tooltip.enabled" + "Description": "Specifies whether a tooltip is enabled." }, "format": { "PrimitiveTypes": [ @@ -35282,26 +33848,19 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxSliderBase.Options.tooltip.format" + "Description": "Specifies a tooltip's display format." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSliderBase.Options.tooltip.position" + "Description": "Specifies whether a tooltip is over or under the slider." }, "showMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSliderBase.Options.tooltip.showMode" + "Description": "Specifies when the widget shows a tooltip." } } }, @@ -35309,7 +33868,7 @@ "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -35317,32 +33876,32 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "dxSlider.Options.value" + "Description": "The current slider value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -35351,12 +33910,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxSortable": { - "DocID": "dxSortable", + "Description": "Sortable is a user interface utility that allows a widget's items to be reordered via drag and drop gestures.", "IsTranscludedContent": true, "Module": "ui/sortable", "Options": { @@ -35364,19 +33923,19 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSortable.Options.allowDropInsideItem" + "Description": "Allows a user to drop an item inside another item." }, "allowReordering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSortable.Options.allowReordering" + "Description": "Allows a user to reorder sortable items." }, "autoScroll": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DraggableBase.Options.autoScroll" + "Description": "Enables automatic scrolling while dragging an item beyond the viewport." }, "boundary": { "PrimitiveTypes": [ @@ -35384,7 +33943,7 @@ "JQuery", "string" ], - "DocID": "DraggableBase.Options.boundary" + "Description": "Specifies a DOM element that limits the dragging area." }, "container": { "PrimitiveTypes": [ @@ -35392,25 +33951,25 @@ "JQuery", "string" ], - "DocID": "DraggableBase.Options.container" + "Description": "Specifies a custom container in which the draggable item should be rendered." }, "cursorOffset": { "PrimitiveTypes": [ "string" ], - "DocID": "DraggableBase.Options.cursorOffset", + "Description": "Specifies the cursor offset from the dragged item.", "Options": { "x": { "PrimitiveTypes": [ "number" ], - "DocID": "DraggableBase.Options.cursorOffset.x" + "Description": "Specifies the horizontal cursor offset from the dragged item in pixels." }, "y": { "PrimitiveTypes": [ "number" ], - "DocID": "DraggableBase.Options.cursorOffset.y" + "Description": "Specifies the vertical cursor offset from the dragged item in pixels." } } }, @@ -35418,50 +33977,50 @@ "PrimitiveTypes": [ "any" ], - "DocID": "DraggableBase.Options.data" + "Description": "A container for custom data." }, "dragDirection": { "PrimitiveTypes": [ "string" ], - "DocID": "DraggableBase.Options.dragDirection" + "Description": "Specifies the directions in which an item can be dragged." }, "dragTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSortable.Options.dragTemplate" + "Description": "Specifies custom markup to be shown instead of the item being dragged." }, "dropFeedbackMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSortable.Options.dropFeedbackMode" + "Description": "Specifies how to highlight the item's drop position." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "filter": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSortable.Options.filter" + "Description": "Specifies a CSS selector for the items that can be dragged." }, "group": { "PrimitiveTypes": [ "string" ], - "DocID": "DraggableBase.Options.group" + "Description": "Allows you to group several widgets, so that users can drag and drop items between them." }, "handle": { "PrimitiveTypes": [ "string" ], - "DocID": "DraggableBase.Options.handle" + "Description": "Specifies a CSS selector (ID or class) that should act as the drag handle(s) for the item(s)." }, "height": { "PrimitiveTypes": [ @@ -35470,19 +34029,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "itemOrientation": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSortable.Options.itemOrientation" + "Description": "Notifies the widget of the items' orientation." }, "moveItemOnDrop": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSortable.Options.moveItemOnDrop" + "Description": "Moves an element in the HTML markup when it is dropped." }, "onAdd": { "PrimitiveTypes": [ @@ -35490,7 +34049,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSortable.Options.onAdd" + "Description": "A function that is called when a new item is added." }, "onDisposing": { "PrimitiveTypes": [ @@ -35498,7 +34057,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDragChange": { "PrimitiveTypes": [ @@ -35506,7 +34065,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSortable.Options.onDragChange" + "Description": "A function that is called when the dragged item's position in the list is changed." }, "onDragEnd": { "PrimitiveTypes": [ @@ -35514,7 +34073,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSortable.Options.onDragEnd" + "Description": "A function that is called when the drag gesture is finished." }, "onDragMove": { "PrimitiveTypes": [ @@ -35522,7 +34081,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSortable.Options.onDragMove" + "Description": "A function that is called every time a draggable item is moved." }, "onDragStart": { "PrimitiveTypes": [ @@ -35530,7 +34089,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSortable.Options.onDragStart" + "Description": "A function that is called when drag gesture is initialized." }, "onInitialized": { "PrimitiveTypes": [ @@ -35538,7 +34097,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -35546,7 +34105,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onRemove": { "PrimitiveTypes": [ @@ -35554,7 +34113,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSortable.Options.onRemove" + "Description": "A function that is called when a draggable item is removed." }, "onReorder": { "PrimitiveTypes": [ @@ -35562,25 +34121,25 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSortable.Options.onReorder" + "Description": "A function that is called when the draggable items are reordered." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scrollSensitivity": { "PrimitiveTypes": [ "number" ], - "DocID": "DraggableBase.Options.scrollSensitivity" + "Description": "Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true." }, "scrollSpeed": { "PrimitiveTypes": [ "number" ], - "DocID": "DraggableBase.Options.scrollSpeed" + "Description": "Specifies the scrolling speed when dragging an item beyond the viewport. Applies only if autoScroll is true." }, "width": { "PrimitiveTypes": [ @@ -35589,31 +34148,31 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxSparkline": { - "DocID": "dxSparkline", + "Description": "The Sparkline widget is a compact chart that contains only one series. Owing to their size, sparklines occupy very little space and can be easily collected in a table or embedded straight in text.", "Module": "viz/sparkline", "Options": { "argumentField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.argumentField" + "Description": "Specifies the data source field that provides arguments for a sparkline." }, "barNegativeColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.barNegativeColor" + "Description": "Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only." }, "barPositiveColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.barPositiveColor" + "Description": "Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only." }, "dataSource": { "PrimitiveTypes": [ @@ -35624,84 +34183,77 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxSparkline.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "firstLastColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.firstLastColor" + "Description": "Sets a color for the boundary of both the first and last points on a sparkline." }, "ignoreEmptyPoints": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSparkline.Options.ignoreEmptyPoints" + "Description": "Specifies whether the sparkline should ignore null data points." }, "lineColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.lineColor" + "Description": "Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types." }, "lineWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSparkline.Options.lineWidth" + "Description": "Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types." }, "lossColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.lossColor" + "Description": "Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only." }, "margin": { - "DocID": "BaseWidget.Options.margin", + "Description": "Generates space around the widget.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.bottom" + "Description": "Specifies the bottom margin of the widget in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.left" + "Description": "Specifies the left margin of the widget in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.right" + "Description": "Specifies the right margin of the widget in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.margin.top" + "Description": "Specifies the top margin of the widget in pixels." } } }, @@ -35709,25 +34261,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.maxColor" + "Description": "Sets a color for the boundary of the maximum point on a sparkline." }, "maxValue": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSparkline.Options.maxValue" + "Description": "Specifies the maximum value of the sparkline's value axis." }, "minColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.minColor" + "Description": "Sets a color for the boundary of the minimum point on a sparkline." }, "minValue": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSparkline.Options.minValue" + "Description": "Specifies the minimum value of the sparkline value axis." }, "onDisposing": { "PrimitiveTypes": [ @@ -35735,7 +34287,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDrawn": { "PrimitiveTypes": [ @@ -35743,7 +34295,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onExported": { "PrimitiveTypes": [ @@ -35751,7 +34303,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -35759,7 +34311,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -35767,7 +34319,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -35775,7 +34327,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -35783,7 +34335,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -35791,7 +34343,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onTooltipHidden": { "PrimitiveTypes": [ @@ -35799,7 +34351,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseSparkline.Options.onTooltipHidden" + "Description": "A function that is executed when a tooltip becomes hidden." }, "onTooltipShown": { "PrimitiveTypes": [ @@ -35807,64 +34359,64 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseSparkline.Options.onTooltipShown" + "Description": "A function that is executed when a tooltip appears." }, "pathModified": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "pointColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.pointColor" + "Description": "Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types." }, "pointSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSparkline.Options.pointSize" + "Description": "Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types." }, "pointSymbol": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.pointSymbol" + "Description": "Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showFirstLast": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSparkline.Options.showFirstLast" + "Description": "Specifies whether or not to indicate both the first and last values on a sparkline." }, "showMinMax": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSparkline.Options.showMinMax" + "Description": "Specifies whether or not to indicate both the minimum and maximum values on a sparkline." }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, @@ -35872,49 +34424,49 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "tooltip": { - "DocID": "BaseSparkline.Options.tooltip", + "Description": "Configures the tooltip.", "Options": { "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.arrowLength" + "Description": "Specifies the length of a tooltip's arrow in pixels." }, "border": { - "DocID": "BaseWidget.Options.tooltip.border", + "Description": "Configures a tooltip's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.color" + "Description": "Colors a tooltip's border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.dashStyle" + "Description": "Specifies the dash style of a tooltip's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.opacity" + "Description": "Specifies the transparency of a tooltip's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.border.visible" + "Description": "Specifies whether a tooltip's border is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.width" + "Description": "Specifies the width of a tooltip's border in pixels." } } }, @@ -35922,7 +34474,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.color" + "Description": "Colors all tooltips." }, "container": { "PrimitiveTypes": [ @@ -35930,115 +34482,103 @@ "JQuery", "string" ], - "DocID": "BaseWidget.Options.tooltip.container" + "Description": "Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "BaseSparkline.Options.tooltip.contentTemplate" + "Description": "Specifies a custom template for tooltips." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.cornerRadius" + "Description": "Makes all the tooltip's corners rounded." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseSparkline.Options.tooltip.customizeTooltip" + "Description": "Allows you to change tooltip appearance." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseSparkline.Options.tooltip.enabled" + "Description": "Enables tooltips." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.font" + "Description": "Specifies tooltips' font options." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.format" + "Description": "Formats a value before it is displayed it in a tooltip." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.opacity" + "Description": "Specifies tooltips' transparency." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between a tooltip's left/right border and its text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text." }, "shadow": { - "DocID": "BaseWidget.Options.tooltip.shadow", + "Description": "Configures a tooltip's shadow.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.blur" + "Description": "Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.shadow.color" + "Description": "Colors a tooltip's shadow." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetX" + "Description": "Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetY" + "Description": "Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.opacity" + "Description": "Specifies the transparency of a tooltip's shadow." } } }, @@ -36046,7 +34586,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.zIndex" + "Description": "Specifies a tooltip's z-index." } } }, @@ -36054,85 +34594,85 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.type" + "Description": "Determines the type of a sparkline." }, "valueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.valueField" + "Description": "Specifies the data source field that provides values for a sparkline." }, "winColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSparkline.Options.winColor" + "Description": "Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only." }, "winlossThreshold": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSparkline.Options.winlossThreshold" + "Description": "Specifies a value that serves as a threshold for the sparkline of the winloss type." } } }, "dxSpeedDialAction": { - "DocID": "dxSpeedDialAction", + "Description": "The SpeedDialAction is a button that performs a custom action. It can be represented by a Floating Action Button (FAB) or a button in a speed dial menu opened with the FAB.", "Module": "ui/speed_dial_action", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSpeedDialAction.Options.icon" + "Description": "Specifies the icon the FAB or speed dial action button displays." }, "index": { "PrimitiveTypes": [ "number" ], - "DocID": "dxSpeedDialAction.Options.index" + "Description": "Allows you to reorder action buttons in the speed dial menu." }, "label": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSpeedDialAction.Options.label" + "Description": "Specifies the text label displayed inside the FAB or near the speed dial action button." }, "onClick": { "PrimitiveTypes": [ @@ -36140,7 +34680,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSpeedDialAction.Options.onClick" + "Description": "A function that is executed when the FAB or speed dial action button is clicked or tapped." }, "onContentReady": { "PrimitiveTypes": [ @@ -36148,7 +34688,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSpeedDialAction.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -36156,7 +34696,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -36164,7 +34704,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -36172,30 +34712,30 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSpeedDialAction.Options.visible" + "Description": "Allows you to hide the FAB from the view or the action from the speed dial menu." } } }, "dxSwitch": { - "DocID": "dxSwitch", + "Description": "The Switch is a widget that can be in two states: \"On\" and \"Off\".", "Module": "ui/switch", "IsEditor": true, "Options": { @@ -36203,31 +34743,31 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSwitch.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSwitch.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -36236,38 +34776,38 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSwitch.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSwitch.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "offText": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "dxSwitch.Options.offText" + "Description": "Use the switchedOffText option instead." }, "onContentReady": { "PrimitiveTypes": [ @@ -36275,7 +34815,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -36283,7 +34823,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -36291,7 +34831,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -36299,14 +34839,14 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onText": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "dxSwitch.Options.onText" + "Description": "Use the switchedOnText option instead." }, "onValueChanged": { "PrimitiveTypes": [ @@ -36314,43 +34854,43 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "switchedOffText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSwitch.Options.switchedOffText" + "Description": "Specifies the text displayed when the widget is switched off." }, "switchedOnText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSwitch.Options.switchedOnText" + "Description": "Specifies the text displayed when the widget is switched on." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -36358,32 +34898,32 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxSwitch.Options.value" + "Description": "A Boolean value specifying whether the current switch state is \"On\" or \"Off\"." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -36392,31 +34932,31 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxTabPanel": { - "DocID": "dxTabPanel", + "Description": "The TabPanel is a widget consisting of the Tabs and MultiView widgets. It automatically synchronizes the selected tab with the currently displayed view and vice versa.", "Module": "ui/tab_panel", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "animationEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabPanel.Options.animationEnabled" + "Description": "Specifies whether or not to animate the displayed item change." }, "dataSource": { "PrimitiveTypes": [ @@ -36432,39 +34972,32 @@ "ItemComplexTypes": [ "TabPanelItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxTabPanel.Options.dataSource" + "Description": "Binds the widget to data." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMultiView.Options.deferRendering" + "Description": "Specifies whether to render the view's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabPanel.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -36473,25 +35006,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabPanel.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -36501,57 +35034,57 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxTabPanel.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "badge": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabPanelItem.badge" + "Description": "Specifies a badge text for the tab." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabPanelItem.icon" + "Description": "Specifies the icon to be displayed in the tab's title." }, "tabTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxTabPanelItem.tabTemplate" + "Description": "Specifies a template that should be used to render the tab for this item only." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabPanelItem.title" + "Description": "Specifies the item title text displayed on a corresponding tab." } } }, @@ -36560,26 +35093,26 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "itemTitleTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxTabPanel.Options.itemTitleTemplate" + "Description": "Specifies a custom template for item titles." }, "loop": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMultiView.Options.loop" + "Description": "A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidget.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onContentReady": { "PrimitiveTypes": [ @@ -36587,7 +35120,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -36595,7 +35128,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -36603,7 +35136,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -36612,7 +35145,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -36620,7 +35153,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemHold": { "PrimitiveTypes": [ @@ -36628,7 +35161,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -36636,7 +35169,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -36644,7 +35177,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -36652,7 +35185,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onSelectionChanged" + "Description": "A function that is executed when a collection item is selected or selection is canceled." }, "onTitleClick": { "PrimitiveTypes": [ @@ -36661,7 +35194,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTabPanel.Options.onTitleClick" + "Description": "A function that is executed when a tab is clicked or tapped." }, "onTitleHold": { "PrimitiveTypes": [ @@ -36669,7 +35202,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTabPanel.Options.onTitleHold" + "Description": "A function that is executed when a tab has been held for a specified period." }, "onTitleRendered": { "PrimitiveTypes": [ @@ -36677,69 +35210,69 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTabPanel.Options.onTitleRendered" + "Description": "A function that is executed after a tab is rendered." }, "repaintChangesOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabPanel.Options.repaintChangesOnly" + "Description": "Specifies whether to repaint only those elements whose data changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scrollByContent": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabPanel.Options.scrollByContent" + "Description": "A Boolean value specifying if tabs in the title are scrolled by content." }, "scrollingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabPanel.Options.scrollingEnabled" + "Description": "A Boolean indicating whether or not to add scrolling support for tabs in the title." }, "selectedIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "dxMultiView.Options.selectedIndex" + "Description": "The index of the currently displayed item." }, "selectedItem": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "CollectionWidget.Options.selectedItem" + "Description": "The selected item object." }, "showNavButtons": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabPanel.Options.showNavButtons" + "Description": "Specifies whether navigation buttons should be available when tabs exceed the widget's width." }, "swipeEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabPanel.Options.swipeEnabled" + "Description": "A Boolean value specifying whether or not to allow users to change the selected index by swiping." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -36748,19 +35281,19 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxTabs": { - "DocID": "dxTabs", + "Description": "The Tabs is a tab strip used to switch between pages or views. This widget is included in the TabPanel widget, but you can use the Tabs separately as well.", "Module": "ui/tabs", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "dataSource": { "PrimitiveTypes": [ @@ -36776,33 +35309,26 @@ "ItemComplexTypes": [ "TabsItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxTabs.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabs.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -36811,25 +35337,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabs.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -36839,50 +35365,50 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxTabs.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "badge": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabsItem.badge" + "Description": "Specifies a badge text for the tab." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabsItem.icon" + "Description": "Specifies the icon to be displayed on the tab." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -36891,7 +35417,7 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "keyExpr": { "PrimitiveTypes": [ @@ -36899,13 +35425,13 @@ "string" ], "IsFunc": true, - "DocID": "CollectionWidget.Options.keyExpr" + "Description": "Specifies the key property that provides key values to access data items. Each key value must be unique." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidget.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onContentReady": { "PrimitiveTypes": [ @@ -36913,7 +35439,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -36921,7 +35447,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -36929,7 +35455,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -36938,7 +35464,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -36946,7 +35472,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemHold": { "PrimitiveTypes": [ @@ -36954,7 +35480,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -36962,7 +35488,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -36970,7 +35496,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -36978,45 +35504,45 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onSelectionChanged" + "Description": "A function that is executed when a collection item is selected or selection is canceled." }, "repaintChangesOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabs.Options.repaintChangesOnly" + "Description": "Specifies whether to repaint only those elements whose data changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scrollByContent": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabs.Options.scrollByContent" + "Description": "Specifies whether or not an end-user can scroll tabs by swiping." }, "scrollingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabs.Options.scrollingEnabled" + "Description": "Specifies whether or not an end-user can scroll tabs." }, "selectedIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "CollectionWidget.Options.selectedIndex" + "Description": "The index of the currently selected widget item." }, "selectedItem": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "CollectionWidget.Options.selectedItem" + "Description": "The selected item object." }, "selectedItemKeys": { "ItemPrimitiveTypes": [ @@ -37025,7 +35551,7 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "selectedItemKey", - "DocID": "CollectionWidget.Options.selectedItemKeys" + "Description": "Specifies an array of currently selected item keys." }, "selectedItems": { "ItemPrimitiveTypes": [ @@ -37036,31 +35562,31 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "selectedItem", - "DocID": "dxTabs.Options.selectedItems" + "Description": "An array of currently selected item objects." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabs.Options.selectionMode" + "Description": "Specifies whether the widget enables an end-user to select only a single item or multiple items." }, "showNavButtons": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTabs.Options.showNavButtons" + "Description": "Specifies whether navigation buttons should be available when tabs exceed the widget's width." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -37069,12 +35595,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxTagBox": { - "DocID": "dxTagBox", + "Description": "The TagBox widget is an editor that allows an end user to select multiple items from a drop-down list.", "Module": "ui/tag_box", "IsEditor": true, "Options": { @@ -37082,25 +35608,25 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSelectBox.Options.acceptCustomValue" + "Description": "Specifies whether the widget allows a user to enter a custom value. Requires the onCustomItemCreating handler implementation." }, "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "applyValueMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTagBox.Options.applyValueMode" + "Description": "Specifies how the widget applies values." }, "buttons": { "ItemPrimitiveTypes": [ @@ -37110,16 +35636,9 @@ "ItemComplexTypes": [ "TextEditorButton" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "button", - "DocID": "dxDropDownEditor.Options.buttons" + "Description": "Allows you to add custom buttons to the input text field." }, "dataSource": { "PrimitiveTypes": [ @@ -37131,27 +35650,20 @@ "DevExpress.ui.CollectionWidgetItem", "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "DataExpressionMixin.Options.dataSource" + "Description": "Binds the widget to data." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownEditor.Options.deferRendering" + "Description": "Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "displayExpr": { "PrimitiveTypes": [ @@ -37159,46 +35671,46 @@ "string" ], "IsFunc": true, - "DocID": "DataExpressionMixin.Options.displayExpr" + "Description": "Specifies the data field whose values should be displayed." }, "dropDownButtonTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDropDownEditor.Options.dropDownButtonTemplate" + "Description": "Specifies a custom template for the drop-down button." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "fieldTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSelectBox.Options.fieldTemplate" + "Description": "Specifies a custom template for the text field. Must contain the TextBox widget." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "grouped": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownList.Options.grouped" + "Description": "Specifies whether data items should be grouped." }, "groupTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDropDownList.Options.groupTemplate" + "Description": "Specifies a custom template for group captions." }, "height": { "PrimitiveTypes": [ @@ -37207,37 +35719,37 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hideSelectedItems": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTagBox.Options.hideSelectedItems" + "Description": "A Boolean value specifying whether or not to hide selected items." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "inputAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTextEditor.Options.inputAttr" + "Description": "Specifies the attributes to be passed on to the underlying HTML element." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "items": { "ItemPrimitiveTypes": [ @@ -37245,38 +35757,38 @@ ], "IsCollection": true, "SingularName": "item", - "DocID": "DataExpressionMixin.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -37285,44 +35797,44 @@ "any" ], "IsTemplate": true, - "DocID": "DataExpressionMixin.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "maxDisplayedTags": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTagBox.Options.maxDisplayedTags" + "Description": "Specifies the limit on displayed tags. On exceeding it, the widget replaces all tags with a single multi-tag that displays the number of selected items." }, "maxLength": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxTextBox.Options.maxLength" + "Description": "Specifies the maximum number of characters you can enter into the textbox." }, "minSearchLength": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDropDownList.Options.minSearchLength" + "Description": "The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true." }, "multiline": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTagBox.Options.multiline" + "Description": "A Boolean value specifying whether or not the widget is multiline." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownList.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onChange": { "PrimitiveTypes": [ @@ -37330,7 +35842,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onChange" + "Description": "A function that is executed when the widget loses focus after the text field's content was changed using the keyboard." }, "onClosed": { "PrimitiveTypes": [ @@ -37338,7 +35850,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onClosed" + "Description": "A function that is executed once the drop-down editor is closed." }, "onContentReady": { "PrimitiveTypes": [ @@ -37346,7 +35858,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onCustomItemCreating": { "PrimitiveTypes": [ @@ -37354,7 +35866,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxSelectBox.Options.onCustomItemCreating" + "Description": "A function that is executed when a user adds a custom item. Requires acceptCustomValue to be set to true." }, "onDisposing": { "PrimitiveTypes": [ @@ -37362,7 +35874,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEnterKey": { "PrimitiveTypes": [ @@ -37370,7 +35882,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onEnterKey" + "Description": "A function that is executed when the Enter key has been pressed while the widget is focused." }, "onFocusIn": { "PrimitiveTypes": [ @@ -37378,7 +35890,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusIn" + "Description": "A function that is executed when the widget gets focus." }, "onFocusOut": { "PrimitiveTypes": [ @@ -37386,7 +35898,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusOut" + "Description": "A function that is executed when the widget loses focus." }, "onInitialized": { "PrimitiveTypes": [ @@ -37394,7 +35906,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onInput": { "PrimitiveTypes": [ @@ -37402,7 +35914,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onInput" + "Description": "A function that is executed each time the widget's input is changed while the widget is focused." }, "onItemClick": { "PrimitiveTypes": [ @@ -37410,7 +35922,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownList.Options.onItemClick" + "Description": "A function that is executed when a list item is clicked or tapped." }, "onKeyDown": { "PrimitiveTypes": [ @@ -37418,7 +35930,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyDown" + "Description": "A function that is executed when a user is pressing a key on the keyboard." }, "onKeyPress": { "PrimitiveTypes": [ @@ -37426,7 +35938,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyPress" + "Description": "A function that is executed when a user presses a key on the keyboard." }, "onKeyUp": { "PrimitiveTypes": [ @@ -37434,7 +35946,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyUp" + "Description": "A function that is executed when a user releases a key on the keyboard." }, "onMultiTagPreparing": { "PrimitiveTypes": [ @@ -37442,7 +35954,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTagBox.Options.onMultiTagPreparing" + "Description": "A function that is executed before the multi-tag is rendered." }, "onOpened": { "PrimitiveTypes": [ @@ -37450,7 +35962,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownEditor.Options.onOpened" + "Description": "A function that is executed once the drop-down editor is opened." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -37458,7 +35970,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectAllValueChanged": { "PrimitiveTypes": [ @@ -37466,7 +35978,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTagBox.Options.onSelectAllValueChanged" + "Description": "A function that is executed when the \"Select All\" check box value is changed. Applies only if showSelectionControls is true." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -37474,7 +35986,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTagBox.Options.onSelectionChanged" + "Description": "A function that is executed when a list item is selected or selection is canceled." }, "onValueChanged": { "PrimitiveTypes": [ @@ -37482,75 +35994,73 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDropDownList.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "opened": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxDropDownEditor.Options.opened" + "Description": "Specifies whether or not the drop-down editor is displayed." }, "openOnFieldClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSelectBox.Options.openOnFieldClick" + "Description": "Specifies whether a user can open the drop-down list by clicking a text field." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSelectBox.Options.placeholder" + "Description": "The text that is provided as a hint in the select box editor." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "searchEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownList.Options.searchEnabled" + "Description": "Specifies whether to allow searching." }, "searchExpr": { "PrimitiveTypes": [ - "Function", - "string" + "Function" ], "ItemPrimitiveTypes": [ - "Function", - "string" + "Function" ], "IsCollection": true, "SingularName": "searchExpr", - "DocID": "dxDropDownList.Options.searchExpr" + "Description": "Specifies the name of a data source item field or an expression whose value is compared to the search criterion." }, "searchMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDropDownList.Options.searchMode" + "Description": "Specifies a comparison operation used to search widget items." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "dxDropDownList.Options.searchTimeout" + "Description": "Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed." }, "selectAllMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTagBox.Options.selectAllMode" + "Description": "Specifies the mode in which all items are selected." }, "selectedItems": { "ItemPrimitiveTypes": [ @@ -37561,69 +36071,69 @@ "IsCollection": true, "IsReadonly": true, "SingularName": "selectedItem", - "DocID": "dxTagBox.Options.selectedItems" + "Description": "Gets the currently selected items." }, "showClearButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.showClearButton" + "Description": "Specifies whether to display the Clear button in the widget." }, "showDataBeforeSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownList.Options.showDataBeforeSearch" + "Description": "Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value." }, "showDropDownButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTagBox.Options.showDropDownButton" + "Description": "Specifies whether the drop-down button is visible." }, "showMultiTagOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTagBox.Options.showMultiTagOnly" + "Description": "Specifies whether the multi-tag is shown without ordinary tags." }, "showSelectionControls": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSelectBox.Options.showSelectionControls" + "Description": "Specifies whether or not to display selection controls." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.stylingMode" + "Description": "Specifies how the widget's text field is styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "tagTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxTagBox.Options.tagTemplate" + "Description": "Specifies a custom template for tags." }, "text": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxTextEditor.Options.text" + "Description": "The read-only option that holds the text displayed by the widget input element." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -37631,19 +36141,19 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "ItemPrimitiveTypes": [ @@ -37654,7 +36164,7 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "value", - "DocID": "dxTagBox.Options.value" + "Description": "Specifies the selected items." }, "valueExpr": { "PrimitiveTypes": [ @@ -37662,13 +36172,13 @@ "string" ], "IsFunc": true, - "DocID": "DataExpressionMixin.Options.valueExpr" + "Description": "Specifies which data field provides unique values to the widget's value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -37677,18 +36187,18 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." }, "wrapItemText": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDropDownList.Options.wrapItemText" + "Description": "Specifies whether text that exceeds the drop-down list width should be wrapped." } } }, "dxTextArea": { - "DocID": "dxTextArea", + "Description": "The TextArea is a widget that enables a user to enter and edit a multi-line text.", "Module": "ui/text_area", "IsEditor": true, "Options": { @@ -37696,37 +36206,37 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "autoResizeEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextArea.Options.autoResizeEnabled" + "Description": "A Boolean value specifying whether or not the auto resizing mode is enabled." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -37735,58 +36245,58 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "inputAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTextEditor.Options.inputAttr" + "Description": "Specifies the attributes to be passed on to the underlying HTML element." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "maxHeight": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxTextArea.Options.maxHeight" + "Description": "Specifies the maximum height of the widget." }, "maxLength": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxTextBox.Options.maxLength" + "Description": "Specifies the maximum number of characters you can enter into the textbox." }, "minHeight": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxTextArea.Options.minHeight" + "Description": "Specifies the minimum height of the widget." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "onChange": { "PrimitiveTypes": [ @@ -37794,7 +36304,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onChange" + "Description": "A function that is executed when the widget loses focus after the text field's content was changed using the keyboard." }, "onContentReady": { "PrimitiveTypes": [ @@ -37802,7 +36312,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onCopy": { "PrimitiveTypes": [ @@ -37810,7 +36320,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCopy" + "Description": "A function that is executed when the widget's input has been copied." }, "onCut": { "PrimitiveTypes": [ @@ -37818,7 +36328,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCut" + "Description": "A function that is executed when the widget's input has been cut." }, "onDisposing": { "PrimitiveTypes": [ @@ -37826,7 +36336,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEnterKey": { "PrimitiveTypes": [ @@ -37834,7 +36344,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onEnterKey" + "Description": "A function that is executed when the Enter key has been pressed while the widget is focused." }, "onFocusIn": { "PrimitiveTypes": [ @@ -37842,7 +36352,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusIn" + "Description": "A function that is executed when the widget gets focus." }, "onFocusOut": { "PrimitiveTypes": [ @@ -37850,7 +36360,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusOut" + "Description": "A function that is executed when the widget loses focus." }, "onInitialized": { "PrimitiveTypes": [ @@ -37858,7 +36368,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onInput": { "PrimitiveTypes": [ @@ -37866,7 +36376,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onInput" + "Description": "A function that is executed each time the widget's input is changed while the widget is focused." }, "onKeyDown": { "PrimitiveTypes": [ @@ -37874,7 +36384,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyDown" + "Description": "A function that is executed when a user is pressing a key on the keyboard." }, "onKeyPress": { "PrimitiveTypes": [ @@ -37882,7 +36392,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyPress" + "Description": "A function that is executed when a user presses a key on the keyboard." }, "onKeyUp": { "PrimitiveTypes": [ @@ -37890,7 +36400,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyUp" + "Description": "A function that is executed when a user releases a key on the keyboard." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -37898,7 +36408,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPaste": { "PrimitiveTypes": [ @@ -37906,7 +36416,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onPaste" + "Description": "A function that is executed when the widget's input has been pasted." }, "onValueChanged": { "PrimitiveTypes": [ @@ -37914,56 +36424,56 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.placeholder" + "Description": "The text displayed by the widget when the widget value is empty." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "spellcheck": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextArea.Options.spellcheck" + "Description": "Specifies whether or not the widget checks the inner text for spelling mistakes." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.stylingMode" + "Description": "Specifies how the widget's text field is styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "text": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxTextEditor.Options.text" + "Description": "The read-only option that holds the text displayed by the widget input element." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -37971,38 +36481,38 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "dxTextBox.Options.value" + "Description": "Specifies a value the widget displays." }, "valueChangeEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.valueChangeEvent" + "Description": "Specifies the DOM events after which the widget's value should be updated." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -38011,12 +36521,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxTextBox": { - "DocID": "dxTextBox", + "Description": "The TextBox is a widget that enables a user to enter and edit a single line of text.", "Module": "ui/text_box", "IsEditor": true, "Options": { @@ -38024,13 +36534,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "buttons": { "ItemPrimitiveTypes": [ @@ -38040,34 +36550,27 @@ "ItemComplexTypes": [ "TextEditorButton" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "button", - "DocID": "dxTextEditor.Options.buttons" + "Description": "Allows you to add custom buttons to the input text field." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -38076,74 +36579,74 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "inputAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTextEditor.Options.inputAttr" + "Description": "Specifies the attributes to be passed on to the underlying HTML element." }, "isValid": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.isValid" + "Description": "Specifies or indicates whether the editor's value is valid." }, "mask": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.mask" + "Description": "The editor mask that specifies the custom format of the entered string." }, "maskChar": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.maskChar" + "Description": "Specifies a mask placeholder. A single character is recommended." }, "maskInvalidMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.maskInvalidMessage" + "Description": "A message displayed when the entered text does not match the specified pattern." }, "maskRules": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTextEditor.Options.maskRules" + "Description": "Specifies custom mask rules." }, "maxLength": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxTextBox.Options.maxLength" + "Description": "Specifies the maximum number of characters you can enter into the textbox." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextBox.Options.mode" + "Description": "The \"mode\" attribute value of the actual HTML input element representing the text box." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.name" + "Description": "The value to be assigned to the `name` attribute of the underlying HTML element." }, "onChange": { "PrimitiveTypes": [ @@ -38151,7 +36654,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onChange" + "Description": "A function that is executed when the widget loses focus after the text field's content was changed using the keyboard." }, "onContentReady": { "PrimitiveTypes": [ @@ -38159,7 +36662,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onCopy": { "PrimitiveTypes": [ @@ -38167,7 +36670,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCopy" + "Description": "A function that is executed when the widget's input has been copied." }, "onCut": { "PrimitiveTypes": [ @@ -38175,7 +36678,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onCut" + "Description": "A function that is executed when the widget's input has been cut." }, "onDisposing": { "PrimitiveTypes": [ @@ -38183,7 +36686,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEnterKey": { "PrimitiveTypes": [ @@ -38191,7 +36694,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onEnterKey" + "Description": "A function that is executed when the Enter key has been pressed while the widget is focused." }, "onFocusIn": { "PrimitiveTypes": [ @@ -38199,7 +36702,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusIn" + "Description": "A function that is executed when the widget gets focus." }, "onFocusOut": { "PrimitiveTypes": [ @@ -38207,7 +36710,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onFocusOut" + "Description": "A function that is executed when the widget loses focus." }, "onInitialized": { "PrimitiveTypes": [ @@ -38215,7 +36718,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onInput": { "PrimitiveTypes": [ @@ -38223,7 +36726,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onInput" + "Description": "A function that is executed each time the widget's input is changed while the widget is focused." }, "onKeyDown": { "PrimitiveTypes": [ @@ -38231,7 +36734,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyDown" + "Description": "A function that is executed when a user is pressing a key on the keyboard." }, "onKeyPress": { "PrimitiveTypes": [ @@ -38239,7 +36742,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyPress" + "Description": "A function that is executed when a user presses a key on the keyboard." }, "onKeyUp": { "PrimitiveTypes": [ @@ -38247,7 +36750,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onKeyUp" + "Description": "A function that is executed when a user releases a key on the keyboard." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -38255,7 +36758,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onPaste": { "PrimitiveTypes": [ @@ -38263,7 +36766,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTextEditor.Options.onPaste" + "Description": "A function that is executed when the widget's input has been pasted." }, "onValueChanged": { "PrimitiveTypes": [ @@ -38271,74 +36774,74 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Editor.Options.onValueChanged" + "Description": "A function that is executed after the widget's value is changed." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.placeholder" + "Description": "The text displayed by the widget when the widget value is empty." }, "readOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Editor.Options.readOnly" + "Description": "Specifies whether the editor is read-only." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showClearButton": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.showClearButton" + "Description": "Specifies whether to display the Clear button in the widget." }, "showMaskMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.showMaskMode" + "Description": "Specifies when the widget shows the mask. Applies only if useMaskedValue is true." }, "spellcheck": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.spellcheck" + "Description": "Specifies whether or not the widget checks the inner text for spelling mistakes." }, "stylingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.stylingMode" + "Description": "Specifies how the widget's text field is styled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "text": { "PrimitiveTypes": [ "string" ], "IsReadonly": true, - "DocID": "dxTextEditor.Options.text" + "Description": "The read-only option that holds the text displayed by the widget input element." }, "useMaskedValue": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTextEditor.Options.useMaskedValue" + "Description": "Specifies whether the value should contain mask characters or not." }, "validationError": { "PrimitiveTypes": [ "any" ], - "DocID": "Editor.Options.validationError" + "Description": "Information on the broken validation rule. Contains the first item from the validationErrors array." }, "validationErrors": { "ItemPrimitiveTypes": [ @@ -38346,38 +36849,38 @@ ], "IsCollection": true, "SingularName": "validationError", - "DocID": "Editor.Options.validationErrors" + "Description": "An array of the validation rules that failed." }, "validationMessageMode": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationMessageMode" + "Description": "Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed." }, "validationStatus": { "PrimitiveTypes": [ "string" ], - "DocID": "Editor.Options.validationStatus" + "Description": "Indicates or specifies the current validation status." }, "value": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "dxTextBox.Options.value" + "Description": "Specifies a value the widget displays." }, "valueChangeEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditor.Options.valueChangeEvent" + "Description": "Specifies the DOM events after which the widget's value should be updated." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -38386,37 +36889,37 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxTileView": { - "DocID": "dxTileView", + "Description": "The TileView widget contains a collection of tiles. Tiles can store much more information than ordinary buttons, that is why they are very popular in apps designed for touch devices.", "Module": "ui/tile_view", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTileView.Options.activeStateEnabled" + "Description": "A Boolean value specifying whether or not the widget changes its state when interacting with a user." }, "baseItemHeight": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTileView.Options.baseItemHeight" + "Description": "Specifies the height of the base tile view item." }, "baseItemWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTileView.Options.baseItemWidth" + "Description": "Specifies the width of the base tile view item." }, "dataSource": { "PrimitiveTypes": [ @@ -38432,39 +36935,32 @@ "ItemComplexTypes": [ "TileViewItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxTileView.Options.dataSource" + "Description": "Binds the widget to data." }, "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTileView.Options.direction" + "Description": "Specifies whether tiles are placed horizontally or vertically." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTileView.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -38473,31 +36969,31 @@ "string" ], "IsFunc": true, - "DocID": "dxTileView.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTileView.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "itemMargin": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTileView.Options.itemMargin" + "Description": "Specifies the distance in pixels between adjacent tiles." }, "items": { "ItemPrimitiveTypes": [ @@ -38507,50 +37003,50 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxTileView.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "heightRatio": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTileViewItem.heightRatio" + "Description": "Specifies a multiplier for the baseItemHeight option value (for the purpose of obtaining the actual item height)." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." }, "widthRatio": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTileViewItem.widthRatio" + "Description": "Specifies a multiplier for the baseItemWidth option value (for the purpose of obtaining the actual item width)." } } }, @@ -38559,13 +37055,13 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidget.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onContentReady": { "PrimitiveTypes": [ @@ -38573,7 +37069,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -38581,7 +37077,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -38589,7 +37085,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -38598,7 +37094,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -38606,7 +37102,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemHold": { "PrimitiveTypes": [ @@ -38614,7 +37110,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -38622,7 +37118,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -38630,31 +37126,31 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "showScrollbar": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTileView.Options.showScrollbar" + "Description": "A Boolean value specifying whether or not to display a scrollbar." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -38663,52 +37159,40 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxToast": { - "DocID": "dxToast", + "Description": "The Toast is a widget that provides pop-up notifications.", "Module": "ui/toast", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "animation": { - "DocID": "dxToast.Options.animation", + "Description": "Configures widget visibility animations. This object contains two fields: show and hide.", "Options": { "hide": { "PrimitiveTypes": [ - "animationConfig" + "DevExpress.animationConfig" ], "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "animationConfig", - "Path": "animation/fx" - } - ], - "DocID": "dxToast.Options.animation.hide" + "Description": "An object that defines the animation options used when the widget is being hidden." }, "show": { "PrimitiveTypes": [ - "animationConfig" + "DevExpress.animationConfig" ], "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "animationConfig", - "Path": "animation/fx" - } - ], - "DocID": "dxToast.Options.animation.show" + "Description": "An object that defines the animation options used when the widget is being shown." } } }, @@ -38716,7 +37200,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxToast.Options.closeOnClick" + "Description": "A Boolean value specifying whether or not the toast is closed if a user clicks it." }, "closeOnOutsideClick": { "PrimitiveTypes": [ @@ -38724,44 +37208,44 @@ "Function" ], "IsFunc": true, - "DocID": "dxToast.Options.closeOnOutsideClick" + "Description": "Specifies whether to close the widget if a user clicks outside it." }, "closeOnSwipe": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxToast.Options.closeOnSwipe" + "Description": "A Boolean value specifying whether or not the toast is closed if a user swipes it out of the screen boundaries." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxOverlay.Options.contentTemplate" + "Description": "Specifies a custom template for the widget content." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxOverlay.Options.deferRendering" + "Description": "Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately." }, "displayTime": { "PrimitiveTypes": [ "number" ], - "DocID": "dxToast.Options.displayTime" + "Description": "The time span in milliseconds during which the Toast widget is visible." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "height": { "PrimitiveTypes": [ @@ -38770,19 +37254,19 @@ "string" ], "IsFunc": true, - "DocID": "dxToast.Options.height" + "Description": "Specifies the widget's height in pixels." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "maxHeight": { "PrimitiveTypes": [ @@ -38791,7 +37275,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.maxHeight" + "Description": "Specifies the maximum height the widget can reach while resizing." }, "maxWidth": { "PrimitiveTypes": [ @@ -38800,13 +37284,13 @@ "string" ], "IsFunc": true, - "DocID": "dxToast.Options.maxWidth" + "Description": "Specifies the maximum width the widget can reach while resizing." }, "message": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToast.Options.message" + "Description": "The Toast message text." }, "minHeight": { "PrimitiveTypes": [ @@ -38815,7 +37299,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.minHeight" + "Description": "Specifies the minimum height the widget can reach while resizing." }, "minWidth": { "PrimitiveTypes": [ @@ -38824,7 +37308,7 @@ "string" ], "IsFunc": true, - "DocID": "dxToast.Options.minWidth" + "Description": "Specifies the minimum width the widget can reach while resizing." }, "onContentReady": { "PrimitiveTypes": [ @@ -38832,7 +37316,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -38840,7 +37324,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onHidden": { "PrimitiveTypes": [ @@ -38848,7 +37332,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onHidden" + "Description": "A function that is executed after the widget is hidden." }, "onHiding": { "PrimitiveTypes": [ @@ -38856,7 +37340,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onHiding" + "Description": "A function that is executed before the widget is hidden." }, "onInitialized": { "PrimitiveTypes": [ @@ -38864,7 +37348,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -38872,7 +37356,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onShowing": { "PrimitiveTypes": [ @@ -38880,7 +37364,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onShowing" + "Description": "A function that is executed before the widget is displayed." }, "onShown": { "PrimitiveTypes": [ @@ -38888,7 +37372,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onShown" + "Description": "A function that is executed after the widget is displayed." }, "position": { "PrimitiveTypes": [ @@ -38898,52 +37382,45 @@ "ComplexTypes": [ "PositionConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsChangeable": true, - "DocID": "dxToast.Options.position" + "Description": "Positions the widget." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "shading": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxToast.Options.shading" + "Description": "Specifies whether to shade the background when the widget is active." }, "shadingColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxOverlay.Options.shadingColor" + "Description": "Specifies the shading color. Applies only if shading is enabled." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToast.Options.type" + "Description": "Specifies the Toast widget type." }, "visible": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxOverlay.Options.visible" + "Description": "A Boolean value specifying whether or not the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -38952,12 +37429,12 @@ "string" ], "IsFunc": true, - "DocID": "dxToast.Options.width" + "Description": "Specifies the widget's width in pixels." } } }, "dxToolbar": { - "DocID": "dxToolbar", + "Description": "The Toolbar is a widget containing items that usually manage screen content. Those items can be plain text or widgets.", "Module": "ui/toolbar", "Options": { "dataSource": { @@ -38974,27 +37451,20 @@ "ItemComplexTypes": [ "ToolbarItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxToolbar.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -39003,25 +37473,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -39031,81 +37501,81 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxToolbar.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.cssClass" + "Description": "Specifies a CSS class to be applied to the item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "locateInMenu": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.locateInMenu" + "Description": "Specifies when to display an item in the toolbar's overflow menu." }, "location": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.location" + "Description": "Specifies a location for the item on the toolbar." }, "menuItemTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxToolbarItem.menuItemTemplate" + "Description": "Specifies a template that should be used to render a menu item." }, "options": { "PrimitiveTypes": [ "any" ], - "DocID": "dxToolbarItem.options" + "Description": "Configures the DevExtreme widget used as a toolbar item." }, "showText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.showText" + "Description": "Specifies when to display the text for the widget item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." }, "widget": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.widget" + "Description": "A widget that presents a toolbar item. To configure it, use the options object." } } }, @@ -39114,20 +37584,20 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "menuItemTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxToolbar.Options.menuItemTemplate" + "Description": "Specifies a custom template for menu items." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidget.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onContentReady": { "PrimitiveTypes": [ @@ -39135,7 +37605,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -39143,7 +37613,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -39151,7 +37621,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -39160,7 +37630,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -39168,7 +37638,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemHold": { "PrimitiveTypes": [ @@ -39176,7 +37646,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -39184,7 +37654,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -39192,25 +37662,25 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "renderAs": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbar.Options.renderAs" + "Description": "Informs the widget about its location in a view HTML markup." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -39219,47 +37689,35 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxTooltip": { - "DocID": "dxTooltip", + "Description": "The Tooltip widget displays a tooltip for a specified element on the page.", "IsTranscludedContent": true, "Module": "ui/tooltip", "Options": { "animation": { - "DocID": "dxPopover.Options.animation", + "Description": "Configures widget visibility animations. This object contains two fields: show and hide.", "Options": { "hide": { "PrimitiveTypes": [ - "animationConfig" + "DevExpress.animationConfig" ], "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "animationConfig", - "Path": "animation/fx" - } - ], - "DocID": "dxPopover.Options.animation.hide" + "Description": "An object that defines the animation options used when the widget is being hidden." }, "show": { "PrimitiveTypes": [ - "animationConfig" + "DevExpress.animationConfig" ], "ComplexTypes": [ "AnimationConfig" ], - "TypeImports": [ - { - "Name": "animationConfig", - "Path": "animation/fx" - } - ], - "DocID": "dxPopover.Options.animation.show" + "Description": "An object that defines the animation options used when the widget is being shown." } } }, @@ -39269,7 +37727,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxPopover.Options.closeOnOutsideClick" + "Description": "A Boolean value specifying whether or not the widget is closed if a user clicks outside of the popover window and outside the target element." }, "container": { "PrimitiveTypes": [ @@ -39277,32 +37735,32 @@ "JQuery", "string" ], - "DocID": "dxPopup.Options.container" + "Description": "Specifies the container in which to render the widget." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxOverlay.Options.contentTemplate" + "Description": "Specifies a custom template for the widget content." }, "deferRendering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxOverlay.Options.deferRendering" + "Description": "Specifies whether to render the widget's content when it is displayed. If false, the content is rendered immediately." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -39312,25 +37770,25 @@ ], "IsFunc": true, "IsChangeable": true, - "DocID": "dxPopover.Options.height" + "Description": "Specifies the widget's height." }, "hideEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopover.Options.hideEvent", + "Description": "Specifies options of popover hiding.", "Options": { "delay": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPopover.Options.hideEvent.delay" + "Description": "The delay in milliseconds after which the widget is hidden." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopover.Options.hideEvent.name" + "Description": "Specifies the event names on which the widget is hidden." } } }, @@ -39338,13 +37796,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "maxHeight": { "PrimitiveTypes": [ @@ -39353,7 +37811,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.maxHeight" + "Description": "Specifies the maximum height the widget can reach while resizing." }, "maxWidth": { "PrimitiveTypes": [ @@ -39362,7 +37820,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.maxWidth" + "Description": "Specifies the maximum width the widget can reach while resizing." }, "minHeight": { "PrimitiveTypes": [ @@ -39371,7 +37829,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.minHeight" + "Description": "Specifies the minimum height the widget can reach while resizing." }, "minWidth": { "PrimitiveTypes": [ @@ -39380,7 +37838,7 @@ "string" ], "IsFunc": true, - "DocID": "dxOverlay.Options.minWidth" + "Description": "Specifies the minimum width the widget can reach while resizing." }, "onContentReady": { "PrimitiveTypes": [ @@ -39388,7 +37846,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -39396,7 +37854,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onHidden": { "PrimitiveTypes": [ @@ -39404,7 +37862,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onHidden" + "Description": "A function that is executed after the widget is hidden." }, "onHiding": { "PrimitiveTypes": [ @@ -39412,7 +37870,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onHiding" + "Description": "A function that is executed before the widget is hidden." }, "onInitialized": { "PrimitiveTypes": [ @@ -39420,7 +37878,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -39428,7 +37886,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onShowing": { "PrimitiveTypes": [ @@ -39436,7 +37894,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onShowing" + "Description": "A function that is executed before the widget is displayed." }, "onShown": { "PrimitiveTypes": [ @@ -39444,7 +37902,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxOverlay.Options.onShown" + "Description": "A function that is executed after the widget is displayed." }, "position": { "PrimitiveTypes": [ @@ -39454,51 +37912,44 @@ "ComplexTypes": [ "PositionConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsChangeable": true, - "DocID": "dxPopover.Options.position" + "Description": "An object defining widget positioning options." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "shading": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPopover.Options.shading" + "Description": "Specifies whether to shade the background when the widget is active." }, "shadingColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxOverlay.Options.shadingColor" + "Description": "Specifies the shading color. Applies only if shading is enabled." }, "showEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopover.Options.showEvent", + "Description": "Specifies options for displaying the widget.", "Options": { "delay": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPopover.Options.showEvent.delay" + "Description": "The delay in milliseconds after which the widget is displayed." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPopover.Options.showEvent.name" + "Description": "Specifies the event names on which the widget is shown." } } }, @@ -39508,14 +37959,14 @@ "JQuery", "string" ], - "DocID": "dxPopover.Options.target" + "Description": "The target element associated with the widget." }, "visible": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "dxOverlay.Options.visible" + "Description": "A Boolean value specifying whether or not the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -39525,156 +37976,156 @@ ], "IsFunc": true, "IsChangeable": true, - "DocID": "dxPopover.Options.width" + "Description": "Specifies the widget's width." } } }, "dxTreeList": { - "DocID": "dxTreeList", + "Description": "The TreeList is a widget that represents data from a local or remote source in the form of a multi-column tree view. This widget offers such features as sorting, filtering, editing, selection, etc.", "Module": "ui/tree_list", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "allowColumnReordering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.allowColumnReordering" + "Description": "Specifies whether a user can reorder columns." }, "allowColumnResizing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.allowColumnResizing" + "Description": "Specifies whether a user can resize columns." }, "autoExpandAll": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeList.Options.autoExpandAll" + "Description": "Specifies whether all rows are expanded initially." }, "autoNavigateToFocusedRow": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.autoNavigateToFocusedRow" + "Description": "Automatically scrolls to the focused row when the focusedRowKey is changed." }, "cacheEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.cacheEnabled" + "Description": "Specifies whether data should be cached." }, "cellHintEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.cellHintEnabled" + "Description": "Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content." }, "columnAutoWidth": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.columnAutoWidth" + "Description": "Specifies whether columns should adjust their widths to the content." }, "columnChooser": { - "DocID": "GridBase.Options.columnChooser", + "Description": "Configures the column chooser.", "Options": { "allowSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.columnChooser.allowSearch" + "Description": "Specifies whether searching is enabled in the column chooser." }, "emptyPanelText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnChooser.emptyPanelText" + "Description": "Specifies text displayed by the column chooser when it is empty." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.columnChooser.enabled" + "Description": "Specifies whether a user can open the column chooser." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.columnChooser.height" + "Description": "Specifies the height of the column chooser." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnChooser.mode" + "Description": "Specifies how a user manages columns using the column chooser." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.columnChooser.searchTimeout" + "Description": "Specifies a delay in milliseconds between when a user finishes typing in the column chooser's search panel, and when the search is executed." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnChooser.title" + "Description": "Specifies the title of the column chooser." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.columnChooser.width" + "Description": "Specifies the width of the column chooser." } } }, "columnFixing": { - "DocID": "GridBase.Options.columnFixing", + "Description": "Configures column fixing.", "Options": { "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.columnFixing.enabled" + "Description": "Enables column fixing." }, "texts": { - "DocID": "GridBase.Options.columnFixing.texts", + "Description": "Contains options that specify texts for column fixing commands in the context menu of a column header.", "Options": { "fix": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnFixing.texts.fix" + "Description": "Specifies text for the context menu item that fixes a column." }, "leftPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnFixing.texts.leftPosition" + "Description": "Specifies text for the context menu subitem that fixes a column to the left edge of the widget." }, "rightPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnFixing.texts.rightPosition" + "Description": "Specifies text for the context menu subitem that fixes a column to the right edge of the widget." }, "unfix": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnFixing.texts.unfix" + "Description": "Specifies text for the context menu item that unfixes a column." } } } @@ -39684,19 +38135,19 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.columnHidingEnabled" + "Description": "Specifies whether the widget should hide columns to adapt to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is \"widget\"." }, "columnMinWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.columnMinWidth" + "Description": "Specifies the minimum width of columns." }, "columnResizingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.columnResizingMode" + "Description": "Specifies how the widget resizes columns. Applies only if allowColumnResizing is true." }, "columns": { "ItemPrimitiveTypes": [ @@ -39706,30 +38157,23 @@ "ItemComplexTypes": [ "TreeListColumn" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "IsChangeable": true, "SingularName": "column", - "DocID": "dxTreeList.Options.columns" + "Description": "Configures columns." }, "columnWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.columnWidth" + "Description": "Specifies the width for all data columns. Has a lower priority than the column.width option." }, "customizeColumns": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxTreeList.Options.customizeColumns" + "Description": "Customizes columns after they are created." }, "dataSource": { "PrimitiveTypes": [ @@ -39740,36 +38184,29 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "GridBase.Options.dataSource" + "Description": "Binds the widget to data." }, "dataStructure": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeList.Options.dataStructure" + "Description": "Notifies the widget of the used data structure." }, "dateSerializationFormat": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.dateSerializationFormat" + "Description": "Specifies the format in which date-time values should be sent to the server. Use it only if you do not specify the dataSource at design time." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "editing": { - "DocID": "dxTreeList.Options.editing", + "Description": "Configures editing.", "Options": { "allowAdding": { "PrimitiveTypes": [ @@ -39777,7 +38214,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxTreeList.Options.editing.allowAdding" + "Description": "Specifies whether a user can add new rows. It is called for each data row when defined as a function." }, "allowDeleting": { "PrimitiveTypes": [ @@ -39785,7 +38222,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxTreeList.Options.editing.allowDeleting" + "Description": "Specifies whether a user can delete rows. It is called for each data row when defined as a function." }, "allowUpdating": { "PrimitiveTypes": [ @@ -39793,136 +38230,124 @@ "Function" ], "IsFunc": true, - "DocID": "dxTreeList.Options.editing.allowUpdating" + "Description": "Specifies whether a user can update rows. It is called for each data row when defined as a function" }, "form": { "PrimitiveTypes": [ - "dxFormOptions" + "DevExpress.ui.dxFormOptions" ], "ComplexTypes": [ "dxFormOptions" ], - "TypeImports": [ - { - "Name": "dxFormOptions", - "Path": "ui/form" - } - ], - "DocID": "GridBase.Options.editing.form" + "Description": "Configures the form. Used only if editing.mode is \"form\" or \"popup\"." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.mode" + "Description": "Specifies how a user edits data." }, "popup": { "PrimitiveTypes": [ - "dxPopupOptions" + "DevExpress.ui.dxPopupOptions" ], "ComplexTypes": [ "dxPopupOptions" ], - "TypeImports": [ - { - "Name": "dxPopupOptions", - "Path": "ui/popup" - } - ], - "DocID": "GridBase.Options.editing.popup" + "Description": "Configures the popup. Used only if editing.mode is \"popup\"." }, "refreshMode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.refreshMode" + "Description": "Specifies operations that are performed after saving changes." }, "selectTextOnEditStart": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.editing.selectTextOnEditStart" + "Description": "Specifies whether to select text in a cell when a user starts editing." }, "startEditAction": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.startEditAction" + "Description": "Specifies whether a single or double click should switch a cell to the editing state. Applies if editing.mode is \"cell\" or \"batch\"." }, "texts": { - "DocID": "dxTreeList.Options.editing.texts", + "Description": "Contains options that specify texts for editing-related UI elements.", "Options": { "addRow": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.addRow" + "Description": "Specifies text for a hint that appears when a user pauses on the global \"Add\" button. Applies only if editing.allowAdding is true." }, "addRowToNode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeList.Options.editing.texts.addRowToNode" + "Description": "Specifies text for the button that adds a new nested row. Applies if the editing.mode is \"batch\" or \"cell\"." }, "cancelAllChanges": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.cancelAllChanges" + "Description": "Specifies text for a hint that appears when a user pauses on the \"Discard\" button. Applies only if editing.mode is \"batch\"." }, "cancelRowChanges": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.cancelRowChanges" + "Description": "Specifies text for a button that cancels changes in a row. Applies only if editing.allowUpdating is true and editing.mode is \"row\"." }, "confirmDeleteMessage": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.confirmDeleteMessage" + "Description": "Specifies a message that prompts a user to confirm deletion." }, "confirmDeleteTitle": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.confirmDeleteTitle" + "Description": "Specifies a title for the window that asks a user to confirm deletion." }, "deleteRow": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.deleteRow" + "Description": "Specifies text for buttons that delete rows. Applies only if allowDeleting is true." }, "editRow": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.editRow" + "Description": "Specifies text for buttons that switch rows into the editing state. Applies only if allowUpdating is true." }, "saveAllChanges": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.saveAllChanges" + "Description": "Specifies text for a hint that appears when a user pauses on the global \"Save\" button. Applies only if editing.mode is \"batch\"." }, "saveRowChanges": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.saveRowChanges" + "Description": "Specifies text for a button that saves changes made in a row. Applies only if allowUpdating is true." }, "undeleteRow": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.undeleteRow" + "Description": "Specifies text for buttons that recover deleted rows. Applies only if allowDeleting is true and editing.mode is \"batch\"." }, "validationCancelChanges": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.editing.texts.validationCancelChanges" + "Description": "Specifies text for a hint appearing when a user pauses on the button that cancels changes in a cell. Applies only if editing.mode is \"cell\" and data validation is enabled." } } }, @@ -39930,7 +38355,7 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.editing.useIcons" + "Description": "Specifies whether the editing column uses icons instead of links." } } }, @@ -39938,13 +38363,13 @@ "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "errorRowEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.errorRowEnabled" + "Description": "Indicates whether to show the error row." }, "expandedRowKeys": { "ItemPrimitiveTypes": [ @@ -39953,87 +38378,75 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "expandedRowKey", - "DocID": "dxTreeList.Options.expandedRowKeys" + "Description": "Specifies keys of the initially expanded rows." }, "expandNodesOnFiltering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeList.Options.expandNodesOnFiltering" + "Description": "Specifies whether nodes appear expanded or collapsed after filtering is applied." }, "filterBuilder": { "PrimitiveTypes": [ - "dxFilterBuilderOptions" + "DevExpress.ui.dxFilterBuilderOptions" ], "ComplexTypes": [ "dxFilterBuilderOptions" ], - "TypeImports": [ - { - "Name": "dxFilterBuilderOptions", - "Path": "ui/filter_builder" - } - ], - "DocID": "GridBase.Options.filterBuilder" + "Description": "Configures the integrated filter builder." }, "filterBuilderPopup": { "PrimitiveTypes": [ - "dxPopupOptions" + "DevExpress.ui.dxPopupOptions" ], "ComplexTypes": [ "dxPopupOptions" ], - "TypeImports": [ - { - "Name": "dxPopupOptions", - "Path": "ui/popup" - } - ], - "DocID": "GridBase.Options.filterBuilderPopup" + "Description": "Configures the popup in which the integrated filter builder is shown." }, "filterMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeList.Options.filterMode" + "Description": "Specifies whether filter and search results should include matching rows only, matching rows with ancestors, or matching rows with ancestors and descendants (full branch)." }, "filterPanel": { - "DocID": "GridBase.Options.filterPanel", + "Description": "Configures the filter panel.", "Options": { "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBase.Options.filterPanel.customizeText" + "Description": "Customizes the filter expression's text representation." }, "filterEnabled": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "GridBase.Options.filterPanel.filterEnabled" + "Description": "Specifies whether the filter expression is applied." }, "texts": { - "DocID": "GridBase.Options.filterPanel.texts", + "Description": "Specifies texts for the filter panel's elements.", "Options": { "clearFilter": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterPanel.texts.clearFilter" + "Description": "The text of the \"Clear\" link." }, "createFilter": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterPanel.texts.createFilter" + "Description": "The text of the \"Create Filter\" link." }, "filterEnabledHint": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterPanel.texts.filterEnabledHint" + "Description": "The hint of the checkbox that applies the filter." } } }, @@ -40041,105 +38454,105 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.filterPanel.visible" + "Description": "Specifies whether the filter panel is visible." } } }, "filterRow": { - "DocID": "GridBase.Options.filterRow", + "Description": "Configures the filter row.", "Options": { "applyFilter": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.applyFilter" + "Description": "Specifies when to apply a filter." }, "applyFilterText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.applyFilterText" + "Description": "Specifies text for a hint that appears when a user pauses on a button that applies the filter." }, "betweenEndText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.betweenEndText" + "Description": "Specifies a placeholder for the editor that specifies the end of a range when a user selects the \"between\" filter operation." }, "betweenStartText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.betweenStartText" + "Description": "Specifies a placeholder for the editor that specifies the start of a range when a user selects the \"between\" filter operation." }, "operationDescriptions": { - "DocID": "GridBase.Options.filterRow.operationDescriptions", + "Description": "Specifies descriptions for filter operations on the filter list.", "Options": { "between": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.between" + "Description": "A description for the \"between\" operation." }, "contains": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.contains" + "Description": "A description for the \"contains\" operation." }, "endsWith": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.endsWith" + "Description": "A description for the \"endswith\" operation." }, "equal": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.equal" + "Description": "A description for the \"=\" operation." }, "greaterThan": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.greaterThan" + "Description": "A description for the \">\" operation." }, "greaterThanOrEqual": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.greaterThanOrEqual" + "Description": "A description for the \">=\" operation." }, "lessThan": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.lessThan" + "Description": "A description for the \"<\" operation." }, "lessThanOrEqual": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.lessThanOrEqual" + "Description": "A description for the \"<=\" operation." }, "notContains": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.notContains" + "Description": "A description for the \"notcontains\" operation." }, "notEqual": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.notEqual" + "Description": "A description for the \"<>\" operation." }, "startsWith": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.operationDescriptions.startsWith" + "Description": "A description for the \"startswith\" operation." } } }, @@ -40147,25 +38560,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.resetOperationText" + "Description": "Specifies text for the reset operation on the filter list." }, "showAllText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.filterRow.showAllText" + "Description": "Specifies text for the item that clears the applied filter. Used only when a cell of the filter row contains a select box." }, "showOperationChooser": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.filterRow.showOperationChooser" + "Description": "Specifies whether icons that open the filter lists are visible." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.filterRow.visible" + "Description": "Specifies whether the filter row is visible." } } }, @@ -40174,7 +38587,7 @@ "boolean", "string" ], - "DocID": "GridBase.Options.filterSyncEnabled" + "Description": "Specifies whether to synchronize the filter row, header filter, and filter builder. The synchronized filter expression is stored in the filterValue option." }, "filterValue": { "PrimitiveTypes": [ @@ -40182,40 +38595,40 @@ ], "IsFilterExpr": true, "IsChangeable": true, - "DocID": "GridBase.Options.filterValue" + "Description": "Specifies a filter expression." }, "focusedColumnIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "GridBase.Options.focusedColumnIndex" + "Description": "The index of the column that contains the focused data cell." }, "focusedRowEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.focusedRowEnabled" + "Description": "Specifies whether the focused row feature is enabled." }, "focusedRowIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "GridBase.Options.focusedRowIndex" + "Description": "Specifies the initially or currently focused grid row's index. Use it when focusedRowEnabled is true." }, "focusedRowKey": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "GridBase.Options.focusedRowKey" + "Description": "Specifies initially or currently focused grid row's key. Use it when focusedRowEnabled is true." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "hasItemsExpr": { "PrimitiveTypes": [ @@ -40223,49 +38636,49 @@ "string" ], "IsFunc": true, - "DocID": "dxTreeList.Options.hasItemsExpr" + "Description": "Specifies which data field defines whether the node has children." }, "headerFilter": { - "DocID": "GridBase.Options.headerFilter", + "Description": "Configures the header filter feature.", "Options": { "allowSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.headerFilter.allowSearch" + "Description": "Specifies whether searching is enabled in the header filter." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.headerFilter.height" + "Description": "Specifies the height of the popup menu that contains values for filtering." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.headerFilter.searchTimeout" + "Description": "Specifies a delay in milliseconds between when a user finishes typing in the header filter's search panel, and when the search is executed." }, "texts": { - "DocID": "GridBase.Options.headerFilter.texts", + "Description": "Contains options that specify text for various elements of the popup menu.", "Options": { "cancel": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.headerFilter.texts.cancel" + "Description": "Specifies text for the button that closes the popup menu without applying a filter." }, "emptyValue": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.headerFilter.texts.emptyValue" + "Description": "Specifies a name for the item that represents empty values in the popup menu." }, "ok": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.headerFilter.texts.ok" + "Description": "Specifies text for the button that applies the specified filter." } } }, @@ -40273,13 +38686,13 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.headerFilter.visible" + "Description": "Indicates whether header filter icons are visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.headerFilter.width" + "Description": "Specifies the width of the popup menu that contains values for filtering." } } }, @@ -40290,25 +38703,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "highlightChanges": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.highlightChanges" + "Description": "Specifies whether to highlight rows and cells with edited data. repaintChangesOnly should be true." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemsExpr": { "PrimitiveTypes": [ @@ -40316,34 +38729,34 @@ "string" ], "IsFunc": true, - "DocID": "dxTreeList.Options.itemsExpr" + "Description": "Specifies which data field contains nested items. Set this option when your data has a hierarchical structure." }, "keyboardNavigation": { - "DocID": "GridBase.Options.keyboardNavigation", + "Description": "Configures keyboard navigation.", "Options": { "editOnKeyPress": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.keyboardNavigation.editOnKeyPress" + "Description": "Specifies whether users can enter a new cell value on a key press. Applies if editing.mode is \"cell\" or \"batch\"." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.keyboardNavigation.enabled" + "Description": "Enables keyboard navigation." }, "enterKeyAction": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.keyboardNavigation.enterKeyAction" + "Description": "Specifies whether the Enter key switches the cell to the editing state or moves focus in the enterKeyDirection. Applies if editing.mode is \"cell\" or \"batch\"." }, "enterKeyDirection": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.keyboardNavigation.enterKeyDirection" + "Description": "Specifies the direction in which to move focus when a user presses Enter. Applies if editing.mode is \"cell\" or \"batch\"." } } }, @@ -40353,65 +38766,65 @@ "string" ], "IsFunc": true, - "DocID": "dxTreeList.Options.keyExpr" + "Description": "Specifies the key property (or properties) that provide(s) key values to access data items. Each key value must be unique." }, "loadPanel": { - "DocID": "GridBase.Options.loadPanel", + "Description": "Configures the load panel.", "Options": { "enabled": { "PrimitiveTypes": [ "boolean", "string" ], - "DocID": "GridBase.Options.loadPanel.enabled" + "Description": "Enables displaying the load panel automatically." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.loadPanel.height" + "Description": "Specifies the height of the load panel in pixels." }, "indicatorSrc": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.loadPanel.indicatorSrc" + "Description": "Specifies a URL pointing to an image to be used as a loading indicator." }, "shading": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.loadPanel.shading" + "Description": "Specifies whether to shade the widget when the load panel is shown." }, "shadingColor": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.loadPanel.shadingColor" + "Description": "Specifies the shading color. Applies only if shading is true." }, "showIndicator": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.loadPanel.showIndicator" + "Description": "Specifies whether to show the loading indicator." }, "showPane": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.loadPanel.showPane" + "Description": "Specifies whether to show the pane of the load panel." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.loadPanel.text" + "Description": "Specifies text displayed on the load panel." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.loadPanel.width" + "Description": "Specifies the width of the load panel in pixels." } } }, @@ -40419,7 +38832,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.noDataText" + "Description": "Specifies text shown when the widget does not display any data." }, "onAdaptiveDetailRowPreparing": { "PrimitiveTypes": [ @@ -40427,7 +38840,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onAdaptiveDetailRowPreparing" + "Description": "A function that is executed before an adaptive detail row is rendered." }, "onCellClick": { "PrimitiveTypes": [ @@ -40436,7 +38849,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onCellClick" + "Description": "A function that is executed when a cell is clicked or tapped. Executed before onRowClick." }, "onCellDblClick": { "PrimitiveTypes": [ @@ -40444,7 +38857,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onCellDblClick" + "Description": "A function that is executed when a cell is double-clicked or double-tapped. Executed before onRowDblClick." }, "onCellHoverChanged": { "PrimitiveTypes": [ @@ -40452,7 +38865,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onCellHoverChanged" + "Description": "A function that is executed after the pointer enters or leaves a cell." }, "onCellPrepared": { "PrimitiveTypes": [ @@ -40460,7 +38873,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onCellPrepared" + "Description": "A function that is executed after a grid cell is created." }, "onContentReady": { "PrimitiveTypes": [ @@ -40468,7 +38881,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onContextMenuPreparing": { "PrimitiveTypes": [ @@ -40476,7 +38889,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onContextMenuPreparing" + "Description": "A function that is executed before the context menu is rendered." }, "onDataErrorOccurred": { "PrimitiveTypes": [ @@ -40484,7 +38897,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onDataErrorOccurred" + "Description": "A function that is executed when an error occurs in the data source." }, "onDisposing": { "PrimitiveTypes": [ @@ -40492,7 +38905,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onEditingStart": { "PrimitiveTypes": [ @@ -40500,7 +38913,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onEditingStart" + "Description": "A function that is executed before a cell or row switches to the editing state." }, "onEditorPrepared": { "PrimitiveTypes": [ @@ -40508,7 +38921,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onEditorPrepared" + "Description": "A function that is executed after an editor is created. Not executed for cells with an editCellTemplate." }, "onEditorPreparing": { "PrimitiveTypes": [ @@ -40516,7 +38929,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onEditorPreparing" + "Description": "A function used to customize or replace default editors. Not executed for cells with an editCellTemplate." }, "onFocusedCellChanged": { "PrimitiveTypes": [ @@ -40524,7 +38937,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onFocusedCellChanged" + "Description": "A function that is executed after the focused cell changes. Applies only to cells in data rows." }, "onFocusedCellChanging": { "PrimitiveTypes": [ @@ -40532,7 +38945,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onFocusedCellChanging" + "Description": "A function that is executed before the focused cell changes. Applies only to cells in data rows." }, "onFocusedRowChanged": { "PrimitiveTypes": [ @@ -40540,7 +38953,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onFocusedRowChanged" + "Description": "A function that executed when the focused row changes. Applies only to data rows. focusedRowEnabled should be true." }, "onFocusedRowChanging": { "PrimitiveTypes": [ @@ -40548,7 +38961,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onFocusedRowChanging" + "Description": "A function that is executed before the focused row changes. Applies only to data rows. focusedRowEnabled should be true." }, "onInitialized": { "PrimitiveTypes": [ @@ -40556,7 +38969,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onInitNewRow": { "PrimitiveTypes": [ @@ -40564,7 +38977,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onInitNewRow" + "Description": "A function that is executed before a new row is added to the widget." }, "onKeyDown": { "PrimitiveTypes": [ @@ -40572,7 +38985,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onKeyDown" + "Description": "A function that is executed when the widget is in focus and a key has been pressed down." }, "onNodesInitialized": { "PrimitiveTypes": [ @@ -40580,7 +38993,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onNodesInitialized" + "Description": "A function that is executed after the loaded nodes are initialized." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -40588,7 +39001,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onRowClick": { "PrimitiveTypes": [ @@ -40597,7 +39010,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onRowClick" + "Description": "A function that is executed when a grid row is clicked or tapped." }, "onRowCollapsed": { "PrimitiveTypes": [ @@ -40605,7 +39018,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowCollapsed" + "Description": "A function that is executed after a row is collapsed." }, "onRowCollapsing": { "PrimitiveTypes": [ @@ -40613,7 +39026,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowCollapsing" + "Description": "A function that is executed before a row is collapsed." }, "onRowDblClick": { "PrimitiveTypes": [ @@ -40621,7 +39034,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onRowDblClick" + "Description": "A function that is executed when a row is double-clicked or double-tapped. Executed after onCellDblClick." }, "onRowExpanded": { "PrimitiveTypes": [ @@ -40629,7 +39042,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowExpanded" + "Description": "A function that is executed after a row is expanded." }, "onRowExpanding": { "PrimitiveTypes": [ @@ -40637,7 +39050,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowExpanding" + "Description": "A function that is executed before a row is expanded." }, "onRowInserted": { "PrimitiveTypes": [ @@ -40645,7 +39058,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowInserted" + "Description": "A function that is executed after a new row has been inserted into the data source." }, "onRowInserting": { "PrimitiveTypes": [ @@ -40653,7 +39066,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowInserting" + "Description": "A function that is executed before a new row is inserted into the data source." }, "onRowPrepared": { "PrimitiveTypes": [ @@ -40661,7 +39074,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeList.Options.onRowPrepared" + "Description": "A function that is executed after a row is created." }, "onRowRemoved": { "PrimitiveTypes": [ @@ -40669,7 +39082,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowRemoved" + "Description": "A function that is executed after a row has been removed from the data source." }, "onRowRemoving": { "PrimitiveTypes": [ @@ -40677,7 +39090,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowRemoving" + "Description": "A function that is executed before a row is removed from the data source." }, "onRowUpdated": { "PrimitiveTypes": [ @@ -40685,7 +39098,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowUpdated" + "Description": "A function that is executed after a row has been updated in the data source." }, "onRowUpdating": { "PrimitiveTypes": [ @@ -40693,7 +39106,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowUpdating" + "Description": "A function that is executed before a row is updated in the data source." }, "onRowValidating": { "PrimitiveTypes": [ @@ -40701,7 +39114,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onRowValidating" + "Description": "A function that is executed after cells in a row are validated against validation rules." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -40709,7 +39122,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onSelectionChanged" + "Description": "A function that is executed after selecting a row or clearing its selection." }, "onToolbarPreparing": { "PrimitiveTypes": [ @@ -40717,10 +39130,10 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.onToolbarPreparing" + "Description": "A function that is executed before the toolbar is created." }, "pager": { - "DocID": "GridBase.Options.pager", + "Description": "Configures the pager.", "Options": { "allowedPageSizes": { "PrimitiveTypes": [ @@ -40731,63 +39144,63 @@ ], "IsCollection": true, "SingularName": "allowedPageSize", - "DocID": "GridBase.Options.pager.allowedPageSizes" + "Description": "Specifies the available page sizes in the page size selector." }, "infoText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.pager.infoText" + "Description": "Specifies the page information text." }, "showInfo": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.pager.showInfo" + "Description": "Specifies whether to show the page information." }, "showNavigationButtons": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.pager.showNavigationButtons" + "Description": "Specifies whether to show navigation buttons." }, "showPageSizeSelector": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.pager.showPageSizeSelector" + "Description": "Specifies whether to show the page size selector." }, "visible": { "PrimitiveTypes": [ "boolean", "string" ], - "DocID": "GridBase.Options.pager.visible" + "Description": "Specifies whether the pager is visible." } } }, "paging": { - "DocID": "dxTreeList.Options.paging", + "Description": "Configures paging.", "Options": { "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeList.Options.paging.enabled" + "Description": "Enables paging." }, "pageIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "GridBase.Options.paging.pageIndex" + "Description": "Specifies the page to be displayed using a zero-based index." }, "pageSize": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "GridBase.Options.paging.pageSize" + "Description": "Specifies the page size." } } }, @@ -40797,31 +39210,31 @@ "string" ], "IsFunc": true, - "DocID": "dxTreeList.Options.parentIdExpr" + "Description": "Specifies which data field provides parent keys." }, "remoteOperations": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeList.Options.remoteOperations", + "Description": "Notifies the TreeList of the server's data processing operations. Applies only if data has a plain structure.", "Options": { "filtering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeList.Options.remoteOperations.filtering" + "Description": "Specifies whether filtering should be performed on the server." }, "grouping": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeList.Options.remoteOperations.grouping" + "Description": "Specifies whether grouping should be performed on the server." }, "sorting": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeList.Options.remoteOperations.sorting" + "Description": "Specifies whether sorting should be performed on the server." } } }, @@ -40829,46 +39242,46 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.renderAsync" + "Description": "Specifies whether to render the filter row, command columns, and columns with showEditorAlways set to true after other elements." }, "repaintChangesOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.repaintChangesOnly" + "Description": "Specifies whether to repaint only those cells whose data changed." }, "rootValue": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTreeList.Options.rootValue" + "Description": "Specifies the root node's identifier. Applies if dataStructure is \"plain\"." }, "rowAlternationEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.rowAlternationEnabled" + "Description": "Specifies whether rows should be shaded differently." }, "rowDragging": { - "DocID": "GridBase.Options.rowDragging", + "Description": "Configures row reordering using drag and drop gestures.", "Options": { "allowDropInsideItem": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.rowDragging.allowDropInsideItem" + "Description": "Allows users to drop a row inside another row." }, "allowReordering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.rowDragging.allowReordering" + "Description": "Allows row reordering using drag and drop gestures." }, "autoScroll": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.rowDragging.autoScroll" + "Description": "Enables automatic scrolling while dragging a row beyond the viewport." }, "boundary": { "PrimitiveTypes": [ @@ -40876,7 +39289,7 @@ "JQuery", "string" ], - "DocID": "GridBase.Options.rowDragging.boundary" + "Description": "Specifies a DOM element that limits the dragging area." }, "container": { "PrimitiveTypes": [ @@ -40884,25 +39297,25 @@ "JQuery", "string" ], - "DocID": "GridBase.Options.rowDragging.container" + "Description": "Specifies a custom container in which the draggable row should be rendered." }, "cursorOffset": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.rowDragging.cursorOffset", + "Description": "Specifies the cursor offset from the dragged row.", "Options": { "x": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.rowDragging.cursorOffset.x" + "Description": "Specifies the horizontal cursor offset from the dragged row in pixels." }, "y": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.rowDragging.cursorOffset.y" + "Description": "Specifies the vertical cursor offset from the dragged row in pixels." } } }, @@ -40910,44 +39323,44 @@ "PrimitiveTypes": [ "any" ], - "DocID": "GridBase.Options.rowDragging.data" + "Description": "A container for custom data." }, "dragDirection": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.rowDragging.dragDirection" + "Description": "Specifies the directions in which a row can be dragged." }, "dragTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "GridBase.Options.rowDragging.dragTemplate" + "Description": "Specifies custom markup to be shown instead of the item being dragged." }, "dropFeedbackMode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.rowDragging.dropFeedbackMode" + "Description": "Specifies how to highlight the row's drop position." }, "filter": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.rowDragging.filter" + "Description": "Specifies a CSS selector for draggable rows." }, "group": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.rowDragging.group" + "Description": "Allows you to group several widgets so that users can drag and drop rows between them." }, "handle": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.rowDragging.handle" + "Description": "Specifies a CSS selector (ID or class) for the element(s) that should act as the drag handle(s)." }, "onAdd": { "PrimitiveTypes": [ @@ -40955,7 +39368,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onAdd" + "Description": "A function that is called when a new row is added." }, "onDragChange": { "PrimitiveTypes": [ @@ -40963,7 +39376,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onDragChange" + "Description": "A function that is called when the dragged row's position is changed." }, "onDragEnd": { "PrimitiveTypes": [ @@ -40971,7 +39384,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onDragEnd" + "Description": "A function that is called when the drag gesture is finished." }, "onDragMove": { "PrimitiveTypes": [ @@ -40979,7 +39392,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onDragMove" + "Description": "A function that is called every time a draggable row is moved." }, "onDragStart": { "PrimitiveTypes": [ @@ -40987,7 +39400,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onDragStart" + "Description": "A function that is called when the drag gesture is initialized." }, "onRemove": { "PrimitiveTypes": [ @@ -40995,7 +39408,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onRemove" + "Description": "A function that is called when a draggable row is removed." }, "onReorder": { "PrimitiveTypes": [ @@ -41003,25 +39416,25 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "GridBase.Options.rowDragging.onReorder" + "Description": "A function that is called when the draggable rows are reordered." }, "scrollSensitivity": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.rowDragging.scrollSensitivity" + "Description": "Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true." }, "scrollSpeed": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.rowDragging.scrollSpeed" + "Description": "Specifies the scrolling speed when dragging a row beyond the viewport. Applies only if autoScroll is true." }, "showDragIcons": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.rowDragging.showDragIcons" + "Description": "Shows or hides row dragging icons." } } }, @@ -41029,107 +39442,107 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scrolling": { - "DocID": "dxTreeList.Options.scrolling", + "Description": "Configures scrolling.", "Options": { "columnRenderingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.scrolling.columnRenderingMode" + "Description": "Specifies the rendering mode for columns. Applies when columns are left outside the viewport. Requires the columnWidth, columnAutoWidth, or width (for all columns) option specified." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeList.Options.scrolling.mode" + "Description": "Specifies the scrolling mode." }, "preloadEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.scrolling.preloadEnabled" + "Description": "Specifies whether the widget should load adjacent pages. Applies only if scrolling.mode is \"virtual\" or \"infinite\"." }, "rowRenderingMode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.scrolling.rowRenderingMode" + "Description": "Specifies the rendering mode for loaded rows." }, "scrollByContent": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.scrolling.scrollByContent" + "Description": "Specifies whether a user can scroll the content with a swipe gesture. Applies only if useNative is false." }, "scrollByThumb": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.scrolling.scrollByThumb" + "Description": "Specifies whether a user can scroll the content with the scrollbar. Applies only if useNative is false." }, "showScrollbar": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.scrolling.showScrollbar" + "Description": "Specifies when to show scrollbars. Applies only if useNative is false." }, "useNative": { "PrimitiveTypes": [ "boolean", "string" ], - "DocID": "GridBase.Options.scrolling.useNative" + "Description": "Specifies whether the widget should use native or simulated scrolling." } } }, "searchPanel": { - "DocID": "GridBase.Options.searchPanel", + "Description": "Configures the search panel.", "Options": { "highlightCaseSensitive": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.searchPanel.highlightCaseSensitive" + "Description": "Notifies the widget whether search is case-sensitive to ensure that search results are highlighted correctly. Applies only if highlightSearchText is true." }, "highlightSearchText": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.searchPanel.highlightSearchText" + "Description": "Specifies whether found substrings should be highlighted." }, "placeholder": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.searchPanel.placeholder" + "Description": "Specifies a placeholder for the search panel." }, "searchVisibleColumnsOnly": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.searchPanel.searchVisibleColumnsOnly" + "Description": "Specifies whether the widget should search against all columns or only visible ones." }, "text": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "GridBase.Options.searchPanel.text" + "Description": "Sets a search string for the search panel." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.searchPanel.visible" + "Description": "Specifies whether the search panel is visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.searchPanel.width" + "Description": "Specifies the width of the search panel in pixels." } } }, @@ -41140,28 +39553,28 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "selectedRowKey", - "DocID": "GridBase.Options.selectedRowKeys" + "Description": "Allows you to select rows or determine which rows are selected." }, "selection": { - "DocID": "dxTreeList.Options.selection", + "Description": "Configures runtime selection.", "Options": { "allowSelectAll": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.selection.allowSelectAll" + "Description": "Specifies whether a user can select all rows at once." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.selection.mode" + "Description": "Specifies the selection mode." }, "recursive": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeList.Options.selection.recursive" + "Description": "Specifies whether selection is recursive." } } }, @@ -41169,101 +39582,101 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.showBorders" + "Description": "Specifies whether the outer borders of the widget are visible." }, "showColumnHeaders": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.showColumnHeaders" + "Description": "Specifies whether column headers are visible." }, "showColumnLines": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.showColumnLines" + "Description": "Specifies whether vertical lines that separate one column from another are visible." }, "showRowLines": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.showRowLines" + "Description": "Specifies whether horizontal lines that separate one row from another are visible." }, "sorting": { - "DocID": "GridBase.Options.sorting", + "Description": "Configures runtime sorting.", "Options": { "ascendingText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.sorting.ascendingText" + "Description": "Specifies text for the context menu item that sets an ascending sort order in a column." }, "clearText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.sorting.clearText" + "Description": "Specifies text for the context menu item that clears sorting settings for a column." }, "descendingText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.sorting.descendingText" + "Description": "Specifies text for the context menu item that sets a descending sort order in a column." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.sorting.mode" + "Description": "Specifies the sorting mode." }, "showSortIndexes": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.sorting.showSortIndexes" + "Description": "Specifies whether to display sort indexes in column headers. Applies only when sorting.mode is \"multiple\" and data is sorted by two or more columns." } } }, "stateStoring": { - "DocID": "GridBase.Options.stateStoring", + "Description": "Configures state storing.", "Options": { "customLoad": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBase.Options.stateStoring.customLoad" + "Description": "Specifies a function that is executed on state loading. Applies only if the type is 'custom'." }, "customSave": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBase.Options.stateStoring.customSave" + "Description": "Specifies a function that is executed on state saving. Applies only if the type is \"custom\"." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.stateStoring.enabled" + "Description": "Enables state storing." }, "savingTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBase.Options.stateStoring.savingTimeout" + "Description": "Specifies the delay in milliseconds between when a user makes a change and when this change is saved." }, "storageKey": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.stateStoring.storageKey" + "Description": "Specifies the key for storing the widget state." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBase.Options.stateStoring.type" + "Description": "Specifies the type of storage where the state is saved." } } }, @@ -41271,19 +39684,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "twoWayBindingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.twoWayBindingEnabled" + "Description": "Specifies whether to enable two-way data binding." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -41292,46 +39705,46 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." }, "wordWrapEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBase.Options.wordWrapEnabled" + "Description": "Specifies whether text that does not fit into a column should be wrapped." } } }, "dxTreeMap": { - "DocID": "dxTreeMap", + "Description": "The TreeMap is a widget that displays hierarchical data by using nested rectangles.", "Module": "viz/tree_map", "Options": { "childrenField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.childrenField" + "Description": "Specifies the name of the data source field that provides nested items for a group. Applies to hierarchical data sources only." }, "colorField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.colorField" + "Description": "Specifies the name of the data source field that provides colors for tiles." }, "colorizer": { - "DocID": "dxTreeMap.Options.colorizer", + "Description": "Manages the color settings.", "Options": { "colorCodeField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.colorizer.colorCodeField" + "Description": "Specifies the name of the data source field whose values define the color of a tile. Applies only if the type option is \"gradient\" or \"range\"." }, "colorizeGroups": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeMap.Options.colorizer.colorizeGroups" + "Description": "Specifies whether or not all tiles in a group must be colored uniformly. Applies only if the type option is \"discrete\"." }, "palette": { "PrimitiveTypes": [ @@ -41342,13 +39755,13 @@ ], "IsCollection": true, "SingularName": "palette", - "DocID": "dxTreeMap.Options.colorizer.palette" + "Description": "Sets the palette to be used to colorize tiles." }, "paletteExtensionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.colorizer.paletteExtensionMode" + "Description": "Specifies what to do with colors in the palette when their number is less than the number of treemap tiles." }, "range": { "ItemPrimitiveTypes": [ @@ -41356,13 +39769,13 @@ ], "IsCollection": true, "SingularName": "range", - "DocID": "dxTreeMap.Options.colorizer.range" + "Description": "Allows you to paint tiles with similar values uniformly. Applies only if the type option is \"gradient\" or \"range\"." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.colorizer.type" + "Description": "Specifies the colorizing algorithm." } } }, @@ -41375,48 +39788,41 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxTreeMap.Options.dataSource" + "Description": "Binds the widget to data." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "export": { - "DocID": "BaseWidget.Options.export", + "Description": "Configures the exporting and printing features.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.backgroundColor" + "Description": "Specifies the color that will fill transparent regions in the resulting file or document." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.enabled" + "Description": "Enables the client-side exporting in the widget." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.fileName" + "Description": "Specifies a default name for the file to which the widget will be exported." }, "formats": { "ItemPrimitiveTypes": [ @@ -41424,53 +39830,53 @@ ], "IsCollection": true, "SingularName": "format", - "DocID": "BaseWidget.Options.export.formats" + "Description": "Specifies a set of export formats." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.export.margin" + "Description": "Adds an empty space around the exported widget; measured in pixels." }, "printingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.printingEnabled" + "Description": "Enables the printing feature in the widget. Applies only if the export.enabled option is true." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "BaseWidget.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." }, "svgToCanvas": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseWidget.Options.export.svgToCanvas" + "Description": "A function that renders SVG markup on the HTML canvas. Required to export custom SVG elements (for example, markerTemplate)." } } }, "group": { - "DocID": "dxTreeMap.Options.group", + "Description": "Configures groups.", "Options": { "border": { - "DocID": "dxTreeMap.Options.group.border", + "Description": "Configures the group borders.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.group.border.color" + "Description": "Colors the group borders." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTreeMap.Options.group.border.width" + "Description": "Specifies the width of the group borders in pixels." } } }, @@ -41478,37 +39884,37 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.group.color" + "Description": "Colors the group headers." }, "headerHeight": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTreeMap.Options.group.headerHeight" + "Description": "Specifies the height of the group headers in pixels." }, "hoverEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeMap.Options.group.hoverEnabled" + "Description": "Specifies whether groups change their style when a user pauses on them." }, "hoverStyle": { - "DocID": "dxTreeMap.Options.group.hoverStyle", + "Description": "Specifies the appearance of groups in the hover state.", "Options": { "border": { - "DocID": "dxTreeMap.Options.group.hoverStyle.border", + "Description": "Configures the appearance of the group borders in the hover state.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.group.hoverStyle.border.color" + "Description": "Colors the group borders in the hover state." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTreeMap.Options.group.hoverStyle.border.width" + "Description": "Specifies the width of the group borders in pixels. Applies to a group in the hover state." } } }, @@ -41516,12 +39922,12 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.group.hoverStyle.color" + "Description": "Colors the group headers in the hover state." } } }, "label": { - "DocID": "dxTreeMap.Options.group.label", + "Description": "Configures the group labels.", "Options": { "font": { "PrimitiveTypes": [ @@ -41530,46 +39936,39 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxTreeMap.Options.group.label.font" + "Description": "Specifies the font settings of the group labels." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.group.label.textOverflow" + "Description": "Specifies what to do with labels that overflow their group headers: hide, truncated them with ellipsis, or leave them as they are." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeMap.Options.group.label.visible" + "Description": "Changes the visibility of the group labels." } } }, "selectionStyle": { - "DocID": "dxTreeMap.Options.group.selectionStyle", + "Description": "Specifies the appearance of groups in the selected state.", "Options": { "border": { - "DocID": "dxTreeMap.Options.group.selectionStyle.border", + "Description": "Configures the appearance of the group borders in the selected state.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.group.selectionStyle.border.color" + "Description": "Colors the group borders in the selected state." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTreeMap.Options.group.selectionStyle.border.width" + "Description": "Specifies the width of the group borders in pixels. Applies to a group in the selected state." } } }, @@ -41577,7 +39976,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.group.selectionStyle.color" + "Description": "Colors the group headers in the selected state." } } } @@ -41587,25 +39986,25 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeMap.Options.hoverEnabled" + "Description": "Specifies whether tiles and groups change their style when a user pauses on them." }, "idField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.idField" + "Description": "Specifies the name of the data source field that provides IDs for items. Applies to plain data sources only." }, "interactWithGroup": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeMap.Options.interactWithGroup" + "Description": "Specifies whether the user will interact with a single tile or its group." }, "labelField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.labelField" + "Description": "Specifies the name of the data source field that provides texts for tile and group labels." }, "layoutAlgorithm": { "PrimitiveTypes": [ @@ -41613,56 +40012,50 @@ "string" ], "IsFunc": true, - "DocID": "dxTreeMap.Options.layoutAlgorithm" + "Description": "Specifies the layout algorithm." }, "layoutDirection": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.layoutDirection" + "Description": "Specifies the direction in which the items will be laid out." }, "loadingIndicator": { - "DocID": "BaseWidget.Options.loadingIndicator", + "Description": "Configures the loading indicator.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.backgroundColor" + "Description": "Colors the background of the loading indicator." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.loadingIndicator.enabled" + "Description": "Specifies whether the loading indicator should be displayed and hidden automatically." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.loadingIndicator.font" + "Description": "Specifies font options for the loading indicator." }, "show": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "BaseWidget.Options.loadingIndicator.show" + "Description": "Allows you to change the loading indicator's visibility." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.text" + "Description": "Specifies the text to be displayed by the loading indicator." } } }, @@ -41670,7 +40063,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxTreeMap.Options.maxDepth" + "Description": "Specifies how many hierarchical levels must be visualized." }, "onClick": { "PrimitiveTypes": [ @@ -41679,7 +40072,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeMap.Options.onClick" + "Description": "A function that is executed when a node is clicked or tapped." }, "onDisposing": { "PrimitiveTypes": [ @@ -41687,7 +40080,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDrawn": { "PrimitiveTypes": [ @@ -41695,7 +40088,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onDrill": { "PrimitiveTypes": [ @@ -41703,7 +40096,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeMap.Options.onDrill" + "Description": "A function that is executed when a user drills up or down." }, "onExported": { "PrimitiveTypes": [ @@ -41711,7 +40104,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -41719,7 +40112,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -41727,7 +40120,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onHoverChanged": { "PrimitiveTypes": [ @@ -41735,7 +40128,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeMap.Options.onHoverChanged" + "Description": "A function that is executed after the pointer enters or leaves a node." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -41743,7 +40136,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -41751,7 +40144,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onNodesInitialized": { "PrimitiveTypes": [ @@ -41759,7 +40152,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeMap.Options.onNodesInitialized" + "Description": "A function that is executed only once, after the nodes are initialized." }, "onNodesRendering": { "PrimitiveTypes": [ @@ -41767,7 +40160,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeMap.Options.onNodesRendering" + "Description": "A function that is executed before the nodes are displayed and each time the collection of active nodes is changed." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -41775,7 +40168,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -41783,59 +40176,59 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeMap.Options.onSelectionChanged" + "Description": "A function that is executed when a node is selected or selection is canceled." }, "parentField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.parentField" + "Description": "Specifies the name of the data source field that provides parent IDs for items. Applies to plain data sources only." }, "pathModified": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "redrawOnResize": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.redrawOnResize" + "Description": "Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates." }, "resolveLabelOverflow": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "dxTreeMap.Options.resolveLabelOverflow" + "Description": "Use the tile.label.textOverflow option instead." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.selectionMode" + "Description": "Specifies whether a single or multiple nodes can be in the selected state simultaneously." }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, @@ -41843,25 +40236,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "tile": { - "DocID": "dxTreeMap.Options.tile", + "Description": "Configures tiles.", "Options": { "border": { - "DocID": "dxTreeMap.Options.tile.border", + "Description": "Configures the tile borders.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.tile.border.color" + "Description": "Colors the tile borders." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTreeMap.Options.tile.border.width" + "Description": "Specifies the width of the tile borders in pixels." } } }, @@ -41869,25 +40262,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.tile.color" + "Description": "Specifies a single color for all tiles." }, "hoverStyle": { - "DocID": "dxTreeMap.Options.tile.hoverStyle", + "Description": "Specifies the appearance of tiles in the hover state.", "Options": { "border": { - "DocID": "dxTreeMap.Options.tile.hoverStyle.border", + "Description": "Configures the appearance of the tile borders in the hover state.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.tile.hoverStyle.border.color" + "Description": "Colors the tile borders in the hover state." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTreeMap.Options.tile.hoverStyle.border.width" + "Description": "Specifies the width of the tile borders in pixels. Applies to a tile in the hover state." } } }, @@ -41895,12 +40288,12 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.tile.hoverStyle.color" + "Description": "Colors tiles in the hover state." } } }, "label": { - "DocID": "dxTreeMap.Options.tile.label", + "Description": "Configures the tile labels.", "Options": { "font": { "PrimitiveTypes": [ @@ -41909,52 +40302,45 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxTreeMap.Options.tile.label.font" + "Description": "Specifies the font settings of the tile labels." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.tile.label.textOverflow" + "Description": "Specifies what to do with labels that overflow their tiles after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeMap.Options.tile.label.visible" + "Description": "Changes the visibility of the tile labels." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.tile.label.wordWrap" + "Description": "Specifies how to wrap texts that do not fit into a single line." } } }, "selectionStyle": { - "DocID": "dxTreeMap.Options.tile.selectionStyle", + "Description": "Specifies the appearance of tiles in the selected state.", "Options": { "border": { - "DocID": "dxTreeMap.Options.tile.selectionStyle.border", + "Description": "Configures the appearance of the tile borders in the selected state.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.tile.selectionStyle.border.color" + "Description": "Colors the tile borders in the selected state." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTreeMap.Options.tile.selectionStyle.border.width" + "Description": "Specifies the width of the tile borders in pixels. Applies to a tile in the selected state." } } }, @@ -41962,7 +40348,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.tile.selectionStyle.color" + "Description": "Colors tiles in the selected state." } } } @@ -41972,58 +40358,52 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title", + "Description": "Configures the widget's title.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.title.font" + "Description": "Specifies font options for the title." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.horizontalAlignment" + "Description": "Specifies the title's alignment in a horizontal direction." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin", + "Description": "Generates space around the title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.bottom" + "Description": "Specifies the bottom margin of the title." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.left" + "Description": "Specifies the left margin of the title." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.right" + "Description": "Specifies the right margin of the title." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.top" + "Description": "Specifies the top margin of the title." } } }, @@ -42031,13 +40411,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle", + "Description": "Configures the widget's subtitle.", "Options": { "font": { "PrimitiveTypes": [ @@ -42046,38 +40426,31 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseWidget.Options.title.subtitle.font" + "Description": "Specifies font options for the subtitle." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.subtitle.offset" + "Description": "Specifies the distance between the title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.text" + "Description": "Specifies text for the subtitle." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.textOverflow" + "Description": "Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.wordWrap" + "Description": "Specifies how to wrap the subtitle if it does not fit into a single line." } } }, @@ -42085,69 +40458,69 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.text" + "Description": "Specifies the title's text." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.textOverflow" + "Description": "Specifies what to do with the title when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.verticalAlignment" + "Description": "Specifies the title's alignment in a vertical direction." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.wordWrap" + "Description": "Specifies how to wrap the title if it does not fit into a single line." } } }, "tooltip": { - "DocID": "dxTreeMap.Options.tooltip", + "Description": "Configures tooltips - small pop-up rectangles that display information about a data-visualizing widget element being pressed or hovered over with the mouse pointer.", "Options": { "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.arrowLength" + "Description": "Specifies the length of a tooltip's arrow in pixels." }, "border": { - "DocID": "BaseWidget.Options.tooltip.border", + "Description": "Configures a tooltip's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.color" + "Description": "Colors a tooltip's border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.dashStyle" + "Description": "Specifies the dash style of a tooltip's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.opacity" + "Description": "Specifies the transparency of a tooltip's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.border.visible" + "Description": "Specifies whether a tooltip's border is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.width" + "Description": "Specifies the width of a tooltip's border in pixels." } } }, @@ -42155,7 +40528,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.color" + "Description": "Colors all tooltips." }, "container": { "PrimitiveTypes": [ @@ -42163,115 +40536,103 @@ "JQuery", "string" ], - "DocID": "BaseWidget.Options.tooltip.container" + "Description": "Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxTreeMap.Options.tooltip.contentTemplate" + "Description": "Specifies a custom template for a tooltip." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.cornerRadius" + "Description": "Makes all the tooltip's corners rounded." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxTreeMap.Options.tooltip.customizeTooltip" + "Description": "Allows you to change tooltip appearance." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.enabled" + "Description": "Enables tooltips." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.font" + "Description": "Specifies tooltips' font options." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.format" + "Description": "Formats a value before it is displayed it in a tooltip." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.opacity" + "Description": "Specifies tooltips' transparency." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between a tooltip's left/right border and its text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text." }, "shadow": { - "DocID": "BaseWidget.Options.tooltip.shadow", + "Description": "Configures a tooltip's shadow.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.blur" + "Description": "Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.shadow.color" + "Description": "Colors a tooltip's shadow." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetX" + "Description": "Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetY" + "Description": "Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.opacity" + "Description": "Specifies the transparency of a tooltip's shadow." } } }, @@ -42279,7 +40640,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.zIndex" + "Description": "Specifies a tooltip's z-index." } } }, @@ -42287,38 +40648,38 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeMap.Options.valueField" + "Description": "Specifies the name of the data source field that provides values for tiles." } } }, "dxTreeView": { - "DocID": "dxTreeView", + "Description": "The TreeView widget is a tree-like representation of textual data.", "Module": "ui/tree_view", "Options": { "accessKey": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.accessKey" + "Description": "Specifies the shortcut key that sets focus on the widget." }, "activeStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.activeStateEnabled" + "Description": "Specifies whether or not the widget changes its state when interacting with a user." }, "animationEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeView.Options.animationEnabled" + "Description": "Specifies whether or not to animate item collapsing and expanding." }, "createChildren": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxTreeView.Options.createChildren" + "Description": "Allows you to load nodes on demand." }, "dataSource": { "PrimitiveTypes": [ @@ -42332,27 +40693,20 @@ "ItemComplexTypes": [ "TreeViewItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxTreeView.Options.dataSource" + "Description": "Binds the widget to data." }, "dataStructure": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeView.Options.dataStructure" + "Description": "Notifies the widget of the used data structure." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "disabledExpr": { "PrimitiveTypes": [ @@ -42360,7 +40714,7 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.disabledExpr" + "Description": "Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled." }, "displayExpr": { "PrimitiveTypes": [ @@ -42368,19 +40722,19 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.displayExpr" + "Description": "Specifies the data field whose values should be displayed." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "expandAllEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeView.Options.expandAllEnabled" + "Description": "Specifies whether or not a user can expand all tree view items by the \"*\" hot key." }, "expandedExpr": { "PrimitiveTypes": [ @@ -42388,25 +40742,25 @@ "string" ], "IsFunc": true, - "DocID": "dxTreeView.Options.expandedExpr" + "Description": "Specifies which data source field specifies whether an item is expanded." }, "expandEvent": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeView.Options.expandEvent" + "Description": "Specifies the event on which to expand/collapse a node." }, "expandNodesRecursive": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeView.Options.expandNodesRecursive" + "Description": "Specifies whether or not all parent nodes of an initially expanded node are displayed expanded." }, "focusStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "HierarchicalCollectionWidget.Options.focusStateEnabled" + "Description": "Specifies whether the widget can be focused using keyboard navigation." }, "hasItemsExpr": { "PrimitiveTypes": [ @@ -42414,7 +40768,7 @@ "string" ], "IsFunc": true, - "DocID": "dxTreeView.Options.hasItemsExpr" + "Description": "Specifies the name of the data source item field whose value defines whether or not the corresponding node includes child nodes." }, "height": { "PrimitiveTypes": [ @@ -42423,25 +40777,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "Widget.Options.hint" + "Description": "Specifies text for a hint that appears when a user pauses on the widget." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "HierarchicalCollectionWidget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "itemHoldTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "CollectionWidget.Options.itemHoldTimeout" + "Description": "The time period in milliseconds before the onItemHold event is raised." }, "items": { "ItemPrimitiveTypes": [ @@ -42450,17 +40804,10 @@ "ItemComplexTypes": [ "TreeViewItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "dxTreeView.Options.items" + "Description": "An array of items displayed by the widget." }, "itemsExpr": { "PrimitiveTypes": [ @@ -42468,14 +40815,14 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.itemsExpr" + "Description": "Specifies which data field contains nested items." }, "itemTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "keyExpr": { "PrimitiveTypes": [ @@ -42483,13 +40830,13 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.keyExpr" + "Description": "Specifies which data field provides keys for TreeView items." }, "noDataText": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidget.Options.noDataText" + "Description": "The text or HTML markup displayed by the widget if the item collection is empty." }, "onContentReady": { "PrimitiveTypes": [ @@ -42497,7 +40844,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -42505,7 +40852,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -42513,7 +40860,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -42521,7 +40868,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeView.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onItemCollapsed": { "PrimitiveTypes": [ @@ -42529,7 +40876,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeView.Options.onItemCollapsed" + "Description": "A function that is executed when a tree view item is collapsed." }, "onItemContextMenu": { "PrimitiveTypes": [ @@ -42537,7 +40884,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeView.Options.onItemContextMenu" + "Description": "A function that is executed when a collection item is right-clicked or pressed." }, "onItemExpanded": { "PrimitiveTypes": [ @@ -42545,7 +40892,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeView.Options.onItemExpanded" + "Description": "A function that is executed when a tree view item is expanded." }, "onItemHold": { "PrimitiveTypes": [ @@ -42553,7 +40900,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeView.Options.onItemHold" + "Description": "A function that is executed when a collection item has been held for a specified period." }, "onItemRendered": { "PrimitiveTypes": [ @@ -42561,7 +40908,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeView.Options.onItemRendered" + "Description": "A function that is executed after a collection item is rendered." }, "onItemSelectionChanged": { "PrimitiveTypes": [ @@ -42569,7 +40916,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeView.Options.onItemSelectionChanged" + "Description": "A function that is executed when a tree view item is selected or selection is canceled." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -42577,7 +40924,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectAllValueChanged": { "PrimitiveTypes": [ @@ -42585,7 +40932,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeView.Options.onSelectAllValueChanged" + "Description": "A function that is executed when the \"Select All\" check box value is changed. Applies only if showCheckBoxesMode is \"selectAll\" and selectionMode is \"multiple\"." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -42593,7 +40940,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeView.Options.onSelectionChanged" + "Description": "A function that is executed when a tree view item is selected or selection is canceled." }, "parentIdExpr": { "PrimitiveTypes": [ @@ -42601,89 +40948,81 @@ "string" ], "IsFunc": true, - "DocID": "dxTreeView.Options.parentIdExpr" + "Description": "Specifies the name of the data source item field for holding the parent key of the corresponding node." }, "rootValue": { "PrimitiveTypes": [ "any" ], - "DocID": "dxTreeView.Options.rootValue" + "Description": "Specifies the parent ID value of the root item." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "DOMComponent.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "scrollDirection": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeView.Options.scrollDirection" + "Description": "A string value specifying available scrolling directions." }, "searchEditorOptions": { "PrimitiveTypes": [ - "dxTextBoxOptions" + "DevExpress.ui.dxTextBoxOptions" ], "ComplexTypes": [ "dxTextBoxOptions" ], - "TypeImports": [ - { - "Name": "dxTextBoxOptions", - "Path": "ui/text_box" - } - ], - "DocID": "SearchBoxMixin.Options.searchEditorOptions" + "Description": "Configures the search panel." }, "searchEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "SearchBoxMixin.Options.searchEnabled" + "Description": "Specifies whether the search panel is visible." }, "searchExpr": { "PrimitiveTypes": [ - "Function", - "string" + "Function" ], "ItemPrimitiveTypes": [ - "Function", - "string" + "Function" ], "IsCollection": true, "SingularName": "searchExpr", - "DocID": "SearchBoxMixin.Options.searchExpr" + "Description": "Specifies a data object's field name or an expression whose value is compared to the search string." }, "searchMode": { "PrimitiveTypes": [ "string" ], - "DocID": "SearchBoxMixin.Options.searchMode" + "Description": "Specifies a comparison operation used to search widget items." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "SearchBoxMixin.Options.searchTimeout" + "Description": "Specifies a delay in milliseconds between when a user finishes typing, and the search is executed." }, "searchValue": { "PrimitiveTypes": [ "string" ], - "DocID": "SearchBoxMixin.Options.searchValue" + "Description": "Specifies the current search string." }, "selectAllText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeView.Options.selectAllText" + "Description": "Specifies the text displayed at the \"Select All\" check box." }, "selectByClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeView.Options.selectByClick" + "Description": "Specifies whether or not an item becomes selected if a user clicks it." }, "selectedExpr": { "PrimitiveTypes": [ @@ -42691,43 +41030,43 @@ "string" ], "IsFunc": true, - "DocID": "HierarchicalCollectionWidget.Options.selectedExpr" + "Description": "Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeView.Options.selectionMode" + "Description": "Specifies item selection mode." }, "selectNodesRecursive": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeView.Options.selectNodesRecursive" + "Description": "Specifies whether or not to select nodes recursively." }, "showCheckBoxesMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeView.Options.showCheckBoxesMode" + "Description": "Specifies the current check boxes display mode." }, "tabIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "Widget.Options.tabIndex" + "Description": "Specifies the number of the element when the Tab key is used for navigating." }, "virtualModeEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeView.Options.virtualModeEnabled" + "Description": "Enables the virtual mode in which nodes are loaded on demand. Use it to enhance the performance on large datasets." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.visible" + "Description": "Specifies whether the widget is visible." }, "width": { "PrimitiveTypes": [ @@ -42736,12 +41075,12 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxValidationGroup": { - "DocID": "dxValidationGroup", + "Description": "The ValidationGroup is a widget that allows you to validate several editors simultaneously.", "IsTranscludedContent": true, "Module": "ui/validation_group", "Options": { @@ -42749,7 +41088,7 @@ "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -42758,7 +41097,7 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "onDisposing": { "PrimitiveTypes": [ @@ -42766,7 +41105,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -42774,7 +41113,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -42782,7 +41121,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "width": { "PrimitiveTypes": [ @@ -42791,25 +41130,25 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxValidationSummary": { - "DocID": "dxValidationSummary", + "Description": "A widget for displaying the result of checking validation rules for editors.", "Module": "ui/validation_summary", "Options": { "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "hoverStateEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "Widget.Options.hoverStateEnabled" + "Description": "Specifies whether the widget changes its state when a user pauses on it." }, "items": { "ItemPrimitiveTypes": [ @@ -42819,38 +41158,38 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "item", - "DocID": "CollectionWidget.Options.items", + "Description": "An array of items displayed by the widget.", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, @@ -42859,7 +41198,7 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidget.Options.itemTemplate" + "Description": "Specifies a custom template for items." }, "onContentReady": { "PrimitiveTypes": [ @@ -42867,7 +41206,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Widget.Options.onContentReady" + "Description": "A function that is executed when the widget's content is ready and each time the content is changed." }, "onDisposing": { "PrimitiveTypes": [ @@ -42875,7 +41214,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -42883,7 +41222,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onItemClick": { "PrimitiveTypes": [ @@ -42892,7 +41231,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "CollectionWidget.Options.onItemClick" + "Description": "A function that is executed when a collection item is clicked or tapped." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -42900,58 +41239,58 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "validationGroup": { "PrimitiveTypes": [ "string" ], - "DocID": "dxValidationSummary.Options.validationGroup" + "Description": "Specifies the validation group for which summary should be generated." } } }, "dxValidator": { - "DocID": "dxValidator", + "Description": "A widget that is used to validate the associated DevExtreme editors against the defined validation rules.", "IsExtensionComponent": true, "Module": "ui/validator", "Options": { "adapter": { - "DocID": "dxValidator.Options.adapter", + "Description": "An object that specifies what and when to validate, and how to apply the validation result.", "Options": { "applyValidationResults": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxValidator.Options.adapter.applyValidationResults" + "Description": "A function that the Validator widget calls after validating a specified value." }, "bypass": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxValidator.Options.adapter.bypass" + "Description": "A function that returns a Boolean value specifying whether or not to bypass validation." }, "focus": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxValidator.Options.adapter.focus" + "Description": "A function that sets focus to a validated editor when the corresponding ValidationSummary item is focused." }, "getValue": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxValidator.Options.adapter.getValue" + "Description": "A function that returns the value to be validated." }, "reset": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxValidator.Options.adapter.reset" + "Description": "A function that resets the validated values." }, "validationRequestsCallbacks": { "PrimitiveTypes": [ @@ -42962,7 +41301,7 @@ ], "IsCollection": true, "SingularName": "validationRequestsCallback", - "DocID": "dxValidator.Options.adapter.validationRequestsCallbacks" + "Description": "Callbacks to be executed on the value validation." } } }, @@ -42970,7 +41309,7 @@ "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "height": { "PrimitiveTypes": [ @@ -42979,13 +41318,13 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.height" + "Description": "Specifies the widget's height." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxValidator.Options.name" + "Description": "Specifies the editor name to be used in the validation default messages." }, "onDisposing": { "PrimitiveTypes": [ @@ -42993,7 +41332,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onInitialized": { "PrimitiveTypes": [ @@ -43001,7 +41340,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -43009,7 +41348,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onValidated": { "PrimitiveTypes": [ @@ -43017,13 +41356,13 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxValidator.Options.onValidated" + "Description": "A function that is executed after a value is validated." }, "validationGroup": { "PrimitiveTypes": [ "string" ], - "DocID": "dxValidator.Options.validationGroup" + "Description": "Specifies the validation group the editor will be related to." }, "validationRules": { "ItemPrimitiveTypes": [ @@ -43048,16 +41387,9 @@ "EmailRule", "AsyncRule" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "validationRule", - "DocID": "dxValidator.Options.validationRules" + "Description": "An array of validation rules to be checked for the editor with which the dxValidator object is associated." }, "width": { "PrimitiveTypes": [ @@ -43066,28 +41398,28 @@ "string" ], "IsFunc": true, - "DocID": "DOMComponent.Options.width" + "Description": "Specifies the widget's width." } } }, "dxVectorMap": { - "DocID": "dxVectorMap", + "Description": "The VectorMap is a widget that visualizes geographical locations. This widget represents a geographical map that contains areas and markers. Areas embody continents and countries. Markers flag specific points on the map, for example, towns, cities or capitals.", "Module": "viz/vector_map", "Options": { "background": { - "DocID": "dxVectorMap.Options.background", + "Description": "Specifies the options for the map background.", "Options": { "borderColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.background.borderColor" + "Description": "Specifies a color for the background border." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.background.color" + "Description": "Specifies a color for the background." } } }, @@ -43097,7 +41429,7 @@ ], "IsCollection": true, "SingularName": "bound", - "DocID": "dxVectorMap.Options.bounds" + "Description": "Specifies the positioning of a map in geographical coordinates." }, "center": { "ItemPrimitiveTypes": [ @@ -43105,52 +41437,52 @@ ], "IsCollection": true, "SingularName": "center", - "DocID": "dxVectorMap.Options.center" + "Description": "Specifies the geographical coordinates of the center for a map." }, "controlBar": { - "DocID": "dxVectorMap.Options.controlBar", + "Description": "Configures the control bar.", "Options": { "borderColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.controlBar.borderColor" + "Description": "Specifies a color for the outline of the control bar elements." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.controlBar.color" + "Description": "Specifies a color for the inner area of the control bar elements." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxVectorMap.Options.controlBar.enabled" + "Description": "Specifies whether or not to display the control bar." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.controlBar.horizontalAlignment" + "Description": "Specifies the position of the control bar." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.controlBar.margin" + "Description": "Specifies the margin of the control bar in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.controlBar.opacity" + "Description": "Specifies the opacity of the control bar." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.controlBar.verticalAlignment" + "Description": "Specifies the position of the control bar." } } }, @@ -43158,34 +41490,34 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.disabled" + "Description": "Specifies whether the widget responds to user interaction." }, "elementAttr": { "PrimitiveTypes": [ "any" ], - "DocID": "DOMComponent.Options.elementAttr" + "Description": "Specifies the attributes to be attached to the widget's root element." }, "export": { - "DocID": "BaseWidget.Options.export", + "Description": "Configures the exporting and printing features.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.backgroundColor" + "Description": "Specifies the color that will fill transparent regions in the resulting file or document." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.enabled" + "Description": "Enables the client-side exporting in the widget." }, "fileName": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.export.fileName" + "Description": "Specifies a default name for the file to which the widget will be exported." }, "formats": { "ItemPrimitiveTypes": [ @@ -43193,33 +41525,33 @@ ], "IsCollection": true, "SingularName": "format", - "DocID": "BaseWidget.Options.export.formats" + "Description": "Specifies a set of export formats." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.export.margin" + "Description": "Adds an empty space around the exported widget; measured in pixels." }, "printingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.export.printingEnabled" + "Description": "Enables the printing feature in the widget. Applies only if the export.enabled option is true." }, "proxyUrl": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "BaseWidget.Options.export.proxyUrl" + "Description": "Since v10, Safari browser supports API for saving files, and this option is no longer required." }, "svgToCanvas": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "BaseWidget.Options.export.svgToCanvas" + "Description": "A function that renders SVG markup on the HTML canvas. Required to export custom SVG elements (for example, markerTemplate)." } } }, @@ -43229,31 +41561,31 @@ ], "IsCollection": true, "SingularName": "layer", - "DocID": "dxVectorMap.Options.layers", + "Description": "Specifies options for VectorMap widget layers.", "Options": { "borderColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.borderColor" + "Description": "Specifies a color for the border of the layer elements." }, "borderWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.layers.borderWidth" + "Description": "Specifies the line width (for layers of a line type) or width of the layer elements border in pixels." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.color" + "Description": "Specifies a color for layer elements." }, "colorGroupingField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.colorGroupingField" + "Description": "Specifies the field that provides data to be used for coloring of layer elements." }, "colorGroups": { "ItemPrimitiveTypes": [ @@ -43261,20 +41593,20 @@ ], "IsCollection": true, "SingularName": "colorGroup", - "DocID": "dxVectorMap.Options.layers.colorGroups" + "Description": "Allows you to paint layer elements with similar attributes in the same color." }, "customize": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxVectorMap.Options.layers.customize" + "Description": "Specifies the function that customizes each layer element individually." }, "dataField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.dataField" + "Description": "Specifies the name of the attribute containing marker data. Setting this option makes sense only if the layer type is \"marker\" and the elementType is \"bubble\", \"pie\" or \"image\"." }, "dataSource": { "PrimitiveTypes": [ @@ -43286,60 +41618,53 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxVectorMap.Options.layers.dataSource" + "Description": "Specifies a data source for the layer." }, "elementType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.elementType" + "Description": "Specifies the type of a marker element. Setting this option makes sense only if the layer type is \"marker\"." }, "hoveredBorderColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.hoveredBorderColor" + "Description": "Specifies a color for the border of the layer element when it is hovered over." }, "hoveredBorderWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.layers.hoveredBorderWidth" + "Description": "Specifies the pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is hovered over." }, "hoveredColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.hoveredColor" + "Description": "Specifies a color for a layer element when it is hovered over." }, "hoverEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxVectorMap.Options.layers.hoverEnabled" + "Description": "Specifies whether or not to change the appearance of a layer element when it is hovered over." }, "label": { - "DocID": "dxVectorMap.Options.layers.label", + "Description": "Specifies marker label options.", "Options": { "dataField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.label.dataField" + "Description": "The name of the data source attribute containing marker texts." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxVectorMap.Options.layers.label.enabled" + "Description": "Enables marker labels." }, "font": { "PrimitiveTypes": [ @@ -43348,14 +41673,7 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxVectorMap.Options.layers.label.font" + "Description": "Specifies font options for marker labels." } } }, @@ -43363,25 +41681,25 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.layers.maxSize" + "Description": "Specifies the pixel-measured diameter of the marker that represents the biggest value. Setting this option makes sense only if the layer type is \"marker\"." }, "minSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.layers.minSize" + "Description": "Specifies the pixel-measured diameter of the marker that represents the smallest value. Setting this option makes sense only if the layer type is \"marker\"." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.name" + "Description": "Specifies the layer name." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.layers.opacity" + "Description": "Specifies the layer opacity (from 0 to 1)." }, "palette": { "PrimitiveTypes": [ @@ -43392,49 +41710,49 @@ ], "IsCollection": true, "SingularName": "palette", - "DocID": "dxVectorMap.Options.layers.palette" + "Description": "Specifies the name of the palette or a custom range of colors to be used for coloring a layer." }, "paletteSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.layers.paletteSize" + "Description": "Specifies the number of colors in a palette." }, "selectedBorderColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.selectedBorderColor" + "Description": "Specifies a color for the border of the layer element when it is selected." }, "selectedBorderWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.layers.selectedBorderWidth" + "Description": "Specifies a pixel-measured line width (for layers of a line type) or width for the border of the layer element when it is selected." }, "selectedColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.selectedColor" + "Description": "Specifies a color for the layer element when it is selected." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.selectionMode" + "Description": "Specifies whether single or multiple map elements can be selected on a vector map." }, "size": { "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.layers.size" + "Description": "Specifies the size of markers. Setting this option makes sense only if the layer type is \"marker\" and the elementType is \"dot\", \"pie\" or \"image\"." }, "sizeGroupingField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.sizeGroupingField" + "Description": "Specifies the field that provides data to be used for sizing bubble markers. Setting this option makes sense only if the layer type is \"marker\" and the elementType is \"bubble\"." }, "sizeGroups": { "ItemPrimitiveTypes": [ @@ -43442,13 +41760,13 @@ ], "IsCollection": true, "SingularName": "sizeGroup", - "DocID": "dxVectorMap.Options.layers.sizeGroups" + "Description": "Allows you to display bubbles with similar attributes in the same size. Setting this option makes sense only if the layer type is \"marker\" and the elementType is \"bubble\"." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.layers.type" + "Description": "Specifies layer type." } } }, @@ -43458,52 +41776,52 @@ ], "IsCollection": true, "SingularName": "legend", - "DocID": "dxVectorMap.Options.legends", + "Description": "Configures map legends.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.backgroundColor" + "Description": "Colors the legend's background." }, "border": { - "DocID": "BaseLegend.border", + "Description": "Configures the legend's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.border.color" + "Description": "Colors the legend's border." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.cornerRadius" + "Description": "Makes all the legend's corners rounded." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.border.dashStyle" + "Description": "Sets a dash style for the legend's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.opacity" + "Description": "Specifies the transparency of the legend's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseLegend.border.visible" + "Description": "Shows the legend's border." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.border.width" + "Description": "Specifies the width of the legend's border in pixels." } } }, @@ -43511,97 +41829,91 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.columnCount" + "Description": "Arranges legend items into several columns." }, "columnItemSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.columnItemSpacing" + "Description": "Specifies an empty space between item columns in pixels." }, "customizeHint": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxVectorMap.Options.legends.customizeHint" + "Description": "Specifies text for a hint that appears when a user hovers the mouse pointer over the text of a legend item." }, "customizeItems": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxVectorMap.Options.legends.customizeItems" + "Description": "Allows you to change the order and visibility of legend items." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxVectorMap.Options.legends.customizeText" + "Description": "Specifies text for legend items." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxVectorMap.Options.legends.font" + "Description": "Specifies the legend items' font options." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.horizontalAlignment" + "Description": "Along with verticalAlignment, specifies the legend's position." }, "itemsAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.itemsAlignment" + "Description": "Aligns items in the last column or row (depending on the legend's orientation). Applies when legend items are not divided into columns or rows equally." }, "itemTextPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.itemTextPosition" + "Description": "Specifies the text's position relative to the marker in a legend item." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin", + "Description": "Generates an empty space, measured in pixels, around the legend.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.bottom" + "Description": "Specifies the legend's bottom margin in pixels." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.left" + "Description": "Specifies the legend's left margin in pixels." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.right" + "Description": "Specifies the legend's right margin in pixels." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.margin.top" + "Description": "Specifies the legend's top margin in pixels." } } }, @@ -43609,71 +41921,71 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.legends.markerColor" + "Description": "Specifies the color of item markers in the legend. The specified color applied only when the legend uses 'size' source." }, "markerShape": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.legends.markerShape" + "Description": "Specifies the shape of item markers." }, "markerSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.legends.markerSize" + "Description": "Specifies the marker's size in a legend item in pixels." }, "markerTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxVectorMap.Options.legends.markerTemplate" + "Description": "Specifies an SVG element that serves as a custom legend item marker." }, "orientation": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.orientation" + "Description": "Arranges legend items vertically (in a column) or horizontally (in a row). The default value is \"horizontal\" if the legend.horizontalAlignment is \"center\". Otherwise, it is \"vertical\"." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between the legend's left/right border and its items." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between the legend's top/bottom border and its items." }, "rowCount": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.rowCount" + "Description": "Arranges legend items in several rows." }, "rowItemSpacing": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.rowItemSpacing" + "Description": "Specifies an empty space between item rows in pixels." }, "source": { - "DocID": "dxVectorMap.Options.legends.source", + "Description": "Specifies the source of data for the legend.", "Options": { "grouping": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.legends.source.grouping" + "Description": "Specifies the type of the legend grouping." }, "layer": { "PrimitiveTypes": [ "string" ], - "DocID": "dxVectorMap.Options.legends.source.layer" + "Description": "Specifies a layer to which the legend belongs." } } }, @@ -43681,7 +41993,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title", + "Description": "Configures the legend title.", "Options": { "font": { "PrimitiveTypes": [ @@ -43690,47 +42002,40 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseLegend.title.font" + "Description": "Specifies the legend title's font options." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.horizontalAlignment" + "Description": "Along with verticalAlignment, specifies the legend title's position." }, "margin": { - "DocID": "BaseLegend.title.margin", + "Description": "Generates space around the legend title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.bottom" + "Description": "Specifies the legend title's bottom margin." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.left" + "Description": "Specifies the legend title's left margin." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.right" + "Description": "Specifies the legend title's right margin." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.margin.top" + "Description": "Specifies the legend title's top margin." } } }, @@ -43738,13 +42043,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the legend title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.subtitle", + "Description": "Configures the legend subtitle. The subtitle appears only if the title is specified.", "Options": { "font": { "PrimitiveTypes": [ @@ -43753,26 +42058,19 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseLegend.title.subtitle.font" + "Description": "Specifies the legend subtitle's font options." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseLegend.title.subtitle.offset" + "Description": "Specifies the distance between the legend's title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.subtitle.text" + "Description": "Specifies the subtitle's text." } } }, @@ -43780,13 +42078,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.text" + "Description": "Specifies the legend title's text." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.title.verticalAlignment" + "Description": "Specifies the legend title's vertical alignment." } } }, @@ -43794,58 +42092,52 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseLegend.verticalAlignment" + "Description": "Along with horizontalAlignment, specifies the legend's position." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseLegend.visible" + "Description": "Specifies the legend's visibility." } } }, "loadingIndicator": { - "DocID": "BaseWidget.Options.loadingIndicator", + "Description": "Configures the loading indicator.", "Options": { "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.backgroundColor" + "Description": "Colors the background of the loading indicator." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.loadingIndicator.enabled" + "Description": "Specifies whether the loading indicator should be displayed and hidden automatically." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.loadingIndicator.font" + "Description": "Specifies font options for the loading indicator." }, "show": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "BaseWidget.Options.loadingIndicator.show" + "Description": "Allows you to change the loading indicator's visibility." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.loadingIndicator.text" + "Description": "Specifies the text to be displayed by the loading indicator." } } }, @@ -43853,7 +42145,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.maxZoomFactor" + "Description": "Specifies a map's maximum zoom factor." }, "onCenterChanged": { "PrimitiveTypes": [ @@ -43861,7 +42153,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxVectorMap.Options.onCenterChanged" + "Description": "A function that is executed each time the center coordinates are changed." }, "onClick": { "PrimitiveTypes": [ @@ -43870,7 +42162,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxVectorMap.Options.onClick" + "Description": "A function that is executed when any location on the map is clicked or tapped." }, "onDisposing": { "PrimitiveTypes": [ @@ -43878,7 +42170,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onDisposing" + "Description": "A function that is executed before the widget is disposed of." }, "onDrawn": { "PrimitiveTypes": [ @@ -43886,7 +42178,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onDrawn" + "Description": "A function that is executed when the widget's rendering has finished." }, "onExported": { "PrimitiveTypes": [ @@ -43894,7 +42186,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExported" + "Description": "A function that is executed after the widget is exported." }, "onExporting": { "PrimitiveTypes": [ @@ -43902,7 +42194,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onExporting" + "Description": "A function that is executed before the widget is exported." }, "onFileSaving": { "PrimitiveTypes": [ @@ -43910,7 +42202,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onFileSaving" + "Description": "A function that is executed before a file with exported widget is saved to the user's local storage." }, "onIncidentOccurred": { "PrimitiveTypes": [ @@ -43918,7 +42210,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "BaseWidget.Options.onIncidentOccurred" + "Description": "A function that is executed when an error or warning occurs." }, "onInitialized": { "PrimitiveTypes": [ @@ -43926,7 +42218,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "Component.Options.onInitialized" + "Description": "A function used in JavaScript frameworks to save the widget instance." }, "onOptionChanged": { "PrimitiveTypes": [ @@ -43934,7 +42226,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "DOMComponent.Options.onOptionChanged" + "Description": "A function that is executed after a widget option is changed." }, "onSelectionChanged": { "PrimitiveTypes": [ @@ -43942,7 +42234,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxVectorMap.Options.onSelectionChanged" + "Description": "A function that is executed when a layer element is selected or selection is canceled." }, "onTooltipHidden": { "PrimitiveTypes": [ @@ -43950,7 +42242,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxVectorMap.Options.onTooltipHidden" + "Description": "A function that is executed when a tooltip becomes hidden." }, "onTooltipShown": { "PrimitiveTypes": [ @@ -43958,7 +42250,7 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxVectorMap.Options.onTooltipShown" + "Description": "A function that is executed when a tooltip appears." }, "onZoomFactorChanged": { "PrimitiveTypes": [ @@ -43966,19 +42258,19 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxVectorMap.Options.onZoomFactorChanged" + "Description": "A function that is executed each time the zoom factor is changed." }, "panningEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxVectorMap.Options.panningEnabled" + "Description": "Disables the panning capability." }, "pathModified": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.pathModified" + "Description": "Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path." }, "projection": { "PrimitiveTypes": [ @@ -43989,41 +42281,34 @@ "ComplexTypes": [ "VectorMapProjectionConfig" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxVectorMap.Options.projection" + "Description": "Specifies the map projection." }, "redrawOnResize": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.redrawOnResize" + "Description": "Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates." }, "rtlEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.rtlEnabled" + "Description": "Switches the widget to a right-to-left representation." }, "size": { - "DocID": "BaseWidget.Options.size", + "Description": "Specifies the widget's size in pixels.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.height" + "Description": "Specifies the height of the widget in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.size.width" + "Description": "Specifies the width of the widget in pixels." } } }, @@ -44031,64 +42316,58 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.theme" + "Description": "Sets the name of the theme the widget uses." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title", + "Description": "Configures the widget's title.", "Options": { "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.title.font" + "Description": "Specifies font options for the title." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.horizontalAlignment" + "Description": "Specifies the title's alignment in a horizontal direction." }, "margin": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin", + "Description": "Generates space around the title.", "Options": { "bottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.bottom" + "Description": "Specifies the bottom margin of the title." }, "left": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.left" + "Description": "Specifies the left margin of the title." }, "right": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.right" + "Description": "Specifies the right margin of the title." }, "top": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.margin.top" + "Description": "Specifies the top margin of the title." } } }, @@ -44096,13 +42375,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.placeholderSize" + "Description": "Reserves a pixel-measured space for the title." }, "subtitle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle", + "Description": "Configures the widget's subtitle.", "Options": { "font": { "PrimitiveTypes": [ @@ -44111,38 +42390,31 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "BaseWidget.Options.title.subtitle.font" + "Description": "Specifies font options for the subtitle." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.title.subtitle.offset" + "Description": "Specifies the distance between the title and subtitle in pixels." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.text" + "Description": "Specifies text for the subtitle." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.textOverflow" + "Description": "Specifies what to do with the subtitle when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.subtitle.wordWrap" + "Description": "Specifies how to wrap the subtitle if it does not fit into a single line." } } }, @@ -44150,69 +42422,69 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.text" + "Description": "Specifies the title's text." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.textOverflow" + "Description": "Specifies what to do with the title when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.verticalAlignment" + "Description": "Specifies the title's alignment in a vertical direction." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.title.wordWrap" + "Description": "Specifies how to wrap the title if it does not fit into a single line." } } }, "tooltip": { - "DocID": "dxVectorMap.Options.tooltip", + "Description": "Configures tooltips.", "Options": { "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.arrowLength" + "Description": "Specifies the length of a tooltip's arrow in pixels." }, "border": { - "DocID": "BaseWidget.Options.tooltip.border", + "Description": "Configures a tooltip's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.color" + "Description": "Colors a tooltip's border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.border.dashStyle" + "Description": "Specifies the dash style of a tooltip's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.opacity" + "Description": "Specifies the transparency of a tooltip's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.border.visible" + "Description": "Specifies whether a tooltip's border is visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.border.width" + "Description": "Specifies the width of a tooltip's border in pixels." } } }, @@ -44220,7 +42492,7 @@ "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.color" + "Description": "Colors all tooltips." }, "container": { "PrimitiveTypes": [ @@ -44228,99 +42500,93 @@ "JQuery", "string" ], - "DocID": "BaseWidget.Options.tooltip.container" + "Description": "Specifies the container in which to draw tooltips. The default container is the HTML DOM `` element." }, "contentTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxVectorMap.Options.tooltip.contentTemplate" + "Description": "Specifies a custom template for a tooltip." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.cornerRadius" + "Description": "Makes all the tooltip's corners rounded." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxVectorMap.Options.tooltip.customizeTooltip" + "Description": "Specifies text and appearance of a set of tooltips." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "BaseWidget.Options.tooltip.enabled" + "Description": "Enables tooltips." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "BaseWidget.Options.tooltip.font" + "Description": "Specifies tooltips' font options." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.opacity" + "Description": "Specifies tooltips' transparency." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingLeftRight" + "Description": "Generates an empty space, measured in pixels, between a tooltip's left/right border and its text." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.paddingTopBottom" + "Description": "Generates an empty space, measured in pixels, between a tooltip's top/bottom border and its text." }, "shadow": { - "DocID": "BaseWidget.Options.tooltip.shadow", + "Description": "Configures a tooltip's shadow.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.blur" + "Description": "Specifies the blur distance of a tooltip's shadow. The larger the value, the blurrier the shadow's edge." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "BaseWidget.Options.tooltip.shadow.color" + "Description": "Colors a tooltip's shadow." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetX" + "Description": "Specifies the horizontal offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.offsetY" + "Description": "Specifies the vertical offset of a tooltip's shadow relative to the tooltip itself. Measured in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.shadow.opacity" + "Description": "Specifies the transparency of a tooltip's shadow." } } }, @@ -44328,7 +42594,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "BaseWidget.Options.tooltip.zIndex" + "Description": "Specifies a tooltip's z-index." } } }, @@ -44336,63 +42602,63 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxVectorMap.Options.touchEnabled" + "Description": "Specifies whether the map should respond to touch gestures." }, "wheelEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxVectorMap.Options.wheelEnabled" + "Description": "Specifies whether or not the map should respond when a user rolls the mouse wheel." }, "zoomFactor": { "PrimitiveTypes": [ "number" ], - "DocID": "dxVectorMap.Options.zoomFactor" + "Description": "Specifies a number that is used to zoom a map initially." }, "zoomingEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxVectorMap.Options.zoomingEnabled" + "Description": "Disables the zooming capability." } } } }, "ExtraObjects": { "AnimationConfig": { - "DocID": "animationConfig", + "Description": "Defines animation options.", "Options": { "complete": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "animationConfig.complete" + "Description": "A function called after animation is completed." }, "delay": { "PrimitiveTypes": [ "number" ], - "DocID": "animationConfig.delay" + "Description": "A number specifying wait time before animation execution." }, "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "animationConfig.direction" + "Description": "Specifies the animation direction for the \"slideIn\" and \"slideOut\" animation types." }, "duration": { "PrimitiveTypes": [ "number" ], - "DocID": "animationConfig.duration" + "Description": "A number specifying the time in milliseconds spent on animation." }, "easing": { "PrimitiveTypes": [ "string" ], - "DocID": "animationConfig.easing" + "Description": "A string specifying the easing function for animation." }, "from": { "PrimitiveTypes": [ @@ -44400,20 +42666,20 @@ "number", "string" ], - "DocID": "animationConfig.from" + "Description": "Specifies the initial animation state." }, "staggerDelay": { "PrimitiveTypes": [ "number" ], - "DocID": "animationConfig.staggerDelay" + "Description": "A number specifying the time period to wait before the animation of the next stagger item starts." }, "start": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "animationConfig.start" + "Description": "A function called before animation is started." }, "to": { "PrimitiveTypes": [ @@ -44421,76 +42687,76 @@ "number", "string" ], - "DocID": "animationConfig.to" + "Description": "Specifies a final animation state." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "animationConfig.type" + "Description": "A string value specifying the animation type." } } }, "AsyncRule": { - "DocID": "AsyncRule", + "Description": "A custom validation rule that is checked asynchronously. Use async rules for server-side validation.", "Options": { "ignoreEmptyValue": { "PrimitiveTypes": [ "boolean" ], - "DocID": "AsyncRule.ignoreEmptyValue" + "Description": "If true, the validationCallback is not executed for null, undefined, false, and empty strings." }, "message": { "PrimitiveTypes": [ "string" ], - "DocID": "AsyncRule.message" + "Description": "Specifies the message that is shown if the rule is broken." }, "reevaluate": { "PrimitiveTypes": [ "boolean" ], - "DocID": "AsyncRule.reevaluate" + "Description": "Indicates whether the rule should always be checked for the target value or only when the value changes." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "AsyncRule.type" + "Description": "Specifies the rule type. Set it to \"async\" to use the AsyncRule." }, "validationCallback": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "AsyncRule.validationCallback" + "Description": "A function that validates the target value." } } }, "ChartCommonSeriesSettings": { - "DocID": "ChartCommonSeriesSettings", + "Description": "Specifies settings common for all series in the chart.", "Options": { "aggregation": { - "DocID": "dxChartSeriesTypes.CommonSeries.aggregation", + "Description": "Configures data aggregation for the series.", "Options": { "calculate": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChartSeriesTypes.CommonSeries.aggregation.calculate" + "Description": "Specifies a custom aggregate function. Applies only if the aggregation method is \"custom\"." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.aggregation.enabled" + "Description": "Enables data aggregation for the series." }, "method": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.aggregation.method" + "Description": "Specifies how to aggregate series points." } } }, @@ -44501,19 +42767,19 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.area" + "Description": "Defines common settings for all area series." }, "argumentField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.argumentField" + "Description": "Specifies which data source field provides arguments for series points." }, "axis": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.axis" + "Description": "Binds the series to a value axis." }, "bar": { "PrimitiveTypes": [ @@ -44522,52 +42788,52 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.bar" + "Description": "Defines common settings for all bar series." }, "barOverlapGroup": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.barOverlapGroup" + "Description": "Allows you to group bar series so that bars with the same argument overlap." }, "barPadding": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.barPadding" + "Description": "Controls the padding and consequently the width of all bars in a series using relative units. Ignored if the barWidth option is set." }, "barWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.barWidth" + "Description": "Specifies a fixed width for all bars in a series, measured in pixels. Takes precedence over the barPadding option." }, "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.border", + "Description": "Configures the series border (in area-like series) or the series point border (in bar-like and bubble series).", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.border.color" + "Description": "Colors the series border (in area-like series) or the series point border (in bar-like and bubble series)." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.border.dashStyle" + "Description": "Sets a dash style for the series border (in area-like series) or for the series point border (in bar-like and bubble series)." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.border.visible" + "Description": "Shows the series border (in area-like series) or the series point border (in bar-like and bubble series)." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.border.width" + "Description": "Sets a pixel-measured width for the series border (in area-like series) or for the series point border (in bar-like and bubble series)." } } }, @@ -44578,7 +42844,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.bubble" + "Description": "Defines common settings for all bubble series." }, "candlestick": { "PrimitiveTypes": [ @@ -44587,31 +42853,31 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.candlestick" + "Description": "Defines common settings for all candlestick series." }, "closeValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.closeValueField" + "Description": "Specifies which data source field provides close values for points of a financial series." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.color" + "Description": "Specifies the color of the series." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.cornerRadius" + "Description": "Makes bars look rounded. Applies only to bar-like series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.dashStyle" + "Description": "Specifies the dash style of the series line. Applies only to line-like series." }, "fullstackedarea": { "PrimitiveTypes": [ @@ -44620,7 +42886,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.fullstackedarea" + "Description": "Defines common settings for all full-stacked area series." }, "fullstackedbar": { "PrimitiveTypes": [ @@ -44629,7 +42895,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.fullstackedbar" + "Description": "Defines common settings for all full-stacked bar series." }, "fullstackedline": { "PrimitiveTypes": [ @@ -44638,7 +42904,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.fullstackedline" + "Description": "Defines common settings for all full-stacked line series." }, "fullstackedspline": { "PrimitiveTypes": [ @@ -44647,7 +42913,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.fullstackedspline" + "Description": "Defines common settings for all full-stacked spline series." }, "fullstackedsplinearea": { "PrimitiveTypes": [ @@ -44656,49 +42922,49 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.fullstackedsplinearea" + "Description": "Defines common settings for all full-stacked spline area series." }, "highValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.highValueField" + "Description": "Specifies which data source field provides high values for points of a financial series." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverMode" + "Description": "Specifies series elements to be highlighted when a user points to a series." }, "hoverStyle": { - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle", + "Description": "Configures the appearance adopted by the series when a user points to it.", "Options": { "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.border", + "Description": "Configures the appearance adopted by the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user points to the series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.border.color" + "Description": "Colors the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user points to the series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.border.dashStyle" + "Description": "Sets a dash style for the series border (in area-like series) or for the series point border (in bar-like and bubble series) when a user points to the series." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.border.visible" + "Description": "Shows the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user points to the series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.border.width" + "Description": "Sets a pixel-measured width for the series border (in area-like series) or for the series point border (in bar-like and bubble series) when a user points to the series." } } }, @@ -44706,40 +42972,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.color" + "Description": "Specifies the color of the series in the hovered state." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.dashStyle" + "Description": "Specifies the dash style of the series line when the series is in the hovered state. Applies only to line-like series." }, "hatching": { - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.hatching", + "Description": "Configures hatching that applies when a user points to the series.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.hatching.direction" + "Description": "Specifies the direction of hatching lines." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.hatching.opacity" + "Description": "Specifies how transparent hatching lines should be." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.hatching.step" + "Description": "Specifies the distance between two side-by-side hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.hatching.width" + "Description": "Specifies the width of hatching lines in pixels." } } }, @@ -44747,7 +43013,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.width" + "Description": "Specifies the pixel-measured width of the series line when the series is in the hovered state." } } }, @@ -44755,94 +43021,88 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.ignoreEmptyPoints" + "Description": "Specifies whether the series should ignore null data points." }, "innerColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.innerColor" + "Description": "Specifies a filling color for the body of a series point that visualizes a non-reduced value. Applies only to candlestick series." }, "label": { - "DocID": "dxChartSeriesTypes.CommonSeries.label", + "Description": "Configures point labels.", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.alignment" + "Description": "Aligns point labels in relation to their points." }, "argumentFormat": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.argumentFormat" + "Description": "Formats the point argument before it is displayed in the point label. To format the point value, use the format option." }, "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.backgroundColor" + "Description": "Colors the point labels' background. The default color is inherited from the points." }, "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.label.border", + "Description": "Configures the borders of point labels.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.border.color" + "Description": "Colors the border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.border.dashStyle" + "Description": "Specifies the dash style of the border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.border.visible" + "Description": "Makes the border visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.border.width" + "Description": "Specifies the width of the border in pixels." } } }, "connector": { - "DocID": "dxChartSeriesTypes.CommonSeries.label.connector", + "Description": "Configures the label connectors.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.connector.color" + "Description": "Colors the connectors." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.connector.visible" + "Description": "Makes the connectors visible. Applies only if label.visible is set to true." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.connector.width" + "Description": "Specifies the width of the connectors in pixels." } } }, @@ -44851,74 +43111,62 @@ "Function" ], "IsFunc": true, - "DocID": "dxChartSeriesTypes.CommonSeries.label.customizeText" + "Description": "Customizes the text displayed by point labels." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.font" + "Description": "Specifies font options for point labels." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.format" + "Description": "Formats the point value before it will be displayed in the point label." }, "horizontalOffset": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.horizontalOffset" + "Description": "Along with verticalOffset, shifts point labels from their initial positions." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.position" + "Description": "Specifies whether to display point labels inside or outside of series points. Applies only to bubble, range-like and bar-like series." }, "rotationAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.rotationAngle" + "Description": "Rotates point labels." }, "showForZeroValues": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.showForZeroValues" + "Description": "Specifies whether or not to show labels for points with zero value. Applies only to bar-like series." }, "verticalOffset": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.verticalOffset" + "Description": "Along with horizontalOffset, shifts point labels from their initial positions." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.visible" + "Description": "Makes the point labels visible." } } }, @@ -44929,67 +43177,67 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.line" + "Description": "Defines common settings for all line series." }, "lowValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.lowValueField" + "Description": "Specifies which data source field provides low values for points of a financial series." }, "maxLabelCount": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.maxLabelCount" + "Description": "Specifies a limit for the number of point labels." }, "minBarSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.minBarSize" + "Description": "Specifies the minimal possible height (or length if the chart is rotated) of a bar in pixels. Applies only to bar-like series." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.opacity" + "Description": "Specifies how transparent the series should be." }, "openValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.openValueField" + "Description": "Specifies which data source field provides open values for points of a financial series." }, "pane": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.pane" + "Description": "Specifies which pane the series should belong to. Accepts the name of the pane." }, "point": { - "DocID": "dxChartSeriesTypes.CommonSeries.point", + "Description": "Configures series points in scatter, line- and area-like series.", "Options": { "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.point.border", + "Description": "Configures the appearance of the series point border in scatter, line- and area-like series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.border.color" + "Description": "Colors the border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.border.visible" + "Description": "Makes the border visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.border.width" + "Description": "Sets the width of the border in pixels." } } }, @@ -44997,37 +43245,37 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.color" + "Description": "Colors the series points." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverMode" + "Description": "Specifies series elements to be highlighted when a user pauses on a series point." }, "hoverStyle": { - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle", + "Description": "Configures the appearance adopted by a series point when a user pauses on it.", "Options": { "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle.border", + "Description": "Configures the appearance of the point border when a user pauses on the point.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle.border.color" + "Description": "Specifies the color of the point border when the point is in the hovered state." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle.border.visible" + "Description": "Makes the border visible when a user pauses on the series point." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle.border.width" + "Description": "Specifies the width of the point border when the point is in the hovered state." } } }, @@ -45035,13 +43283,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle.color" + "Description": "Specifies the color of series points in the hovered state." }, "size": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle.size" + "Description": "Specfies the diameter of series points in the hovered state." } } }, @@ -45049,25 +43297,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image", + "Description": "Substitutes the standard point symbols with an image.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.height", + "Description": "Specifies the height of the image used instead of a point marker.", "Options": { "rangeMaxPoint": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.height.rangeMaxPoint" + "Description": "Specifies the height of the image that represents the maximum point in a range area series." }, "rangeMinPoint": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.height.rangeMinPoint" + "Description": "Specifies the height of the image that represents the minimum point in a range area series." } } }, @@ -45075,19 +43323,19 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.url", + "Description": "Specifies the URL of the image to be used as a point marker.", "Options": { "rangeMaxPoint": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.url.rangeMaxPoint" + "Description": "Specifies the URL of the image to be used as a maximum point marker." }, "rangeMinPoint": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.url.rangeMinPoint" + "Description": "Specifies the URL of the image to be used as a maximum point marker." } } }, @@ -45095,19 +43343,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.width", + "Description": "Specifies the width of an image that is used as a point marker.", "Options": { "rangeMaxPoint": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.width.rangeMaxPoint" + "Description": "Specifies the width of the image that represents the maximum point in a range area series." }, "rangeMinPoint": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.width.rangeMinPoint" + "Description": "Specifies the width of the image that represents the minimum point in a range area series." } } } @@ -45117,31 +43365,31 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionMode" + "Description": "Specifies series elements to be highlighted when a user selects a series point." }, "selectionStyle": { - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle", + "Description": "Configures the appearance of a selected series point.", "Options": { "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle.border", + "Description": "Configures the border of a selected point.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle.border.color" + "Description": "Specifies the color of the point border when the point is selected." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle.border.visible" + "Description": "Makes the border of a selected point visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle.border.width" + "Description": "Specifies the width of the point border when the point is selected." } } }, @@ -45149,13 +43397,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle.color" + "Description": "Specifies the color of series points in the selected state." }, "size": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle.size" + "Description": "Specfies the diameter of series points in the selected state." } } }, @@ -45163,19 +43411,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.size" + "Description": "Specifies the diameter of series points in pixels." }, "symbol": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.symbol" + "Description": "Specifies which symbol should represent series points in scatter, line- and area-like series." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.visible" + "Description": "Makes the series points visible." } } }, @@ -45186,7 +43434,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.rangearea" + "Description": "Defines common settings for all range area series." }, "rangebar": { "PrimitiveTypes": [ @@ -45195,34 +43443,34 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.rangebar" + "Description": "Defines common settings for all range bar series." }, "rangeValue1Field": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.rangeValue1Field" + "Description": "Coupled with the rangeValue2Field option, specifies which data source field provides values for a range-like series." }, "rangeValue2Field": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.rangeValue2Field" + "Description": "Coupled with the rangeValue1Field option, specifies which data source field provides values for a range-like series." }, "reduction": { - "DocID": "dxChartSeriesTypes.CommonSeries.reduction", + "Description": "Specifies reduction options for financial series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.reduction.color" + "Description": "Specifies a color for the points whose price has decreased in comparison to the price of the previous point." }, "level": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.reduction.level" + "Description": "Specifies whether high, low, open or close prices of points should be compared." } } }, @@ -45233,43 +43481,43 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.scatter" + "Description": "Defines common settings for all scatter series." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionMode" + "Description": "Specifies series elements to be highlighted when a user selects a series." }, "selectionStyle": { - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle", + "Description": "Configures the appearance adopted by the series when a user selects it.", "Options": { "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.border", + "Description": "Configures the appearance adopted by the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user selects the series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.border.color" + "Description": "Colors the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user selects the series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.border.dashStyle" + "Description": "Sets a dash style for the series border (in area-like series) or for the series point border (in bar-like and bubble series) when a user selects the series." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.border.visible" + "Description": "Shows the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user selects the series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.border.width" + "Description": "Sets a pixel-measured width for the series border (in area-like series) or for the series point border (in bar-like and bubble series) when a user selects the series." } } }, @@ -45277,40 +43525,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.color" + "Description": "Specifies the color of the series in the selected state." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.dashStyle" + "Description": "Specifies the dash style of the series line when the series is in the selected state. Applies only to line-like series." }, "hatching": { - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.hatching", + "Description": "Configures hatching that applies when a user selects the series.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.hatching.direction" + "Description": "Specifies the direction of hatching lines." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.hatching.opacity" + "Description": "Specifies how transparent hatching lines should be." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.hatching.step" + "Description": "Specifies the distance between two side-by-side hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.hatching.width" + "Description": "Specifies the width of hatching lines in pixels." } } }, @@ -45318,7 +43566,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.width" + "Description": "Specifies the pixel-measured width of the series line when the series is in the selected state." } } }, @@ -45326,13 +43574,13 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.showInLegend" + "Description": "Specifies whether to show the series in the legend or not." }, "sizeField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.sizeField" + "Description": "Specifies which data source field provides size values for bubbles. Required by and applies only to bubble series." }, "spline": { "PrimitiveTypes": [ @@ -45341,7 +43589,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.spline" + "Description": "Defines common settings for all spline series." }, "splinearea": { "PrimitiveTypes": [ @@ -45350,13 +43598,13 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.splinearea" + "Description": "Defines common settings for all spline area series." }, "stack": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.stack" + "Description": "Specifies which stack the series should belongs to. Applies only to stacked bar and full-stacked bar series." }, "stackedarea": { "PrimitiveTypes": [ @@ -45365,7 +43613,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.stackedarea" + "Description": "Defines common settings for all stacked area series." }, "stackedbar": { "PrimitiveTypes": [ @@ -45374,7 +43622,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.stackedbar" + "Description": "Defines common settings for all stacked bar series." }, "stackedline": { "PrimitiveTypes": [ @@ -45383,7 +43631,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.stackedline" + "Description": "Defines common settings for all stacked line series." }, "stackedspline": { "PrimitiveTypes": [ @@ -45392,7 +43640,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.stackedspline" + "Description": "Defines common settings for all stacked spline series." }, "stackedsplinearea": { "PrimitiveTypes": [ @@ -45401,7 +43649,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.stackedsplinearea" + "Description": "Defines common settings for all stacked spline area series." }, "steparea": { "PrimitiveTypes": [ @@ -45410,7 +43658,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.steparea" + "Description": "Defines common settings for all step area series." }, "stepline": { "PrimitiveTypes": [ @@ -45419,7 +43667,7 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.stepline" + "Description": "Defines common settings for all step line series." }, "stock": { "PrimitiveTypes": [ @@ -45428,76 +43676,76 @@ "ComplexTypes": [ "ChartCommonSeriesSettings" ], - "DocID": "ChartCommonSeriesSettings.stock" + "Description": "Defines common settings for all stock series." }, "tagField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.tagField" + "Description": "Specifies which data source field provides auxiliary data for series points." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "ChartCommonSeriesSettings.type" + "Description": "Specifies the type of the series." }, "valueErrorBar": { - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar", + "Description": "Configures error bars.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.color" + "Description": "Specifies the color of error bars." }, "displayMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.displayMode" + "Description": "Specifies whether error bars must be displayed in full or partially." }, "edgeLength": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.edgeLength" + "Description": "Specifies the length of the lines that indicate error bar edges." }, "highValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.highValueField" + "Description": "Specifies which data field provides high error values." }, "lineWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.lineWidth" + "Description": "Specifies the width of the error bar line." }, "lowValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.lowValueField" + "Description": "Specifies which data field provides low error values." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.opacity" + "Description": "Specifies how trasparent error bars should be." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.type" + "Description": "Specifies how error bar values must be calculated." }, "value": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.value" + "Description": "Specifies the value to be used for generating error bars." } } }, @@ -45505,47 +43753,47 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueField" + "Description": "Specifies which data source field provides values for series points." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.visible" + "Description": "Specifies whether the series is visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.width" + "Description": "Specifies the width of the series line in pixels. Applies only to line-like series." } } }, "ChartSeries": { - "DocID": "ChartSeries", + "Description": "Specifies options for Chart widget series.", "IsCollection": true, "Options": { "aggregation": { - "DocID": "dxChartSeriesTypes.CommonSeries.aggregation", + "Description": "Configures data aggregation for the series.", "Options": { "calculate": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChartSeriesTypes.CommonSeries.aggregation.calculate" + "Description": "Specifies a custom aggregate function. Applies only if the aggregation method is \"custom\"." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.aggregation.enabled" + "Description": "Enables data aggregation for the series." }, "method": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.aggregation.method" + "Description": "Specifies how to aggregate series points." } } }, @@ -45553,58 +43801,58 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.argumentField" + "Description": "Specifies which data source field provides arguments for series points." }, "axis": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.axis" + "Description": "Binds the series to a value axis." }, "barOverlapGroup": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.barOverlapGroup" + "Description": "Allows you to group bar series so that bars with the same argument overlap." }, "barPadding": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.barPadding" + "Description": "Controls the padding and consequently the width of all bars in a series using relative units. Ignored if the barWidth option is set." }, "barWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.barWidth" + "Description": "Specifies a fixed width for all bars in a series, measured in pixels. Takes precedence over the barPadding option." }, "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.border", + "Description": "Configures the series border (in area-like series) or the series point border (in bar-like and bubble series).", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.border.color" + "Description": "Colors the series border (in area-like series) or the series point border (in bar-like and bubble series)." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.border.dashStyle" + "Description": "Sets a dash style for the series border (in area-like series) or for the series point border (in bar-like and bubble series)." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.border.visible" + "Description": "Shows the series border (in area-like series) or the series point border (in bar-like and bubble series)." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.border.width" + "Description": "Sets a pixel-measured width for the series border (in area-like series) or for the series point border (in bar-like and bubble series)." } } }, @@ -45612,67 +43860,67 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.closeValueField" + "Description": "Specifies which data source field provides close values for points of a financial series." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.color" + "Description": "Specifies the color of the series." }, "cornerRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.cornerRadius" + "Description": "Makes bars look rounded. Applies only to bar-like series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.dashStyle" + "Description": "Specifies the dash style of the series line. Applies only to line-like series." }, "highValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.highValueField" + "Description": "Specifies which data source field provides high values for points of a financial series." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverMode" + "Description": "Specifies series elements to be highlighted when a user points to a series." }, "hoverStyle": { - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle", + "Description": "Configures the appearance adopted by the series when a user points to it.", "Options": { "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.border", + "Description": "Configures the appearance adopted by the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user points to the series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.border.color" + "Description": "Colors the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user points to the series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.border.dashStyle" + "Description": "Sets a dash style for the series border (in area-like series) or for the series point border (in bar-like and bubble series) when a user points to the series." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.border.visible" + "Description": "Shows the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user points to the series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.border.width" + "Description": "Sets a pixel-measured width for the series border (in area-like series) or for the series point border (in bar-like and bubble series) when a user points to the series." } } }, @@ -45680,40 +43928,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.color" + "Description": "Specifies the color of the series in the hovered state." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.dashStyle" + "Description": "Specifies the dash style of the series line when the series is in the hovered state. Applies only to line-like series." }, "hatching": { - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.hatching", + "Description": "Configures hatching that applies when a user points to the series.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.hatching.direction" + "Description": "Specifies the direction of hatching lines." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.hatching.opacity" + "Description": "Specifies how transparent hatching lines should be." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.hatching.step" + "Description": "Specifies the distance between two side-by-side hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.hatching.width" + "Description": "Specifies the width of hatching lines in pixels." } } }, @@ -45721,7 +43969,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.hoverStyle.width" + "Description": "Specifies the pixel-measured width of the series line when the series is in the hovered state." } } }, @@ -45729,94 +43977,88 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.ignoreEmptyPoints" + "Description": "Specifies whether the series should ignore null data points." }, "innerColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.innerColor" + "Description": "Specifies a filling color for the body of a series point that visualizes a non-reduced value. Applies only to candlestick series." }, "label": { - "DocID": "dxChartSeriesTypes.CommonSeries.label", + "Description": "Configures point labels.", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.alignment" + "Description": "Aligns point labels in relation to their points." }, "argumentFormat": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.argumentFormat" + "Description": "Formats the point argument before it is displayed in the point label. To format the point value, use the format option." }, "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.backgroundColor" + "Description": "Colors the point labels' background. The default color is inherited from the points." }, "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.label.border", + "Description": "Configures the borders of point labels.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.border.color" + "Description": "Colors the border." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.border.dashStyle" + "Description": "Specifies the dash style of the border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.border.visible" + "Description": "Makes the border visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.border.width" + "Description": "Specifies the width of the border in pixels." } } }, "connector": { - "DocID": "dxChartSeriesTypes.CommonSeries.label.connector", + "Description": "Configures the label connectors.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.connector.color" + "Description": "Colors the connectors." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.connector.visible" + "Description": "Makes the connectors visible. Applies only if label.visible is set to true." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.connector.width" + "Description": "Specifies the width of the connectors in pixels." } } }, @@ -45825,74 +44067,62 @@ "Function" ], "IsFunc": true, - "DocID": "dxChartSeriesTypes.CommonSeries.label.customizeText" + "Description": "Customizes the text displayed by point labels." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.font" + "Description": "Specifies font options for point labels." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.format" + "Description": "Formats the point value before it will be displayed in the point label." }, "horizontalOffset": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.horizontalOffset" + "Description": "Along with verticalOffset, shifts point labels from their initial positions." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.position" + "Description": "Specifies whether to display point labels inside or outside of series points. Applies only to bubble, range-like and bar-like series." }, "rotationAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.rotationAngle" + "Description": "Rotates point labels." }, "showForZeroValues": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.showForZeroValues" + "Description": "Specifies whether or not to show labels for points with zero value. Applies only to bar-like series." }, "verticalOffset": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.verticalOffset" + "Description": "Along with horizontalOffset, shifts point labels from their initial positions." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.label.visible" + "Description": "Makes the point labels visible." } } }, @@ -45900,67 +44130,67 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.lowValueField" + "Description": "Specifies which data source field provides low values for points of a financial series." }, "maxLabelCount": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.maxLabelCount" + "Description": "Specifies a limit for the number of point labels." }, "minBarSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.minBarSize" + "Description": "Specifies the minimal possible height (or length if the chart is rotated) of a bar in pixels. Applies only to bar-like series." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "ChartSeries.name" + "Description": "Specifies the name that identifies the series." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.opacity" + "Description": "Specifies how transparent the series should be." }, "openValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.openValueField" + "Description": "Specifies which data source field provides open values for points of a financial series." }, "pane": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.pane" + "Description": "Specifies which pane the series should belong to. Accepts the name of the pane." }, "point": { - "DocID": "dxChartSeriesTypes.CommonSeries.point", + "Description": "Configures series points in scatter, line- and area-like series.", "Options": { "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.point.border", + "Description": "Configures the appearance of the series point border in scatter, line- and area-like series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.border.color" + "Description": "Colors the border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.border.visible" + "Description": "Makes the border visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.border.width" + "Description": "Sets the width of the border in pixels." } } }, @@ -45968,37 +44198,37 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.color" + "Description": "Colors the series points." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverMode" + "Description": "Specifies series elements to be highlighted when a user pauses on a series point." }, "hoverStyle": { - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle", + "Description": "Configures the appearance adopted by a series point when a user pauses on it.", "Options": { "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle.border", + "Description": "Configures the appearance of the point border when a user pauses on the point.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle.border.color" + "Description": "Specifies the color of the point border when the point is in the hovered state." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle.border.visible" + "Description": "Makes the border visible when a user pauses on the series point." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle.border.width" + "Description": "Specifies the width of the point border when the point is in the hovered state." } } }, @@ -46006,13 +44236,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle.color" + "Description": "Specifies the color of series points in the hovered state." }, "size": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.hoverStyle.size" + "Description": "Specfies the diameter of series points in the hovered state." } } }, @@ -46020,25 +44250,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image", + "Description": "Substitutes the standard point symbols with an image.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.height", + "Description": "Specifies the height of the image used instead of a point marker.", "Options": { "rangeMaxPoint": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.height.rangeMaxPoint" + "Description": "Specifies the height of the image that represents the maximum point in a range area series." }, "rangeMinPoint": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.height.rangeMinPoint" + "Description": "Specifies the height of the image that represents the minimum point in a range area series." } } }, @@ -46046,19 +44276,19 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.url", + "Description": "Specifies the URL of the image to be used as a point marker.", "Options": { "rangeMaxPoint": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.url.rangeMaxPoint" + "Description": "Specifies the URL of the image to be used as a maximum point marker." }, "rangeMinPoint": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.url.rangeMinPoint" + "Description": "Specifies the URL of the image to be used as a maximum point marker." } } }, @@ -46066,19 +44296,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.width", + "Description": "Specifies the width of an image that is used as a point marker.", "Options": { "rangeMaxPoint": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.width.rangeMaxPoint" + "Description": "Specifies the width of the image that represents the maximum point in a range area series." }, "rangeMinPoint": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.image.width.rangeMinPoint" + "Description": "Specifies the width of the image that represents the minimum point in a range area series." } } } @@ -46088,31 +44318,31 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionMode" + "Description": "Specifies series elements to be highlighted when a user selects a series point." }, "selectionStyle": { - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle", + "Description": "Configures the appearance of a selected series point.", "Options": { "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle.border", + "Description": "Configures the border of a selected point.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle.border.color" + "Description": "Specifies the color of the point border when the point is selected." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle.border.visible" + "Description": "Makes the border of a selected point visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle.border.width" + "Description": "Specifies the width of the point border when the point is selected." } } }, @@ -46120,13 +44350,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle.color" + "Description": "Specifies the color of series points in the selected state." }, "size": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.selectionStyle.size" + "Description": "Specfies the diameter of series points in the selected state." } } }, @@ -46134,19 +44364,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.size" + "Description": "Specifies the diameter of series points in pixels." }, "symbol": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.symbol" + "Description": "Specifies which symbol should represent series points in scatter, line- and area-like series." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.point.visible" + "Description": "Makes the series points visible." } } }, @@ -46154,28 +44384,28 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.rangeValue1Field" + "Description": "Coupled with the rangeValue2Field option, specifies which data source field provides values for a range-like series." }, "rangeValue2Field": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.rangeValue2Field" + "Description": "Coupled with the rangeValue1Field option, specifies which data source field provides values for a range-like series." }, "reduction": { - "DocID": "dxChartSeriesTypes.CommonSeries.reduction", + "Description": "Specifies reduction options for financial series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.reduction.color" + "Description": "Specifies a color for the points whose price has decreased in comparison to the price of the previous point." }, "level": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.reduction.level" + "Description": "Specifies whether high, low, open or close prices of points should be compared." } } }, @@ -46183,37 +44413,37 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionMode" + "Description": "Specifies series elements to be highlighted when a user selects a series." }, "selectionStyle": { - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle", + "Description": "Configures the appearance adopted by the series when a user selects it.", "Options": { "border": { - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.border", + "Description": "Configures the appearance adopted by the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user selects the series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.border.color" + "Description": "Colors the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user selects the series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.border.dashStyle" + "Description": "Sets a dash style for the series border (in area-like series) or for the series point border (in bar-like and bubble series) when a user selects the series." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.border.visible" + "Description": "Shows the series border (in area-like series) or the series point border (in bar-like and bubble series) when a user selects the series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.border.width" + "Description": "Sets a pixel-measured width for the series border (in area-like series) or for the series point border (in bar-like and bubble series) when a user selects the series." } } }, @@ -46221,40 +44451,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.color" + "Description": "Specifies the color of the series in the selected state." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.dashStyle" + "Description": "Specifies the dash style of the series line when the series is in the selected state. Applies only to line-like series." }, "hatching": { - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.hatching", + "Description": "Configures hatching that applies when a user selects the series.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.hatching.direction" + "Description": "Specifies the direction of hatching lines." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.hatching.opacity" + "Description": "Specifies how transparent hatching lines should be." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.hatching.step" + "Description": "Specifies the distance between two side-by-side hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.hatching.width" + "Description": "Specifies the width of hatching lines in pixels." } } }, @@ -46262,7 +44492,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.selectionStyle.width" + "Description": "Specifies the pixel-measured width of the series line when the series is in the selected state." } } }, @@ -46270,94 +44500,94 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.showInLegend" + "Description": "Specifies whether to show the series in the legend or not." }, "sizeField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.sizeField" + "Description": "Specifies which data source field provides size values for bubbles. Required by and applies only to bubble series." }, "stack": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.stack" + "Description": "Specifies which stack the series should belongs to. Applies only to stacked bar and full-stacked bar series." }, "tag": { "PrimitiveTypes": [ "any" ], - "DocID": "ChartSeries.tag" + "Description": "Specifies data about a series." }, "tagField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.tagField" + "Description": "Specifies which data source field provides auxiliary data for series points." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "ChartSeries.type" + "Description": "Sets the series type." }, "valueErrorBar": { - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar", + "Description": "Configures error bars.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.color" + "Description": "Specifies the color of error bars." }, "displayMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.displayMode" + "Description": "Specifies whether error bars must be displayed in full or partially." }, "edgeLength": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.edgeLength" + "Description": "Specifies the length of the lines that indicate error bar edges." }, "highValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.highValueField" + "Description": "Specifies which data field provides high error values." }, "lineWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.lineWidth" + "Description": "Specifies the width of the error bar line." }, "lowValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.lowValueField" + "Description": "Specifies which data field provides low error values." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.opacity" + "Description": "Specifies how trasparent error bars should be." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.type" + "Description": "Specifies how error bar values must be calculated." }, "value": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueErrorBar.value" + "Description": "Specifies the value to be used for generating error bars." } } }, @@ -46365,24 +44595,24 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartSeriesTypes.CommonSeries.valueField" + "Description": "Specifies which data source field provides values for series points." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartSeriesTypes.CommonSeries.visible" + "Description": "Specifies whether the series is visible or not." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartSeriesTypes.CommonSeries.width" + "Description": "Specifies the width of the series line in pixels. Applies only to line-like series." } } }, "CompareRule": { - "DocID": "CompareRule", + "Description": "A validation rule that demands that a validated editor has a value that is equal to a specified expression.", "IsCollection": true, "Options": { "comparisonTarget": { @@ -46390,139 +44620,137 @@ "Function" ], "IsFunc": true, - "DocID": "CompareRule.comparisonTarget" + "Description": "Specifies the function whose return value is used for comparison with the validated value." }, "comparisonType": { "PrimitiveTypes": [ "string" ], - "DocID": "CompareRule.comparisonType" + "Description": "Specifies the operator to be used for comparing the validated value with the target." }, "ignoreEmptyValue": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CompareRule.ignoreEmptyValue" + "Description": "If set to true, empty values are valid." }, "message": { "PrimitiveTypes": [ "string" ], - "DocID": "CompareRule.message" + "Description": "Specifies the message that is shown if the rule is broken." }, "reevaluate": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CompareRule.reevaluate" + "Description": "Indicates whether or not the rule should be always checked for the target value or only when the target value changes." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "CompareRule.type" + "Description": "Specifies the rule type. Set it to \"compare\" to use the CompareRule." } } }, "CustomRule": { - "DocID": "CustomRule", + "Description": "A rule with custom validation logic.", "IsCollection": true, "Options": { "ignoreEmptyValue": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CustomRule.ignoreEmptyValue" + "Description": "If true, the validationCallback is not executed for null, undefined, false, and empty strings." }, "message": { "PrimitiveTypes": [ "string" ], - "DocID": "CustomRule.message" + "Description": "Specifies the message that is shown if the rule is broken." }, "reevaluate": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CustomRule.reevaluate" + "Description": "Indicates whether the rule should be always checked for the target value or only when the target value changes." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "CustomRule.type" + "Description": "Specifies the rule type. Set it to \"custom\" to use the CustomRule." }, "validationCallback": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "CustomRule.validationCallback" + "Description": "A function that validates the target value." } } }, "AccordionItem": { - "DocID": "dxAccordionItem", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxAccordionItem.icon" + "Description": "Specifies the icon to be displayed in the panel's title." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "dxAccordionItem.title" + "Description": "Specifies text displayed for the widget item title." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, "ActionSheetItem": { - "DocID": "dxActionSheetItem", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxActionSheetItem.icon" + "Description": "Specifies the icon to be displayed on the action sheet button." }, "onClick": { "PrimitiveTypes": [ @@ -46531,155 +44759,146 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxActionSheetItem.onClick" + "Description": "A handler for the click event raised for the button representing the given action sheet button." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxActionSheetItem.type" + "Description": "Specifies the type of the button that represents an action sheet item." } } }, "BoxItem": { - "DocID": "dxBoxItem", "Options": { "baseSize": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxBoxItem.baseSize" + "Description": "Specifies the base size of an item element along the main direction." }, "box": { "PrimitiveTypes": [ - "dxBoxOptions" + "DevExpress.ui.dxBoxOptions" ], "ComplexTypes": [ "dxBoxOptions" ], - "TypeImports": [ - { - "Name": "dxBoxOptions", - "Path": "ui/box" - } - ], - "DocID": "dxBoxItem.box" + "Description": "Holds a Box configuration object for the item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "ratio": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBoxItem.ratio" + "Description": "Specifies the ratio value used to count the item element size along the main direction." }, "shrink": { "PrimitiveTypes": [ "number" ], - "DocID": "dxBoxItem.shrink" + "Description": "A factor that defines how much an item shrinks relative to the rest of the items in the container." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, "ButtonGroupItem": { - "DocID": "dxButtonGroupItem", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "dxButtonGroupItem.hint" + "Description": "Specifies a text for the hint that appears when the button is hovered over or long-pressed." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxButtonGroupItem.icon" + "Description": "Specifies the icon to be displayed on the button." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxButtonGroupItem.type" + "Description": "Specifies the button type." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, "ChartAnnotationConfig": { - "DocID": "dxChartAnnotationConfig", "Options": { "allowDragging": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartCommonAnnotationConfig.allowDragging" + "Description": "Specifies whether users can drag and drop the annotation." }, "argument": { "PrimitiveTypes": [ @@ -46687,64 +44906,63 @@ "number", "string" ], - "DocID": "dxChartCommonAnnotationConfig.argument" + "Description": "Positions the annotation relative to a specific argument." }, "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.arrowLength" + "Description": "Specifies the length of the annotation's arrow in pixels." }, "arrowWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.arrowWidth" + "Description": "Specifies the width of the annotation's arrow at its junction with the annotation rectangle." }, "axis": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.axis" + "Description": "Specifies the name of the value axis on which the value is specified. Useful for a multi-axis chart." }, "border": { - "DocID": "dxChartCommonAnnotationConfig.border", + "Description": "Configures the appearance of the annotation's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.border.color" + "Description": "Colors the annotation's border." }, "cornerRadius": { "PrimitiveTypes": [ "number" - ], - "DocID": "dxChartCommonAnnotationConfig.border.cornerRadius" + ] }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.border.dashStyle" + "Description": "Specifies the dash style of the annotation's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.border.opacity" + "Description": "Specifies the opacity of the annotation's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartCommonAnnotationConfig.border.visible" + "Description": "Specifies the visibility of the annotation's border." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.border.width" + "Description": "Specifies the width of the annotation's border in pixels." } } }, @@ -46752,71 +44970,65 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.color" + "Description": "Specifies the color that fills the annotation." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChartCommonAnnotationConfig.customizeTooltip" + "Description": "Customizes the text and appearance of the annotation's tooltip." }, "data": { "PrimitiveTypes": [ "any" ], - "DocID": "dxChartCommonAnnotationConfig.data" + "Description": "A container for custom data." }, "description": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.description" + "Description": "Specifies the annotation's description displayed in the tooltip." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChartCommonAnnotationConfig.font" + "Description": "Specifies the annotation's font options. Applies only to text annotations." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.height" + "Description": "Specifies the annotation's height in pixels." }, "image": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.image", + "Description": "Configures the image to be displayed in the annotation. Applies only if the type is \"image\".", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.image.height" + "Description": "Specifies the image's height in pixels." }, "url": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.image.url" + "Description": "Specifies the image's URL." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.image.width" + "Description": "Specifies the image's width in pixels." } } }, @@ -46824,76 +45036,76 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartAnnotationConfig.name" + "Description": "Specifies the annotation's name." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.offsetX" + "Description": "Moves the annotation horizontally." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.offsetY" + "Description": "Moves the annotation vertically." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.opacity" + "Description": "Specifies the annotation's opacity." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.paddingLeftRight" + "Description": "Along with paddingTopBottom, generates an empty space around the annotation's text or image; specified in pixels." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.paddingTopBottom" + "Description": "Along with paddingLeftRight, generates an empty space around the annotation's text or image; specified in pixels." }, "series": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.series" + "Description": "Anchors the annotation to a series point. Accepts the name of the point's series." }, "shadow": { - "DocID": "dxChartCommonAnnotationConfig.shadow", + "Description": "Configures the annotation's shadows.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.shadow.blur" + "Description": "Specifies the blur distance of the shadows. A larger value increases the blur distance." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.shadow.color" + "Description": "Colors the annotation's shadows." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.shadow.offsetX" + "Description": "Moves the shadows horizontally." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.shadow.offsetY" + "Description": "Moves the shadows vertically." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.shadow.opacity" + "Description": "Specifies the opacity of the shadows." } } }, @@ -46902,38 +45114,38 @@ "any" ], "IsTemplate": true, - "DocID": "dxChartCommonAnnotationConfig.template" + "Description": "Specifies a custom template for the annotation." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.text" + "Description": "Specifies the annotation's text. Applies only if the type is \"text\"." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.textOverflow" + "Description": "Specifies what to do with the annotation's text when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "tooltipEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartCommonAnnotationConfig.tooltipEnabled" + "Description": "Specifies whether the annotation tooltip is enabled." }, "tooltipTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxChartCommonAnnotationConfig.tooltipTemplate" + "Description": "Specifies a custom template for an annotation's tooltip." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.type" + "Description": "Specifies whether the annotation displays a text or an image. This is a required setting." }, "value": { "PrimitiveTypes": [ @@ -46941,42 +45153,41 @@ "number", "string" ], - "DocID": "dxChartCommonAnnotationConfig.value" + "Description": "Positions the annotation relative to a value on the specified value axis." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.width" + "Description": "Specifies the annotation's width in pixels." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.wordWrap" + "Description": "Specifies how to wrap the annotation's text if it does not fit into a single line." }, "x": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.x" + "Description": "Along with y, positions the annotation's center at a specific pixel coordinate. (0, 0) is the upper left corner of the chart." }, "y": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.y" + "Description": "Along with x, positions the annotation's center at a specific pixel coordinate. (0, 0) is the upper left corner of the chart." } } }, "ChartCommonAnnotationConfig": { - "DocID": "dxChartCommonAnnotationConfig", "Options": { "allowDragging": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartCommonAnnotationConfig.allowDragging" + "Description": "Specifies whether users can drag and drop the annotation." }, "argument": { "PrimitiveTypes": [ @@ -46984,64 +45195,63 @@ "number", "string" ], - "DocID": "dxChartCommonAnnotationConfig.argument" + "Description": "Positions the annotation relative to a specific argument." }, "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.arrowLength" + "Description": "Specifies the length of the annotation's arrow in pixels." }, "arrowWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.arrowWidth" + "Description": "Specifies the width of the annotation's arrow at its junction with the annotation rectangle." }, "axis": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.axis" + "Description": "Specifies the name of the value axis on which the value is specified. Useful for a multi-axis chart." }, "border": { - "DocID": "dxChartCommonAnnotationConfig.border", + "Description": "Configures the appearance of the annotation's border.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.border.color" + "Description": "Colors the annotation's border." }, "cornerRadius": { "PrimitiveTypes": [ "number" - ], - "DocID": "dxChartCommonAnnotationConfig.border.cornerRadius" + ] }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.border.dashStyle" + "Description": "Specifies the dash style of the annotation's border." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.border.opacity" + "Description": "Specifies the opacity of the annotation's border." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartCommonAnnotationConfig.border.visible" + "Description": "Specifies the visibility of the annotation's border." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.border.width" + "Description": "Specifies the width of the annotation's border in pixels." } } }, @@ -47049,71 +45259,65 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.color" + "Description": "Specifies the color that fills the annotation." }, "customizeTooltip": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxChartCommonAnnotationConfig.customizeTooltip" + "Description": "Customizes the text and appearance of the annotation's tooltip." }, "data": { "PrimitiveTypes": [ "any" ], - "DocID": "dxChartCommonAnnotationConfig.data" + "Description": "A container for custom data." }, "description": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.description" + "Description": "Specifies the annotation's description displayed in the tooltip." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxChartCommonAnnotationConfig.font" + "Description": "Specifies the annotation's font options. Applies only to text annotations." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.height" + "Description": "Specifies the annotation's height in pixels." }, "image": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.image", + "Description": "Configures the image to be displayed in the annotation. Applies only if the type is \"image\".", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.image.height" + "Description": "Specifies the image's height in pixels." }, "url": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.image.url" + "Description": "Specifies the image's URL." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.image.width" + "Description": "Specifies the image's width in pixels." } } }, @@ -47121,70 +45325,70 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.offsetX" + "Description": "Moves the annotation horizontally." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.offsetY" + "Description": "Moves the annotation vertically." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.opacity" + "Description": "Specifies the annotation's opacity." }, "paddingLeftRight": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.paddingLeftRight" + "Description": "Along with paddingTopBottom, generates an empty space around the annotation's text or image; specified in pixels." }, "paddingTopBottom": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.paddingTopBottom" + "Description": "Along with paddingLeftRight, generates an empty space around the annotation's text or image; specified in pixels." }, "series": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.series" + "Description": "Anchors the annotation to a series point. Accepts the name of the point's series." }, "shadow": { - "DocID": "dxChartCommonAnnotationConfig.shadow", + "Description": "Configures the annotation's shadows.", "Options": { "blur": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.shadow.blur" + "Description": "Specifies the blur distance of the shadows. A larger value increases the blur distance." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.shadow.color" + "Description": "Colors the annotation's shadows." }, "offsetX": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.shadow.offsetX" + "Description": "Moves the shadows horizontally." }, "offsetY": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.shadow.offsetY" + "Description": "Moves the shadows vertically." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.shadow.opacity" + "Description": "Specifies the opacity of the shadows." } } }, @@ -47193,38 +45397,38 @@ "any" ], "IsTemplate": true, - "DocID": "dxChartCommonAnnotationConfig.template" + "Description": "Specifies a custom template for the annotation." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.text" + "Description": "Specifies the annotation's text. Applies only if the type is \"text\"." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.textOverflow" + "Description": "Specifies what to do with the annotation's text when it overflows the allocated space after applying wordWrap: hide, truncate it and display an ellipsis, or do nothing." }, "tooltipEnabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxChartCommonAnnotationConfig.tooltipEnabled" + "Description": "Specifies whether the annotation tooltip is enabled." }, "tooltipTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxChartCommonAnnotationConfig.tooltipTemplate" + "Description": "Specifies a custom template for an annotation's tooltip." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.type" + "Description": "Specifies whether the annotation displays a text or an image. This is a required setting." }, "value": { "PrimitiveTypes": [ @@ -47232,60 +45436,59 @@ "number", "string" ], - "DocID": "dxChartCommonAnnotationConfig.value" + "Description": "Positions the annotation relative to a value on the specified value axis." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.width" + "Description": "Specifies the annotation's width in pixels." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "dxChartCommonAnnotationConfig.wordWrap" + "Description": "Specifies how to wrap the annotation's text if it does not fit into a single line." }, "x": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.x" + "Description": "Along with y, positions the annotation's center at a specific pixel coordinate. (0, 0) is the upper left corner of the chart." }, "y": { "PrimitiveTypes": [ "number" ], - "DocID": "dxChartCommonAnnotationConfig.y" + "Description": "Along with x, positions the annotation's center at a specific pixel coordinate. (0, 0) is the upper left corner of the chart." } } }, "ContextMenuItem": { - "DocID": "dxContextMenuItem", "Options": { "beginGroup": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.beginGroup" + "Description": "Specifies whether a group separator is displayed over the item." }, "closeMenuOnClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.closeMenuOnClick" + "Description": "Specifies if a menu is closed when a user clicks the item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.disabled" + "Description": "Specifies whether the menu item responds to user interaction." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBaseItem.icon" + "Description": "Specifies the menu item's icon." }, "items": { "ItemPrimitiveTypes": [ @@ -47294,130 +45497,122 @@ "ItemComplexTypes": [ "ContextMenuItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "item", - "DocID": "dxContextMenuItem.items" + "Description": "Specifies nested menu items." }, "selectable": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.selectable" + "Description": "Specifies whether or not a user can select a menu item." }, "selected": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.selected" + "Description": "Specifies whether or not the item is selected." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBaseItem.text" + "Description": "Specifies the text inserted into the item element." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.visible" + "Description": "Specifies whether or not the menu item is visible." } } }, "DataGridColumn": { - "DocID": "dxDataGridColumn", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.alignment" + "Description": "Aligns the content of the column." }, "allowEditing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowEditing" + "Description": "Specifies whether a user can edit values in the column at runtime. By default, inherits the value of the editing.allowUpdating option." }, "allowExporting": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGridColumn.allowExporting" + "Description": "Specifies whether data from this column should be exported. Applies only if the column is visible." }, "allowFiltering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowFiltering" + "Description": "Specifies whether data can be filtered by this column. Applies only if filterRow.visible is true." }, "allowFixing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowFixing" + "Description": "Specifies whether a user can fix the column at runtime. Applies only if columnFixing.enabled is true." }, "allowGrouping": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGridColumn.allowGrouping" + "Description": "Specifies whether the user can group data by values of this column. Applies only when grouping is enabled." }, "allowHeaderFiltering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowHeaderFiltering" + "Description": "Specifies whether the header filter can be used to filter data by this column. Applies only if headerFilter.visible is true. By default, inherits the value of the allowFiltering option." }, "allowHiding": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowHiding" + "Description": "Specifies whether a user can hide the column using the column chooser at runtime. Applies only if columnChooser.enabled is true." }, "allowReordering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowReordering" + "Description": "Specifies whether this column can be used in column reordering at runtime. Applies only if allowColumnReordering is true." }, "allowResizing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowResizing" + "Description": "Specifies whether a user can resize the column at runtime. Applies only if allowColumnResizing is true." }, "allowSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowSearch" + "Description": "Specifies whether this column can be searched. Applies only if searchPanel.visible is true. Inherits the value of the allowFiltering option by default." }, "allowSorting": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowSorting" + "Description": "Specifies whether a user can sort rows by this column at runtime. Applies only if sorting.mode differs from \"none\"." }, "autoExpandGroup": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGridColumn.autoExpandGroup" + "Description": "Specifies whether groups appear expanded or not when records are grouped by a specific column. Setting this option makes sense only when grouping is allowed for this column." }, "buttons": { "ItemPrimitiveTypes": [ @@ -47427,23 +45622,16 @@ "ItemComplexTypes": [ "DataGridColumnButton" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "button", - "DocID": "dxDataGridColumn.buttons" + "Description": "Allows you to customize buttons in the editing column or create a custom command column. Applies only if the column's type is \"buttons\"." }, "calculateCellValue": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBaseColumn.calculateCellValue" + "Description": "Calculates custom cell values. Use this function to create an unbound data column." }, "calculateDisplayValue": { "PrimitiveTypes": [ @@ -47451,14 +45639,14 @@ "string" ], "IsFunc": true, - "DocID": "GridBaseColumn.calculateDisplayValue" + "Description": "Calculates custom display values for column cells. Requires specifying the dataField or calculateCellValue option. Used in lookup optimization." }, "calculateFilterExpression": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBaseColumn.calculateFilterExpression" + "Description": "Specifies the column's custom filtering rules." }, "calculateGroupValue": { "PrimitiveTypes": [ @@ -47466,7 +45654,7 @@ "string" ], "IsFunc": true, - "DocID": "dxDataGridColumn.calculateGroupValue" + "Description": "Specifies a field name or a function that returns a field name or a value to be used for grouping column cells." }, "calculateSortValue": { "PrimitiveTypes": [ @@ -47474,20 +45662,20 @@ "string" ], "IsFunc": true, - "DocID": "GridBaseColumn.calculateSortValue" + "Description": "Calculates custom values to be used in sorting." }, "caption": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.caption" + "Description": "Specifies a caption for the column." }, "cellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDataGridColumn.cellTemplate" + "Description": "Specifies a custom template for data cells." }, "columns": { "ItemPrimitiveTypes": [ @@ -47497,66 +45685,59 @@ "ItemComplexTypes": [ "DataGridColumn" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "column", - "DocID": "dxDataGridColumn.columns" + "Description": "An array of grid columns." }, "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.cssClass" + "Description": "Specifies a CSS class to be applied to the column." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBaseColumn.customizeText" + "Description": "Customizes the text displayed in column cells." }, "dataField": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.dataField" + "Description": "Binds the column to a field of the dataSource." }, "dataType": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.dataType" + "Description": "Casts column values to a specific data type." }, "editCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDataGridColumn.editCellTemplate" + "Description": "Specifies a custom template for data cells in editing state." }, "editorOptions": { "PrimitiveTypes": [ "any" ], - "DocID": "GridBaseColumn.editorOptions" + "Description": "Configures the default widget used for editing and filtering in the filter row." }, "encodeHtml": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.encodeHtml" + "Description": "Specifies whether HTML tags are displayed as plain text or applied to the values of the column." }, "falseText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.falseText" + "Description": "In a boolean column, replaces all false items with a specified text. Applies only if showEditorAlways option is false." }, "filterOperations": { "ItemPrimitiveTypes": [ @@ -47564,20 +45745,20 @@ ], "IsCollection": true, "SingularName": "filterOperation", - "DocID": "GridBaseColumn.filterOperations" + "Description": "Specifies a set of available filter operations. Applies only if filterRow.visible and allowFiltering are true." }, "filterType": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.filterType" + "Description": "Specifies whether a user changes the current filter by including (selecting) or excluding (clearing the selection of) values. Applies only if headerFilter.visible and allowHeaderFiltering are true." }, "filterValue": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "GridBaseColumn.filterValue" + "Description": "Specifies the column's filter value displayed in the filter row." }, "filterValues": { "ItemPrimitiveTypes": [ @@ -47586,80 +45767,68 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "filterValue", - "DocID": "GridBaseColumn.filterValues" + "Description": "Specifies values selected in the column's header filter." }, "fixed": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.fixed" + "Description": "Fixes the column." }, "fixedPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.fixedPosition" + "Description": "Specifies the widget's edge to which the column is fixed. Applies only if columns[].fixed is true." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "GridBaseColumn.format" + "Description": "Formats a value before it is displayed in a column cell." }, "formItem": { "PrimitiveTypes": [ - "dxFormSimpleItem" + "DevExpress.ui.dxFormSimpleItem" ], "ComplexTypes": [ "FormSimpleItem" ], - "TypeImports": [ - { - "Name": "dxFormSimpleItem", - "Path": "ui/form" - } - ], - "DocID": "GridBaseColumn.formItem" + "Description": "Configures the form item that the column produces in the editing state. Applies only if editing.mode is \"form\" or \"popup\"." }, "groupCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDataGridColumn.groupCellTemplate" + "Description": "Specifies a custom template for group cells (group rows)." }, "groupIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "dxDataGridColumn.groupIndex" + "Description": "Specifies the index of a column when grid records are grouped by the values of this column." }, "headerCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDataGridColumn.headerCellTemplate" + "Description": "Specifies a custom template for column headers." }, "headerFilter": { - "DocID": "GridBaseColumn.headerFilter", + "Description": "Specifies data settings for the header filter.", "Options": { "allowSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.headerFilter.allowSearch" + "Description": "Specifies whether searching is enabled in the header filter." }, "dataSource": { "PrimitiveTypes": [ @@ -47669,41 +45838,34 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsFunc": true, "IsDataSource": true, - "DocID": "GridBaseColumn.headerFilter.dataSource" + "Description": "Specifies a data source for the header filter." }, "groupInterval": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "GridBaseColumn.headerFilter.groupInterval" + "Description": "Specifies how the header filter combines values into groups." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBaseColumn.headerFilter.height" + "Description": "Specifies the height of the popup menu containing filtering values." }, "searchMode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.headerFilter.searchMode" + "Description": "Specifies a comparison operation used to search header filter values." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBaseColumn.headerFilter.width" + "Description": "Specifies the width of the popup menu containing filtering values." } } }, @@ -47711,22 +45873,22 @@ "PrimitiveTypes": [ "number" ], - "DocID": "GridBaseColumn.hidingPriority" + "Description": "Specifies the order in which columns are hidden when the widget adapts to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is \"widget\"." }, "isBand": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.isBand" + "Description": "Specifies whether the column bands other columns or not." }, "lookup": { - "DocID": "GridBaseColumn.lookup", + "Description": "Specifies options of a lookup column.", "Options": { "allowClearing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.lookup.allowClearing" + "Description": "Specifies whether to display the Clear button in lookup column cells while they are being edited." }, "dataSource": { "PrimitiveTypes": [ @@ -47737,16 +45899,9 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsFunc": true, "IsDataSource": true, - "DocID": "GridBaseColumn.lookup.dataSource" + "Description": "Specifies the data source for the lookup column." }, "displayExpr": { "PrimitiveTypes": [ @@ -47754,13 +45909,13 @@ "string" ], "IsFunc": true, - "DocID": "GridBaseColumn.lookup.displayExpr" + "Description": "Specifies the data source field whose values must be displayed." }, "valueExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.lookup.valueExpr" + "Description": "Specifies the data source field whose values must be replaced." } } }, @@ -47768,90 +45923,90 @@ "PrimitiveTypes": [ "number" ], - "DocID": "GridBaseColumn.minWidth" + "Description": "Specifies the minimum width of the column." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.name" + "Description": "Specifies the identifier of the column." }, "ownerBand": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBaseColumn.ownerBand" + "Description": "Specifies the band column that owns the current column. Accepts the index of the band column in the columns array." }, "renderAsync": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.renderAsync" + "Description": "Specifies whether to render the column after other columns and elements. Use if column cells have a complex template. Requires the width option specified." }, "selectedFilterOperation": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "GridBaseColumn.selectedFilterOperation" + "Description": "Specifies the column's filter operation displayed in the filter row." }, "setCellValue": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBaseColumn.setCellValue" + "Description": "Specifies a function to be invoked after the user has edited a cell value, but before it will be saved in the data source." }, "showEditorAlways": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.showEditorAlways" + "Description": "Specifies whether the column displays its values using editors." }, "showInColumnChooser": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.showInColumnChooser" + "Description": "Specifies whether the column chooser can contain the column header." }, "showWhenGrouped": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxDataGridColumn.showWhenGrouped" + "Description": "Specifies whether or not to display the column when grid records are grouped by it." }, "sortIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "GridBaseColumn.sortIndex" + "Description": "Specifies the index according to which columns participate in sorting." }, "sortingMethod": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBaseColumn.sortingMethod" + "Description": "Specifies a custom comparison function for sorting. Applies only when sorting is performed on the client." }, "sortOrder": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "GridBaseColumn.sortOrder" + "Description": "Specifies the sort order of column values." }, "trueText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.trueText" + "Description": "In a boolean column, replaces all true items with a specified text. Applies only if showEditorAlways option is false." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGridColumn.type" + "Description": "Specifies the command column that this object customizes." }, "validationRules": { "ItemPrimitiveTypes": [ @@ -47876,66 +46031,59 @@ "EmailRule", "AsyncRule" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "validationRule", - "DocID": "GridBaseColumn.validationRules" + "Description": "Specifies validation rules to be checked when cell values are updated." }, "visible": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "GridBaseColumn.visible" + "Description": "Specifies whether the column is visible, that is, occupies space in the table." }, "visibleIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "GridBaseColumn.visibleIndex" + "Description": "Specifies the position of the column regarding other columns in the resulting widget." }, "width": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "GridBaseColumn.width" + "Description": "Specifies the column's width in pixels or as a percentage. Ignored if it is less than minWidth." } } }, "DataGridColumnButton": { - "DocID": "dxDataGridColumnButton", + "Description": "Allows you to customize buttons in the editing column or create a custom command column. Applies only if the column's type is \"buttons\".", "Options": { "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumnButton.cssClass" + "Description": "Specifies a CSS class to be applied to the button." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumnButton.hint" + "Description": "Specifies the text for the hint that appears when the button is hovered over or long-pressed." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumnButton.icon" + "Description": "Specifies the button's icon." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxDataGridColumnButton.name" + "Description": "The name used to identify a built-in button." }, "onClick": { "PrimitiveTypes": [ @@ -47944,20 +46092,20 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxDataGridColumnButton.onClick" + "Description": "A function that is executed when the button is clicked or tapped. Not executed if a template is used." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxDataGridColumnButton.template" + "Description": "Specifies a custom button template." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumnButton.text" + "Description": "Specifies the button's text. Applies only if the button's icon is not specified." }, "visible": { "PrimitiveTypes": [ @@ -47965,69 +46113,59 @@ "Function" ], "IsFunc": true, - "DocID": "dxDataGridColumnButton.visible" + "Description": "Specifies the button's visibility." } } }, "DropDownButtonItem": { - "DocID": "dxDropDownButtonItem", "Options": { "badge": { "PrimitiveTypes": [ "string" ], - "DocID": "dxListItem.badge" + "Description": "Specifies the text of a badge displayed for the list item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxListItem.icon" - }, - "onClick": { - "PrimitiveTypes": [ - "Function", - "string" - ], - "IsFunc": true, - "IsEvent": true, - "DocID": "dxDropDownButtonItem.onClick" + "Description": "Specifies the list item's icon." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, "FileManagerContextMenu": { - "DocID": "dxFileManagerContextMenu", + "Description": "Configures the context menu.", "Options": { "items": { "ItemPrimitiveTypes": [ @@ -48037,45 +46175,38 @@ "ItemComplexTypes": [ "FileManagerContextMenuItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "item", - "DocID": "dxFileManagerContextMenu.items" + "Description": "Configures context menu items' settings." } } }, "FileManagerContextMenuItem": { - "DocID": "dxFileManagerContextMenuItem", + "Description": "Configures the context menu item.", "Options": { "beginGroup": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.beginGroup" + "Description": "Specifies whether a group separator is displayed over the item." }, "closeMenuOnClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.closeMenuOnClick" + "Description": "Specifies if a menu is closed when a user clicks the item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.disabled" + "Description": "Specifies whether the menu item responds to user interaction." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBaseItem.icon" + "Description": "Specifies the menu item's icon." }, "items": { "ItemPrimitiveTypes": [ @@ -48084,58 +46215,51 @@ "ItemComplexTypes": [ "FileManagerContextMenuItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "item", - "DocID": "dxFileManagerContextMenuItem.items" + "Description": "Configures settings for context menu items' subitems." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileManagerContextMenuItem.name" + "Description": "Specifies the context menu item's name." }, "selectable": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.selectable" + "Description": "Specifies whether or not a user can select a menu item." }, "selected": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.selected" + "Description": "Specifies whether or not the item is selected." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBaseItem.text" + "Description": "Specifies the text inserted into the item element." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileManagerContextMenuItem.visible" + "Description": "Specifies the context menu item's visibility." } } }, "FileManagerToolbar": { - "DocID": "dxFileManagerToolbar", + "Description": "", "Options": { "fileSelectionItems": { "ItemPrimitiveTypes": [ @@ -48145,16 +46269,9 @@ "ItemComplexTypes": [ "FileManagerToolbarItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "fileSelectionItem", - "DocID": "dxFileManagerToolbar.fileSelectionItems" + "Description": "Configures settings of the toolbar items that are visible when users select files." }, "items": { "ItemPrimitiveTypes": [ @@ -48164,126 +46281,118 @@ "ItemComplexTypes": [ "FileManagerToolbarItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "item", - "DocID": "dxFileManagerToolbar.items" + "Description": "Configures toolbar items' settings." } } }, "FileManagerToolbarItem": { - "DocID": "dxFileManagerToolbarItem", + "Description": "Configures the toolbar item.", "Options": { "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.cssClass" + "Description": "Specifies a CSS class to be applied to the item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "locateInMenu": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.locateInMenu" + "Description": "Specifies when to display an item in the toolbar's overflow menu." }, "location": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileManagerToolbarItem.location" + "Description": "Specifies the toolbar item's location." }, "menuItemTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxToolbarItem.menuItemTemplate" + "Description": "Specifies a template that should be used to render a menu item." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFileManagerToolbarItem.name" + "Description": "Specifies the toolbar item's name." }, "options": { "PrimitiveTypes": [ "any" ], - "DocID": "dxToolbarItem.options" + "Description": "Configures the DevExtreme widget used as a toolbar item." }, "showText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.showText" + "Description": "Specifies when to display the text for the widget item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFileManagerToolbarItem.visible" + "Description": "Specifies the toolbar item's visibility." }, "widget": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.widget" + "Description": "A widget that presents a toolbar item. To configure it, use the options object." } } }, "FilterBuilderCustomOperation": { - "DocID": "dxFilterBuilderCustomOperation", "Options": { "calculateFilterExpression": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxFilterBuilderCustomOperation.calculateFilterExpression" + "Description": "Specifies a function that returns a filter expression for this custom operation." }, "caption": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilderCustomOperation.caption" + "Description": "Specifies the operation's caption." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxFilterBuilderCustomOperation.customizeText" + "Description": "Customizes the field value's text representation." }, "dataTypes": { "ItemPrimitiveTypes": [ @@ -48291,88 +46400,88 @@ ], "IsCollection": true, "SingularName": "dataType", - "DocID": "dxFilterBuilderCustomOperation.dataTypes" + "Description": "Specifies for which data types the operation is available by default." }, "editorTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxFilterBuilderCustomOperation.editorTemplate" + "Description": "Specifies a custom template for the widget used to edit the field value." }, "hasValue": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFilterBuilderCustomOperation.hasValue" + "Description": "Specifies whether the operation can have a value. If it can, the editor is displayed." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilderCustomOperation.icon" + "Description": "Specifies the icon that should represent the filter operation." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilderCustomOperation.name" + "Description": "Specifies the operation's identifier." } } }, "FilterBuilderField": { - "DocID": "dxFilterBuilderField", + "Description": "The FilterBuilder's field structure.", "Options": { "calculateFilterExpression": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxFilterBuilderField.calculateFilterExpression" + "Description": "Specifies the field's custom filtering rules." }, "caption": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilderField.caption" + "Description": "Specifies the data field's caption." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "dxFilterBuilderField.customizeText" + "Description": "Customizes the input value's display text." }, "dataField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilderField.dataField" + "Description": "Specifies the name of a field to be filtered." }, "dataType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilderField.dataType" + "Description": "Casts field values to a specific data type." }, "editorOptions": { "PrimitiveTypes": [ "any" ], - "DocID": "dxFilterBuilderField.editorOptions" + "Description": "Configures the widget used to edit the field value." }, "editorTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxFilterBuilderField.editorTemplate" + "Description": "Specifies the editor's custom template." }, "falseText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilderField.falseText" + "Description": "Specifies the false value text. Applies only if dataType is \"boolean\"." }, "filterOperations": { "ItemPrimitiveTypes": [ @@ -48380,32 +46489,26 @@ ], "IsCollection": true, "SingularName": "filterOperation", - "DocID": "dxFilterBuilderField.filterOperations" + "Description": "Specifies a set of available filter operations." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxFilterBuilderField.format" + "Description": "Formats a value before it is displayed." }, "lookup": { - "DocID": "dxFilterBuilderField.lookup", + "Description": "Configures the lookup field.", "Options": { "allowClearing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFilterBuilderField.lookup.allowClearing" + "Description": "Specifies whether to display the Clear button in the lookup field while it is being edited." }, "dataSource": { "PrimitiveTypes": [ @@ -48415,15 +46518,8 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxFilterBuilderField.lookup.dataSource" + "Description": "Specifies the lookup data source." }, "displayExpr": { "PrimitiveTypes": [ @@ -48431,7 +46527,7 @@ "string" ], "IsFunc": true, - "DocID": "dxFilterBuilderField.lookup.displayExpr" + "Description": "Specifies the data field whose values should be displayed." }, "valueExpr": { "PrimitiveTypes": [ @@ -48439,7 +46535,7 @@ "string" ], "IsFunc": true, - "DocID": "dxFilterBuilderField.lookup.valueExpr" + "Description": "Specifies the data source field whose values should be replaced." } } }, @@ -48447,179 +46543,173 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilderField.name" + "Description": "Specifies the field's name. Use it to distinguish the field from other fields when they have identical dataField values." }, "trueText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFilterBuilderField.trueText" + "Description": "Specifies the true value text. Applies only if dataType is \"boolean\"." } } }, "FormButtonItem": { - "DocID": "dxFormButtonItem", + "Description": "Configures a button form item.", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], "IsDeprecated": true, - "DocID": "dxFormButtonItem.alignment" + "Description": "Use horizontalAlignment instead." }, "buttonOptions": { "PrimitiveTypes": [ - "dxButtonOptions" + "DevExpress.ui.dxButtonOptions" ], "ComplexTypes": [ "dxButtonOptions" ], - "TypeImports": [ - { - "Name": "dxButtonOptions", - "Path": "ui/button" - } - ], - "DocID": "dxFormButtonItem.buttonOptions" + "Description": "Configures the button." }, "colSpan": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFormButtonItem.colSpan" + "Description": "Specifies how many columns the item spans." }, "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormButtonItem.cssClass" + "Description": "Specifies a CSS class to be applied to the item." }, "horizontalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormButtonItem.horizontalAlignment" + "Description": "Specifies the button's horizontal alignment." }, "itemType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormButtonItem.itemType" + "Description": "Specifies the item's type. Set it to \"button\" to create a button item." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormButtonItem.name" + "Description": "Specifies the item's identifier." }, "verticalAlignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormButtonItem.verticalAlignment" + "Description": "Specifies the button's vertical alignment." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFormButtonItem.visible" + "Description": "Specifies whether the item is visible." }, "visibleIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFormButtonItem.visibleIndex" + "Description": "Specifies the item's position regarding other items in a group, tab, or the whole widget." } } }, "FormEmptyItem": { - "DocID": "dxFormEmptyItem", + "Description": "This article describes configuration options of an empty form item.", "Options": { "colSpan": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFormEmptyItem.colSpan" + "Description": "Specifies the number of columns spanned by the item." }, "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormEmptyItem.cssClass" + "Description": "Specifies a CSS class to be applied to the form item." }, "itemType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormEmptyItem.itemType" + "Description": "Specifies the item's type. Set it to \"empty\" to create an empty item." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormEmptyItem.name" + "Description": "Specifies a name that identifies the form item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFormEmptyItem.visible" + "Description": "Specifies whether or not the current form item is visible." }, "visibleIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFormEmptyItem.visibleIndex" + "Description": "Specifies the sequence number of the item in a form, group or tab." } } }, "FormGroupItem": { - "DocID": "dxFormGroupItem", + "Description": "This article describes configuration options of a group form item.", "Options": { "alignItemLabels": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFormGroupItem.alignItemLabels" + "Description": "Specifies whether or not all group item labels are aligned." }, "caption": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormGroupItem.caption" + "Description": "Specifies the group caption." }, "colCount": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFormGroupItem.colCount" + "Description": "The count of columns in the group layout." }, "colCountByScreen": { - "DocID": "dxFormGroupItem.colCountByScreen", + "Description": "Specifies the relation between the screen size qualifier and the number of columns in the grouped layout.", "Options": { "lg": { "PrimitiveTypes": [ "number" ], - "DocID": "ColCountResponsible.lg" + "Description": "The count of columns for a large screen size." }, "md": { "PrimitiveTypes": [ "number" ], - "DocID": "ColCountResponsible.md" + "Description": "The count of columns for a middle-sized screen." }, "sm": { "PrimitiveTypes": [ "number" ], - "DocID": "ColCountResponsible.sm" + "Description": "The count of columns for a small-sized screen." }, "xs": { "PrimitiveTypes": [ "number" ], - "DocID": "ColCountResponsible.xs" + "Description": "The count of columns for an extra small-sized screen." } } }, @@ -48627,13 +46717,13 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxFormGroupItem.colSpan" + "Description": "Specifies the number of columns spanned by the item." }, "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormGroupItem.cssClass" + "Description": "Specifies a CSS class to be applied to the form item." }, "items": { "ItemPrimitiveTypes": [ @@ -48650,133 +46740,126 @@ "FormEmptyItem", "FormButtonItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "item", - "DocID": "dxFormGroupItem.items" + "Description": "Holds an array of form items displayed within the group." }, "itemType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormGroupItem.itemType" + "Description": "Specifies the item's type. Set it to \"group\" to create a group item." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormGroupItem.name" + "Description": "Specifies a name that identifies the form item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxFormGroupItem.template" + "Description": "A template to be used for rendering a group item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFormGroupItem.visible" + "Description": "Specifies whether or not the current form item is visible." }, "visibleIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFormGroupItem.visibleIndex" + "Description": "Specifies the sequence number of the item in a form, group or tab." } } }, "FormSimpleItem": { - "DocID": "dxFormSimpleItem", + "Description": "This article describes configuration options of a simple form item.", "Options": { "colSpan": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFormSimpleItem.colSpan" + "Description": "Specifies the number of columns spanned by the item." }, "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormSimpleItem.cssClass" + "Description": "Specifies a CSS class to be applied to the form item." }, "dataField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormSimpleItem.dataField" + "Description": "Specifies the path to the formData object field bound to the current form item." }, "editorOptions": { "PrimitiveTypes": [ "any" ], - "DocID": "dxFormSimpleItem.editorOptions" + "Description": "Configures the form item's editor." }, "editorType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormSimpleItem.editorType" + "Description": "Specifies which editor widget is used to display and edit the form item value." }, "helpText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormSimpleItem.helpText" + "Description": "Specifies the help text displayed for the current form item." }, "isRequired": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFormSimpleItem.isRequired" + "Description": "Specifies whether the current form item is required." }, "itemType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormSimpleItem.itemType" + "Description": "Specifies the item's type. Set it to \"simple\" to create a simple item." }, "label": { - "DocID": "dxFormSimpleItem.label", + "Description": "Specifies options for the form item label.", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormSimpleItem.label.alignment" + "Description": "Specifies the label's horizontal alignment." }, "location": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormSimpleItem.label.location" + "Description": "Specifies the location of a label against the editor." }, "showColon": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFormSimpleItem.label.showColon" + "Description": "Specifies whether or not a colon is displayed at the end of the current label." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormSimpleItem.label.text" + "Description": "Specifies the label text." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFormSimpleItem.label.visible" + "Description": "Specifies whether or not the label is visible." } } }, @@ -48784,14 +46867,14 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxFormSimpleItem.name" + "Description": "Specifies a name that identifies the form item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxFormSimpleItem.template" + "Description": "A template to be used for rendering the form item." }, "validationRules": { "ItemPrimitiveTypes": [ @@ -48816,72 +46899,59 @@ "EmailRule", "AsyncRule" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "validationRule", - "DocID": "dxFormSimpleItem.validationRules" + "Description": "An array of validation rules to be checked for the form item editor." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFormSimpleItem.visible" + "Description": "Specifies whether or not the current form item is visible." }, "visibleIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFormSimpleItem.visibleIndex" + "Description": "Specifies the sequence number of the item in a form, group or tab." } } }, "FormTabbedItem": { - "DocID": "dxFormTabbedItem", + "Description": "This article describes configuration options of a tabbed form item.", "Options": { "colSpan": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFormTabbedItem.colSpan" + "Description": "Specifies the number of columns spanned by the item." }, "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormTabbedItem.cssClass" + "Description": "Specifies a CSS class to be applied to the form item." }, "itemType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormTabbedItem.itemType" + "Description": "Specifies the item's type. Set it to \"tabbed\" to create a tabbed item." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormTabbedItem.name" + "Description": "Specifies a name that identifies the form item." }, "tabPanelOptions": { "PrimitiveTypes": [ - "dxTabPanelOptions" + "DevExpress.ui.dxTabPanelOptions" ], "ComplexTypes": [ "dxTabPanelOptions" ], - "TypeImports": [ - { - "Name": "dxTabPanelOptions", - "Path": "ui/tab_panel" - } - ], - "DocID": "dxFormTabbedItem.tabPanelOptions" + "Description": "Holds a configuration object for the TabPanel widget used to display the current form item." }, "tabs": { "ItemPrimitiveTypes": [ @@ -48889,52 +46959,52 @@ ], "IsCollection": true, "SingularName": "tab", - "DocID": "dxFormTabbedItem.tabs", + "Description": "An array of tab configuration objects.", "Options": { "alignItemLabels": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFormTabbedItem.tabs.alignItemLabels" + "Description": "Specifies whether or not labels of items displayed within the current tab are aligned." }, "badge": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormTabbedItem.tabs.badge" + "Description": "Specifies a badge text for the tab." }, "colCount": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFormTabbedItem.tabs.colCount" + "Description": "The count of columns in the tab layout." }, "colCountByScreen": { - "DocID": "dxFormTabbedItem.tabs.colCountByScreen", + "Description": "Specifies the relation between the screen size qualifier and the number of columns in the tabbed layout.", "Options": { "lg": { "PrimitiveTypes": [ "number" ], - "DocID": "ColCountResponsible.lg" + "Description": "The count of columns for a large screen size." }, "md": { "PrimitiveTypes": [ "number" ], - "DocID": "ColCountResponsible.md" + "Description": "The count of columns for a middle-sized screen." }, "sm": { "PrimitiveTypes": [ "number" ], - "DocID": "ColCountResponsible.sm" + "Description": "The count of columns for a small-sized screen." }, "xs": { "PrimitiveTypes": [ "number" ], - "DocID": "ColCountResponsible.xs" + "Description": "The count of columns for an extra small-sized screen." } } }, @@ -48942,13 +47012,13 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFormTabbedItem.tabs.disabled" + "Description": "Specifies whether the tab responds to user interaction." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormTabbedItem.tabs.icon" + "Description": "Specifies the icon to be displayed on the tab." }, "items": { "ItemPrimitiveTypes": [ @@ -48965,36 +47035,29 @@ "FormEmptyItem", "FormButtonItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "item", - "DocID": "dxFormTabbedItem.tabs.items" + "Description": "Holds an array of form items displayed within the tab." }, "tabTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxFormTabbedItem.tabs.tabTemplate" + "Description": "The template to be used for rendering the tab." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxFormTabbedItem.tabs.template" + "Description": "The template to be used for rendering the tab content." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "dxFormTabbedItem.tabs.title" + "Description": "Specifies the tab title." } } }, @@ -49002,60 +47065,58 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxFormTabbedItem.visible" + "Description": "Specifies whether or not the current form item is visible." }, "visibleIndex": { "PrimitiveTypes": [ "number" ], - "DocID": "dxFormTabbedItem.visibleIndex" + "Description": "Specifies the sequence number of the item in a form, group or tab." } } }, "GalleryItem": { - "DocID": "dxGalleryItem", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "imageAlt": { "PrimitiveTypes": [ "string" ], - "DocID": "dxGalleryItem.imageAlt" + "Description": "Specifies the text passed to the alt attribute of the image markup element." }, "imageSrc": { "PrimitiveTypes": [ "string" ], - "DocID": "dxGalleryItem.imageSrc" + "Description": "Specifies the URL of the image displayed by the item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." } } }, "HtmlEditorMediaResizing": { - "DocID": "dxHtmlEditorMediaResizing", "Options": { "allowedTargets": { "ItemPrimitiveTypes": [ @@ -49063,18 +47124,17 @@ ], "IsCollection": true, "SingularName": "allowedTarget", - "DocID": "dxHtmlEditorMediaResizing.allowedTargets" + "Description": "Specifies media types that can be resized. Currently, only images are supported." }, "enabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxHtmlEditorMediaResizing.enabled" + "Description": "Enables media resizing." } } }, "HtmlEditorMention": { - "DocID": "dxHtmlEditorMention", "Options": { "dataSource": { "PrimitiveTypes": [ @@ -49084,15 +47144,8 @@ "ItemPrimitiveTypes": [ "string" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxHtmlEditorMention.dataSource" + "Description": "Provides data for the suggestion list." }, "displayExpr": { "PrimitiveTypes": [ @@ -49100,52 +47153,50 @@ "string" ], "IsFunc": true, - "DocID": "dxHtmlEditorMention.displayExpr" + "Description": "Specifies the data field whose values should be displayed in the suggestion list." }, "itemTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxHtmlEditorMention.itemTemplate" + "Description": "Specifies a custom template for suggestion list items." }, "marker": { "PrimitiveTypes": [ "string" ], - "DocID": "dxHtmlEditorMention.marker" + "Description": "Specifies the prefix that a user enters to activate mentions. You can use different prefixes with different dataSources." }, "minSearchLength": { "PrimitiveTypes": [ "number" ], - "DocID": "dxHtmlEditorMention.minSearchLength" + "Description": "Specifies the minimum number of characters that a user should type to trigger the search." }, "searchExpr": { "PrimitiveTypes": [ - "Function", - "string" + "Function" ], "ItemPrimitiveTypes": [ - "Function", - "string" + "Function" ], "IsCollection": true, "SingularName": "searchExpr", - "DocID": "dxHtmlEditorMention.searchExpr" + "Description": "Specifies one or several data fields to search." }, "searchTimeout": { "PrimitiveTypes": [ "number" ], - "DocID": "dxHtmlEditorMention.searchTimeout" + "Description": "Specifies the delay between when a user stops typing and when the search is executed." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxHtmlEditorMention.template" + "Description": "Specifies a custom template for mentions." }, "valueExpr": { "PrimitiveTypes": [ @@ -49153,12 +47204,11 @@ "string" ], "IsFunc": true, - "DocID": "dxHtmlEditorMention.valueExpr" + "Description": "Specifies which data field provides unique values to the template's `id` parameter." } } }, "HtmlEditorToolbar": { - "DocID": "dxHtmlEditorToolbar", "Options": { "container": { "PrimitiveTypes": [ @@ -49166,7 +47216,7 @@ "JQuery", "string" ], - "DocID": "dxHtmlEditorToolbar.container" + "Description": "Specifies the container in which to place the toolbar." }, "items": { "ItemPrimitiveTypes": [ @@ -49176,39 +47226,31 @@ "ItemComplexTypes": [ "HtmlEditorToolbarItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "item", - "DocID": "dxHtmlEditorToolbar.items" + "Description": "Configures toolbar items. These items allow users to format text and execute commands." } } }, "HtmlEditorToolbarItem": { - "DocID": "dxHtmlEditorToolbarItem", "Options": { "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.cssClass" + "Description": "Specifies a CSS class to be applied to the item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "formatName": { "PrimitiveTypes": [ "string" ], - "DocID": "dxHtmlEditorToolbarItem.formatName" + "Description": "Specifies the predefined item that this object customizes or a format with multiple choices." }, "formatValues": { "ItemPrimitiveTypes": [ @@ -49218,74 +47260,73 @@ ], "IsCollection": true, "SingularName": "formatValue", - "DocID": "dxHtmlEditorToolbarItem.formatValues" + "Description": "Specifies values for a format with multiple choices. Should be used with the formatName." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "locateInMenu": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.locateInMenu" + "Description": "Specifies when to display an item in the toolbar's overflow menu." }, "location": { "PrimitiveTypes": [ "string" ], - "DocID": "dxHtmlEditorToolbarItem.location" + "Description": "Specifies a location for the item on the toolbar." }, "menuItemTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxToolbarItem.menuItemTemplate" + "Description": "Specifies a template that should be used to render a menu item." }, "options": { "PrimitiveTypes": [ "any" ], - "DocID": "dxToolbarItem.options" + "Description": "Configures the DevExtreme widget used as a toolbar item." }, "showText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.showText" + "Description": "Specifies when to display the text for the widget item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." }, "widget": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.widget" + "Description": "A widget that presents a toolbar item. To configure it, use the options object." } } }, "HtmlEditorVariables": { - "DocID": "dxHtmlEditorVariables", "Options": { "dataSource": { "PrimitiveTypes": [ @@ -49296,15 +47337,8 @@ "ItemPrimitiveTypes": [ "string" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsDataSource": true, - "DocID": "dxHtmlEditorVariables.dataSource" + "Description": "Specifies a collection of variables available for a user." }, "escapeChar": { "PrimitiveTypes": [ @@ -49315,96 +47349,94 @@ ], "IsCollection": true, "SingularName": "escapeChar", - "DocID": "dxHtmlEditorVariables.escapeChar" + "Description": "Specifies the special character(s) that should surround the variables." } } }, "ListItem": { - "DocID": "dxListItem", "Options": { "badge": { "PrimitiveTypes": [ "string" ], - "DocID": "dxListItem.badge" + "Description": "Specifies the text of a badge displayed for the list item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxListItem.icon" + "Description": "Specifies the list item's icon." }, "key": { "PrimitiveTypes": [ "string" ], - "DocID": "dxListItem.key" + "Description": "Specifies the name of the list items group in a grouped list." }, "showChevron": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxListItem.showChevron" + "Description": "Specifies whether or not to display a chevron for the list item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, "MenuItem": { - "DocID": "dxMenuItem", "Options": { "beginGroup": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.beginGroup" + "Description": "Specifies whether a group separator is displayed over the item." }, "closeMenuOnClick": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.closeMenuOnClick" + "Description": "Specifies if a menu is closed when a user clicks the item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.disabled" + "Description": "Specifies whether the menu item responds to user interaction." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBaseItem.icon" + "Description": "Specifies the menu item's icon." }, "items": { "ItemPrimitiveTypes": [ @@ -49413,94 +47445,85 @@ "ItemComplexTypes": [ "MenuItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "item", - "DocID": "dxMenuItem.items" + "Description": "Specifies nested menu items." }, "selectable": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.selectable" + "Description": "Specifies whether or not a user can select a menu item." }, "selected": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.selected" + "Description": "Specifies whether or not the item is selected." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxMenuBaseItem.text" + "Description": "Specifies the text inserted into the item element." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxMenuBaseItem.visible" + "Description": "Specifies whether or not the menu item is visible." } } }, "MultiViewItem": { - "DocID": "dxMultiViewItem", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." } } }, "ResponsiveBoxItem": { - "DocID": "dxResponsiveBoxItem", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "location": { "ItemPrimitiveTypes": [ @@ -49508,37 +47531,37 @@ ], "IsCollection": true, "SingularName": "location", - "DocID": "dxResponsiveBoxItem.location", + "Description": "Specifies the item location and size against the widget grid.", "Options": { "col": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResponsiveBoxItem.location.col" + "Description": "Specifies which column the element should occupy. Accepts an index from the cols array." }, "colspan": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResponsiveBoxItem.location.colspan" + "Description": "Specifies how many columns the element should span." }, "row": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResponsiveBoxItem.location.row" + "Description": "Specifies which row the element should occupy. Accepts an index from the rows array." }, "rowspan": { "PrimitiveTypes": [ "number" ], - "DocID": "dxResponsiveBoxItem.location.rowspan" + "Description": "Specifies how many rows the element should span." }, "screen": { "PrimitiveTypes": [ "string" ], - "DocID": "dxResponsiveBoxItem.location.screen" + "Description": "Decides on which screens the current location settings should be applied to the element." } } }, @@ -49547,473 +47570,460 @@ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, "SchedulerAppointment": { - "DocID": "dxSchedulerAppointment", + "Description": "An object that describes an appointment in the Scheduler widget.", "Options": { "allDay": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSchedulerAppointment.allDay" + "Description": "Specifies whether the appointment lasts all day." }, "description": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSchedulerAppointment.description" + "Description": "Specifies a detail description of the appointment." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSchedulerAppointment.disabled" + "Description": "Specifies whether the appointment responds to user interaction." }, "endDate": { "PrimitiveTypes": [ "Date" ], - "DocID": "dxSchedulerAppointment.endDate" + "Description": "Specifies the ending of the appointment." }, "endDateTimeZone": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSchedulerAppointment.endDateTimeZone" + "Description": "Specifies the time zone for an appointment's endDate. Applies only if the timeZone option is unspecified." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSchedulerAppointment.html" + "Description": "Specifies HTML code inserted into the appointment element." }, "recurrenceException": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSchedulerAppointment.recurrenceException" + "Description": "Specifies exceptions for the current recurring appointment." }, "recurrenceRule": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSchedulerAppointment.recurrenceRule" + "Description": "Specifies a recurrence rule for generating recurring appointments in the scheduler." }, "startDate": { "PrimitiveTypes": [ "Date" ], - "DocID": "dxSchedulerAppointment.startDate" + "Description": "Specifies the start of the appointment." }, "startDateTimeZone": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSchedulerAppointment.startDateTimeZone" + "Description": "Specifies the time zone for an appointment's startDate. Applies only if the timeZone option is unspecified." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSchedulerAppointment.template" + "Description": "Specifies a template that should be used to render this appointment only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "dxSchedulerAppointment.text" + "Description": "Specifies the subject of the appointment." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxSchedulerAppointment.visible" + "Description": "Specifies whether or not an appointment must be displayed." } } }, "SlideOutItem": { - "DocID": "dxSlideOutItem", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "menuTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxSlideOutItem.menuTemplate" + "Description": "Specifies a template that should be used to render a menu item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, "TabPanelItem": { - "DocID": "dxTabPanelItem", "Options": { "badge": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabPanelItem.badge" + "Description": "Specifies a badge text for the tab." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabPanelItem.icon" + "Description": "Specifies the icon to be displayed in the tab's title." }, "tabTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxTabPanelItem.tabTemplate" + "Description": "Specifies a template that should be used to render the tab for this item only." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "title": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabPanelItem.title" + "Description": "Specifies the item title text displayed on a corresponding tab." } } }, "TabsItem": { - "DocID": "dxTabsItem", "Options": { "badge": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabsItem.badge" + "Description": "Specifies a badge text for the tab." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTabsItem.icon" + "Description": "Specifies the icon to be displayed on the tab." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, "TextEditorButton": { - "DocID": "dxTextEditorButton", "Options": { "location": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditorButton.location" + "Description": "Specifies whether to place the button before or after the input text field." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTextEditorButton.name" + "Description": "Specifies the button's name." }, "options": { "PrimitiveTypes": [ - "dxButtonOptions" + "DevExpress.ui.dxButtonOptions" ], "ComplexTypes": [ "dxButtonOptions" ], - "TypeImports": [ - { - "Name": "dxButtonOptions", - "Path": "ui/button" - } - ], - "DocID": "dxTextEditorButton.options" + "Description": "Configures the Button widget used as the action button." } } }, "TileViewItem": { - "DocID": "dxTileViewItem", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "heightRatio": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTileViewItem.heightRatio" + "Description": "Specifies a multiplier for the baseItemHeight option value (for the purpose of obtaining the actual item height)." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." }, "widthRatio": { "PrimitiveTypes": [ "number" ], - "DocID": "dxTileViewItem.widthRatio" + "Description": "Specifies a multiplier for the baseItemWidth option value (for the purpose of obtaining the actual item width)." } } }, "ToolbarItem": { - "DocID": "dxToolbarItem", "Options": { "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.cssClass" + "Description": "Specifies a CSS class to be applied to the item." }, "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "locateInMenu": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.locateInMenu" + "Description": "Specifies when to display an item in the toolbar's overflow menu." }, "location": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.location" + "Description": "Specifies a location for the item on the toolbar." }, "menuItemTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxToolbarItem.menuItemTemplate" + "Description": "Specifies a template that should be used to render a menu item." }, "options": { "PrimitiveTypes": [ "any" ], - "DocID": "dxToolbarItem.options" + "Description": "Configures the DevExtreme widget used as a toolbar item." }, "showText": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.showText" + "Description": "Specifies when to display the text for the widget item." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." }, "widget": { "PrimitiveTypes": [ "string" ], - "DocID": "dxToolbarItem.widget" + "Description": "A widget that presents a toolbar item. To configure it, use the options object." } } }, "TreeListColumn": { - "DocID": "dxTreeListColumn", "Options": { "alignment": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.alignment" + "Description": "Aligns the content of the column." }, "allowEditing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowEditing" + "Description": "Specifies whether a user can edit values in the column at runtime. By default, inherits the value of the editing.allowUpdating option." }, "allowFiltering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowFiltering" + "Description": "Specifies whether data can be filtered by this column. Applies only if filterRow.visible is true." }, "allowFixing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowFixing" + "Description": "Specifies whether a user can fix the column at runtime. Applies only if columnFixing.enabled is true." }, "allowHeaderFiltering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowHeaderFiltering" + "Description": "Specifies whether the header filter can be used to filter data by this column. Applies only if headerFilter.visible is true. By default, inherits the value of the allowFiltering option." }, "allowHiding": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowHiding" + "Description": "Specifies whether a user can hide the column using the column chooser at runtime. Applies only if columnChooser.enabled is true." }, "allowReordering": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowReordering" + "Description": "Specifies whether this column can be used in column reordering at runtime. Applies only if allowColumnReordering is true." }, "allowResizing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowResizing" + "Description": "Specifies whether a user can resize the column at runtime. Applies only if allowColumnResizing is true." }, "allowSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowSearch" + "Description": "Specifies whether this column can be searched. Applies only if searchPanel.visible is true. Inherits the value of the allowFiltering option by default." }, "allowSorting": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.allowSorting" + "Description": "Specifies whether a user can sort rows by this column at runtime. Applies only if sorting.mode differs from \"none\"." }, "buttons": { "ItemPrimitiveTypes": [ @@ -50023,23 +48033,16 @@ "ItemComplexTypes": [ "TreeListColumnButton" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "button", - "DocID": "dxTreeListColumn.buttons" + "Description": "Allows you to customize buttons in the editing column or create a custom command column. Applies only if the column's type is \"buttons\"." }, "calculateCellValue": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBaseColumn.calculateCellValue" + "Description": "Calculates custom cell values. Use this function to create an unbound data column." }, "calculateDisplayValue": { "PrimitiveTypes": [ @@ -50047,14 +48050,14 @@ "string" ], "IsFunc": true, - "DocID": "GridBaseColumn.calculateDisplayValue" + "Description": "Calculates custom display values for column cells. Requires specifying the dataField or calculateCellValue option. Used in lookup optimization." }, "calculateFilterExpression": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBaseColumn.calculateFilterExpression" + "Description": "Specifies the column's custom filtering rules." }, "calculateSortValue": { "PrimitiveTypes": [ @@ -50062,20 +48065,20 @@ "string" ], "IsFunc": true, - "DocID": "GridBaseColumn.calculateSortValue" + "Description": "Calculates custom values to be used in sorting." }, "caption": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.caption" + "Description": "Specifies a caption for the column." }, "cellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxTreeListColumn.cellTemplate" + "Description": "Specifies a custom template for data cells." }, "columns": { "ItemPrimitiveTypes": [ @@ -50085,66 +48088,59 @@ "ItemComplexTypes": [ "TreeListColumn" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "column", - "DocID": "dxTreeListColumn.columns" + "Description": "Configures columns." }, "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.cssClass" + "Description": "Specifies a CSS class to be applied to the column." }, "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBaseColumn.customizeText" + "Description": "Customizes the text displayed in column cells." }, "dataField": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.dataField" + "Description": "Binds the column to a field of the dataSource." }, "dataType": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.dataType" + "Description": "Casts column values to a specific data type." }, "editCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxTreeListColumn.editCellTemplate" + "Description": "Specifies a custom template for data cells in editing state." }, "editorOptions": { "PrimitiveTypes": [ "any" ], - "DocID": "GridBaseColumn.editorOptions" + "Description": "Configures the default widget used for editing and filtering in the filter row." }, "encodeHtml": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.encodeHtml" + "Description": "Specifies whether HTML tags are displayed as plain text or applied to the values of the column." }, "falseText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.falseText" + "Description": "In a boolean column, replaces all false items with a specified text. Applies only if showEditorAlways option is false." }, "filterOperations": { "ItemPrimitiveTypes": [ @@ -50152,20 +48148,20 @@ ], "IsCollection": true, "SingularName": "filterOperation", - "DocID": "GridBaseColumn.filterOperations" + "Description": "Specifies a set of available filter operations. Applies only if filterRow.visible and allowFiltering are true." }, "filterType": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.filterType" + "Description": "Specifies whether a user changes the current filter by including (selecting) or excluding (clearing the selection of) values. Applies only if headerFilter.visible and allowHeaderFiltering are true." }, "filterValue": { "PrimitiveTypes": [ "any" ], "IsChangeable": true, - "DocID": "GridBaseColumn.filterValue" + "Description": "Specifies the column's filter value displayed in the filter row." }, "filterValues": { "ItemPrimitiveTypes": [ @@ -50174,66 +48170,54 @@ "IsCollection": true, "IsChangeable": true, "SingularName": "filterValue", - "DocID": "GridBaseColumn.filterValues" + "Description": "Specifies values selected in the column's header filter." }, "fixed": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.fixed" + "Description": "Fixes the column." }, "fixedPosition": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.fixedPosition" + "Description": "Specifies the widget's edge to which the column is fixed. Applies only if columns[].fixed is true." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "GridBaseColumn.format" + "Description": "Formats a value before it is displayed in a column cell." }, "formItem": { "PrimitiveTypes": [ - "dxFormSimpleItem" + "DevExpress.ui.dxFormSimpleItem" ], "ComplexTypes": [ "FormSimpleItem" ], - "TypeImports": [ - { - "Name": "dxFormSimpleItem", - "Path": "ui/form" - } - ], - "DocID": "GridBaseColumn.formItem" + "Description": "Configures the form item that the column produces in the editing state. Applies only if editing.mode is \"form\" or \"popup\"." }, "headerCellTemplate": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxTreeListColumn.headerCellTemplate" + "Description": "Specifies a custom template for column headers." }, "headerFilter": { - "DocID": "GridBaseColumn.headerFilter", + "Description": "Specifies data settings for the header filter.", "Options": { "allowSearch": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.headerFilter.allowSearch" + "Description": "Specifies whether searching is enabled in the header filter." }, "dataSource": { "PrimitiveTypes": [ @@ -50243,41 +48227,34 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsFunc": true, "IsDataSource": true, - "DocID": "GridBaseColumn.headerFilter.dataSource" + "Description": "Specifies a data source for the header filter." }, "groupInterval": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "GridBaseColumn.headerFilter.groupInterval" + "Description": "Specifies how the header filter combines values into groups." }, "height": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBaseColumn.headerFilter.height" + "Description": "Specifies the height of the popup menu containing filtering values." }, "searchMode": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.headerFilter.searchMode" + "Description": "Specifies a comparison operation used to search header filter values." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBaseColumn.headerFilter.width" + "Description": "Specifies the width of the popup menu containing filtering values." } } }, @@ -50285,22 +48262,22 @@ "PrimitiveTypes": [ "number" ], - "DocID": "GridBaseColumn.hidingPriority" + "Description": "Specifies the order in which columns are hidden when the widget adapts to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is \"widget\"." }, "isBand": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.isBand" + "Description": "Specifies whether the column bands other columns or not." }, "lookup": { - "DocID": "GridBaseColumn.lookup", + "Description": "Specifies options of a lookup column.", "Options": { "allowClearing": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.lookup.allowClearing" + "Description": "Specifies whether to display the Clear button in lookup column cells while they are being edited." }, "dataSource": { "PrimitiveTypes": [ @@ -50311,16 +48288,9 @@ "ItemPrimitiveTypes": [ "any" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsFunc": true, "IsDataSource": true, - "DocID": "GridBaseColumn.lookup.dataSource" + "Description": "Specifies the data source for the lookup column." }, "displayExpr": { "PrimitiveTypes": [ @@ -50328,13 +48298,13 @@ "string" ], "IsFunc": true, - "DocID": "GridBaseColumn.lookup.displayExpr" + "Description": "Specifies the data source field whose values must be displayed." }, "valueExpr": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.lookup.valueExpr" + "Description": "Specifies the data source field whose values must be replaced." } } }, @@ -50342,84 +48312,84 @@ "PrimitiveTypes": [ "number" ], - "DocID": "GridBaseColumn.minWidth" + "Description": "Specifies the minimum width of the column." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.name" + "Description": "Specifies the identifier of the column." }, "ownerBand": { "PrimitiveTypes": [ "number" ], - "DocID": "GridBaseColumn.ownerBand" + "Description": "Specifies the band column that owns the current column. Accepts the index of the band column in the columns array." }, "renderAsync": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.renderAsync" + "Description": "Specifies whether to render the column after other columns and elements. Use if column cells have a complex template. Requires the width option specified." }, "selectedFilterOperation": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "GridBaseColumn.selectedFilterOperation" + "Description": "Specifies the column's filter operation displayed in the filter row." }, "setCellValue": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBaseColumn.setCellValue" + "Description": "Specifies a function to be invoked after the user has edited a cell value, but before it will be saved in the data source." }, "showEditorAlways": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.showEditorAlways" + "Description": "Specifies whether the column displays its values using editors." }, "showInColumnChooser": { "PrimitiveTypes": [ "boolean" ], - "DocID": "GridBaseColumn.showInColumnChooser" + "Description": "Specifies whether the column chooser can contain the column header." }, "sortIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "GridBaseColumn.sortIndex" + "Description": "Specifies the index according to which columns participate in sorting." }, "sortingMethod": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "GridBaseColumn.sortingMethod" + "Description": "Specifies a custom comparison function for sorting. Applies only when sorting is performed on the client." }, "sortOrder": { "PrimitiveTypes": [ "string" ], "IsChangeable": true, - "DocID": "GridBaseColumn.sortOrder" + "Description": "Specifies the sort order of column values." }, "trueText": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumn.trueText" + "Description": "In a boolean column, replaces all true items with a specified text. Applies only if showEditorAlways option is false." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeListColumn.type" + "Description": "Specifies the command column that this object customizes." }, "validationRules": { "ItemPrimitiveTypes": [ @@ -50444,66 +48414,59 @@ "EmailRule", "AsyncRule" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "validationRule", - "DocID": "GridBaseColumn.validationRules" + "Description": "Specifies validation rules to be checked when cell values are updated." }, "visible": { "PrimitiveTypes": [ "boolean" ], "IsChangeable": true, - "DocID": "GridBaseColumn.visible" + "Description": "Specifies whether the column is visible, that is, occupies space in the table." }, "visibleIndex": { "PrimitiveTypes": [ "number" ], "IsChangeable": true, - "DocID": "GridBaseColumn.visibleIndex" + "Description": "Specifies the position of the column regarding other columns in the resulting widget." }, "width": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "GridBaseColumn.width" + "Description": "Specifies the column's width in pixels or as a percentage. Ignored if it is less than minWidth." } } }, "TreeListColumnButton": { - "DocID": "dxTreeListColumnButton", + "Description": "Allows you to customize buttons in the editing column or create a custom command column. Applies only if the column's type is \"buttons\".", "Options": { "cssClass": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumnButton.cssClass" + "Description": "Specifies a CSS class to be applied to the button." }, "hint": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumnButton.hint" + "Description": "Specifies the text for the hint that appears when the button is hovered over or long-pressed." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumnButton.icon" + "Description": "Specifies the button's icon." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeListColumnButton.name" + "Description": "The name used to identify a built-in button." }, "onClick": { "PrimitiveTypes": [ @@ -50512,20 +48475,20 @@ ], "IsFunc": true, "IsEvent": true, - "DocID": "dxTreeListColumnButton.onClick" + "Description": "A function that is executed when the button is clicked or tapped. Not executed if a template is used." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "dxTreeListColumnButton.template" + "Description": "Specifies a custom button template." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "GridBaseColumnButton.text" + "Description": "Specifies the button's text. Applies only if the button's icon is not specified." }, "visible": { "PrimitiveTypes": [ @@ -50533,42 +48496,41 @@ "Function" ], "IsFunc": true, - "DocID": "dxTreeListColumnButton.visible" + "Description": "Specifies the button's visibility." } } }, "TreeViewItem": { - "DocID": "dxTreeViewItem", "Options": { "disabled": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.disabled" + "Description": "Specifies whether the widget item responds to user interaction." }, "expanded": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeViewItem.expanded" + "Description": "Specifies whether or not the tree view item is displayed expanded." }, "hasItems": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeViewItem.hasItems" + "Description": "Specifies whether or not the tree view item has children." }, "html": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.html" + "Description": "Specifies html code inserted into the widget item element." }, "icon": { "PrimitiveTypes": [ "string" ], - "DocID": "dxTreeViewItem.icon" + "Description": "Specifies the tree view item's icon." }, "items": { "ItemPrimitiveTypes": [ @@ -50577,204 +48539,197 @@ "ItemComplexTypes": [ "TreeViewItem" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], "IsCollection": true, "SingularName": "item", - "DocID": "dxTreeViewItem.items" + "Description": "Specifies nested tree view items." }, "parentId": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "dxTreeViewItem.parentId" + "Description": "Holds the key of the parent item." }, "selected": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxTreeViewItem.selected" + "Description": "Specifies whether or not the tree view item is displayed selected." }, "template": { "PrimitiveTypes": [ "any" ], "IsTemplate": true, - "DocID": "CollectionWidgetItem.template" + "Description": "Specifies a template that should be used to render this item only." }, "text": { "PrimitiveTypes": [ "string" ], - "DocID": "CollectionWidgetItem.text" + "Description": "Specifies text displayed for the widget item." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "CollectionWidgetItem.visible" + "Description": "Specifies whether or not a widget item must be displayed." } } }, "EmailRule": { - "DocID": "EmailRule", + "Description": "A validation rule that demands that the validated field match the Email pattern.", "IsCollection": true, "Options": { "ignoreEmptyValue": { "PrimitiveTypes": [ "boolean" ], - "DocID": "EmailRule.ignoreEmptyValue" + "Description": "If set to true, empty values are valid." }, "message": { "PrimitiveTypes": [ "string" ], - "DocID": "EmailRule.message" + "Description": "Specifies the message that is shown if the rule is broken." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "EmailRule.type" + "Description": "Specifies the rule type. Set it to \"email\" to use the EmailRule." } } }, "VizFont": { - "DocID": "Font", + "Description": "Font options.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "Font.color" + "Description": "Specifies font color." }, "family": { "PrimitiveTypes": [ "string" ], - "DocID": "Font.family" + "Description": "Specifies font family." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "Font.opacity" + "Description": "Specifies font opacity." }, "size": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "Font.size" + "Description": "Specifies font size." }, "weight": { "PrimitiveTypes": [ "number" ], - "DocID": "Font.weight" + "Description": "Specifies font weight. Accepts values from 100 to 900 in increments of 100. Higher values increase boldness." } } }, "Format": { - "DocID": "format", + "Description": "Formats values.", "Options": { "currency": { "PrimitiveTypes": [ "string" ], - "DocID": "format.currency" + "Description": "Specifies a 3-letter ISO 4217 code for currency. Applies only if the type is \"currency\"." }, "formatter": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "format.formatter" + "Description": "A function that converts numeric or date-time values to a string." }, "parser": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "format.parser" + "Description": "Parses string values into numeric or date-time values. Can be used with formatter or one of the predefined formats." }, "precision": { "PrimitiveTypes": [ "number" ], - "DocID": "format.precision" + "Description": "Specifies a precision for values of a numeric format." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "format.type" + "Description": "Specifies a predefined format. Does not apply if you have specified the formatter function." } } }, "GaugeIndicator": { - "DocID": "GaugeIndicator", + "Description": "", "Options": { "arrowLength": { "PrimitiveTypes": [ "number" ], - "DocID": "CommonIndicator.arrowLength" + "Description": "Specifies the length of an arrow for the indicator of the textCloud type in pixels." }, "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "CommonIndicator.backgroundColor" + "Description": "Specifies the background color for the indicator of the rangeBar type." }, "baseValue": { "PrimitiveTypes": [ "number" ], - "DocID": "CommonIndicator.baseValue" + "Description": "Specifies the base value for the indicator of the rangeBar type." }, "beginAdaptingAtRadius": { "PrimitiveTypes": [ "number" ], - "DocID": "CommonIndicator.beginAdaptingAtRadius" + "Description": "Specifies a radius small enough for the indicator to begin adapting." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "CommonIndicator.color" + "Description": "Specifies a color of the indicator." }, "horizontalOrientation": { "PrimitiveTypes": [ "string" ], - "DocID": "CommonIndicator.horizontalOrientation" + "Description": "Specifies the orientation of the rangeBar indicator. Applies only if the geometry.orientation option is \"vertical\"." }, "indentFromCenter": { "PrimitiveTypes": [ "number" ], - "DocID": "CommonIndicator.indentFromCenter" + "Description": "Specifies the distance between the needle and the center of a gauge for the indicator of a needle-like type." }, "length": { "PrimitiveTypes": [ "number" ], - "DocID": "CommonIndicator.length" + "Description": "Specifies the indicator length." }, "offset": { "PrimitiveTypes": [ "number" ], - "DocID": "CommonIndicator.offset" + "Description": "Specifies the distance between the indicator and the invisible scale line." }, "palette": { "PrimitiveTypes": [ @@ -50785,47 +48740,47 @@ ], "IsCollection": true, "SingularName": "palette", - "DocID": "CommonIndicator.palette" + "Description": "Sets the palette to be used to colorize indicators differently." }, "secondColor": { "PrimitiveTypes": [ "string" ], - "DocID": "CommonIndicator.secondColor" + "Description": "Specifies the second color for the indicator of the twoColorNeedle type." }, "secondFraction": { "PrimitiveTypes": [ "number" ], - "DocID": "CommonIndicator.secondFraction" + "Description": "Specifies the length of a twoNeedleColor type indicator tip as a percentage." }, "size": { "PrimitiveTypes": [ "number" ], - "DocID": "CommonIndicator.size" + "Description": "Specifies the range bar size for an indicator of the rangeBar type." }, "spindleGapSize": { "PrimitiveTypes": [ "number" ], - "DocID": "CommonIndicator.spindleGapSize" + "Description": "Specifies the inner diameter in pixels, so that the spindle has the shape of a ring." }, "spindleSize": { "PrimitiveTypes": [ "number" ], - "DocID": "CommonIndicator.spindleSize" + "Description": "Specifies the spindle's diameter in pixels for the indicator of a needle-like type." }, "text": { - "DocID": "CommonIndicator.text", + "Description": "Specifies the appearance of the text displayed in an indicator of the rangeBar type.", "Options": { "customizeText": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "CommonIndicator.text.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed in an indicator." }, "font": { "PrimitiveTypes": [ @@ -50834,14 +48789,7 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "CommonIndicator.text.font" + "Description": "Specifies font options for the text displayed by the indicator." }, "format": { "PrimitiveTypes": [ @@ -50851,20 +48799,13 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "CommonIndicator.text.format" + "Description": "Formats a value before it is displayed in an indicator. Accepts only numeric formats." }, "indent": { "PrimitiveTypes": [ "number" ], - "DocID": "CommonIndicator.text.indent" + "Description": "Specifies the range bar's label indent in pixels." } } }, @@ -50872,118 +48813,118 @@ "PrimitiveTypes": [ "string" ], - "DocID": "GaugeIndicator.type" + "Description": "Specifies the type of gauge indicators." }, "verticalOrientation": { "PrimitiveTypes": [ "string" ], - "DocID": "CommonIndicator.verticalOrientation" + "Description": "Specifies the orientation of the rangeBar indicator. Applies only if the geometry.orientation option is \"horizontal\"." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "CommonIndicator.width" + "Description": "Specifies the width of an indicator in pixels." } } }, "NumericRule": { - "DocID": "NumericRule", + "Description": "A validation rule that demands that the validated field has a numeric value.", "IsCollection": true, "Options": { "ignoreEmptyValue": { "PrimitiveTypes": [ "boolean" ], - "DocID": "NumericRule.ignoreEmptyValue" + "Description": "If set to true, empty values are valid." }, "message": { "PrimitiveTypes": [ "string" ], - "DocID": "NumericRule.message" + "Description": "Specifies the message that is shown if the rule is broken." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "NumericRule.type" + "Description": "Specifies the rule type. Set it to \"numeric\" to use the NumericRule." } } }, "PatternRule": { - "DocID": "PatternRule", + "Description": "A validation rule that demands that the validated field match a specified pattern.", "IsCollection": true, "Options": { "ignoreEmptyValue": { "PrimitiveTypes": [ "boolean" ], - "DocID": "PatternRule.ignoreEmptyValue" + "Description": "If set to true, empty values are valid." }, "message": { "PrimitiveTypes": [ "string" ], - "DocID": "PatternRule.message" + "Description": "Specifies the message that is shown if the rule is broken." }, "pattern": { "PrimitiveTypes": [ "RegExp", "string" ], - "DocID": "PatternRule.pattern" + "Description": "Specifies the regular expression that the validated value must match." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "PatternRule.type" + "Description": "Specifies the rule type. Set it to \"pattern\" to use the PatternRule." } } }, "PieChartCommonSeriesSettings": { - "DocID": "PieChartCommonSeriesSettings", + "Description": "An object defining the configuration options that are common for all series of the PieChart widget.", "Options": { "argumentField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.argumentField" + "Description": "Specifies the data source field that provides arguments for series points." }, "argumentType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.argumentType" + "Description": "Specifies the required type for series arguments." }, "border": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.border", + "Description": "An object defining the series border configuration options.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.border.color" + "Description": "Sets a border color for a series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.border.dashStyle" + "Description": "Specifies a dash style for the border of a series point." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.border.visible" + "Description": "Sets border visibility for a series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.border.width" + "Description": "Sets a border width for a series in pixels." } } }, @@ -50991,43 +48932,43 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.color" + "Description": "Specifies a series color." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverMode" + "Description": "Specifies the chart elements to highlight when a series is hovered over." }, "hoverStyle": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle", + "Description": "An object defining configuration options for a hovered series.", "Options": { "border": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.border", + "Description": "An object defining the border options for a hovered series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.border.color" + "Description": "Sets a border color for the series when it is hovered over." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.border.dashStyle" + "Description": "Specifies a dash style for the border of a series point when this point is hovered over." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.border.visible" + "Description": "Sets border visibility for a hovered series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.border.width" + "Description": "Sets a border width for a hovered series." } } }, @@ -51035,41 +48976,41 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.color" + "Description": "Sets a color for the series when it is hovered over." }, "hatching": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.hatching", + "Description": "Specifies the hatching options to be applied when a point is hovered over.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.hatching.direction" + "Description": "Specifies how to apply hatching to highlight the hovered point." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.hatching.opacity" + "Description": "Specifies the opacity of hatching lines." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.hatching.step" + "Description": "Specifies the distance between two hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.hatching.width" + "Description": "Specifies the width of hatching lines in pixels." } } } } }, "label": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label", + "Description": "An object defining the label configuration options.", "Options": { "argumentFormat": { "PrimitiveTypes": [ @@ -51079,70 +49020,63 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.argumentFormat" + "Description": "Formats the point argument before it is displayed in the point label. To format the point value, use the format option." }, "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.backgroundColor" + "Description": "Colors the point labels' background. The default color is inherited from the points." }, "border": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.border", + "Description": "Specifies border options for point labels.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.border.color" + "Description": "Specifies a border color for point labels." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.border.dashStyle" + "Description": "Specifies a dash style for the borders of point labels." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.border.visible" + "Description": "Indicates whether or not borders are visible in point labels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.border.width" + "Description": "Specifies the border width for point labels." } } }, "connector": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.connector", + "Description": "Specifies connector options for series point labels.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.connector.color" + "Description": "Specifies the color of label connectors." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.connector.visible" + "Description": "Indicates whether or not label connectors are visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.connector.width" + "Description": "Specifies the width of label connectors." } } }, @@ -51151,7 +49085,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed by point labels." }, "font": { "PrimitiveTypes": [ @@ -51160,14 +49094,7 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.font" + "Description": "Specifies font options for the text displayed in point labels." }, "format": { "PrimitiveTypes": [ @@ -51177,50 +49104,43 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.format" + "Description": "Formats a value before it is displayed in a point label." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.position" + "Description": "Specifies a label position relative to the chart." }, "radialOffset": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.radialOffset" + "Description": "Specifies how to shift labels from their initial position in a radial direction in pixels." }, "rotationAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.rotationAngle" + "Description": "Specifies the angle used to rotate point labels from their initial position." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.textOverflow" + "Description": "Specifies what to do with label texts that overflow the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.visible" + "Description": "Specifies the visibility of point labels." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.wordWrap" + "Description": "Specifies how to wrap label texts if they do not fit into a single line." } } }, @@ -51228,49 +49148,49 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.maxLabelCount" + "Description": "Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed." }, "minSegmentSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.minSegmentSize" + "Description": "Specifies a minimal size of a displayed pie segment." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionMode" + "Description": "Specifies the chart elements to highlight when the series is selected." }, "selectionStyle": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle", + "Description": "An object defining configuration options for the series when it is selected.", "Options": { "border": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.border", + "Description": "An object defining the border options for a selected series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.border.color" + "Description": "Sets a border color for a selected series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.border.dashStyle" + "Description": "Specifies a dash style for the border of a selected series point." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.border.visible" + "Description": "Sets a border visibility for a selected series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.border.width" + "Description": "Sets a border width for a selected series." } } }, @@ -51278,65 +49198,65 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.color" + "Description": "Sets a color for a series when it is selected." }, "hatching": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.hatching", + "Description": "Specifies the hatching options to be applied when a point is selected.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.hatching.direction" + "Description": "Specifies how to apply hatching to highlight the selected point." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.hatching.opacity" + "Description": "Specifies the opacity of hatching lines." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.hatching.step" + "Description": "Specifies the distance between two hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.hatching.width" + "Description": "Specifies the width of hatching lines in pixels." } } } } }, "smallValuesGrouping": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.smallValuesGrouping", + "Description": "Specifies chart segment grouping options.", "Options": { "groupName": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.smallValuesGrouping.groupName" + "Description": "Specifies the name of the grouped chart segment. This name represents the segment in the chart legend." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.smallValuesGrouping.mode" + "Description": "Specifies the segment grouping mode." }, "threshold": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.smallValuesGrouping.threshold" + "Description": "Specifies a threshold for segment values." }, "topCount": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.smallValuesGrouping.topCount" + "Description": "Specifies how many segments must not be grouped." } } }, @@ -51344,58 +49264,58 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.tagField" + "Description": "Specifies the name of the data source field that provides data about a point." }, "valueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.valueField" + "Description": "Specifies the data source field that provides values for series points." } } }, "PieChartSeries": { - "DocID": "PieChartSeries", + "Description": "Specifies options for the series of the PieChart widget.", "IsCollection": true, "Options": { "argumentField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.argumentField" + "Description": "Specifies the data source field that provides arguments for series points." }, "argumentType": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.argumentType" + "Description": "Specifies the required type for series arguments." }, "border": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.border", + "Description": "An object defining the series border configuration options.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.border.color" + "Description": "Sets a border color for a series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.border.dashStyle" + "Description": "Specifies a dash style for the border of a series point." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.border.visible" + "Description": "Sets border visibility for a series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.border.width" + "Description": "Sets a border width for a series in pixels." } } }, @@ -51403,43 +49323,43 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.color" + "Description": "Specifies a series color." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverMode" + "Description": "Specifies the chart elements to highlight when a series is hovered over." }, "hoverStyle": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle", + "Description": "An object defining configuration options for a hovered series.", "Options": { "border": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.border", + "Description": "An object defining the border options for a hovered series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.border.color" + "Description": "Sets a border color for the series when it is hovered over." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.border.dashStyle" + "Description": "Specifies a dash style for the border of a series point when this point is hovered over." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.border.visible" + "Description": "Sets border visibility for a hovered series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.border.width" + "Description": "Sets a border width for a hovered series." } } }, @@ -51447,41 +49367,41 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.color" + "Description": "Sets a color for the series when it is hovered over." }, "hatching": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.hatching", + "Description": "Specifies the hatching options to be applied when a point is hovered over.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.hatching.direction" + "Description": "Specifies how to apply hatching to highlight the hovered point." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.hatching.opacity" + "Description": "Specifies the opacity of hatching lines." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.hatching.step" + "Description": "Specifies the distance between two hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.hoverStyle.hatching.width" + "Description": "Specifies the width of hatching lines in pixels." } } } } }, "label": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label", + "Description": "An object defining the label configuration options.", "Options": { "argumentFormat": { "PrimitiveTypes": [ @@ -51491,70 +49411,63 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.argumentFormat" + "Description": "Formats the point argument before it is displayed in the point label. To format the point value, use the format option." }, "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.backgroundColor" + "Description": "Colors the point labels' background. The default color is inherited from the points." }, "border": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.border", + "Description": "Specifies border options for point labels.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.border.color" + "Description": "Specifies a border color for point labels." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.border.dashStyle" + "Description": "Specifies a dash style for the borders of point labels." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.border.visible" + "Description": "Indicates whether or not borders are visible in point labels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.border.width" + "Description": "Specifies the border width for point labels." } } }, "connector": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.connector", + "Description": "Specifies connector options for series point labels.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.connector.color" + "Description": "Specifies the color of label connectors." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.connector.visible" + "Description": "Indicates whether or not label connectors are visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.connector.width" + "Description": "Specifies the width of label connectors." } } }, @@ -51563,7 +49476,7 @@ "Function" ], "IsFunc": true, - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed by point labels." }, "font": { "PrimitiveTypes": [ @@ -51572,14 +49485,7 @@ "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.font" + "Description": "Specifies font options for the text displayed in point labels." }, "format": { "PrimitiveTypes": [ @@ -51589,50 +49495,43 @@ "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "default", - "Alias": "DevExpress", - "Path": "bundles/dx.all" - } - ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.format" + "Description": "Formats a value before it is displayed in a point label." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.position" + "Description": "Specifies a label position relative to the chart." }, "radialOffset": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.radialOffset" + "Description": "Specifies how to shift labels from their initial position in a radial direction in pixels." }, "rotationAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.rotationAngle" + "Description": "Specifies the angle used to rotate point labels from their initial position." }, "textOverflow": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.textOverflow" + "Description": "Specifies what to do with label texts that overflow the allocated space after applying wordWrap: hide, truncate them and display an ellipsis, or do nothing." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.visible" + "Description": "Specifies the visibility of point labels." }, "wordWrap": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.label.wordWrap" + "Description": "Specifies how to wrap label texts if they do not fit into a single line." } } }, @@ -51640,55 +49539,55 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.maxLabelCount" + "Description": "Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed." }, "minSegmentSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.minSegmentSize" + "Description": "Specifies a minimal size of a displayed pie segment." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "PieChartSeries.name" + "Description": "Specifies the name that identifies the series." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionMode" + "Description": "Specifies the chart elements to highlight when the series is selected." }, "selectionStyle": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle", + "Description": "An object defining configuration options for the series when it is selected.", "Options": { "border": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.border", + "Description": "An object defining the border options for a selected series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.border.color" + "Description": "Sets a border color for a selected series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.border.dashStyle" + "Description": "Specifies a dash style for the border of a selected series point." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.border.visible" + "Description": "Sets a border visibility for a selected series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.border.width" + "Description": "Sets a border width for a selected series." } } }, @@ -51696,65 +49595,65 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.color" + "Description": "Sets a color for a series when it is selected." }, "hatching": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.hatching", + "Description": "Specifies the hatching options to be applied when a point is selected.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.hatching.direction" + "Description": "Specifies how to apply hatching to highlight the selected point." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.hatching.opacity" + "Description": "Specifies the opacity of hatching lines." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.hatching.step" + "Description": "Specifies the distance between two hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.selectionStyle.hatching.width" + "Description": "Specifies the width of hatching lines in pixels." } } } } }, "smallValuesGrouping": { - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.smallValuesGrouping", + "Description": "Specifies chart segment grouping options.", "Options": { "groupName": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.smallValuesGrouping.groupName" + "Description": "Specifies the name of the grouped chart segment. This name represents the segment in the chart legend." }, "mode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.smallValuesGrouping.mode" + "Description": "Specifies the segment grouping mode." }, "threshold": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.smallValuesGrouping.threshold" + "Description": "Specifies a threshold for segment values." }, "topCount": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.smallValuesGrouping.topCount" + "Description": "Specifies how many segments must not be grouped." } } }, @@ -51762,24 +49661,24 @@ "PrimitiveTypes": [ "any" ], - "DocID": "PieChartSeries.tag" + "Description": "Specifies data about a series." }, "tagField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.tagField" + "Description": "Specifies the name of the data source field that provides data about a point." }, "valueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPieChartSeriesTypes.CommonPieChartSeries.valueField" + "Description": "Specifies the data source field that provides values for series points." } } }, "PolarChartCommonSeriesSettings": { - "DocID": "PolarChartCommonSeriesSettings", + "Description": "An object defining the configuration options that are common for all series of the PolarChart widget.", "Options": { "area": { "PrimitiveTypes": [ @@ -51788,13 +49687,13 @@ "ComplexTypes": [ "PolarChartCommonSeriesSettings" ], - "DocID": "PolarChartCommonSeriesSettings.area" + "Description": "An object that specifies configuration options for all series of the area type in the chart." }, "argumentField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.argumentField" + "Description": "Specifies the data source field that provides arguments for series points." }, "bar": { "PrimitiveTypes": [ @@ -51803,46 +49702,46 @@ "ComplexTypes": [ "PolarChartCommonSeriesSettings" ], - "DocID": "PolarChartCommonSeriesSettings.bar" + "Description": "An object that specifies configuration options for all series of the 'bar' type in the chart." }, "barPadding": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.barPadding" + "Description": "Controls the padding and consequently the angular width of all bars in a series using relative units. Ignored if the barWidth option is set." }, "barWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.barWidth" + "Description": "Specifies a fixed angular width for all bars in a series, measured in degrees. Takes precedence over the barPadding option." }, "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.border", + "Description": "An object defining the series border configuration options.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.border.color" + "Description": "Sets a border color for a series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.border.dashStyle" + "Description": "Specifies a dash style for the borders of series points." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.border.visible" + "Description": "Sets border visibility for a series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.border.width" + "Description": "Sets a border width for a series in pixels." } } }, @@ -51850,55 +49749,55 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.closed" + "Description": "Specifies whether or not to close the chart by joining the end point with the first point." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.color" + "Description": "Specifies a series color." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.dashStyle" + "Description": "Specifies the dash style of the series' line." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverMode" + "Description": "Specifies the series elements to highlight when a series is hovered over." }, "hoverStyle": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle", + "Description": "An object defining configuration options for a hovered series.", "Options": { "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.border", + "Description": "An object defining the border options for a hovered series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.border.color" + "Description": "Sets a border color for a hovered series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.border.dashStyle" + "Description": "Specifies a dash style for the borders of point labels." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.border.visible" + "Description": "Sets a border visibility for a hovered series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.border.width" + "Description": "Sets a border width for a hovered series." } } }, @@ -51906,40 +49805,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.color" + "Description": "Sets a color for a series when it is hovered over." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.dashStyle" + "Description": "Specifies the dash style for the line in a hovered series." }, "hatching": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.hatching", + "Description": "Specifies the hatching options to be applied when a series is hovered over.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.hatching.direction" + "Description": "Specifies how to apply hatching to highlight the hovered series." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.hatching.opacity" + "Description": "Specifies the opacity of hatching lines." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.hatching.step" + "Description": "Specifies the distance between hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.hatching.width" + "Description": "Specifies the width of hatching lines in pixels." } } }, @@ -51947,7 +49846,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.width" + "Description": "Specifies the width of a line in a hovered series." } } }, @@ -51955,82 +49854,76 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.ignoreEmptyPoints" + "Description": "Specifies whether the series should ignore null data points." }, "label": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label", + "Description": "An object defining the label configuration options.", "Options": { "argumentFormat": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.argumentFormat" + "Description": "Formats the point argument before it is displayed in the point label. To format the point value, use the format option." }, "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.backgroundColor" + "Description": "Colors the point labels' background. The default color is inherited from the points." }, "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.border", + "Description": "Specifies border options for point labels.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.border.color" + "Description": "Specifies a border color for point labels." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.border.dashStyle" + "Description": "Specifies a dash style for the borders of point labels." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.border.visible" + "Description": "Indicates whether borders are visible in point labels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.border.width" + "Description": "Specifies the border width for point labels." } } }, "connector": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.connector", + "Description": "Specifies connector options for series point labels.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.connector.color" + "Description": "Specifies the color of label connectors." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.connector.visible" + "Description": "Indicates whether or not label connectors are visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.connector.width" + "Description": "Specifies the width of label connectors." } } }, @@ -52039,62 +49932,50 @@ "Function" ], "IsFunc": true, - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed by point labels." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.font" + "Description": "Specifies font options for the text displayed in point labels." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.format" + "Description": "Formats a value before it is displayed in a point label." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.position" + "Description": "Specifies a label position in bar-like series." }, "rotationAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.rotationAngle" + "Description": "Specifies the angle used to rotate point labels from their initial position." }, "showForZeroValues": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.showForZeroValues" + "Description": "Specifies whether or not to show a label when the point has a zero value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.visible" + "Description": "Specifies the visibility of point labels." } } }, @@ -52105,49 +49986,49 @@ "ComplexTypes": [ "PolarChartCommonSeriesSettings" ], - "DocID": "PolarChartCommonSeriesSettings.line" + "Description": "An object that specifies configuration options for all series of the 'line' type in the chart." }, "maxLabelCount": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.maxLabelCount" + "Description": "Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed." }, "minBarSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.minBarSize" + "Description": "Specifies the minimal length of a displayed bar in pixels." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.opacity" + "Description": "Specifies opacity for a series." }, "point": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point", + "Description": "An object defining configuration options for points in line and area series.", "Options": { "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.border", + "Description": "Specifies border options for points in the line and area series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.border.color" + "Description": "Sets a border color for points in the line and area series." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.border.visible" + "Description": "Sets border visibility for points in the line and area series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.border.width" + "Description": "Sets a border width for points in the line or area series." } } }, @@ -52155,37 +50036,37 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.color" + "Description": "Specifies the points color." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverMode" + "Description": "Specifies what series points to highlight when a point is hovered over." }, "hoverStyle": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle", + "Description": "An object defining configuration options for a hovered point.", "Options": { "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle.border", + "Description": "An object defining the border options for a hovered point.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle.border.color" + "Description": "Sets a border color for a hovered point." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle.border.visible" + "Description": "Sets border visibility for a hovered point." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle.border.width" + "Description": "Sets a border width for a hovered point." } } }, @@ -52193,13 +50074,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle.color" + "Description": "Sets a color for a point when it is hovered over." }, "size": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle.size" + "Description": "Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance)." } } }, @@ -52207,25 +50088,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.image", + "Description": "An object specifying the parameters of an image that is used as a point marker.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.image.height" + "Description": "Specifies the height of an image that is used as a point marker." }, "url": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.image.url" + "Description": "Specifies a URL leading to the image to be used as a point marker." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.image.width" + "Description": "Specifies the width of an image that is used as a point marker." } } }, @@ -52233,31 +50114,31 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionMode" + "Description": "Specifies what series points to highlight when a point is selected." }, "selectionStyle": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle", + "Description": "An object defining configuration options for a selected point.", "Options": { "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle.border", + "Description": "An object defining the border options for a selected point.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle.border.color" + "Description": "Sets a border color for a selected point." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle.border.visible" + "Description": "Sets border visibility for a selected point." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle.border.width" + "Description": "Sets a border width for a selected point." } } }, @@ -52265,13 +50146,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle.color" + "Description": "Sets a color for a point when it is selected." }, "size": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle.size" + "Description": "Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance)." } } }, @@ -52279,19 +50160,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.size" + "Description": "Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance)." }, "symbol": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.symbol" + "Description": "Specifies a symbol for presenting points of the line and area series." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.visible" + "Description": "Specifies the points visibility for a line and area series." } } }, @@ -52302,43 +50183,43 @@ "ComplexTypes": [ "PolarChartCommonSeriesSettings" ], - "DocID": "PolarChartCommonSeriesSettings.scatter" + "Description": "An object that specifies configuration options for all series of the 'scatter' type in the chart." }, "selectionMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionMode" + "Description": "Specifies the series elements to highlight when the series is selected." }, "selectionStyle": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle", + "Description": "An object defining configuration options for a selected series.", "Options": { "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.border", + "Description": "An object defining the border options for a selected series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.border.color" + "Description": "Sets a border color for a selected series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.border.dashStyle" + "Description": "Specifies a dash style for the borders of point labels." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.border.visible" + "Description": "Sets border visibility for a selected series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.border.width" + "Description": "Sets a border width for a selected series." } } }, @@ -52346,40 +50227,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.color" + "Description": "Sets a color for a series when it is selected." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.dashStyle" + "Description": "Specifies the dash style for the line in a selected series." }, "hatching": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.hatching", + "Description": "Specifies the hatching options to be applied when a series is selected.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.hatching.direction" + "Description": "Specifies how to apply hatching to highlight a selected series." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.hatching.opacity" + "Description": "Specifies the opacity of hatching lines." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.hatching.step" + "Description": "Specifies the distance between hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.hatching.width" + "Description": "Specifies the width of hatching lines in pixels." } } }, @@ -52387,7 +50268,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.width" + "Description": "Specifies the width of a line in a selected series." } } }, @@ -52395,13 +50276,13 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.showInLegend" + "Description": "Specifies whether or not to show the series in the chart's legend." }, "stack": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.stack" + "Description": "Specifies the name of the stack where the values of the 'stackedBar' series must be located." }, "stackedbar": { "PrimitiveTypes": [ @@ -52410,76 +50291,76 @@ "ComplexTypes": [ "PolarChartCommonSeriesSettings" ], - "DocID": "PolarChartCommonSeriesSettings.stackedbar" + "Description": "An object that specifies configuration options for all series of the 'stackedBar' type in the chart." }, "tagField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.tagField" + "Description": "Specifies the name of the data source field that provides data about a point." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "PolarChartCommonSeriesSettings.type" + "Description": "Sets a series type." }, "valueErrorBar": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar", + "Description": "Configures error bars.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.color" + "Description": "Specifies the color of error bars." }, "displayMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.displayMode" + "Description": "Specifies whether error bars must be displayed in full or partially." }, "edgeLength": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.edgeLength" + "Description": "Specifies the length of the lines that indicate error bar edges." }, "highValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.highValueField" + "Description": "Specifies the data field that provides data for high error values." }, "lineWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.lineWidth" + "Description": "Specifies the width of the error bar line." }, "lowValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.lowValueField" + "Description": "Specifies the data field that provides data for low error values." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.opacity" + "Description": "Specifies the opacity of error bars." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.type" + "Description": "Specifies how error bar values must be calculated." }, "value": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.value" + "Description": "Specifies the value to be used for generating error bars." } } }, @@ -52487,70 +50368,70 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueField" + "Description": "Specifies the data source field that provides values for series points." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.visible" + "Description": "Specifies the visibility of a series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.width" + "Description": "Specifies a line width." } } }, "PolarChartSeries": { - "DocID": "PolarChartSeries", + "Description": "Specifies options for PolarChart widget series.", "IsCollection": true, "Options": { "argumentField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.argumentField" + "Description": "Specifies the data source field that provides arguments for series points." }, "barPadding": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.barPadding" + "Description": "Controls the padding and consequently the angular width of all bars in a series using relative units. Ignored if the barWidth option is set." }, "barWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.barWidth" + "Description": "Specifies a fixed angular width for all bars in a series, measured in degrees. Takes precedence over the barPadding option." }, "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.border", + "Description": "An object defining the series border configuration options.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.border.color" + "Description": "Sets a border color for a series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.border.dashStyle" + "Description": "Specifies a dash style for the borders of series points." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.border.visible" + "Description": "Sets border visibility for a series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.border.width" + "Description": "Sets a border width for a series in pixels." } } }, @@ -52558,55 +50439,55 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.closed" + "Description": "Specifies whether or not to close the chart by joining the end point with the first point." }, "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.color" + "Description": "Specifies a series color." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.dashStyle" + "Description": "Specifies the dash style of the series' line." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverMode" + "Description": "Specifies the series elements to highlight when a series is hovered over." }, "hoverStyle": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle", + "Description": "An object defining configuration options for a hovered series.", "Options": { "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.border", + "Description": "An object defining the border options for a hovered series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.border.color" + "Description": "Sets a border color for a hovered series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.border.dashStyle" + "Description": "Specifies a dash style for the borders of point labels." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.border.visible" + "Description": "Sets a border visibility for a hovered series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.border.width" + "Description": "Sets a border width for a hovered series." } } }, @@ -52614,40 +50495,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.color" + "Description": "Sets a color for a series when it is hovered over." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.dashStyle" + "Description": "Specifies the dash style for the line in a hovered series." }, "hatching": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.hatching", + "Description": "Specifies the hatching options to be applied when a series is hovered over.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.hatching.direction" + "Description": "Specifies how to apply hatching to highlight the hovered series." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.hatching.opacity" + "Description": "Specifies the opacity of hatching lines." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.hatching.step" + "Description": "Specifies the distance between hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.hatching.width" + "Description": "Specifies the width of hatching lines in pixels." } } }, @@ -52655,7 +50536,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.hoverStyle.width" + "Description": "Specifies the width of a line in a hovered series." } } }, @@ -52663,82 +50544,76 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.ignoreEmptyPoints" + "Description": "Specifies whether the series should ignore null data points." }, "label": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label", + "Description": "An object defining the label configuration options.", "Options": { "argumentFormat": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.argumentFormat" + "Description": "Formats the point argument before it is displayed in the point label. To format the point value, use the format option." }, "backgroundColor": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.backgroundColor" + "Description": "Colors the point labels' background. The default color is inherited from the points." }, "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.border", + "Description": "Specifies border options for point labels.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.border.color" + "Description": "Specifies a border color for point labels." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.border.dashStyle" + "Description": "Specifies a dash style for the borders of point labels." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.border.visible" + "Description": "Indicates whether borders are visible in point labels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.border.width" + "Description": "Specifies the border width for point labels." } } }, "connector": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.connector", + "Description": "Specifies connector options for series point labels.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.connector.color" + "Description": "Specifies the color of label connectors." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.connector.visible" + "Description": "Indicates whether or not label connectors are visible." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.connector.width" + "Description": "Specifies the width of label connectors." } } }, @@ -52747,62 +50622,50 @@ "Function" ], "IsFunc": true, - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.customizeText" + "Description": "Specifies a callback function that returns the text to be displayed by point labels." }, "font": { "PrimitiveTypes": [ - "Font" + "DevExpress.viz.Font" ], "ComplexTypes": [ "VizFont" ], - "TypeImports": [ - { - "Name": "Font", - "Path": "viz/core/base_widget" - } - ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.font" + "Description": "Specifies font options for the text displayed in point labels." }, "format": { "PrimitiveTypes": [ - "format", + "DevExpress.ui.format", "string" ], "ComplexTypes": [ "Format" ], - "TypeImports": [ - { - "Name": "format", - "Path": "ui/widget/ui.widget" - } - ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.format" + "Description": "Formats a value before it is displayed in a point label." }, "position": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.position" + "Description": "Specifies a label position in bar-like series." }, "rotationAngle": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.rotationAngle" + "Description": "Specifies the angle used to rotate point labels from their initial position." }, "showForZeroValues": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.showForZeroValues" + "Description": "Specifies whether or not to show a label when the point has a zero value." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.label.visible" + "Description": "Specifies the visibility of point labels." } } }, @@ -52810,49 +50673,49 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.maxLabelCount" + "Description": "Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed." }, "minBarSize": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.minBarSize" + "Description": "Specifies the minimal length of a displayed bar in pixels." }, "name": { "PrimitiveTypes": [ "string" ], - "DocID": "PolarChartSeries.name" + "Description": "Specifies the name that identifies the series." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.opacity" + "Description": "Specifies opacity for a series." }, "point": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point", + "Description": "An object defining configuration options for points in line and area series.", "Options": { "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.border", + "Description": "Specifies border options for points in the line and area series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.border.color" + "Description": "Sets a border color for points in the line and area series." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.border.visible" + "Description": "Sets border visibility for points in the line and area series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.border.width" + "Description": "Sets a border width for points in the line or area series." } } }, @@ -52860,37 +50723,37 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.color" + "Description": "Specifies the points color." }, "hoverMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverMode" + "Description": "Specifies what series points to highlight when a point is hovered over." }, "hoverStyle": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle", + "Description": "An object defining configuration options for a hovered point.", "Options": { "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle.border", + "Description": "An object defining the border options for a hovered point.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle.border.color" + "Description": "Sets a border color for a hovered point." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle.border.visible" + "Description": "Sets border visibility for a hovered point." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle.border.width" + "Description": "Sets a border width for a hovered point." } } }, @@ -52898,13 +50761,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle.color" + "Description": "Sets a color for a point when it is hovered over." }, "size": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.hoverStyle.size" + "Description": "Specifies the diameter of a hovered point in the series that represents data points as symbols (not as bars for instance)." } } }, @@ -52912,25 +50775,25 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.image", + "Description": "An object specifying the parameters of an image that is used as a point marker.", "Options": { "height": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.image.height" + "Description": "Specifies the height of an image that is used as a point marker." }, "url": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.image.url" + "Description": "Specifies a URL leading to the image to be used as a point marker." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.image.width" + "Description": "Specifies the width of an image that is used as a point marker." } } }, @@ -52938,31 +50801,31 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionMode" + "Description": "Specifies what series points to highlight when a point is selected." }, "selectionStyle": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle", + "Description": "An object defining configuration options for a selected point.", "Options": { "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle.border", + "Description": "An object defining the border options for a selected point.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle.border.color" + "Description": "Sets a border color for a selected point." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle.border.visible" + "Description": "Sets border visibility for a selected point." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle.border.width" + "Description": "Sets a border width for a selected point." } } }, @@ -52970,13 +50833,13 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle.color" + "Description": "Sets a color for a point when it is selected." }, "size": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.selectionStyle.size" + "Description": "Specifies the diameter of a selected point in the series that represents data points as symbols (not as bars for instance)." } } }, @@ -52984,19 +50847,19 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.size" + "Description": "Specifies the point diameter in pixels for those series that represent data points as symbols (not as bars for instance)." }, "symbol": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.symbol" + "Description": "Specifies a symbol for presenting points of the line and area series." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.point.visible" + "Description": "Specifies the points visibility for a line and area series." } } }, @@ -53004,37 +50867,37 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionMode" + "Description": "Specifies the series elements to highlight when the series is selected." }, "selectionStyle": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle", + "Description": "An object defining configuration options for a selected series.", "Options": { "border": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.border", + "Description": "An object defining the border options for a selected series.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.border.color" + "Description": "Sets a border color for a selected series." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.border.dashStyle" + "Description": "Specifies a dash style for the borders of point labels." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.border.visible" + "Description": "Sets border visibility for a selected series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.border.width" + "Description": "Sets a border width for a selected series." } } }, @@ -53042,40 +50905,40 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.color" + "Description": "Sets a color for a series when it is selected." }, "dashStyle": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.dashStyle" + "Description": "Specifies the dash style for the line in a selected series." }, "hatching": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.hatching", + "Description": "Specifies the hatching options to be applied when a series is selected.", "Options": { "direction": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.hatching.direction" + "Description": "Specifies how to apply hatching to highlight a selected series." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.hatching.opacity" + "Description": "Specifies the opacity of hatching lines." }, "step": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.hatching.step" + "Description": "Specifies the distance between hatching lines in pixels." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.hatching.width" + "Description": "Specifies the width of hatching lines in pixels." } } }, @@ -53083,7 +50946,7 @@ "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.selectionStyle.width" + "Description": "Specifies the width of a line in a selected series." } } }, @@ -53091,88 +50954,88 @@ "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.showInLegend" + "Description": "Specifies whether or not to show the series in the chart's legend." }, "stack": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.stack" + "Description": "Specifies the name of the stack where the values of the 'stackedBar' series must be located." }, "tag": { "PrimitiveTypes": [ "any" ], - "DocID": "PolarChartSeries.tag" + "Description": "Specifies data about a series." }, "tagField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.tagField" + "Description": "Specifies the name of the data source field that provides data about a point." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "PolarChartSeries.type" + "Description": "Sets the series type." }, "valueErrorBar": { - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar", + "Description": "Configures error bars.", "Options": { "color": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.color" + "Description": "Specifies the color of error bars." }, "displayMode": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.displayMode" + "Description": "Specifies whether error bars must be displayed in full or partially." }, "edgeLength": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.edgeLength" + "Description": "Specifies the length of the lines that indicate error bar edges." }, "highValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.highValueField" + "Description": "Specifies the data field that provides data for high error values." }, "lineWidth": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.lineWidth" + "Description": "Specifies the width of the error bar line." }, "lowValueField": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.lowValueField" + "Description": "Specifies the data field that provides data for low error values." }, "opacity": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.opacity" + "Description": "Specifies the opacity of error bars." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.type" + "Description": "Specifies how error bar values must be calculated." }, "value": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueErrorBar.value" + "Description": "Specifies the value to be used for generating error bars." } } }, @@ -53180,42 +51043,42 @@ "PrimitiveTypes": [ "string" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.valueField" + "Description": "Specifies the data source field that provides values for series points." }, "visible": { "PrimitiveTypes": [ "boolean" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.visible" + "Description": "Specifies the visibility of a series." }, "width": { "PrimitiveTypes": [ "number" ], - "DocID": "dxPolarChartSeriesTypes.CommonPolarChartSeries.width" + "Description": "Specifies a line width." } } }, "PositionConfig": { - "DocID": "positionConfig", + "Description": "Configures the position of an overlay element.", "Options": { "at": { "PrimitiveTypes": [ "string" ], - "DocID": "positionConfig.at", + "Description": "Specifies the target element's side or corner where the overlay element should be positioned.", "Options": { "x": { "PrimitiveTypes": [ "string" ], - "DocID": "positionConfig.at.x" + "Description": "Specifies a position in the horizontal direction (for left, right, or center alignment)." }, "y": { "PrimitiveTypes": [ "string" ], - "DocID": "positionConfig.at.y" + "Description": "Specifies a position in the vertical direction (for top, bottom, or center alignment)." } } }, @@ -53226,25 +51089,25 @@ "string", "Window" ], - "DocID": "positionConfig.boundary" + "Description": "A boundary element in which the overlay element must be positioned." }, "boundaryOffset": { "PrimitiveTypes": [ "string" ], - "DocID": "positionConfig.boundaryOffset", + "Description": "Specifies the offset of boundaries from the boundary element.", "Options": { "x": { "PrimitiveTypes": [ "number" ], - "DocID": "positionConfig.boundaryOffset.x" + "Description": "Specifies a horizontal offset." }, "y": { "PrimitiveTypes": [ "number" ], - "DocID": "positionConfig.boundaryOffset.y" + "Description": "Specifies a vertical offset." } } }, @@ -53252,19 +51115,19 @@ "PrimitiveTypes": [ "string" ], - "DocID": "positionConfig.collision", + "Description": "Specifies how to resolve collisions - when the overlay element exceeds the boundary element.", "Options": { "x": { "PrimitiveTypes": [ "string" ], - "DocID": "positionConfig.collision.x" + "Description": "Specifies how to resolve horizontal collisions." }, "y": { "PrimitiveTypes": [ "string" ], - "DocID": "positionConfig.collision.y" + "Description": "Specifies how to resolve vertical collisions." } } }, @@ -53272,19 +51135,19 @@ "PrimitiveTypes": [ "string" ], - "DocID": "positionConfig.my", + "Description": "Specifies the overlay element's side or corner to align with a target element.", "Options": { "x": { "PrimitiveTypes": [ "string" ], - "DocID": "positionConfig.my.x" + "Description": "Specifies a position in the horizontal direction (for left, right, or center alignment)." }, "y": { "PrimitiveTypes": [ "string" ], - "DocID": "positionConfig.my.y" + "Description": "Specifies a position in the vertical direction (for top, bottom, or center alignment)." } } }, @@ -53295,100 +51158,100 @@ "string", "Window" ], - "DocID": "positionConfig.of" + "Description": "The target element relative to which the overlay element should be positioned." }, "offset": { "PrimitiveTypes": [ "string" ], - "DocID": "positionConfig.offset", + "Description": "Specifies the overlay element's offset from a specified position.", "Options": { "x": { "PrimitiveTypes": [ "number" ], - "DocID": "positionConfig.offset.x" + "Description": "Specifies a horizontal offset." }, "y": { "PrimitiveTypes": [ "number" ], - "DocID": "positionConfig.offset.y" + "Description": "Specifies a vertical offset." } } } } }, "RangeRule": { - "DocID": "RangeRule", + "Description": "A validation rule that demands the target value be within the specified value range (including the range's end points).", "IsCollection": true, "Options": { "ignoreEmptyValue": { "PrimitiveTypes": [ "boolean" ], - "DocID": "RangeRule.ignoreEmptyValue" + "Description": "If set to true, empty values are valid." }, "max": { "PrimitiveTypes": [ "Date", "number" ], - "DocID": "RangeRule.max" + "Description": "Specifies the maximum value allowed for the validated value." }, "message": { "PrimitiveTypes": [ "string" ], - "DocID": "RangeRule.message" + "Description": "Specifies the message that is shown if the rule is broken." }, "min": { "PrimitiveTypes": [ "Date", "number" ], - "DocID": "RangeRule.min" + "Description": "Specifies the minimum value allowed for the validated value." }, "reevaluate": { "PrimitiveTypes": [ "boolean" ], - "DocID": "RangeRule.reevaluate" + "Description": "Indicates whether the rule should be always checked for the target value or only when the target value changes." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "RangeRule.type" + "Description": "Specifies the rule type. Set it to \"range\" to use the RangeRule." } } }, "RequiredRule": { - "DocID": "RequiredRule", + "Description": "A validation rule that demands that a validated field has a value.", "IsCollection": true, "Options": { "message": { "PrimitiveTypes": [ "string" ], - "DocID": "RequiredRule.message" + "Description": "Specifies the message that is shown if the rule is broken." }, "trim": { "PrimitiveTypes": [ "boolean" ], - "DocID": "RequiredRule.trim" + "Description": "Indicates whether to remove the Space characters from the validated value." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "RequiredRule.type" + "Description": "Specifies the rule type. Set it to \"required\" to use the RequiredRule." } } }, "VizScaleBreak": { - "DocID": "ScaleBreak", + "Description": "A class describing a scale break range. Inherited by scale breaks in the Chart and RangeSelector.", "Options": { "endValue": { "PrimitiveTypes": [ @@ -53396,7 +51259,7 @@ "number", "string" ], - "DocID": "ScaleBreak.endValue" + "Description": "Along with the startValue option, limits the scale break." }, "startValue": { "PrimitiveTypes": [ @@ -53404,79 +51267,78 @@ "number", "string" ], - "DocID": "ScaleBreak.startValue" + "Description": "Along with the endValue option, limits the scale break." } } }, "StringLengthRule": { - "DocID": "StringLengthRule", + "Description": "A validation rule that demands the target value length be within the specified value range (including the range's end points).", "IsCollection": true, "Options": { "ignoreEmptyValue": { "PrimitiveTypes": [ "boolean" ], - "DocID": "StringLengthRule.ignoreEmptyValue" + "Description": "If set to true, empty values are valid." }, "max": { "PrimitiveTypes": [ "number" ], - "DocID": "StringLengthRule.max" + "Description": "Specifies the maximum length allowed for the validated value." }, "message": { "PrimitiveTypes": [ "string" ], - "DocID": "StringLengthRule.message" + "Description": "Specifies the message that is shown if the rule is broken." }, "min": { "PrimitiveTypes": [ "number" ], - "DocID": "StringLengthRule.min" + "Description": "Specifies the minimum length allowed for the validated value." }, "trim": { "PrimitiveTypes": [ "boolean" ], - "DocID": "StringLengthRule.trim" + "Description": "Indicates whether or not to remove the Space characters from the validated value." }, "type": { "PrimitiveTypes": [ "string" ], - "DocID": "StringLengthRule.type" + "Description": "Specifies the rule type. Set it to \"stringLength\" to use the StringLengthRule." } } }, "VectorMapProjectionConfig": { - "DocID": "VectorMapProjectionConfig", "Options": { "aspectRatio": { "PrimitiveTypes": [ "number" ], - "DocID": "VectorMapProjectionConfig.aspectRatio" + "Description": "Specifies the projection's ratio of the width to the height." }, "from": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "VectorMapProjectionConfig.from" + "Description": "Converts coordinates from [x, y] to [lon, lat]." }, "to": { "PrimitiveTypes": [ "Function" ], "IsFunc": true, - "DocID": "VectorMapProjectionConfig.to" + "Description": "Converts coordinates from [lon, lat] to [x, y]." } } }, "VizRange": { - "DocID": "VizRange", + "Description": "", "Options": { "endValue": { "PrimitiveTypes": [ @@ -53485,68 +51347,68 @@ "string" ], "IsChangeable": true, - "DocID": "VizRange.endValue" + "Description": "The range's end value." }, "length": { "PrimitiveTypes": [ "number", "string" ], - "DocID": "VizRange.length", + "Description": "The range's length.", "Options": { "days": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.days" + "Description": "Specifies the time interval measured in days. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "hours": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.hours" + "Description": "Specifies the time interval measured in hours. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "milliseconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.milliseconds" + "Description": "Specifies the time interval measured in milliseconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "minutes": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.minutes" + "Description": "Specifies the time interval measured in minutes. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "months": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.months" + "Description": "Specifies the time interval measured in months. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "quarters": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.quarters" + "Description": "Specifies the time interval measured in quarters. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "seconds": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.seconds" + "Description": "Specifies the time interval measured in seconds. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "weeks": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.weeks" + "Description": "Specifies the time interval measured in weeks. Accepts integer values. Available only for an axis/scale that displays date-time values." }, "years": { "PrimitiveTypes": [ "number" ], - "DocID": "VizTimeInterval.years" + "Description": "Specifies the time interval measured in years. Accepts integer values. Available only for an axis/scale that displays date-time values." } } }, @@ -53557,7 +51419,7 @@ "string" ], "IsChangeable": true, - "DocID": "VizRange.startValue" + "Description": "The range's start value." } } } diff --git a/package.json b/package.json index e475cd070..c34e440df 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "devextreme-angular", - "version": "19.2.8", + "version": "19.2.9", "description": "Angular UI and visualization components based on DevExtreme widgets", "repository": { "type": "git", @@ -14,13 +14,12 @@ "build": "npm run gulp -- build", "test": "npm run gulp -- test", "pack": "npm run gulp -- npm.pack", - "update-integration-meta": "dx-tools update-meta --output-path ./metadata/NGMetaData.json --version 19_2", - "inject-descriptions": "dx-tools inject-descriptions-to-bundle --js-scripts ./npm/dist" + "update-integration-meta": "dx-tools update-meta --output-path ./metadata/NGMetaData.json --version 19_2" }, "author": "Developer Express Inc.", "license": "MIT", "peerDependencies": { - "devextreme": "~19.2.8", + "devextreme": "~19.2.9", "@angular/core": ">6.0.0", "@angular/common": ">6.0.0", "@angular/forms": ">6.0.0" @@ -48,7 +47,7 @@ "devexpress-diagram": "^0.1.43", "devexpress-gantt": "0.0.8", "devextreme": "~19.2.5-build-19347-0331", - "devextreme-internal-tools": "^2.0.0-beta.14", + "devextreme-internal-tools": "stable", "dot": "^1.0.3", "gulp": "^4.0.0", "gulp-header": "^1.8.8", diff --git a/templates/base-nested-component.tst b/templates/base-nested-component.tst index 9d7b59477..0e397a019 100644 --- a/templates/base-nested-component.tst +++ b/templates/base-nested-component.tst @@ -1,9 +1,9 @@ /* tslint:disable:max-line-length */ import { <#= it.baseClass #> } from '<#= it.basePath #>'; +<#? it.isDevExpressRequired #> +import DevExpress from 'devextreme/bundles/dx.all';<#?#> -<#? it.imports #><#~ it.imports :file #>import <#= file.importString #> from '<#= file.path #>'; -<#~#><#?#> export abstract class <#= it.className #> extends <#= it.baseClass #> {<#~ it.properties :prop:i #> get <#= prop.name #>(): <#= prop.type #> { return this._getOption('<#= prop.name #>'); diff --git a/templates/component.tst b/templates/component.tst index 7ccd96376..4ce590d86 100644 --- a/templates/component.tst +++ b/templates/component.tst @@ -37,9 +37,9 @@ import { QueryList<#?#> } from '@angular/core'; +<#? it.isDevExpressRequired #> +import DevExpress from 'devextreme/bundles/dx.all';<#?#> -<#? it.imports #><#~ it.imports :file #>import <#= file.importString #> from '<#= file.path #>'; -<#~#><#?#> import <#= it.className #> from '<#= it.module #>'; <#? it.isEditor #> import { @@ -70,12 +70,9 @@ const CUSTOM_VALUE_ACCESSOR_PROVIDER = { multi: true };<#?#> -/** - * [descr:<#= it.docID #>] -<#? it.isDeprecated #> - * @deprecated [depNote:<#= it.docID #>] -<#?#> - */ +<#? it.description #>/** + * <#= it.description #> + */<#?#> @Component({ selector: '<#= it.selector #>', template: '<#? it.isTranscludedContent #><#?#>',<#? it.isViz #> @@ -90,13 +87,10 @@ const CUSTOM_VALUE_ACCESSOR_PROVIDER = { }) export class <#= it.className #>Component extends <#= baseClass #> <#? implementedInterfaces.length #>implements <#= implementedInterfaces.join(', ') #> <#?#>{ instance: <#= it.className #>; -<#~ it.properties :prop:i #> +<#~ it.properties :prop:i #><#? prop.description #> /** - * [descr:<#= prop.docID #>] - <#? prop.isDeprecated #> - * @deprecated [depNote:<#= prop.docID #>] - <#?#> - */ + * <#= prop.description #> + */<#?#> @Input() get <#= prop.name #>(): <#= prop.type #> { return this._getOption('<#= prop.name #>'); @@ -106,17 +100,10 @@ export class <#= it.className #>Component extends <#= baseClass #> <#? implement }<#? i < it.properties.length-1 #> <#?#><#~#> -<#~ it.events :event:i #> +<#~ it.events :event:i #><#? event.description #> /** - <#? event.isInternal #> - * This member supports the internal infrastructure and is not intended to be used directly from your code. - <#??#> - * [descr:<#= event.docID #>] - <#? event.isDeprecated #> - * @deprecated [depNote:<#= event.docID #>] - <#?#> - <#?#> - */ + * <#= event.description #> + */<#?#> @Output() <#= event.emit #>: <#= event.type #>;<#? i < it.events.length-1 #> <#?#><#~#> diff --git a/templates/nested-component.tst b/templates/nested-component.tst index 0f93d2041..a4ecf739e 100644 --- a/templates/nested-component.tst +++ b/templates/nested-component.tst @@ -23,9 +23,9 @@ import { <#? it.hasTemplate #>import { DOCUMENT } from '@angular/common';<#?#> +<#? it.isDevExpressRequired #> +import DevExpress from 'devextreme/bundles/dx.all';<#?#> -<#? it.imports #><#~ it.imports :file #>import <#= file.importString #> from '<#= file.path #>'; -<#~#><#?#> import { NestedOptionHost,<#? it.hasTemplate #> extractTemplate,<#?#><#? it.hasTemplate #> @@ -56,17 +56,10 @@ export class <#= it.className #>Component extends <#= it.baseClass #><#? it.hasT this._setOption('<#= prop.name #>', value); } <#~#> -<#~ it.events :event:i #> +<#~ it.events :event:i #><#? event.description #> /** - <#? event.isInternal #> - * This member supports the internal infrastructure and is not intended to be used directly from your code. - <#??#> - * [descr:<#= event.docID #>] - <#? event.isDeprecated #> - * @deprecated [depNote:<#= event.docID #>] - <#?#> - <#?#> - */ + * <#= event.description #> + */<#?#> @Output() <#= event.emit #>: <#= event.type #>;<#? i < it.events.length-1 #> <#?#><#~#> protected get _optionPath() { diff --git a/tools/spec/tests/metadata-generator.spec.js b/tools/spec/tests/metadata-generator.spec.js index df5be5baf..4c1ed6149 100644 --- a/tools/spec/tests/metadata-generator.spec.js +++ b/tools/spec/tests/metadata-generator.spec.js @@ -46,57 +46,45 @@ describe("metadata-generator", function() { dxTestWidget: { Options: { onTestEvent: { - DocID: 'Widget.Options.onTestEvent', IsEvent: true, - IsDeprecated: true, + Description: 'onTestEvent description' }, testTemplate: { - DocID: 'Widget.Options.testTemplate', IsTemplate: true, }, testProperty: { - DocID: 'Widget.Options.testProperty' + Description: 'testProperty description' } }, - DocID: 'dxTestWidget', + Description: 'widget description', Module: 'test_widget' }, dxEditorWidget: { Options: { - onValueChanged: { - DocID: 'Widget.Options.onValueChanged', - } + onValueChanged: {} }, - DocID: 'dxEditorWidget', Module: 'test_widget' }, dxCollectionWidget: { Options: { collectionProperty: { - DocID: 'Widget.Options.collectionProperty', IsCollection: true }, dataSourceProperty: { - DocID: 'Widget.Options.dataSourceProperty', IsDataSource: true } }, - DocID: 'dxCollectionWidget', Module: 'test_widget' }, dxExtensionWidget: { IsExtensionComponent: true, Options: {}, - DocID: 'dxExtensionWidget', Module: 'test_widget' }, dxVizWidget: { Options: { - value: { - DocID: 'Widget.Options.value', - } + value: {} }, - DocID: 'dxVizWidget', Module: 'viz/test_widget' } } @@ -135,8 +123,8 @@ describe("metadata-generator", function() { expect(metas.DxTestWidget.widgetName).toBe("dxTestWidget"); }); - it("should generate proper widget docID", function() { - expect(metas.DxTestWidget.docID).toBe('dxTestWidget'); + it("should generate proper widget description", function() { + expect(metas.DxTestWidget.description).toBe('widget description'); }); it("should generate proper events emit field", function() { @@ -156,23 +144,17 @@ describe("metadata-generator", function() { .toEqual(['testEvent']); }); - it("should generate proper events docID field", function() { - expect(metas.DxTestWidget.events - .filter(p => p.emit === 'onTestEvent') - .map(p => p.docID)) - .toEqual(['Widget.Options.onTestEvent']); - }); - - it("should generate proper events deprication field", function() { + it("should generate proper events description field", function() { expect(metas.DxTestWidget.events .filter(p => p.emit === 'onTestEvent') - .map(p => p.isDeprecated)) - .toEqual([true]); + .map(p => p.description)) + .toEqual(['onTestEvent description']); }); - - it("should generate proper events docID field", function() { + + + it("should generate proper events description field", function() { expect(metas.DxTestWidget.events - .filter(p => p.emit !== "onTestEvent" && p.docID === undefined && p.isInternal === true).length) + .filter(p => p.emit !== "onTestEvent" && p.description !== undefined).length) .toEqual(2); }); @@ -183,10 +165,10 @@ describe("metadata-generator", function() { ]); }); - it("should generate proper properties docID", function() { - expect(metas.DxTestWidget.properties.map(p => p.docID)).toEqual([ - 'Widget.Options.testTemplate', - 'Widget.Options.testProperty' + it("should generate proper properties description", function() { + expect(metas.DxTestWidget.properties.map(p => p.description)).toEqual([ + undefined, + 'testProperty description' ]); }); @@ -241,13 +223,7 @@ describe("metadata-generator", function() { }, complexTypedProperty: { PrimitiveTypes: [ - "dxComplexType1" - ], - TypeImports: [ - { - Name: "dxComplexType1", - Path: "ui/dx_complex_types" - } + "DevExpress.ui.ComplexType" ] }, collectionTypedProperty: { @@ -260,13 +236,7 @@ describe("metadata-generator", function() { IsCollection: true, ItemPrimitiveTypes: [ "string", - "dxComplexType2" - ], - TypeImports: [ - { - Name: "dxComplexType2", - Path: "ui/dx_complex_types" - } + "DevExpress.ui.ComplexType" ] }, dataSourceProperty: { @@ -277,13 +247,6 @@ describe("metadata-generator", function() { ], ItemPrimitiveTypes: [ "any" - ], - TypeImports: [ - { - Name: "default", - Alias: "DevExpress", - Path: "bundles/dx.all" - } ] } }, @@ -295,7 +258,7 @@ describe("metadata-generator", function() { IsPromise: true, PrimitiveTypes: [ 'boolean' - ], + ], ItemPrimitiveTypes: [ 'void' ] @@ -316,9 +279,9 @@ describe("metadata-generator", function() { expect(metas.DxTypedWidget.properties.map(p => p.type)).toEqual([ 'boolean', 'string' + TYPES_SEPORATOR + 'number', - 'dxComplexType1', + 'DevExpress.ui.ComplexType', 'Array', - 'Array', + 'Array', 'DevExpress.ui.DataSource' + TYPES_SEPORATOR + 'DevExpress.ui.DataSourceConfig' + TYPES_SEPORATOR + 'Array' ]); expect(metas.DxWidgetWithPromise.properties.map(p => p.type)).toEqual([ @@ -332,24 +295,15 @@ describe("metadata-generator", function() { 'EventEmitter', 'EventEmitter', 'EventEmitter', - 'EventEmitter', + 'EventEmitter', 'EventEmitter>', - 'EventEmitter>', + 'EventEmitter>', 'EventEmitter>' ]); }); - it("should generate type imports", function() { - expect(metas.DxTypedWidget.imports).toEqual([ - { - importString: "DevExpress", - path: "devextreme/bundles/dx.all", - }, - { - importString: "{ dxComplexType1, dxComplexType2 }", - path: "devextreme/ui/dx_complex_types", - } - ]); + it("should detect the DevExpress namespace import necessary", function() { + expect(metas.DxTypedWidget.isDevExpressRequired).toBe(true); }); }); @@ -693,30 +647,12 @@ describe("metadata-generator", function() { }, PrimitiveTypes: [ 'boolean', - 'DevExpress.ui.dxComplexType', - 'dxComplexType1' - ], - TypeImports: [ - { - Name: "dxComplexType1", - Path: "ui/dx_complex_types" - }, - { - Name: "default", - Alias: "DevExpress", - Path: "bundles/dx.all" - } + 'DevExpress.ui.dxComplexType' ] }, property1: { PrimitiveTypes: [ 'string' - ], - TypeImports: [ - { - Name: "dxComplexType2", - Path: "ui/dx_complex_types" - } ] }, property3: { @@ -780,7 +716,7 @@ describe("metadata-generator", function() { 'string' + TYPES_SEPORATOR + '{ nestedProperty1?: number }' + TYPES_SEPORATOR + 'boolean' + TYPES_SEPORATOR + - 'DevExpress.ui.dxComplexType' + TYPES_SEPORATOR + "dxComplexType1" + TYPES_SEPORATOR + + 'DevExpress.ui.dxComplexType' + TYPES_SEPORATOR + '{ nestedProperty2?: string }', 'string', 'any', @@ -788,18 +724,9 @@ describe("metadata-generator", function() { 'any' ]); }); - - it("should generate type imports for merged nested components", function() { - expect(metas.DxoExternalProperty.imports).toEqual([ - { - importString: "DevExpress", - path: "devextreme/bundles/dx.all", - }, - { - importString: "{ dxComplexType1, dxComplexType2 }", - path: "devextreme/ui/dx_complex_types", - } - ]); + + it("should generate nested components with merged isDevExpressRequired", function() { + expect(metas.DxoExternalProperty.isDevExpressRequired).toBe(true); }); }); @@ -818,16 +745,10 @@ describe("metadata-generator", function() { deep: { PrimitiveTypes: [ "boolean", - "dxComplexType1" + "DevExpress.ui.ComplexType" ], ComplexTypes: [ 'ExternalPropertyType' - ], - TypeImports: [ - { - Name: "dxComplexType1", - Path: "ui/dx_complex_types" - } ] }, collectionDeeps : { @@ -856,16 +777,10 @@ describe("metadata-generator", function() { }, PrimitiveTypes: [ "string", - "dxComplexType2" + "DevExpress.ui.ComplexType" ], ComplexTypes: [ 'ExternalPropertyType' - ], - TypeImports: [ - { - Name: "dxComplexType2", - Path: "ui/dx_complex_types" - } ] }, nestedItems: { // DxiNestedItem @@ -878,16 +793,10 @@ describe("metadata-generator", function() { }, ItemPrimitiveTypes: [ "string", - "dxComplexType3" + "DevExpress.ui.ComplexType" ], IsCollection: true, - SingularName: "nestedItem", - TypeImports: [ - { - Name: "dxComplexType3", - Path: "ui/dx_other_complex_types" - } - ] + SingularName: "nestedItem" } }, PrimitiveTypes: [ @@ -925,16 +834,10 @@ describe("metadata-generator", function() { Options: { nestedExternalProperty: { // DxoNestedExternalProperty PrimitiveTypes: [ - 'dxComplexType4' + 'DevExpress.ui.ComplexType' ], ComplexTypes: [ 'ExternalPropertyType' - ], - TypeImports: [ - { - Name: "dxComplexType4", - Path: "ui/dx_other_complex_types" - } ] } } @@ -960,49 +863,25 @@ describe("metadata-generator", function() { it("should generate proper typed properties", function() { expect(metas.DxoProperty.properties.map(p => p.type)).toEqual([ - `string${TYPES_SEPORATOR}dxComplexType2${TYPES_SEPORATOR}` + - `{ deep?: boolean${TYPES_SEPORATOR}dxComplexType1, ` + + `string${TYPES_SEPORATOR}DevExpress.ui.ComplexType${TYPES_SEPORATOR}` + + `{ deep?: boolean${TYPES_SEPORATOR}DevExpress.ui.ComplexType, ` + `collectionDeeps?: boolean${TYPES_SEPORATOR}Array, ` + `deepWithPromise?: Promise & JQueryPromise }`, - `Array` + `Array` ]); }); - it("should generate type imports", function() { - - expect(metas.DxoProperty.imports).toEqual([ - { - path: "devextreme/ui/dx_complex_types", - importString: "{ dxComplexType1, dxComplexType2 }", - }, - { - path: "devextreme/ui/dx_other_complex_types", - importString: "{ dxComplexType3 }", - } - ]); - - expect(metas.DxoNested.imports).toEqual([ - { - path: "devextreme/ui/dx_complex_types", - importString: "{ dxComplexType1 }", - } - ]); - - expect(metas.DxoExternalPropertyType.imports).toEqual([ - { - path: "devextreme/ui/dx_other_complex_types", - importString: "{ dxComplexType4 }", - } - ]); - }); - - it("should not generate type imports if not required", function() { - expect(metas.DxiNestedItem.imports).toBeUndefined() - expect(metas.DxiCollectionItem.imports).toBeUndefined() - expect(metas.DxoCollectionItem.imports).toBeUndefined() - expect(metas.DxoNestedExternalProperty.imports).toBeUndefined() - expect(metas.DxoDeep.imports).toBeUndefined() + it("should detect the DevExpress namespace import necessary", function() { + expect(metas.DxoProperty.isDevExpressRequired).toBe(true); + expect(metas.DxoNested.isDevExpressRequired).toBe(true); + expect(metas.DxiNestedItem.isDevExpressRequired).toBe(false); + expect(metas.DxiCollectionItem.isDevExpressRequired).toBe(false); + expect(metas.DxoCollectionItem.isDevExpressRequired).toBe(false); + + expect(metas.DxoExternalPropertyType.isDevExpressRequired).toBe(true); + expect(metas.DxoNestedExternalProperty.isDevExpressRequired).toBe(false); + expect(metas.DxoDeep.isDevExpressRequired).toBe(false); }); }); diff --git a/tools/src/helpers.ts b/tools/src/helpers.ts deleted file mode 100644 index 2ec2efa1e..000000000 --- a/tools/src/helpers.ts +++ /dev/null @@ -1,8 +0,0 @@ - -export function byKeyComparer(getter: (obj: T) => string): Parameters["sort"]>[0] { - return (objA: T, objB: T) => getter(objA).localeCompare(getter(objB)); -} - -export function getValues(obj: Record): T[] { - return obj ? Object.keys(obj).map(k => obj[k]) : undefined; -} diff --git a/tools/src/import-helper.ts b/tools/src/import-helper.ts deleted file mode 100644 index 10c0a3faf..000000000 --- a/tools/src/import-helper.ts +++ /dev/null @@ -1,81 +0,0 @@ -import { Import, ImportName, Option } from './metadata-model'; -import { getValues, byKeyComparer } from './helpers'; - -export interface FileImport { - path: string; - importString: string; -} - -export function buildImports(options: Option[]): FileImport[] { - - const importsByPath = extractImportsMeta(options).reduce( - (importsByPath, {Path, Name, Alias}) => { - if(!importsByPath[Path]) - importsByPath[Path] = {}; - - importsByPath[Path][`${Name}+${Alias}`] = { Name, Alias }; - - return importsByPath; - }, {} as Record> - ); - - return Object.keys(importsByPath) - .map(path => { - const {defaultImport, namedImports} = extractDefaultImport(getValues(importsByPath[path])); - const parts = []; - - if(defaultImport) - parts.push(defaultImport); - - if(namedImports.length) { - const namedImportsString = namedImports - .sort(byKeyComparer(i => i.Name)) - .map(({Name, Alias}) => Alias ? `${Name} as ${Alias}` : Name) - .join(", "); - - parts.push(`{ ${namedImportsString} }`) - } - - return { - path: `devextreme/${path}`, - importString: parts.join(", ") - } as FileImport; - }) - .sort(byKeyComparer(i => i.path)); -} - -function extractImportsMeta(options: Option[]): Import[] { - if(!options || !options.length) - return []; - - return options.reduce( - (r, option) => { - if(option) { - r.push(...option.TypeImports); - r.push(...extractImportsMeta(getValues(option.Options))); - } - return r; - }, [] as Import[] - ); -} - -function extractDefaultImport(imports: ImportName[]): { defaultImport?: string; namedImports: ImportName[] } { - const result: ReturnType = { defaultImport: undefined, namedImports: [] }; - - for(const entry of imports) { - if(isDefaultImport(entry)) { - if(!entry.Alias) - throw new Error("default export must have an alias: " + JSON.stringify(entry)); - - result.defaultImport = entry.Alias; - } else { - result.namedImports.push(entry); - } - } - - return result; -} - -function isDefaultImport(importName: ImportName): boolean { - return importName.Name.toLowerCase() === "default"; -} diff --git a/tools/src/metadata-generator.ts b/tools/src/metadata-generator.ts index 68b7917ad..90160408b 100644 --- a/tools/src/metadata-generator.ts +++ b/tools/src/metadata-generator.ts @@ -3,10 +3,6 @@ import path = require('path'); import mkdirp = require('mkdirp'); import merge = require('deepmerge'); import logger from './logger'; -import { Metadata, Option, NestedOptions } from './metadata-model'; -import { buildImports, FileImport } from './import-helper'; -import { getValues } from './helpers'; - let inflector = require('inflector-js'); const OPTION_COMPONENT_PREFIX = 'Dxo'; @@ -24,87 +20,8 @@ function trimPrefix(prefix: string, value: string) { return value; } -interface Property { - option?: Option; - docID: string; - isDeprecated: boolean; - name: string; - type: string; - typesDescription: TypeDescription; - isCollection?: boolean; -}; - -interface Event { - option?: Option; - emit: string; - type: string; - docID?: string; - isDeprecated?: boolean; - isInternal?: boolean; - subscribe?: string; -} - -interface Container { - className: string; - properties: Property[]; - events: Event[]; -} - -interface ComponentMeta { - docID: string; - isDeprecated: boolean; - selector: string; -} - -interface WidgetComponent extends ComponentMeta, Container { - widgetName: string; - module: string; - nestedComponents: any[]; - isTranscludedContent: boolean; - isViz: boolean; - isExtension: boolean; - isEditor: boolean; -} - -interface Component extends ComponentMeta, Container { - baseClass: string; - basePath: string; - collectionNestedComponents: NestedComponent[]; - isCollection: boolean; -} - -interface NestedComponent extends ComponentMeta, Container { - optionName: string; - path: string; - propertyName: string; - isCollection: boolean; - hasTemplate: boolean; - collectionNestedComponents: NestedComponent[]; -} - -interface BaseNestedComponent extends Container { - baseClass: string; - basePath: string; - path: string; -} - -interface MergedComponent extends Component { - options: Option[]; -} - -interface File { - imports: FileImport[]; -} - -interface TypeDescription { - primitiveTypes: string[]; - arrayTypes: string[]; - dxtypes?: string[]; - typeImports?: { Name: string, File: String }; -} - export interface IObjectStore { - read(name: string): Metadata; + read(name: string): Object; write(name: string, data: Object): void; } @@ -159,10 +76,11 @@ export default class DXComponentMetadataGenerator { className = inflector.camelize(widgetName), dasherizedWidgetName = inflector.dasherize(inflector.underscore(widgetName)), outputFilePath = path.join(config.outputFolderPath, trimDx(dasherizedWidgetName) + '.json'), - events: Event[] = [], + events = [], changeEvents = [], - properties: Property[] = [], - isEditor = Object.keys(widget.Options).indexOf('onValueChanged') !== -1; + properties = [], + isEditor = Object.keys(widget.Options).indexOf('onValueChanged') !== -1, + isDevExpressRequired = false; for (let optionName in widget.Options) { let option = widget.Options[optionName]; @@ -171,23 +89,22 @@ export default class DXComponentMetadataGenerator { let eventName = inflector.camelize(optionName.substr('on'.length), true); events.push({ - docID: option.DocID, - isDeprecated: option.IsDeprecated, emit: optionName, subscribe: eventName, + description: option.Description, type: 'EventEmitter' }); } else { let typesDescription = this.getTypesDescription(option); let finalizedType = this.getType(typesDescription); - let property: Property = { - docID: option.DocID, - isDeprecated: option.IsDeprecated, + isDevExpressRequired = isDevExpressRequired || typesDescription.isDevExpressRequired; + + let property: any = { name: optionName, type: finalizedType, typesDescription: typesDescription, - option + description: option.Description }; if (!!option.IsCollection || !!option.IsDataSource) { @@ -196,7 +113,7 @@ export default class DXComponentMetadataGenerator { properties.push(property); - changeEvents.push(this.createEvent(optionName, finalizedType, option)); + changeEvents.push(this.createEvent(optionName, finalizedType)); let components = this.generateComplexOptionByType(metadata, option, optionName, []); nestedComponents = nestedComponents.concat(...components); @@ -224,9 +141,7 @@ export default class DXComponentMetadataGenerator { return result; }, []); - const widgetMetadata: WidgetComponent & File = { - docID: widget.DocID, - isDeprecated: widget.IsDeprecated, + let widgetMetadata = { className: className, widgetName: widgetName, isTranscludedContent: isTranscludedContent, @@ -237,12 +152,13 @@ export default class DXComponentMetadataGenerator { properties: properties, isEditor: isEditor, module: 'devextreme/' + widget.Module, - imports: buildImports(getValues(widget.Options)), + isDevExpressRequired: isDevExpressRequired, + description: widget.Description, nestedComponents: widgetNestedComponents }; logger('Write metadata to file ' + outputFilePath); - this._store.write(outputFilePath, normalizeMeta(widgetMetadata)); + this._store.write(outputFilePath, widgetMetadata); allNestedComponents = allNestedComponents.concat(...nestedComponents); } @@ -250,25 +166,25 @@ export default class DXComponentMetadataGenerator { this.generateNestedOptions(config, allNestedComponents); } - private createEvent(name, type, option: Option): Event { + private createEvent(name, type) { return { - isInternal: true, emit: `${name}Change`, type: `EventEmitter<${type}>`, - option + description: `This member supports the internal infrastructure and is not intended to be used directly from your code.` }; } - private getTypesDescription(optionMetadata: Option): TypeDescription { + private getTypesDescription(optionMetadata) { let typeParts = this.getTypeParts(optionMetadata); return { primitiveTypes: typeParts.primitiveTypes, - arrayTypes: typeParts.arrayTypes + arrayTypes: typeParts.arrayTypes, + isDevExpressRequired: this.detectComplexTypes(typeParts.primitiveTypes) || this.detectComplexTypes(typeParts.arrayTypes) }; } - private getTypeParts(optionMetadata: Option): { primitiveTypes: string[]; arrayTypes: string[] } { + private getTypeParts(optionMetadata) { let primitiveTypes = optionMetadata.PrimitiveTypes ? optionMetadata.PrimitiveTypes.slice(0) : []; let arrayTypes = []; @@ -308,7 +224,7 @@ export default class DXComponentMetadataGenerator { return ''; } - private getType(typesDescription: TypeDescription) { + private getType(typesDescription) { let primitiveTypes = typesDescription.primitiveTypes.slice(0); let result = 'any'; @@ -328,7 +244,13 @@ export default class DXComponentMetadataGenerator { return [].concat(array1, newTypes); } - private getExternalObjectInfo(metadata: Metadata, typeName) { + private detectComplexTypes(types) { + return types.some(type => + (type.type ? type.type : type) + .indexOf('.') > -1); + } + + private getExternalObjectInfo(metadata, typeName) { let externalObject = metadata.ExtraObjects[typeName]; if (!externalObject) { @@ -350,7 +272,7 @@ export default class DXComponentMetadataGenerator { } } - private generateComplexOptionByType(metadata: Metadata, option: Option, optionName: string, complexTypes: string[]) { + private generateComplexOptionByType(metadata, option, optionName, complexTypes) { let optionComplexTypes = option[option.IsCollection ? 'ItemComplexTypes' : 'ComplexTypes']; if (option.Options) { return this.generateComplexOption(metadata, option.Options, optionName, complexTypes, option); @@ -380,7 +302,7 @@ export default class DXComponentMetadataGenerator { } } - private generateComplexOption(metadata: Metadata, nestedOptions: NestedOptions, optionName, complexTypes, option: Option) { + private generateComplexOption(metadata, nestedOptions, optionName, complexTypes, option) { if (!nestedOptions || !Object.keys(nestedOptions).length) { return; } @@ -398,9 +320,7 @@ export default class DXComponentMetadataGenerator { selector = inflector.dasherize(underscoreSelector), path = inflector.dasherize(underscorePlural); - let complexOptionMetadata: NestedComponent & File = { - docID: option.DocID, - isDeprecated: option.IsDeprecated, + let complexOptionMetadata: any = { className: inflector.camelize(underscoreSelector), selector: selector, optionName: optionName, @@ -410,36 +330,37 @@ export default class DXComponentMetadataGenerator { propertyName: optionName, isCollection: option.IsCollection, hasTemplate: option.Options && option.Options.template && option.Options.template.IsTemplate, - collectionNestedComponents: [], - imports: [] + collectionNestedComponents: [] }; let nestedComponents = [complexOptionMetadata]; + let isDevExpressRequired = false; for (let optName in nestedOptions) { - let nestedOption = nestedOptions[optName]; - let typesDescription = this.getTypesDescription(nestedOption); + let optionMetadata = nestedOptions[optName]; + let typesDescription = this.getTypesDescription(optionMetadata); let propertyType = this.getType(typesDescription); - let property: Property = { - docID: nestedOption.DocID, - isDeprecated: nestedOption.IsDeprecated, + isDevExpressRequired = isDevExpressRequired || typesDescription.isDevExpressRequired; + + let property: any = { name: optName, type: propertyType, - typesDescription: typesDescription, - option: nestedOption + typesDescription: typesDescription }; - if (nestedOption.IsCollection) { + if (optionMetadata.IsCollection) { property.isCollection = true; } complexOptionMetadata.properties.push(property); - if (nestedOption.IsChangeable || nestedOption.IsReadonly) { - complexOptionMetadata.events.push(this.createEvent(optName, propertyType, nestedOption)); + if (optionMetadata.IsChangeable || optionMetadata.IsReadonly) { + complexOptionMetadata.events.push(this.createEvent(optName, propertyType)); } + complexOptionMetadata.isDevExpressRequired = isDevExpressRequired; + let components = this.generateComplexOptionByType(metadata, nestedOptions[optName], optName, complexTypes) || []; nestedComponents = nestedComponents.concat(...components); @@ -462,8 +383,6 @@ export default class DXComponentMetadataGenerator { .apply(complexOptionMetadata.collectionNestedComponents, ownCollectionNestedComponents); } - complexOptionMetadata.imports = buildImports(getValues(nestedOptions)); - return nestedComponents; } @@ -471,12 +390,12 @@ export default class DXComponentMetadataGenerator { return component.basePath + (component.isCollection ? '-dxi' : ''); } - private generateNestedOptions(config, metadata: Component[]) { - let normalizedMetadata: (MergedComponent)[] = metadata - .reduce((result, component: MergedComponent) => { - let existingComponent = result.filter(c => c.className === component.className)[0] as MergedComponent; + private generateNestedOptions(config, metadata) { + let normalizedMetadata = metadata + .reduce((result, component) => { + let existingComponent = result.filter(c => c.className === component.className)[0]; + if (!existingComponent) { - component.options = component.properties.map(p => p.option); result.push(component); } else { existingComponent.properties = existingComponent.properties @@ -514,10 +433,9 @@ export default class DXComponentMetadataGenerator { existingComponent.baseClass = existingComponent.baseClass || component.baseClass; existingComponent.basePath = existingComponent.basePath || component.basePath; + existingComponent.isDevExpressRequired = existingComponent.isDevExpressRequired || component.isDevExpressRequired; existingComponent.collectionNestedComponents.push .apply(existingComponent.collectionNestedComponents, component.collectionNestedComponents); - - existingComponent.options.push(...component.properties.map(p => p.option)); } return result; @@ -536,17 +454,15 @@ export default class DXComponentMetadataGenerator { .reduce((result, component) => { let existingComponent = result.filter(c => c.className === component.baseClass)[0]; if (!existingComponent && component.baseClass) { - const nestedComponent : BaseNestedComponent & File = { + result.push({ properties: component.properties, events: component.events, className: component.baseClass, path: this.getBaseComponentPath(component), baseClass: component.isCollection ? 'CollectionNestedOption' : 'NestedOption', basePath: 'devextreme-angular/core', - imports: buildImports(component.options) - }; - - result.push(nestedComponent); + isDevExpressRequired: component.isDevExpressRequired + }); } return result; @@ -554,54 +470,32 @@ export default class DXComponentMetadataGenerator { .forEach(componet => { let outputFilePath = path.join(config.outputFolderPath, config.nestedPathPart, config.basePathPart, componet.path + '.json'); - this._store.write(outputFilePath, normalizeMeta(componet)); + this._store.write(outputFilePath, componet); }); - interface NestedComponentFile { - inputs: Property[]; - hasSimpleBaseClass: true - } - normalizedMetadata - .map((component: MergedComponent & NestedComponent & File & NestedComponentFile) => { + .map((component) => { if (component.events && !component.events.length) { delete component.events; } if (component.baseClass) { component.inputs = component.properties; delete component.properties; + component.isDevExpressRequired = component.events ? + this.detectComplexTypes(component.events) : + false; component.basePath = `./base/${this.getBaseComponentPath(component)}`; - - component.imports = component.events - ? component.imports = buildImports(component.events.map((e: Event) => e.option)) - : undefined; } else { component.baseClass = component.isCollection ? 'CollectionNestedOption' : 'NestedOption'; component.basePath = 'devextreme-angular/core'; component.hasSimpleBaseClass = true; - component.imports = buildImports(component.options); } return component; }) .forEach(componet => { let outputFilePath = path.join(config.outputFolderPath, config.nestedPathPart, componet.path + '.json'); - this._store.write(outputFilePath, normalizeMeta(componet)); + this._store.write(outputFilePath, componet); }); } } - -function normalizeMeta(meta: Container & File): Container & File { - const result: Container & File = { - ...meta, - properties: meta.properties && meta.properties.map(({option, ...rest}) => ({ ...rest })), - events: meta.events && meta.events.map(({option, ...rest}) => ({ ...rest })) - }; - - if(!result.imports || !result.imports.length){ - result.imports = undefined; - delete result.imports; - } - - return result -} diff --git a/tools/src/metadata-model.ts b/tools/src/metadata-model.ts deleted file mode 100644 index 4059d2215..000000000 --- a/tools/src/metadata-model.ts +++ /dev/null @@ -1,50 +0,0 @@ -export interface ImportName { - Name: string; - Alias?: string; -} - -export interface Import extends ImportName { - Path: string; -} - -export interface NestedOptions{ - [optionName: string]: Option; -} - -export interface Option { - PrimitiveTypes?: string[]; - ItemPrimitiveTypes: string[]; - TypeImports?: Import[]; - IsDataSource?: boolean; - IsPromise?: boolean; - IsDeprecated?: boolean; - IsCollection?: boolean; - IsChangeable?: boolean; - IsTemplate?: boolean; - IsReadonly?: boolean; - SingularName?: string; - IsEvent?: boolean; - IsFunc?: boolean; - DocID: string; - TsType: { - Name: string; - File: string; - }, - Options: NestedOptions -} - -export interface Metadata { - Widgets: { - [widgetName: string]: { - DocID: string; - Module: string; - IsTranscludedContent?: boolean; - IsExtensionComponent?: boolean; - IsDeprecated?: boolean; - Options: { - [optionName: string]: Option; - } - } - }; - ExtraObjects: any[]; -} \ No newline at end of file