Skip to content

Commit

Permalink
New navigation tree 22.2 (#4400)
Browse files Browse the repository at this point in the history
* Start preparing docs for the new doctree

(cherry picked from commit 1b23deb)

* Update MenuConfig

(cherry picked from commit 6c06e55)

* Pre-final version

(cherry picked from commit f775ac6)

* Update MenuConfig.xml, revert some renamings

(cherry picked from commit dbbec04)

* Add some Demos articles

(cherry picked from commit b53fc1a)

* Add more Demos articles

(cherry picked from commit 56b42c2)

* Update links

(cherry picked from commit 15f0bc0)

* Fix links

* Update demo links

(cherry picked from commit 90dd489)

* WARNING: This file breaks the layout

(cherry picked from commit 76c5125)

* Separate some cases

(cherry picked from commit bd8af61)

* Final topics

(cherry picked from commit ffeb17e)

* Update MenuConfig.xml

(cherry picked from commit 47f3559)

* Update includes

(cherry picked from commit add2230)

* Remove empty modules + hide some CLI articles for jQuery

* Fix links

(cherry picked from commit f962126)

* DocGen 22_1 [06/24/22] (#3908)

* fix code (#3910)

* SelectBox: update the 'fieldTemplate' property (#3912)

* Grids: update the 'onToolbarPreparing' description (#3915)

* Grids: update the 'onEditorPreparing' description (#3923)

* Editors: update the 'valueExpr' property description T879516 (#3933)

* Drop-down Editors: add a note to Getting Started tutorials (#3936)

* Grids: update the 'setCellValue' description (#3940)

* DataGrid: update the 'scrolling.mode' description (#3941)

* DocGen 22_1 [07/08/22] (#3962)

* DocGen 22_1 [07/11/22] (#3964)

* PivotGridFieldChooser: describe the 'encodeHtml' option (#3968)

* DocGen 22_1 [07/15/22] (#3982)

* Autocomplete: add a Getting Started tutorial (#3981)

* Toolbar.items.options: fix code snippet (#3991)

* Gantt: fix doc issues (#3995) (#3996)

(cherry picked from commit 9fad468)

* Grids: add the 'syncLookupFilterValues' description (#3993)

* DocGen 22_1 [07/19/22] (#3998)

* DocGen 22_1 result

* Fix docgen

Co-authored-by: skorokhodova.vlada <[email protected]>

* Update dxGantt.scaleType description (#4001) (#4002)

(cherry picked from commit 10ce124)

* minor fixes (#4003) (#4004)

(cherry picked from commit 08d8ef0)

* Widgets: update 'target' code snippet (#3967)

* Drawer: rework section in the Getting Started tutorial (#4005)

* DocGen 22_1 [07/20/22] (#4007)

* DocGen 22_1 result

* Fix docgen

Co-authored-by: skorokhodova.vlada <[email protected]>

* DocGen 22_1 [07/21/22] (#4014)

* DocGen 22_1 result

* Fix docgen

Co-authored-by: skorokhodova.vlada <[email protected]>

* Fix link in Drawer: Getting Started (#4017)

* Fix broken link (#4023)

* DocGen 22_1 [07/22/22] (#4022)

* DocGen 22_1 result

* Fix docgen

Co-authored-by: skorokhodova.vlada <[email protected]>

* Overlays: add code snippets to 'container' option (#4025)

* Subresource Integrity values for 22.1.4 (#4036)

* DocGen 22_1 result (#4040)

* DocGen 22_1 result (#4053)

* Fix false empty descriptions (#4054)

* Gantt: fix example in taskTooltipContentTemplate (#4055)

* Custom Store: update example for Angular in the Load Data guide (#4058)

* Widgets: change Angular code in defaultOptions (#4061)

* DataGrid: update Column and Row Indexes guide (#4064)

* DataGrid: update Column and Row Indexes guide

* Update concepts/05 UI Components/DataGrid/15 Columns/12 Column and Row Indexes.md

Co-authored-by: arminal <[email protected]>

Co-authored-by: arminal <[email protected]>

* Scheduler: update deleteRecurrence code example (#4065)

* DocGen 22_1 result (#4074)

* FileUploader: fix code snippets in Overview (#4079)

* DocGen 22_1 result (#4085)

* Fix toolbar.items.template code snippet (#4087)

* HtmlEditor: fix tableContextMenuItem.template code snippet (#4091)

* Update internal-tools to v9.1 (#4097)

* DocGen 22_1 result (#4099)

* Map: fix 'type' description T1109746 (#4101)

* Drawer: fix size-related descriptions (#4104)

* DocGen 22_1 result (#4111)

* Getting Started with Drawer: fix React code (#4113)

* DataGrid: fix bug in sorting.mode T1110572 (#4117)

* DocGen 22_1 result (#4121)

* React: Add an Optimize Performance guide (#3969)

* Widgets: fix defaultOptions React code sample (#4125)

* DocGen 22_1 result (#4129)

* React Optimize Performance guide: fix link (#4132)

* DocGen 22_1 result (#4136)

* HtmlEditor: remove 'iframe' from supported tags (#4140)

* Fix typo in documentation (#4144)

The typo was : nmp instead of npm 😉

* Grids: fix allowedPageSizes T1112315 (#4146)

* HtmlEditor: add "mention" format T1105541 (#4149)

* Subresource Integrity values for 22.1.5 (#4157)

* DocGen 22_1 result (#4153)

* DataGrid: virtual scrolling description T1092891 (#4158)

* DataGrid: virtual scrolling description

* Minor fix (virtual scrolling)

* DocGen 22_1 result (#4162)

* DropDownBox: add a Getting Started tutorial (#4159)

* DocGen 22_1 result (#4165)

* DateBox: pickerType: 'rollers' behaviour T1108174 (#4163)

* DateBox: pickerType: 'rollers' behaviour T1108174

* fixes after review

* DataGrid: Form Mode unclear description T1103451 (#4172)

* DataGrid: Form Mode unclear description T1103451

* changes after review (shorter description)

* Apply suggestions from code review

Co-authored-by: RomanTsukanov <[email protected]>

Co-authored-by: RomanTsukanov <[email protected]>

* DocGen 22_1 result (#4177)

* DataGrid: Master-Detail JQuery code snippet typos (#4178)

* DataGrid: Master-Detail JQuery code snippet typos

* Update concepts/05 UI Components/DataGrid/60 Master-Detail Interface/10 User Interaction.md

Co-authored-by: Vlada Skorohodova <[email protected]>

* Add a Troubleshooting section (#4084)

* DropDownBox: dataSource does not support a hierarchical data source T… (#4183)

* DropDownBox: dataSource does not support a hierarchical data source T1099447

* Apply suggestions from code review

Co-authored-by: RomanTsukanov <[email protected]>

Co-authored-by: RomanTsukanov <[email protected]>

* DocGen 22_1 result (#4187)

* Troubleshooting Basics: fix links (#4189)

* PieChart: Missing arguments for customizeTooltip config T1113230 (#4192)

* Grids: describe pager.label property (#4194)

* DocGen 22_1 result (#4198)

* FAB: Incorrect information about SpeedDialAction limits T1112375 (#4197)

* FAB: Incorrect information about SpeedDialAction limits T1112375

* speedDialAction limits

* Apply suggestions from code review

Co-authored-by: RomanTsukanov <[email protected]>

* Apply suggestions from code review

Co-authored-by: RomanTsukanov <[email protected]>

Co-authored-by: RomanTsukanov <[email protected]>

* DropDownButton: Using the stylingMode T1112377 (#4206)

* Update MenuConfig

* NumberBox: Format. Limitet number of digits. T1114679 (#4209)

* Update Choose a Drop-Down Editor article

* Fix links

* Fix link

* Update demo links

* DataGrid: Fix allowReordering description T1115020 (#4212)

* DataGrid: Fix allowReordering description T1115020

* Apply suggestions from code review

Co-authored-by: RomanTsukanov <[email protected]>

* minor fix after review

Co-authored-by: RomanTsukanov <[email protected]>

* Update code examples

* DataGrid: The 'calculateCellValue' property extra info T1094373 (#4223)

* DataGrid: The 'calculateCellValue' property extra info T1094373

* changes after review

* Update api-reference/_hidden/GridBaseColumn/calculateCellValue.md

Co-authored-by: Albert Totten <[email protected]>

Co-authored-by: Albert Totten <[email protected]>

* React: Add extra info about creating React App with TypeScript T1097151 (#4230)

* Fix jQuery code samples (#4229)

* PivotGrid: Fix the Totals and Grand Totals typos (#4236)

* Add bell icon

* Hide Getting Started with Diagram from jQuery

* DataGrid: Update the setCellValue description T1118390 (#4240)

* Update menuconfig

* Diagram: Update the onContentReady property T1118215 (#4245)

* DocGen 22_1 result (#4249)

* Troubleshooting: update description T1118739 (#4250)

* Troubleshooting: update description T1118739

* Apply suggestions from code review

Co-authored-by: RomanTsukanov <[email protected]>

Co-authored-by: RomanTsukanov <[email protected]>

* DataGrid: Update the dataSource property description T1118622 (#4253)

* DataGrid: Update the dataSource property description T1118622

* changes after review

* changes after second review

* links and common info for dataSource

* Apply suggestions from code review

Co-authored-by: RomanTsukanov <[email protected]>

* Apply suggestions from code review

Co-authored-by: RomanTsukanov <[email protected]>

Co-authored-by: RomanTsukanov <[email protected]>

* DocGen 22_1 result (#4258)

* Create codeql-analysis.yml (#4254)

* Validator: update Validation Result React snippet (#4263)

* Validator: update Validation Result React snippet

* extra changes

* Apply suggestions from code review

Co-authored-by: Vlada Skorohodova <[email protected]>

* Apply suggestions from code review

Co-authored-by: Vlada Skorohodova <[email protected]>

Co-authored-by: Vlada Skorohodova <[email protected]>

* Simplify CodeQL config (#4266)

Co-authored-by: aleksandr.bulychev <[email protected]>

* DataGrid: Fix typo related to Filter Row React demo (#4270)

* Corrected typo (#4268)

Line 8 should say "ODataContext" not "ODataContent"

* DocGen 22_1 result (#4277)

* DataGrid: Add extra information about using the selectRows() method T… (#4275)

* DataGrid: Add extra information about using the selectRows() method T1116836

* commit after developers review

* Apply suggestions from code review

Co-authored-by: RomanTsukanov <[email protected]>

* Apply suggestions from code review

Co-authored-by: RomanTsukanov <[email protected]>

Co-authored-by: RomanTsukanov <[email protected]>

* DocGen 22_1 result (#4281)

* Custom Format String: fix insufficient info T1119741 (#4284)

* Subresource Integrity values for 22.1.6 (#4298)

* CheckBox: add a Getting Started tutorial (#4293)

* DocGen 22_1 result (#4307)

* DataGrid: update information related to the remoteOperations property (#4310)

* Custom Format String: fix insufficient info T1119741

* DataGrid: update information related to the remoteOperations property

* DocGen 22_1 result (#4318)

* Overlays: add W1021 warning description (#4319)

* Overlay: update baseZIndex(zIndex) description (#4326)

* Custom Format String: fix insufficient info T1119741

* Overlay: update baseZIndex(zIndex) description

* DocGen 22_1 result (#4325)

* Scheduler: update appointmentTooltipTemplate description (#4333)

* Custom Format String: fix insufficient info T1119741

* Scheduler: update appointmentTooltipTemplate description

* HtmlEditor: update toolbar.options code snippet (jquery) (#4336)

* Custom Format String: fix insufficient info T1119741

* HtmlEditor: update toolbar.options code snippet (jquery)

* DocGen 22_1 result (#4340)

* DocGen 22_1 result (#4345)

* Overlays: describe default values for the animation object (#4349)

* DocGen 22_1 result (#4353)

* ColorBox: add a Getting Started tutorial (#4348)

* DocGen 22_1 result (#4366)

* activeStateEnabled: update description (remove MUI link) (#4379)

* Custom Format String: fix insufficient info T1119741

* activeStateEnabled: update description (remove MUI link)

* DocGen 22_1 [11/21/22] (#4375)

* NumberBox: add getting started description (#4377)

* Custom Format String: fix insufficient info T1119741

* NumberBox: add getting started description

* getting started main changes

* Apply suggestions from code review

Co-authored-by: RomanTsukanov <[email protected]>

* changes after review

* Apply suggestions from code review

Co-authored-by: RomanTsukanov <[email protected]>

* Apply suggestions from code review

Co-authored-by: DirkPieterse <[email protected]>

Co-authored-by: RomanTsukanov <[email protected]>
Co-authored-by: DirkPieterse <[email protected]>

* NumberBox: add example (#4388)

* Custom Format String: fix insufficient info T1119741

* NumberBox: add example

* DocGen 22_1 [11/23/22] (#4389)

* Update MenuConfig

* Update Toolbar demos

* Update MenuConfig

* Fix "How to" display

* Fix link

* Update MenuConfig

* Update MenuConfig

* Update MenuConfig

* Update links

* Change version

* Add menurule for angular

* Remove angularJS and knockout mentions

* Add tag [jquery] to MVC pages

* Update youtube iframe

* Add empty pages for better titles

* Fix broken link

* Fix another broken link

* Fix a bunch of links

* Add jquery tags

* Remove angular links

---------

Co-authored-by: RomanTsukanov <[email protected]>
Co-authored-by: dxrobot <[email protected]>
Co-authored-by: AnnaKondratova <[email protected]>
Co-authored-by: arminal <[email protected]>
Co-authored-by: ilya.kharchenko <[email protected]>
Co-authored-by: Romain Gille <[email protected]>
Co-authored-by: Serhii Pylypchuk <[email protected]>
Co-authored-by: RomanTsukanov <[email protected]>
Co-authored-by: Albert Totten <[email protected]>
Co-authored-by: Oleg Kipchatov <[email protected]>
Co-authored-by: Alexander Bulychev <[email protected]>
Co-authored-by: aleksandr.bulychev <[email protected]>
Co-authored-by: Josh Abbott <[email protected]>
Co-authored-by: DirkPieterse <[email protected]>
  • Loading branch information
15 people authored Oct 6, 2023
1 parent d7901a3 commit f5095e4
Show file tree
Hide file tree
Showing 470 changed files with 2,894 additions and 2,759 deletions.
140 changes: 100 additions & 40 deletions MenuConfig.xml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
id: BaseChartLegendItem
type: Object
inherits: BaseLegendItem
module: viz/chart_components/base_chart
export: BaseChartLegendItem
---
---
##### shortDescription
An object that provides information about a legend item.

---
#####See Also#####
- [legend]({basewidgetpath}/Configuration/legend/)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
##### shortDescription
This section describes interfaces that the {WidgetName} component uses.

---
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ The UI component's instance.

---
#####See Also#####
- **Get a UI component Instance** in [Angular](/concepts/40%20Angular%20Components/20%20Component%20Configuration%20Syntax/44%20Get%20a%20UI%20Component%20Instance.md '/Documentation/Guide/Angular_Components/Component_Configuration_Syntax/#Get_a_UI_Component_Instance') | [AngularJS](/concepts/Getting%20Started/Widget%20Basics%20-%20AngularJS/03%20Get%20a%20Widget%20Instance.md '/Documentation/Guide/Getting_Started/Widget_Basics_-_AngularJS/Get_a_Widget_Instance/') | [Knockout](/concepts/Getting%20Started/Widget%20Basics%20-%20Knockout/03%20Get%20a%20Widget%20Instance.md '/Documentation/Guide/Getting_Started/Widget_Basics_-_Knockout/Get_a_Widget_Instance/') | [Vue](/concepts/55%20Vue%20Components/20%20Component%20Configuration%20Syntax/44%20Get%20a%20UI%20Component%20Instance.md '/Documentation/Guide/Vue_Components/Component_Configuration_Syntax/#Get_a_UI_Component_Instance') | [React](/concepts/50%20React%20Components/40%20Component%20Configuration%20Syntax/65%20Get%20a%20UI%20Component%20Instance.md '/Documentation/Guide/React_Components/Component_Configuration_Syntax/#Get_a_UI_Component_Instance')
#include common-link-getinstance
18 changes: 10 additions & 8 deletions api-reference/10 UI Components/DOMComponent/3 Methods/dispose().md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,29 @@ id: DOMComponent.dispose()
Disposes of all the resources allocated to the {WidgetName} instance.

---

---
##### jQuery

After calling this method, remove the DOM element associated with the UI component:

<!--JavaScript-->
$("#my{WidgetName}").dx{WidgetName}("dispose");
$("#my{WidgetName}").remove();

Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:

---
##### Angular

Use <a href="https://angular.io/guide/built-in-directives#adding-or-removing-an-element-with-ngif" target="_blank">conditional rendering</a> instead of this method:

<!-- tab: app.component.html -->
<dx-{widget-name} ...
*ngIf="condition">
</dx-{widget-name}>

##### Vue

Use <a href="https://v3.vuejs.org/guide/conditional.html" target="_blank">conditional rendering</a> instead of this method:

<!-- tab: App.vue -->
<template>
<Dx{WidgetName} ...
Expand All @@ -43,6 +48,8 @@ Use this method only if the UI component was created with jQuery or pure JavaScr

##### React

Use <a href="https://reactjs.org/docs/conditional-rendering.html" target="_blank">conditional rendering</a> instead of this method:

<!-- tab: App.js -->
import React from 'react';

Expand All @@ -69,8 +76,3 @@ Use this method only if the UI component was created with jQuery or pure JavaScr
export default App;

---

#####See Also#####
- <a href="https://angular.io/guide/built-in-directives#adding-or-removing-an-element-with-ngif" target="_blank">Conditional Rendering in Angular</a>
- <a href="https://v3.vuejs.org/guide/conditional.html" target="_blank">Conditional Rendering in Vue</a>
- <a href="https://reactjs.org/docs/conditional-rendering.html" target="_blank">Conditional Rendering in React</a>
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: GridBase.Options.renderAsync
type: Boolean
default: false
default: undefined
---
---
##### shortDescription
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ default: true
Specifies whether to enable two-way data binding.

---
Two-way data binding ensures that the UI tracks changes made in the data source by a 3rd-party component, and vice versa. This way, the UI component and its data source stay synchronized.
If you implement two-way data binding in the UI component on your own using the [cellTemplate](/api-reference/_hidden/dxDataGridColumn/cellTemplate.md '{basewidgetpath}/Configuration/columns/#cellTemplate') and/or [editCellTemplate](/api-reference/_hidden/dxDataGridColumn/editCellTemplate.md '{basewidgetpath}/Configuration/columns/#editCellTemplate') properties, make sure to set the **twoWayBindingEnabled** property to **false**.
Two-way data binding ensures that the UI tracks changes made in the data source by a 3rd-party component, and vice versa. This way, the UI component and its data source stay synchronized.

[note] The UI component provides two-way data binding through Knockout, Angular or AngularJS resources, so make sure to [add these libraries](/concepts/Common/Distribution%20Channels/05%20CDN '/Documentation/Guide/Common/Distribution_Channels/CDN/') to your app.
If you implement two-way data binding in the UI component on your own using the [cellTemplate](/api-reference/_hidden/dxDataGridColumn/cellTemplate.md '{basewidgetpath}/Configuration/columns/#cellTemplate') and/or [editCellTemplate](/api-reference/_hidden/dxDataGridColumn/editCellTemplate.md '{basewidgetpath}/Configuration/columns/#editCellTemplate') properties, make sure to set the **twoWayBindingEnabled** property to **false**.
35 changes: 0 additions & 35 deletions api-reference/10 UI Components/Markup Components/dxItem/dxItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,41 +57,6 @@ The dxItem component defines custom markup for items in layout and collection UI
})
export class AppModule { }

#####AngularJS

<!--HTML-->
<div dx-list="{ }">
<div data-options="dxItem: { text: 'Apples', disabled: true }"></div>
<div data-options="dxItem: { text: 'Lemons', visible: false }"></div>
<div data-options="dxItem: { }">
<!-- Custom markup -->
</div>
</div>

<!--JavaScript-->
angular.module('DemoApp', ['dx'])
.controller('DemoController', function ($scope) {
// ...
});

#####Knockout

<!--HTML-->
<div data-bind="dxList: { ... }">
<div data-options="dxItem: { text: 'Apples', disabled: true }"></div>
<div data-options="dxItem: { text: 'Lemons', visible: false }"></div>
<div data-options="dxItem: { }">
<!-- Custom markup -->
</div>
</div>

<!--JavaScript-->
var viewModel = {
// ...
};

ko.applyBindings(viewModel);

#####React

<!-- tab: App.js -->
Expand Down
35 changes: 0 additions & 35 deletions api-reference/10 UI Components/UI Events/UI Events.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,39 +47,4 @@ See <a href="http://api.jquery.com/category/events/event-handler-attachment" tar
}
}

##### Knockout

<!--HTML-->
<div id="target" data-bind="dxhold: { execute: dxholdHandler, timeout: 1000 }">
Target element
</div>

<!--JavaScript-->
var viewModel = {
dxholdHandler: function(viewModel, jQueryEvent) {
alert(`The ${$(jQueryEvent.target).text()} element is being held for ${jQueryEvent.data.timeout} ms.`);
}
}

[note]Knockout does not provide an API to unsubscribe from an event.

See <a href="http://knockoutjs.com/documentation/event-binding.html" target="_blank">Knockout documentation</a> for details.

##### AngularJS

<!--HTML-->
<div id="target" dx-hold="{ execute: 'dxholdHandler($event)', timeout: 1000 }">
Target element
</div>

<!--JavaScript-->
angular.module("DemoApp", ["dx"])
.controller("DemoController", function DemoController($scope) {
$scope.dxholdHandler = function(jQueryEvent) {
alert(`The ${$(jQueryEvent.target).text()} element is being held for ${jQueryEvent.data.timeout} ms.`);
}
});

[note]AngularJS does not provide an API to unsubscribe from an event.

---
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
##### shortDescription
This section describes interfaces that the {WidgetName} component uses.

---
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ default: undefined
Specifies the name of the [validation group](/api-reference/10%20UI%20Components/dxValidationGroup '/Documentation/ApiReference/UI_Components/dxValidationGroup/') to be accessed in the [click](/api-reference/10%20UI%20Components/dxButton/4%20Events/click.md '/Documentation/ApiReference/UI_Components/dxButton/Events/#click') event handler.

---
When using a button to validate several editors on a page, the button must "know" in which validation group these editors are located. If the Knockout or AngularJS approach is used, add the button to the **div** element that represents the target validation group. When using the jQuery approach, specify the **validationGroup** configuration property for the button. Assign the validation group name specified for the **validationGroup** property of the [validators](/api-reference/10%20UI%20Components/dxValidator '/Documentation/ApiReference/UI_Components/dxValidator/') that extend the editors to be validated.
When using a button to validate several editors on a page, the button must "know" in which validation group these editors are located.

Specify the **validationGroup** configuration property for the button. Assign the validation group name specified for the **validationGroup** property of the [validators](/api-reference/10%20UI%20Components/dxValidator '/Documentation/ApiReference/UI_Components/dxValidator/') that extend the editors to be validated.

#####See Also#####
- [Validate Several Editor Values](/concepts/05%20UI%20Components/zz%20Common/05%20UI%20Widgets/20%20Data%20Validation/20%20Validate%20Several%20Editor%20Values '/Documentation/Guide/UI_Components/Common/UI_Widgets/Data_Validation/#Validate_Several_Editor_Values')
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ For more information, refer to the following section: [Prohibit Individual Opera
url: "https://js.devexpress.com/Demos/WidgetsGallery/Demo/Diagram/OperationRestrictions/jQuery/Light/"
}

When a user pastes or clones several items in a diagram, the control adds the items to the model one by one. For each added item, the **RequestEditOperation** event fires. In the event handler, you can access the processed item. However, if you call the [getItemById(id)](/api-reference/10%20UI%20Components/dxDiagram/3%20Methods/getItemById(id).md '/Documentation/ApiReference/UI_Components/dxDiagram/Methods/#getItemByIdid') method to access an attached connector (see the [attachedConnectorIds](/api-reference/50%20Common/Object%20Structures/dxDiagramShape/attachedConnectorIds.md '/Documentation/ApiReference/Common/Object_Structures/dxDiagramShape/#attachedConnectorIds') property) or a container's child item (see the [containerChildItemIds](/api-reference/50%20Common/Object%20Structures/dxDiagramShape/containerChildItemIds.md '/Documentation/ApiReference/Common/Object_Structures/dxDiagramShape/#containerChildItemIds') property), you can get the `undefined`result if the item is not added to the model yet.
When a user pastes or clones several items in a diagram, the control adds the items to the model one by one. For each added item, the **RequestEditOperation** event fires. In the event handler, you can access the processed item. However, if you call the [getItemById(id)](/api-reference/10%20UI%20Components/dxDiagram/3%20Methods/getItemById(id).md '/Documentation/ApiReference/UI_Components/dxDiagram/Methods/#getItemByIdid') method to access an attached connector (see the [attachedConnectorIds](/api-reference/50%20Common/Object%20Structures/dxDiagramShape/attachedConnectorIds.md '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/#attachedConnectorIds') property) or a container's child item (see the [containerChildItemIds](/api-reference/50%20Common/Object%20Structures/dxDiagramShape/containerChildItemIds.md '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/#containerChildItemIds') property), you can get the `undefined`result if the item is not added to the model yet.

#####See Also#####
- [Restrict Edit Operations](/concepts/05%20UI%20Components/Diagram/28%20Restrict%20Edit%20Operations '/Documentation/Guide/UI_Components/Diagram/Restrict_Edit_Operations')
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The UI component instance's name.
#include common-ref-elementparam with { element: "UI component" }

##### field(e.items): Array<dxDiagramItem>
An array of selected items ([DiagramShapes](/api-reference/50%20Common/Object%20Structures/dxDiagramShape '/Documentation/ApiReference/Common/Object_Structures/dxDiagramShape/') or [DiagramConnectors](/api-reference/50%20Common/Object%20Structures/dxDiagramConnector '/Documentation/ApiReference/Common/Object_Structures/dxDiagramConnector/')).
An array of selected items ([DiagramShapes](/api-reference/50%20Common/Object%20Structures/dxDiagramShape '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/') or [DiagramConnectors](/api-reference/50%20Common/Object%20Structures/dxDiagramConnector '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramConnector/')).

##### field(e.model): any
Model data. Available only if you use Knockout.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: dxDiagram.getItemById(id)
---
---
##### shortDescription
Returns a [shape](/api-reference/50%20Common/Object%20Structures/dxDiagramShape '/Documentation/ApiReference/Common/Object_Structures/dxDiagramShape/') or [connector](/api-reference/50%20Common/Object%20Structures/dxDiagramConnector '/Documentation/ApiReference/Common/Object_Structures/dxDiagramConnector/') object specified by its internal identifier.
Returns a [shape](/api-reference/50%20Common/Object%20Structures/dxDiagramShape '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/') or [connector](/api-reference/50%20Common/Object%20Structures/dxDiagramConnector '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramConnector/') object specified by its internal identifier.

##### return: dxDiagramItem
A **dxDiagramItem** object descendant (dxDiagramShape or dxDiagramConnector).
Expand All @@ -12,4 +12,4 @@ A **dxDiagramItem** object descendant (dxDiagramShape or dxDiagramConnector).
The item identifier.

---
When a user pastes or clones several items in a diagram, the control adds the items to the model one by one. For each added item, the [requestEditOperation](/api-reference/10%20UI%20Components/dxDiagram/4%20Events/requestEditOperation.md '/Documentation/ApiReference/UI_Components/dxDiagram/Events/#requestEditOperation') event fires. In the event handler, you can access the processed item. However, if you call the **getItemById** method to access an attached connector (see the [attachedConnectorIds](/api-reference/50%20Common/Object%20Structures/dxDiagramShape/attachedConnectorIds.md '/Documentation/ApiReference/Common/Object_Structures/dxDiagramShape/#attachedConnectorIds') property) or a container's child item (see the [containerChildItemIds](/api-reference/50%20Common/Object%20Structures/dxDiagramShape/containerChildItemIds.md '/Documentation/ApiReference/Common/Object_Structures/dxDiagramShape/#containerChildItemIds') property), you can get the `undefined`result if the item is not added to the model yet.
When a user pastes or clones several items in a diagram, the control adds the items to the model one by one. For each added item, the [requestEditOperation](/api-reference/10%20UI%20Components/dxDiagram/4%20Events/requestEditOperation.md '/Documentation/ApiReference/UI_Components/dxDiagram/Events/#requestEditOperation') event fires. In the event handler, you can access the processed item. However, if you call the **getItemById** method to access an attached connector (see the [attachedConnectorIds](/api-reference/50%20Common/Object%20Structures/dxDiagramShape/attachedConnectorIds.md '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/#attachedConnectorIds') property) or a container's child item (see the [containerChildItemIds](/api-reference/50%20Common/Object%20Structures/dxDiagramShape/containerChildItemIds.md '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/#containerChildItemIds') property), you can get the `undefined`result if the item is not added to the model yet.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: dxDiagram.getItemByKey(key)
---
---
##### shortDescription
Returns a [shape](/api-reference/50%20Common/Object%20Structures/dxDiagramShape '/Documentation/ApiReference/Common/Object_Structures/dxDiagramShape/') or [connector](/api-reference/50%20Common/Object%20Structures/dxDiagramConnector '/Documentation/ApiReference/Common/Object_Structures/dxDiagramConnector/') object specified by its key.
Returns a [shape](/api-reference/50%20Common/Object%20Structures/dxDiagramShape '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/') or [connector](/api-reference/50%20Common/Object%20Structures/dxDiagramConnector '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramConnector/') object specified by its key.

##### return: dxDiagramItem
A **dxDiagramItem** object descendant (dxDiagramShape or dxDiagramConnector).
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
##### shortDescription
This section describes interfaces that the {WidgetName} component uses.

---
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ type: Number
---
---
##### shortDescription
The index of the processed text in the connector's [texts](/api-reference/50%20Common/Object%20Structures/dxDiagramConnector/texts.md '/Documentation/ApiReference/Common/Object_Structures/dxDiagramConnector/#texts') collection.
The index of the processed text in the connector's [texts](/api-reference/50%20Common/Object%20Structures/dxDiagramConnector/texts.md '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramConnector/#texts') collection.

---
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ type: Number
---
---
##### shortDescription
The index of the processed text in the connector's [texts](/api-reference/50%20Common/Object%20Structures/dxDiagramConnector/texts.md '/Documentation/ApiReference/Common/Object_Structures/dxDiagramConnector/#texts') collection.
The index of the processed text in the connector's [texts](/api-reference/50%20Common/Object%20Structures/dxDiagramConnector/texts.md '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramConnector/#texts') collection.

---
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ type: String
Gets the identifier of the container that stores the shape.

---
Use the **containerId** property to get the identifier of the container (a shape of the `horizontalContainer` or `verticalContainer` type) that stores the shape. The [containerChildItemIds](/api-reference/50%20Common/Object%20Structures/dxDiagramShape/containerChildItemIds.md '/Documentation/ApiReference/Common/Object_Structures/dxDiagramShape/#containerChildItemIds') property allows you to get identifiers of shapes stored in the container.
Use the **containerId** property to get the identifier of the container (a shape of the `horizontalContainer` or `verticalContainer` type) that stores the shape. The [containerChildItemIds](/api-reference/50%20Common/Object%20Structures/dxDiagramShape/containerChildItemIds.md '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/#containerChildItemIds') property allows you to get identifiers of shapes stored in the container.
Loading

0 comments on commit f5095e4

Please sign in to comment.