Skip to content

Commit 4ae768b

Browse files
authored
Merge pull request #27 from ogobrecht/development
- move demo app, update README
2 parents 87fff82 + 0276793 commit 4ae768b

File tree

5 files changed

+36
-59119
lines changed

5 files changed

+36
-59119
lines changed

README.md

Lines changed: 36 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,40 @@
1-
[Download latest version][1] | [Online demo app][5] | [Wiki][7] | [Issues][4]
1+
[Download latest version](https://github.com/ogobrecht/apex-plugin-dhtmlx-gantt/releases/latest) |
2+
[Online demo app](https://apex.oracle.com/pls/apex/ogobrecht/r/playground/gantt-chart) |
3+
[Wiki](https://github.com/ogobrecht/apex-plugin-dhtmlx-gantt/wiki) |
4+
[Issues](https://github.com/ogobrecht/apex-plugin-dhtmlx-gantt/issues)
25

36
# Oracle APEX Region Type Plugin: dhtmlxGantt
47

5-
* Based on [dhtmlxGantt][2] ([docs][3]) library (v7.0.11)
6-
* This is the GPLv2 version of the library with a reduced set of functions
7-
* [Compare the free and the Pro version][compare]
8-
* If you need all functionality you can buy the Pro version and copy the Pro files into the plugin
9-
* I was asked to create this plugin and I have nothing to do with the company DHTMLX, so please do not complain ;-)
10-
* Minimum supported APEX version is 5.1
11-
* Features of the APEX integration:
12-
* Data can be delivered as XML (string) or JSON (string or object)
13-
* For the XML format there is an own parser integrated to support easy SQL queries - see example below
14-
* The plugin delivers sample data, if no query is defined
15-
* There are five events available to react on chart actions: Task Create, Task Double Click, Task Drag (change of progress, start date, duration), Link Create, Link Double Click
16-
* In the region attributes you can configure some aspects of the Gantt chart - for an example the height, the skin, the UI language (30 different delivered by the vendor); There is also the possibility to place custom before and after initialization JavaScript code
17-
* Everything else can be done with the extensive JavaScript API available from DHTMLX - please refer to the [docs][3]
18-
8+
- Based on [DHTMLX Gantt](https://dhtmlx.com/docs/products/dhtmlxGantt/) library v7.0.11 ([docs](http://docs.dhtmlx.com/gantt/))
9+
- This is the GPLv2 version of the library with a reduced set of functions - [Compare the free and the Pro version](https://docs.dhtmlx.com/gantt/desktop__editions_comparison.html)
10+
- If you need all functionality you can buy the Pro version and copy the Pro files into the plugin
11+
- "Export to PDF" functionality with the help of DHTMLX internet API (watermark without PRO version) - [more infos here...](https://docs.dhtmlx.com/gantt/desktop__export.html#exporttopdf)
12+
- Minimum supported APEX version for the plug-in is 5.1
13+
- Data can be delivered as XML (string) or JSON (string or object)
14+
- The plugin delivers sample data, if no query is defined
15+
- There are five events available to react on chart actions: Task Create, Task Double Click, Task Drag (change of progress, start date, duration), Link Create, Link Double Click
16+
- In the region attributes you can configure some aspects of the Gantt chart - for an example the height, the skin, the UI language (30 different delivered by the vendor); There is also the possibility to place custom before and after initialization JavaScript code
17+
- Everything else can be done with the extensive JavaScript API available from DHTMLX - [please refer to the docs](http://docs.dhtmlx.com/gantt/)
18+
19+
## You need to understand this
20+
21+
- The whole idea of the plug-in ist to integrate the Gantt JavaScript library and to expose relevant events to be able to use standard APEX modal dialogs to edit the tasks and links
22+
- The downside of this is, that you need to work with the event data to open your modal dialogs and that you need to prepare your URLs somewhere
23+
- You can prepare the edit URLs beforehand in the region SQL
24+
- When you change data by interacting with the graph you need to prepare the URL with a dynamic action
25+
- It is highly recommendet to install the demo app and inspect the implementation details:
26+
- Open the [online demo app](https://apex.oracle.com/pls/apex/ogobrecht/r/playground/gantt-chart)
27+
- Download it as it is (top right navigation menu, under the question mark)
28+
- Install it in your own APEX instance or [apex.oracle.com](https://apex.oracle.com/), if your instance has not the same version as [apex.oracle.com](https://apex.oracle.com/)
1929

2030
## How To Use
2131

22-
### The Recommended Way
23-
24-
1. Download the [latest version][1]
25-
2. Go to subdirectory `plugin/demo-objects` for a demo app including supporting objects
26-
3. Run the demo app and inspect, how it was implemented
27-
28-
Notes: Demo app is for APEX 20.2, sorry... try it on apex.oracle.com. Plug-in is still for APEX 5.1.4+ (downgrade was made with a diff tool comparing with an old plug-in version).
29-
30-
### The DIY Way
31-
32-
1. Download the [latest version][1]
32+
1. Download the [latest version](https://github.com/ogobrecht/apex-plugin-dhtmlx-gantt/releases/latest)
3333
2. Install the plugin from the subdirectory `plugin`
3434
3. On your page create a new region of type `dhtmlxGantt [Plug-In]`
35-
4. Optionally provide a query to load data from your tables
36-
* If you provide no query, then the plugin will provide sample data
37-
* For an example query see the inline help in APEX, `plugin/demo-objects/demo-query.sql` or the following section
38-
35+
4. Provide a query to load data from your tables
36+
- If you provide no query, then the plugin will provide sample data
37+
- For an example query see the inline help in APEX, `plugin/demo-objects/demo-query.sql` or the following section
3938

4039
### Example Query
4140

@@ -67,7 +66,7 @@ The result of the query should look like this example (prepared URL's are remove
6766

6867
If you need an JSON example please have a look at the file under `sources/plugin-dhtmlxgantt-helper.js` starting around line 130 - there is the sample data defined for the case that no region query is defined.
6968

70-
The following example query runs against demo tables - you can find the used DDL scripts in the subdirectory `plugin/demo-objects`. The shipped demo app in this directory has the scripts also implemented as supporting objects.
69+
The following example query runs against demo tables as delivered with the supporting objects of the demo app:
7170

7271
```sql
7372
WITH tasks AS ( --> START YOUR TASKS QUERY HERE
@@ -161,9 +160,13 @@ FROM
161160

162161
## Changelog
163162

164-
This project uses [semantic versioning][6].
163+
This project uses [semantic versioning](http://semver.org).
164+
165+
Please use for all comments and discussions the [issues functionality on GitHub](https://github.com/ogobrecht/apex-plugin-dhtmlx-gantt/issues).
165166

166-
Please use for all comments and discussions the [issues functionality on GitHub][4].
167+
### 0.11.1 (2021-11-22)
168+
169+
- Move demo app, update README
167170

168171
### 0.11.0 (2020-12-09)
169172

@@ -214,12 +217,3 @@ Please use for all comments and discussions the [issues functionality on GitHub]
214217
### 0.5.0 (2017-03-14)
215218

216219
- First public release
217-
218-
[1]: https://github.com/ogobrecht/apex-plugin-dhtmlx-gantt/releases/latest
219-
[2]: https://dhtmlx.com/docs/products/dhtmlxGantt/
220-
[3]: http://docs.dhtmlx.com/gantt/
221-
[4]: https://github.com/ogobrecht/apex-plugin-dhtmlx-gantt/issues
222-
[5]: https://apex.oracle.com/pls/apex/f?p=116612
223-
[6]: http://semver.org
224-
[7]: https://github.com/ogobrecht/apex-plugin-dhtmlx-gantt/wiki
225-
[compare]: https://docs.dhtmlx.com/gantt/desktop__editions_comparison.html

0 commit comments

Comments
 (0)