Skip to content

Commit 17c2870

Browse files
[update] integration guides (changes after review)
1 parent 3589dee commit 17c2870

5 files changed

Lines changed: 22 additions & 22 deletions

File tree

docs/guides/diagram_editor/initialization.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
sidebar_label: Initialization
3-
title: Editor initialization
3+
title: Diagram Editor initialization
44
description: You can learn how to start with Diagram Editor in the documentation of the DHTMLX JavaScript Diagram library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Diagram.
55
---
66

7-
# Editor initialization
7+
# Diagram Editor initialization
88

99
This article covers the process of displaying a Diagram Editor on a page. In order to initialize the editor, you need to include source files specific for Editor and use the `DiagramEditor` instance. In all other aspects the initialization stage is the same as for the Diagram component:
1010

1111
- [Download the DHTMLX Diagram package](https://dhtmlx.com/docs/products/dhtmlxDiagram/download.shtml) and unpack it into a folder of your project
1212
- [Include the source files on a page](#including-required-code-files)
13-
- [Initialize the Editor with the object constructor](#initializing-editor)
14-
- [Load data into the Editor](#loading-data-into-editor)
13+
- [Initialize Diagram Editor with the object constructor](#initializing-diagram-editor)
14+
- [Load data into the Diagram Editor](#loading-data-into-diagram-editor)
1515

1616
~~~html
1717
<!DOCTYPE html>
@@ -34,7 +34,7 @@ This article covers the process of displaying a Diagram Editor on a page. In ord
3434
// more objects
3535
];
3636
37-
// creating Editor
37+
// creating Diagram Editor
3838
const editor = new dhx.DiagramEditor("editor_container", {
3939
// config options
4040
});
@@ -67,24 +67,24 @@ You can import JavaScript Diagram Editor into your project using the `yarn` or `
6767
#### Installing trial Diagram Editor via npm and yarn
6868

6969
:::info
70-
If you want to use the trial version of Diagram Editor, download the [**trial Diagram package**](https://dhtmlx.com/docs/products/dhtmlxDiagram/download.shtml) and follow the steps mentioned in the *README* file. Note that the trial Diagram is available 30 days only.
70+
If you want to use the trial version of Diagram Editor, download the [**trial Diagram package**](https://dhtmlx.com/docs/products/dhtmlxDiagram/download.shtml) and follow the steps mentioned in the *README* file. Note that the trial Diagram Editor is available 30 days only.
7171
:::
7272

7373
#### Installing PRO Diagram Editor via npm and yarn
7474

7575
:::info
76-
If you already have Diagram under the proprietary license, send your **license number** to the *contact@dhtmlx.com* email to receive a login and a password for a private **npm** as well as a detailed guide on how to install Diagram. Note that a private **npm** is available before the expiration of the proprietary Diagram license.
76+
If you already have Diagram Editor under the proprietary license, send your **license number** to the *contact@dhtmlx.com* email to receive a login and a password for a private **npm** as well as a detailed guide on how to install Diagram Editor. Note that a private **npm** is available before the expiration of the proprietary Diagram Editor license.
7777
:::
7878

79-
## Initializing Editor
79+
## Initializing Diagram Editor
8080

8181
You can initialize a Diagram Editor in a container, in the document body, or in a layout cell.
8282

8383
### Initialization in a container
8484

85-
To initialize an editor in a container, use the `dhx.DiagramEditor` constructor and pass the following two parameters to the constructor function:
85+
To initialize Diagram Editor in a container, use the `dhx.DiagramEditor` constructor and pass the following two parameters to the constructor function:
8686

87-
- a container to place an Editor into, let's give it the *"editor_container"* id:
87+
- a container to place Diagram Editor into, let's give it the *"editor_container"* id:
8888

8989
~~~html title="index.html"
9090
<div id="editor_container"></div>
@@ -100,7 +100,7 @@ const editor = new dhx.DiagramEditor("editor_container", {
100100

101101
### Initialization in the document body
102102

103-
It is also possible to skip setting a container for Editor and to add it right into the document's body:
103+
It is also possible to skip setting a container for Diagram Editor and to add it right into the document's body:
104104

105105
~~~jsx
106106
const editor = new dhx.DiagramEditor(document.body, {
@@ -143,7 +143,7 @@ const editor = new dhx.DiagramEditor("editor_container", {
143143

144144
Check [the full list of configuration properties of Editor](/api/diagram_editor/editor/config/overview/).
145145

146-
## Loading data into Editor
146+
## Loading data into Diagram Editor
147147

148148
It is possible to load an [appropriate data set](../../../guides/loading_data/#preparing-data-to-load) into the editor via the [parse()](../../../api/diagram_editor/editor/methods/parse_method/) method of the editor.
149149

docs/guides/integrations/angular_integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ body {
135135

136136
#### Loading data
137137

138-
To add data into Diagram Editor, you need to provide a data set. You can create the **data.ts** file in the **src/app/diagram-editor/** directory and add some data into it:
138+
To add data into Diagram Editor, you need to provide a [**data set**](https://github.com/DHTMLX/angular-diagram-demo/blob/master/src/app/diagram/data.ts). You can create the **data.ts** file in the **src/app/diagram-editor/** directory and add some data into it:
139139

140140
~~~jsx title="data.ts"
141141
export function getData() {

docs/guides/integrations/react_integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ export default function DiagramEditorComponent(props) {
111111

112112
#### Adding styles
113113

114-
To display Diagram Editor correctly, you need to specify important styles for Diagram Editor and its container in the main css file of the project:
114+
To display Diagram Editor correctly, you need to specify important styles for Diagram Editor and its container in the CSS file of the project:
115115

116116
~~~css title="index.css"
117117
/* specify styles for initial page */
@@ -132,7 +132,7 @@ body,
132132

133133
#### Loading data
134134

135-
To add data into the Diagram Editor, you need to provide a data set. Let's create the ***data.js*** file in the ***src/*** directory and add some data into it:
135+
To add data into the Diagram Editor, you need to provide a [**data set**](https://github.com/DHTMLX/react-diagram-demo/blob/master/src/data.js). Let's create the ***data.js*** file in the ***src/*** directory and add some data into it:
136136

137137
~~~jsx title="data.js"
138138
export function getData() {

docs/guides/integrations/svelte_integration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To create a **Svelte** JS project, run the following command:
2424
npm create vite@latest
2525
~~~
2626

27-
Let's name the project as **my-svelte-diagram-app**.
27+
Select Svelte and JavaScript options while creating the project. Let's name the project as **my-svelte-diagram-app**.
2828

2929
### Installation of dependencies
3030

@@ -40,7 +40,7 @@ Then you need to install dependencies and run the app. For this, you need to mak
4040

4141
~~~jsx
4242
yarn
43-
yarn dev // or yarn dev
43+
yarn start // or yarn dev
4444
~~~
4545

4646
- if you use [**npm**](https://www.npmjs.com/), you need to call the following commands:
@@ -118,7 +118,7 @@ To display Diagram Editor on the page, you need to create the container for Diag
118118

119119
#### Adding styles
120120

121-
To display Diagram Editor correctly, you need to specify important styles for Diagram Editor and its container in the main css file of the project:
121+
To display Diagram Editor correctly, you need to specify important styles for Diagram Editor and its container in the CSS file of the project:
122122

123123
~~~css title="app.css"
124124
/* specify styles for initial page */
@@ -139,7 +139,7 @@ body,
139139

140140
#### Loading data
141141

142-
To add data into the Diagram Editor, we need to provide a data set. Let's create the ***data.js*** file in the ***src/*** directory and add some data into it:
142+
To add data into the Diagram Editor, we need to provide a [**data set**](https://github.com/DHTMLX/svelte-diagram-demo/blob/main/src/data.js). Let's create the ***data.js*** file in the ***src/*** directory and add some data into it:
143143

144144
~~~jsx title="data.js"
145145
export function getData() {
@@ -167,7 +167,7 @@ export function getData() {
167167
}
168168
~~~
169169

170-
Then open the ***App.svelte*** file, import data, and pass it into the new created `<DiagramEditor/>` components as **props**:
170+
Then open the ***App.svelte*** file, import data, and pass it into the newly created `<DiagramEditor/>` components as **props**:
171171

172172
~~~html {3,5,8} title="App.svelte"
173173
<script>

docs/guides/integrations/vue_integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ export default {
120120

121121
#### Adding styles
122122

123-
To display Diagram Editor correctly, you need to specify important styles for Diagram Editor and its container in the main css file of the project:
123+
To display Diagram Editor correctly, you need to specify important styles for Diagram Editor and its container in the CSS file of the project:
124124

125125
~~~css title="style.css"
126126
/* specify styles for initial page */
@@ -141,7 +141,7 @@ body,
141141

142142
#### Loading data
143143

144-
To add data into the Diagram Editor, you need to provide a data set. You can create the ***data.js*** file in the ***src/*** directory and add some data into it:
144+
To add data into the Diagram Editor, you need to provide a [**data set**](https://github.com/DHTMLX/vue-diagram-demo/blob/master/src/data.js). You can create the ***data.js*** file in the ***src/*** directory and add some data into it:
145145

146146
~~~jsx title="data.js"
147147
export function getData() {

0 commit comments

Comments
 (0)