Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[update] Installing via npm and yarn (Diagram Editor). Integration guides #50

Merged
merged 8 commits into from
Oct 10, 2024
Merged

[update] Installing via npm and yarn (Diagram Editor). Integration guides #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a89e1a3
[update] installing via npm and yarn (Diagram Editor)
serhiipylypchuk1991 Oct 1, 2024
0325d60
[update] React integration guide
serhiipylypchuk1991 Oct 1, 2024
d66a8e0
[update] Angular integration guide
serhiipylypchuk1991 Oct 1, 2024
c01adf6
[update] Vue integration guide
serhiipylypchuk1991 Oct 2, 2024
6bc0b2d
[update] Svelte integration guide
serhiipylypchuk1991 Oct 3, 2024
3589dee
[update] integration guide minor fix
serhiipylypchuk1991 Oct 3, 2024
17c2870
[update] integration guides (changes after review)
serhiipylypchuk1991 Oct 8, 2024
ca50e1a
Merge pull request #49 from DHTMLX/sp-next-integration-guides
serhiipylypchuk1991 Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/trial_diagram.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 28 additions & 12 deletions docs/guides/diagram_editor/initialization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
sidebar_label: Initialization
title: Editor initialization
title: Diagram Editor initialization
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.
---

# Editor initialization
# Diagram Editor initialization

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:
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:

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

~~~html
<!DOCTYPE html>
Expand All @@ -34,7 +34,7 @@ This article covers the process of displaying a Diagram editor on a page. In ord
// more objects
];

// creating Editor
// creating Diagram Editor
const editor = new dhx.DiagramEditor("editor_container", {
// config options
});
Expand All @@ -48,7 +48,7 @@ This article covers the process of displaying a Diagram editor on a page. In ord

## Including required code files

To create Editor, you need to include 2 source files on your page:
To create Diagram Editor, you need to include 2 source files on your page:

- **diagramWithEditor.js**
- **diagramWithEditor.css**
Expand All @@ -60,15 +60,31 @@ Make sure that you set correct relative paths to these files:
<link rel="stylesheet" href="../codebase/diagramWithEditor.css">
~~~

## Initializing Editor
### Installing Diagram Editor via npm and yarn

You can import JavaScript Diagram Editor into your project using the `yarn` or `npm` package manager.

#### Installing trial Diagram Editor via npm and yarn

:::info
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.
:::

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

:::info
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.
:::

## Initializing Diagram Editor

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

### Initialization in a container

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

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

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

### Initialization in the document body

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

~~~jsx
const editor = new dhx.DiagramEditor(document.body, {
Expand Down Expand Up @@ -127,7 +143,7 @@ const editor = new dhx.DiagramEditor("editor_container", {

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

## Loading data into Editor
## Loading data into Diagram Editor

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.

Expand Down
261 changes: 255 additions & 6 deletions docs/guides/integrations/angular_integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,264 @@ description: You can learn about the Integration with Angular in the documentati

# Integration with Angular

DHTMLX Diagram can be easily integrated into an application created with the Angular framework.
:::tip
You should be familiar with the basic concepts and patterns of **Angular** to use this documentation. To refresh your knowledge, please refer to the [**Angular documentation**](https://angular.io/docs).
:::

DHTMLX Diagram Editor is compatible with **Angular**. We have prepared code examples on how to use DHTMLX Diagram Editor with **Angular**. For more information, refer to the corresponding [**Example on GitHub**](https://github.com/DHTMLX/angular-diagram-demo).

## Creating a project

:::info
Before you start to create a new project, install [**Angular CLI**](https://angular.io/cli) and [**Node.js**](https://nodejs.org/en/).
:::

Create a new **my-angular-diagram-app** project using Angular CLI. Run the following command for this purpose:

~~~json
ng new my-angular-diagram-app
~~~

:::note
View the [DHTMLX Diagram + Angular](https://github.com/DHTMLX/angular-diagram-demo) demo on GitHub.
If you want to follow this guide, disable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) when creating new Angular app!
:::

You can clone or download it, and use it for your projects. To run the demo, follow the instructions given in the README file.
The command above installs all the necessary tools, so you don't need to run any additional commands.

### Installation of dependencies

After that, go to the app directory:

~~~json
cd my-angular-diagram-app
~~~

Install dependencies and start the dev server. For this, use the [**yarn**](https://yarnpkg.com/) package manager:

~~~json
yarn
yarn start
~~~

The app should run on a localhost (for instance `http://localhost:3000`).

## Creating Diagram Editor

Now you should get the DHTMLX Diagram Editor source code. First of all, stop the app and proceed with installing the Diagram Editor package.

### Step 1. Package installation

Download the [**trial Diagram package**](/guides/diagram_editor/initialization/#installing-diagram-editor-via-npm-and-yarn) and follow steps mentioned in the README file. Note that trial Diagram Editor is available 30 days only.

### Step 2. Component creation

Now you need to create an Angular component, to add Diagram Editor into the application. Create the **diagram-editor** folder in the **src/app/** directory, add a new file into it and name it **diagram-editor.component.ts**. Then complete the steps described below.

#### Import source files

Open the file and import Diagram Editor source files. Note that:

- if you use PRO version and install the Diagram Editor package from a local folder, the imported path looks like this:

~~~jsx
import { DiagramEditor } from 'dhx-diagram-package';
~~~

- if you use the trial version of Diagram, specify the following path:

~~~jsx
import { DiagramEditor } from '@dhx/trial-diagram';
~~~

In this tutorial you can see how to configure the **trial** version of Diagram.

#### Set the container and initialize Diagram Editor

To display Diagram Editor on the page, you need to set the container to render the component inside and initialize Diagram Editor using the corresponding constructor:

~~~jsx {1,9,13-14,19-20} title="diagram-editor.component.ts"
import { DiagramEditor } from "@dhx/trial-diagram";
import { IDefaultEditorConfig } from "@dhx/trial-diagram/codebase/types/ts-diagram-editor";
import { Component, ElementRef, OnInit, ViewChild, OnDestroy, ViewEncapsulation } from '@angular/core';

@Component({
encapsulation: ViewEncapsulation.None,
selector: 'diagram-editor', // a template name used in the "app.component.ts" file as <diagram-editor/>
styleUrls: ['./diagram-editor.component.css'], // include a css file
template: `<div #container class = "widget"></div>`
})

export class DiagramEditorComponent implements OnInit, OnDestroy {
// initialize container for Diagram Editor
@ViewChild('container', { static: true }) editor_container!: ElementRef;

private _diagram_editor!: DiagramEditor;

ngOnInit() {
// initialize the Diagram Editor component
this._diagram_editor = new DiagramEditor( this.editor_container.nativeElement, { type: "default" } as IDefaultEditorConfig);
}

ngOnDestroy() {
this._diagram_editor.destructor(); // destruct Diagram Editor
}
}
~~~

#### Adding styles

To display Diagram Editor correctly, you need to provide the corresponding styles. For this purpose, you can create the **diagram-editor.component.css** file in the **src/app/diagram-editor/** directory and specify important styles for Diagram Editor and its container:

~~~css title="diagram-editor.component.css"
/* import Diagram Editor styles */
@import "@dhx/trial-diagram/codebase/diagram.min.css";

/* specify styles for initial page */
html,
body {
height: 100%;
padding: 0;
margin: 0;
}

/* specify styles for the Diagram Editor container */
.widget {
height: 100%;
width: 100%;
}
~~~

#### Loading data

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:

~~~jsx title="data.ts"
export function getData() {
return [
{ id: 1, x: 880, y: 105, text: "Does user remember his password?", type: "process", lineHeight: 18, fontColor: "#fff", fill: "#3DA0E3", stroke: "#3DA0E3" },
{ id: 2, x: 1080, y: 125, width: 50, "height": 50, text: "XOR", type: "circle", lineHeight: 18, fontColor: "#fff", fill: "#7D8495", stroke: "#7D8495" },
{ id: 3, x: 1160, y: 40, text: "User forgets his password", type: "preparation", lineHeight: 18, fontColor: "#fff", fill: "#33B579", stroke: "#33B579" },
{ id: 3.1, x: 1340, y: 40, text: "Send an E-mail with new password", type: "process", lineHeight: 18, fontColor: "#fff", fill: "#3DA0E3", stroke: "#3DA0E3" },
{ id: 3.2, x: 1520, y: 40, text: "E-mail sent", type: "preparation", fontColor: "#fff", lineHeight: 18, fill: "#33B579", stroke: "#33B579" },
{ id: 4, x: 1160, y: 180, text: "User remembers his password", type: "preparation", lineHeight: 18, fontColor: "#fff", fill: "#33B579", stroke: "#33B579" },
{ id: 5, x: 1340, y: 180, text: "User types in login and password", type: "process", lineHeight: 18, fontColor: "#fff", fill: "#3DA0E3", stroke: "#3DA0E3" },
// other data

{ from: 1, to: 2, type: "dash", forwardArrow: "filled", stroke: "#7D8495" },
{ from: 2, to: 3, type: "dash", toSide: "bottom", forwardArrow: "filled", stroke: "#7D8495" },
{ from: 2, to: 7.5, type: "dash", fromSide: "bottom", toSide: "top", backArrow: "filled", stroke: "#7D8495" },
{ from: 2, to: 3.2, type: "dash", fromSide: "top", toSide: "top", stroke: "#7D8495" },
{ from: 3, to: 3.1, type: "line", forwardArrow: "filled", stroke: "#7D8495" },
{ from: 3.1, to: 3.2, type: "line", forwardArrow: "filled", stroke: "#7D8495" },
{ from: 2, to: 4, type: "dash", toSide: "top", forwardArrow: "filled", stroke: "#7D8495" },
{ from: 4, to: 5, type: "dash", forwardArrow: "filled", stroke: "#7D8495" },
{ from: 5, to: 6, type: "dash", forwardArrow: "filled", stroke: "#7D8495" },
// other data
]
}
~~~

Then open the ***diagram-editor.component.ts*** file. Import the file with data and apply it using the [`parse()`](api/diagram_editor/editor/methods/parse_method.md) method within the `ngOnInit()` method, as shown below.

~~~jsx {3,19,22} title="diagram-editor.component.ts"
import { DiagramEditor } from "@dhx/trial-diagram";
import { IDefaultEditorConfig } from "@dhx/trial-diagram/codebase/types/ts-diagram-editor";
import { getData } from "./data"; // import data
import { Component, ElementRef, OnInit, ViewChild, OnDestroy, ViewEncapsulation } from '@angular/core';

@Component({
encapsulation: ViewEncapsulation.None,
selector: 'diagram-editor',
styleUrls: ['./diagram-editor.component.css'],
template: `<div #container class = "widget"></div>`
})

export class DiagramEditorComponent implements OnInit, OnDestroy {
@ViewChild('container', { static: true }) editor_container!: ElementRef;

private _diagram_editor!: DiagramEditor;

ngOnInit() {
const data = getData(); // initialize data property
this._diagram_editor = new DiagramEditor( this.editor_container.nativeElement, { type: "default" } as IDefaultEditorConfig);

this._diagram_editor.parse(data);
}

ngOnDestroy() {
this._diagram_editor.destructor();
}
}
~~~

Now the Diagram Editor component is ready to use. When the element will be added to the page, it will initialize the Diagram Editor with data. You can provide necessary configuration settings as well. Visit our [Diagram Editor API docs](/category/diagram-editor-api/) to check the full list of available properties.

#### Handling events

When a user makes some action in the Diagram Editor, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](api/diagram_editor/editor/events/overview.md).

Open the **diagram-editor.component.ts** file and complete the `ngOnInit()` method as in:

~~~jsx {5-7} title="diagram-editor.component.ts"
// ...
ngOnInit() {
this._diagram_editor = new DiagramEditor(this.editor_container.nativeElement, { type: "default" } as IDefaultEditorConfig);

this._diagram_editor.events.on("zoomIn", (step) => {
console.log("The diagram in the editor is zoomed in. The step is" + step);
});
}

ngOnDestroy() {
this._diagram_editor.destructor();
}
~~~

### Step 3. Adding Diagram Editor into the app

To add the ***DiagramEditorComponent*** into the app, open the ***src/app/app.component.ts*** file and replace the default code with the following one:

~~~jsx {5} title="app.component.ts"
import { Component } from "@angular/core";

@Component({
selector: "app-root",
template: `<diagram-editor/>` // a template created in the "diagram-editor.component.ts" file
})
export class AppComponent {
name = "";
}
~~~

Then create the ***app.module.ts*** file in the ***src/app/*** directory and specify the *DiagramEditorComponent* as shown below:

~~~jsx {4-5,8} title="app.module.ts"
import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";

import { AppComponent } from "./app.component";
import { DiagramEditorComponent } from "./diagram-editor/diagram-editor.component";

@NgModule({
declarations: [AppComponent, DiagramEditorComponent],
imports: [BrowserModule],
bootstrap: [AppComponent]
})
export class AppModule {}
~~~

The last step is to open the ***src/main.ts*** file and replace the existing code with the following one:

~~~jsx title="main.ts"
import { platformBrowserDynamic } from "@angular/platform-browser-dynamic";
import { AppModule } from "./app/app.module";
platformBrowserDynamic()
.bootstrapModule(AppModule)
.catch((err) => console.error(err));
~~~

After that, you can start the app to see Diagram Editor loaded with data on a page.

If you use some other frameworks, check the available examples below:
![Diagram Editor initialization](../../assets/trial_diagram.png)

- [Integration with React](/guides/integrations/react_integration/)
- [Integration with Vue.js](/guides/integrations/vue_integration/)
Now you know how to integrate DHTMLX Diagram Editor with Angular. You can customize the code according to your specific requirements. The final example you can find on [**GitHub**](https://github.com/DHTMLX/angular-diagram-demo).
Loading
Loading