Skip to content

Commit

Permalink
DocGen 22_2 result (#5655)
Browse files Browse the repository at this point in the history
  • Loading branch information
dxrobot authored Oct 9, 2023
1 parent f5095e4 commit a4bdd1a
Show file tree
Hide file tree
Showing 80 changed files with 233 additions and 359 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ An object that provides information about a legend item.

---
#####See Also#####
- [legend]({basewidgetpath}/Configuration/legend/)
- [legend](/api-reference/10%20UI%20Components/BaseChart/1%20Configuration/legend '{basewidgetpath}/Configuration/legend/')
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: GridBase.Options.renderAsync
type: Boolean
default: undefined
default: false
---
---
##### shortDescription
Expand Down
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/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.
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/10%20UI%20Components/dxDiagram/7%20Interfaces/dxDiagramShape/attachedConnectorIds.md '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/#attachedConnectorIds') property) or a container's child item (see the [containerChildItemIds](/api-reference/10%20UI%20Components/dxDiagram/7%20Interfaces/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/UI_Components/dxDiagram/Interfaces/dxDiagramShape/') or [DiagramConnectors](/api-reference/50%20Common/Object%20Structures/dxDiagramConnector '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramConnector/')).
An array of selected items ([DiagramShapes](/api-reference/10%20UI%20Components/dxDiagram/7%20Interfaces/dxDiagramShape '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/') or [DiagramConnectors](/api-reference/10%20UI%20Components/dxDiagram/7%20Interfaces/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/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.
Returns a [shape](/api-reference/10%20UI%20Components/dxDiagram/7%20Interfaces/dxDiagramShape '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/') or [connector](/api-reference/10%20UI%20Components/dxDiagram/7%20Interfaces/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/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.
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/10%20UI%20Components/dxDiagram/7%20Interfaces/dxDiagramShape/attachedConnectorIds.md '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/#attachedConnectorIds') property) or a container's child item (see the [containerChildItemIds](/api-reference/10%20UI%20Components/dxDiagram/7%20Interfaces/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/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.
Returns a [shape](/api-reference/10%20UI%20Components/dxDiagram/7%20Interfaces/dxDiagramShape '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/') or [connector](/api-reference/10%20UI%20Components/dxDiagram/7%20Interfaces/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
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/UI_Components/dxDiagram/Interfaces/dxDiagramConnector/#texts') collection.
The index of the processed text in the connector's [texts](/api-reference/10%20UI%20Components/dxDiagram/7%20Interfaces/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/UI_Components/dxDiagram/Interfaces/dxDiagramConnector/#texts') collection.
The index of the processed text in the connector's [texts](/api-reference/10%20UI%20Components/dxDiagram/7%20Interfaces/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/UI_Components/dxDiagram/Interfaces/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/10%20UI%20Components/dxDiagram/7%20Interfaces/dxDiagramShape/containerChildItemIds.md '/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/#containerChildItemIds') property allows you to get identifiers of shapes stored in the container.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ type: String
The file system item's path.

---
The **path** field stores a path to a file/directory as a string of path items separated by a slash. The [pathKeys](/Documentation/ApiReference/UI_Components/dxFileManager/Interfaces/FileSystemItem/Fields/#pathKeys) field stores an array of path item keys. This difference between the fields is more distinct if you specify [keyExpr](/api-reference/10%20UI%20Components/dxFileManager/5%20File%20System%20Providers/FileSystemProviderBase/1%20Configuration/keyExpr.md '/Documentation/ApiReference/UI_Components/dxFileManager/File_System_Providers/Custom/Configuration/#keyExpr') for your File System Provider. For example, the path and pathkeys fields may have the following values if **keyExpr** targets a numeric field:
The **path** field stores a path to a file/directory as a string of path items separated by a slash. The [pathKeys](/api-reference/10%20UI%20Components/dxFileManager/7%20Interfaces/FileSystemItem/2%20Fields/pathKeys.md '/Documentation/ApiReference/UI_Components/dxFileManager/Interfaces/FileSystemItem/Fields/#pathKeys') field stores an array of path item keys. This difference between the fields is more distinct if you specify [keyExpr](/api-reference/10%20UI%20Components/dxFileManager/5%20File%20System%20Providers/FileSystemProviderBase/1%20Configuration/keyExpr.md '/Documentation/ApiReference/UI_Components/dxFileManager/File_System_Providers/Custom/Configuration/#keyExpr') for your File System Provider. For example, the path and pathkeys fields may have the following values if **keyExpr** targets a numeric field:

path: "Documents/Todo.txt"
pathkeys: [10, 20]
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ type: Array<String>
The file system item's path specified in keys.

---
The [path](/Documentation/ApiReference/UI_Components/dxFileManager/Interfaces/FileSystemItem/Fields/#path) field stores a path to a file/directory as a string of path items separated by a slash. The **pathKeys** field stores an array of path item keys. This difference between the fields is more distinct if you specify [keyExpr](/api-reference/10%20UI%20Components/dxFileManager/5%20File%20System%20Providers/FileSystemProviderBase/1%20Configuration/keyExpr.md '/Documentation/ApiReference/UI_Components/dxFileManager/File_System_Providers/Custom/Configuration/#keyExpr') for your File System Provider. For example, the path and pathkeys fields may have the following values if **keyExpr** targets a numeric field:
The [path](/api-reference/10%20UI%20Components/dxFileManager/7%20Interfaces/FileSystemItem/2%20Fields/path.md '/Documentation/ApiReference/UI_Components/dxFileManager/Interfaces/FileSystemItem/Fields/#path') field stores a path to a file/directory as a string of path items separated by a slash. The **pathKeys** field stores an array of path item keys. This difference between the fields is more distinct if you specify [keyExpr](/api-reference/10%20UI%20Components/dxFileManager/5%20File%20System%20Providers/FileSystemProviderBase/1%20Configuration/keyExpr.md '/Documentation/ApiReference/UI_Components/dxFileManager/File_System_Providers/Custom/Configuration/#keyExpr') for your File System Provider. For example, the path and pathkeys fields may have the following values if **keyExpr** targets a numeric field:

path: "Documents/Todo.txt"
pathkeys: [10, 20]
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ type: String | Date | Number
---
---
##### shortDescription
The argument of the [point(s)](/api-reference/50%20Common/Object%20Structures/PieChartLegendItem/points.md '/Documentation/ApiReference/UI_Components/dxPieChart/Interfaces/PieChartLegendItem/#points') that the legend item represents.
The argument of the [point(s)](/api-reference/10%20UI%20Components/dxPieChart/7%20Interfaces/PieChartLegendItem/points.md '/Documentation/ApiReference/UI_Components/dxPieChart/Interfaces/PieChartLegendItem/#points') that the legend item represents.

---
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: Number
---
---
##### shortDescription
The zero-based index of the legend item used to identify the item among other legend items with the same [argument](/api-reference/50%20Common/Object%20Structures/PieChartLegendItem/argument.md '/Documentation/ApiReference/UI_Components/dxPieChart/Interfaces/PieChartLegendItem/#argument').
The zero-based index of the legend item used to identify the item among other legend items with the same [argument](/api-reference/10%20UI%20Components/dxPieChart/7%20Interfaces/PieChartLegendItem/argument.md '/Documentation/ApiReference/UI_Components/dxPieChart/Interfaces/PieChartLegendItem/#argument').

---
Legend items are indexed in the same order as in the data source.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Specifies the display mode for the **All day** panel.

To hide the **All day** panel, set this property to `hidden`.

If you set the `allDayPanelMode` property to `allDay`, the **All day** panel displays only the appointments whose [allDay](/Documentation/ApiReference/UI_Components/dxScheduler/Interfaces/dxSchedulerAppointment/#allDay) property is set to `true`.
If you set the `allDayPanelMode` property to `allDay`, the **All day** panel displays only the appointments whose [allDay](/api-reference/10%20UI%20Components/dxScheduler/7%20Interfaces/dxSchedulerAppointment/allDay.md '/Documentation/ApiReference/UI_Components/dxScheduler/Interfaces/dxSchedulerAppointment/#allDay') property is set to `true`.

To also display appointments that have a duration equal to or more than 24 hours, assign `all` to this property.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Specifies the time zone for the Scheduler's grid. Accepts values from the <a hre
---
If no time zone is specified, the grid displays appointments in the client's time zone.

You can also specify the [startDateTimeZone](/api-reference/50%20Common/Object%20Structures/dxSchedulerAppointment/startDateTimeZone.md '/Documentation/ApiReference/UI_Components/dxScheduler/Interfaces/dxSchedulerAppointment/#startDateTimeZone') and [endDateTimeZone](/api-reference/50%20Common/Object%20Structures/dxSchedulerAppointment/endDateTimeZone.md '/Documentation/ApiReference/UI_Components/dxScheduler/Interfaces/dxSchedulerAppointment/#endDateTimeZone') properties for individual appointments.
You can also specify the [startDateTimeZone](/api-reference/10%20UI%20Components/dxScheduler/7%20Interfaces/dxSchedulerAppointment/startDateTimeZone.md '/Documentation/ApiReference/UI_Components/dxScheduler/Interfaces/dxSchedulerAppointment/#startDateTimeZone') and [endDateTimeZone](/api-reference/10%20UI%20Components/dxScheduler/7%20Interfaces/dxSchedulerAppointment/endDateTimeZone.md '/Documentation/ApiReference/UI_Components/dxScheduler/Interfaces/dxSchedulerAppointment/#endDateTimeZone') properties for individual appointments.

#include common-demobutton with {
url: "https://js.devexpress.com/Demos/WidgetsGallery/Demo/Scheduler/TimeZonesSupport/"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Specifies the display mode for the **All day** panel.

To hide the **All day** panel, set this property to `hidden`.

If you set the `allDayPanelMode` property to `allDay`, the **All day** panel displays only the appointments whose [allDay](/Documentation/ApiReference/UI_Components/dxScheduler/Interfaces/dxSchedulerAppointment/#allDay) property is set to `true`.
If you set the `allDayPanelMode` property to `allDay`, the **All day** panel displays only the appointments whose [allDay](/api-reference/10%20UI%20Components/dxScheduler/7%20Interfaces/dxSchedulerAppointment/allDay.md '/Documentation/ApiReference/UI_Components/dxScheduler/Interfaces/dxSchedulerAppointment/#allDay') property is set to `true`.

To also display appointments that have a duration equal to or more than 24 hours, assign `all` to this property.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: dxSchedulerAppointment.component
---
---
##### shortDescription
An alias for the [template](/api-reference/50%20Common/Object%20Structures/dxSchedulerAppointment/template.md '{currentpath}/#template') property specified in React. Accepts a custom component. Refer to [Using a Custom Component](/concepts/50%20React%20Components/40%20Component%20Configuration%20Syntax/55%20Markup%20Customization/5%20Using%20a%20Custom%20Component.md '/Documentation/Guide/React_Components/Component_Configuration_Syntax/#Markup_Customization/Using_a_Custom_Component') for more information.
An alias for the [template](/api-reference/10%20UI%20Components/dxScheduler/7%20Interfaces/dxSchedulerAppointment/template.md '{currentpath}/#template') property specified in React. Accepts a custom component. Refer to [Using a Custom Component](/concepts/50%20React%20Components/40%20Component%20Configuration%20Syntax/55%20Markup%20Customization/5%20Using%20a%20Custom%20Component.md '/Documentation/Guide/React_Components/Component_Configuration_Syntax/#Markup_Customization/Using_a_Custom_Component') for more information.

---
[tags] react
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ We recommend that you specify appointment dates in <a href="https://en.wikipedia
}

#####See Also#####
- [startDate](/api-reference/50%20Common/Object%20Structures/dxSchedulerAppointment/startDate.md '/Documentation/ApiReference/UI_Components/dxScheduler/Interfaces/dxSchedulerAppointment/#startDate')
- [startDate](/api-reference/10%20UI%20Components/dxScheduler/7%20Interfaces/dxSchedulerAppointment/startDate.md '/Documentation/ApiReference/UI_Components/dxScheduler/Interfaces/dxSchedulerAppointment/#startDate')
Loading

0 comments on commit a4bdd1a

Please sign in to comment.