Skip to content

Commit 6172b69

Browse files
Diagram: Add Overview (#7528) (#8057)
1 parent a8af4e5 commit 6172b69

5 files changed

Lines changed: 64 additions & 0 deletions

File tree

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
DevExtreme Diagram is an interactive component that allows you to create, edit, and display diagrams. You can use the Diagram component to visualize processes and relationships within an organization. DevExtreme Diagram supports exporting in raster and vector image formats.
2+
3+
This overview highlights Diagram elements, key features, and what to explore next.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<img src="/images/diagram/diagram-elements.png" alt="Diagram elements"/>
2+
3+
1. [Toolbar](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/mainToolbar/)
4+
2. [Toolbox](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/toolbox/)
5+
3. [View Toolbar](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/viewToolbar/)
6+
4. [Diagram Page](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/pageSize/)
7+
5. [Shape](/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramShape/)
8+
6. [Connector](/Documentation/ApiReference/UI_Components/dxDiagram/Interfaces/dxDiagramConnector/)
9+
7. [Properties Panel](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/propertiesPanel/)
10+
8. [Properties Panel Button](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/propertiesPanel/#visibility)
11+
12+
You can use the DevExtreme Diagram component to create and edit a variety of diagrams, including:
13+
14+
- Business process diagrams
15+
- Company structure charts
16+
- [UML](https://en.wikipedia.org/wiki/Unified_Modeling_Language) and entity-relationship (ER) diagrams
17+
- Business process model and notation (BPMN) flowcharts
18+
- Software architecture/component diagrams
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
- **Configurable Diagram Creation and Editing**
2+
The Diagram component allows users to create and edit diagrams. You can configure [editing](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/editing/) permissions and enable/disable certain actions such as shape [deletion](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/editing/#allowDeleteShape), [resizing](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/editing/#allowResizeShape) and [adding](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/editing/#allowAddShape). The component also supports custom permission logic implemented in the [edit request handler](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/#onRequestEditOperation).
3+
4+
- **Data Binding**
5+
DevExtreme Diagram can load and display diagrams from different [data source](/Documentation/ApiReference/Data_Layer/DataSource/) types. The component supports two-way data binding and integrates with [DevExtreme DataSource push services](/Documentation/Guide/Data_Binding/Data_Layer/#Data_Modification/Integration_with_Push_Services). Diagram accepts data in the following structures:
6+
- [Node and Connector Arrays](/Documentation/Guide/UI_Components/Diagram/Data_Binding/#Node_and_Edge_Arrays)
7+
- [Plain Node Arrays](/Documentation/Guide/UI_Components/Diagram/Data_Binding/#Linear_Array)
8+
- [Hierarchical Node Arrays](/Documentation/Guide/UI_Components/Diagram/Data_Binding/#Hierarchical_Array)
9+
10+
- **Automatic Layouts**
11+
You can bind Diagram to a data source that does not specify node coordinates. Configure an [automatic layout type](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/nodes/autoLayout/#type) and choose a diagram [orientation](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/nodes/autoLayout/#orientation) to generate diagram layouts.
12+
13+
- **Built-In Shape Types**
14+
The Diagram component ships with 40 resizable [shape types](/Documentation/Guide/UI_Components/Diagram/Shape_Types/). These include shapes that contain images, flowchart shapes, and container shapes.
15+
16+
- **Custom Shapes**
17+
You can configure [custom](/Documentation/Guide/UI_Components/Diagram/Custom_Shapes/) shape [text](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/customShapes/#defaultText) and [connection points](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/customShapes/connectionPoints/), as well as add [inner](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/customShapes/#defaultImageUrl) and [background images](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/customShapes/#backgroundImageUrl).
18+
19+
- **Connector Customization**
20+
You can customize node connectors and arrange them as needed. You can add [points](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/edges/#pointsExpr) and [text](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/edges/#textExpr), specify a [line style](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/edges/#styleExpr), and [lock](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/edges/#lockedExpr) specific connectors.
21+
22+
- **Interaction Functionality**
23+
DevExtreme Diagram includes user interaction features such as [zoom](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/zoomLevel/) and pan, [snap to grid](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/#snapToGrid), and undo/redo.
24+
25+
- **Export**
26+
You can [export](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/export/) diagrams as raster and vector image files. The component can export files in the following formats:
27+
- JPG
28+
- PNG
29+
- SVG
30+
31+
- **Adaptability and RTL**
32+
The component adapts its layout to fit screens of all sizes, including portrait orientation screens. Diagram also ships with [right-to-left](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/#rtlEnabled) (RTL) representation support.
33+
34+
- **Keyboard Navigation**
35+
DevExtreme Diagram supports [keyboard navigation](/Documentation/Guide/UI_Components/Diagram/Keyboard_Support/).
36+
37+
- **Customization**
38+
You can customize the component appearance and configure diagram visual settings such as [page size](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/pageSize/) and [grid visibility](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/#showGrid). You can also toggle [Diagram tools](/Documentation/Guide/UI_Components/Diagram/Diagram_Tools/) as needed or enable [readOnly](/Documentation/ApiReference/UI_Components/dxDiagram/Configuration/#readOnly) to hide all tools.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- [Getting Started with Diagram](/Documentation/Guide/UI_Components/Diagram/Getting_Started_with_Diagram/)
2+
3+
- [API](/Documentation/ApiReference/UI_Components/dxDiagram/)
4+
5+
- [Demos](https://js.devexpress.com/Demos/WidgetsGallery/Demo/Diagram/Overview/)
336 KB
Loading

0 commit comments

Comments
 (0)