├── tslint.json ├── index.dev.js ├── index.js ├── .gitignore ├── .prettierrc ├── index.d.ts ├── .npmignore ├── tsconfig.json ├── package.json ├── README.md ├── src └── mxgraph-factory.ts ├── webpack.config.js └── LICENSE /tslint.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": ["tslint:recommended"] 3 | } 4 | -------------------------------------------------------------------------------- /index.dev.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | module.exports = require("./dist/mxgraph-factory.js"); -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | module.exports = require("./dist/mxgraph-factory.min.js"); 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .vscode 3 | 4 | dist 5 | node_modules 6 | 7 | npm-debug.log* 8 | yarn-debug.log* 9 | yarn-error.log* 10 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "arrowParens": "always", 3 | "printWidth": 120, 4 | "semi": true, 5 | "tabWidth": 4, 6 | "trailingComma": "all" 7 | } 8 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | import { mxgraph } from "./dist/mxgraph-typings"; 2 | import { mxgraphFactory } from "./dist/mxgraph-factory"; 3 | 4 | export { mxgraph, mxgraphFactory }; 5 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .gitignore 3 | .npmignore 4 | .prettierrc 5 | .vscode 6 | 7 | src 8 | npm-debug.log* 9 | package-lock.json 10 | tsconfig.json 11 | tslint.json 12 | webpack.config.js 13 | yarn-debug.log* 14 | yarn-error.log* 15 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "alwaysStrict": true, 4 | "allowSyntheticDefaultImports": true, 5 | "baseUrl": "src", 6 | "declaration": true, 7 | "declarationDir": "dist", 8 | "downlevelIteration": true, 9 | "esModuleInterop": true, 10 | "forceConsistentCasingInFileNames": true, 11 | "importHelpers": true, 12 | "lib": ["dom", "dom.iterable", "es2018"], 13 | "module": "commonjs", 14 | "moduleResolution": "node", 15 | "noImplicitReturns": true, 16 | "noUnusedLocals": true, 17 | "noUnusedParameters": true, 18 | "sourceMap": false, 19 | "strict": true, 20 | "target": "es5" 21 | }, 22 | "include": ["src/**/*"] 23 | } 24 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ts-mxgraph", 3 | "version": "1.0.0", 4 | "description": "A Tiny Typescript Wrapper for mxgraph", 5 | "main": "./index.js", 6 | "types": "./index.d.ts", 7 | "devDependencies": { 8 | "@types/node": "12.12.7", 9 | "copy-webpack-plugin": "5.0.5", 10 | "exports-loader": "0.7.0", 11 | "mxgraph": "4.1.0", 12 | "ts-loader": "6.2.1", 13 | "tslint": "5.20.1", 14 | "tslint-loader": "3.5.4", 15 | "typescript": "3.7.2", 16 | "webpack": "4.41.2", 17 | "webpack-cli": "3.3.10" 18 | }, 19 | "scripts": { 20 | "prepare": "webpack", 21 | "test": "echo \"Error: no test specified\" && exit 1" 22 | }, 23 | "repository": { 24 | "type": "git", 25 | "url": "git+https://github.com/rabpeter/ts-mxgraph.git" 26 | }, 27 | "keywords": [ 28 | "typescript", 29 | "mxgraph" 30 | ], 31 | "author": "rabpeter", 32 | "license": "ISC", 33 | "bugs": { 34 | "url": "https://github.com/rabpeter/ts-mxgraph/issues" 35 | }, 36 | "homepage": "https://github.com/rabpeter/ts-mxgraph#readme" 37 | } 38 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # A Tiny Typescript Wrapper for mxgraph 2 | 3 | **Archived on 2021-01-29**: `ts-mxgraph` was used in [bpmn-visualization](https://github.com/process-analytics/bpmn-visualization-js) until version `0.11.0`, 4 | it has then been replaced by a more standard solution, see [bpmn-visualization Pull Request #1040](https://github.com/process-analytics/bpmn-visualization-js/pull/1040) 5 | 6 | 7 | ## Overview 8 | 9 | A tiny wrapper around [mxgraph](https://github.com/jgraph/mxgraph-js) that 10 | provides a configurable TypeScript compatible package. 11 | 12 | ## Usage 13 | ```sh 14 | npm i -D ts-mxgraph 15 | ``` 16 | 17 | ```typescript 18 | import { mxgraph, mxgraphFactory } from "ts-mxgraph"; 19 | 20 | const { mxGraph, mxGraphModel } = mxgraphFactory({ 21 | mxLoadResources: false, 22 | mxLoadStylesheets: false, 23 | }); 24 | 25 | const container = document.getElementById("mxgraph-container"); 26 | if (container) { 27 | const model: mxgraph.mxGraphModel = new mxGraphModel(); 28 | const graph: mxgraph.mxGraph = new mxGraph(container, model); 29 | } 30 | ``` 31 | 32 | ## License 33 | 34 | [Apache 2.0 License](LICENSE) 35 | -------------------------------------------------------------------------------- /src/mxgraph-factory.ts: -------------------------------------------------------------------------------- 1 | import MxGraphFactory, { mxgraph } from "./mxgraph-typings"; 2 | 3 | export const mxgraphFactory: typeof MxGraphFactory = (options) => { 4 | const optionKeys = [ 5 | "mxBasePath", 6 | "mxDefaultLanguage", 7 | "mxForceIncludes", 8 | "mxImageBasePath", 9 | "mxLanguage", 10 | "mxLanguages", 11 | "mxLoadResources", 12 | "mxLoadStylesheets", 13 | "mxResourceExtension", 14 | ]; 15 | optionKeys.forEach((key: string) => { 16 | (window as any)[key] = (options as any)[key]; 17 | }); 18 | const mxClient: typeof mxgraph = require("mxgraph/javascript/mxClient"); 19 | mxClient.mxCodec.prototype.decode = function(node: Element, into: Element) { 20 | if (node !== null && node.nodeType === mxClient.mxConstants.NODETYPE_ELEMENT) { 21 | const ctor = mxClient[node.nodeName as keyof typeof mxgraph] || (window as any)[node.nodeName]; 22 | if (!ctor) { 23 | throw new Error(`Missing constructor for ${node.nodeName}`); 24 | } 25 | const dec = mxClient.mxCodecRegistry.getCodec(ctor); 26 | if (dec !== null) { 27 | return dec.decode(this, node, into); 28 | } 29 | const obj = node.cloneNode(true) as Element; 30 | obj.removeAttribute("as"); 31 | return obj; 32 | } 33 | return null; 34 | }; 35 | return mxClient; 36 | }; 37 | -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | "use strict"; 2 | 3 | const CopyWebpackPlugin = require("copy-webpack-plugin"); 4 | const path = require("path"); 5 | 6 | const config = { 7 | entry: ["./src/mxgraph-factory.ts"], 8 | module: { 9 | rules: [ 10 | { 11 | enforce: "pre", 12 | loader: "tslint-loader", 13 | options: { 14 | emitErrors: true, 15 | failOnHint: true, 16 | typeCheck: true, 17 | }, 18 | test: /\.ts$/, 19 | }, 20 | { 21 | loader: "ts-loader", 22 | test: /\.ts$/, 23 | }, 24 | { 25 | test: /mxClient\.js$/, 26 | loader: `exports-loader?${[ 27 | "mxAbstractCanvas2D", 28 | "mxActor", 29 | "mxAnimation", 30 | "mxArrow", 31 | "mxArrowConnector", 32 | "mxAutoSaveManager", 33 | "mxCell", 34 | "mxCellAttributeChange", 35 | "mxCellEditor", 36 | "mxCellHighlight", 37 | "mxCellMarker", 38 | "mxCellOverlay", 39 | "mxCellPath", 40 | "mxCellRenderer", 41 | "mxCellState", 42 | "mxCellStatePreview", 43 | "mxCellTracker", 44 | "mxChildChange", 45 | "mxCircleLayout", 46 | "mxClient", 47 | "mxClipboard", 48 | "mxCloud", 49 | "mxCodec", 50 | "mxCodecRegistry", 51 | "mxCollapseChange", 52 | "mxCompactTreeLayout", 53 | "mxCompositeLayout", 54 | "mxConnectionConstraint", 55 | "mxConnectionHandler", 56 | "mxConnector", 57 | "mxConstraintHandler", 58 | "mxConstants", 59 | "mxCoordinateAssignment", 60 | "mxCurrentRootChange", 61 | "mxCylinder", 62 | "mxDefaultKeyHandler", 63 | "mxDefaultPopupMenu", 64 | "mxDefaultToolbar", 65 | "mxDictionary", 66 | "mxDivResizer", 67 | "mxDoubleEllipse", 68 | "mxDragSource", 69 | "mxEdgeHandler", 70 | "mxEdgeLabelLayout", 71 | "mxEdgeSegmentHandler", 72 | "mxEdgeStyle", 73 | "mxEditor", 74 | "mxEffects", 75 | "mxElbowEdgeHandler", 76 | "mxEllipse", 77 | "mxEvent", 78 | "mxEventObject", 79 | "mxEventSource", 80 | "mxFastOrganicLayout", 81 | "mxForm", 82 | "mxGeometry", 83 | "mxGeometryChange", 84 | "mxGraph", 85 | "mxGraphAbstractHierarchyCell", 86 | "mxGraphHandler", 87 | "mxGraphHierarchyEdge", 88 | "mxGraphHierarchyModel", 89 | "mxGraphHierarchyNode", 90 | "mxGraphLayout", 91 | "mxGraphModel", 92 | "mxGraphSelectionModel", 93 | "mxGraphView", 94 | "mxGuide", 95 | "mxHandle", 96 | "mxHexagon", 97 | "mxHierarchicalLayout", 98 | "mxHierarchicalEdgeStyle", 99 | "mxHierarchicalLayoutStage", 100 | "mxImage", 101 | "mxImageBundle", 102 | "mxImageExport", 103 | "mxImageShape", 104 | "mxKeyHandler", 105 | "mxLabel", 106 | "mxLayoutManager", 107 | "mxLine", 108 | "mxLog", 109 | "mxMarker", 110 | "mxMedianHybridCrossingReduction", 111 | "mxMinimumCycleRemover", 112 | "mxMorphing", 113 | "mxMouseEvent", 114 | "mxMultiplicity", 115 | "mxObjectCodec", 116 | "mxObjectIdentity", 117 | "mxOutline", 118 | "mxPanningHandler", 119 | "mxPanningManager", 120 | "mxParallelEdgeLayout", 121 | "mxPartitionLayout", 122 | "mxPerimeter", 123 | "mxPoint", 124 | "mxPolyline", 125 | "mxPopupMenu", 126 | "mxPopupMenuHandler", 127 | "mxPrintPreview", 128 | "mxRadialTreeLayout", 129 | "mxRectangle", 130 | "mxRectangleShape", 131 | "mxResources", 132 | "mxRhombus", 133 | "mxRootChange", 134 | "mxRubberband", 135 | "mxSelectionCellsHandler", 136 | "mxSelectionChange", 137 | "mxShape", 138 | "mxStackLayout", 139 | "mxStencil", 140 | "mxStencilRegistry", 141 | "mxStyleChange", 142 | "mxStyleRegistry", 143 | "mxStylesheet", 144 | "mxSvgCanvas2D", 145 | "mxSwimlane", 146 | "mxSwimlaneLayout", 147 | "mxSwimlaneManager", 148 | "mxSwimlaneModel", 149 | "mxSwimlaneOrdering", 150 | "mxTemporaryCellStates", 151 | "mxTerminalChange", 152 | "mxText", 153 | "mxToolbar", 154 | "mxTooltipHandler", 155 | "mxTriangle", 156 | "mxUndoableEdit", 157 | "mxUndoManager", 158 | "mxUtils", 159 | "mxValueChange", 160 | "mxVertexHandler", 161 | "mxVisibleChange", 162 | "mxWindow", 163 | "mxXmlCanvas2D", 164 | "mxXmlRequest", 165 | ].join(",")}`, 166 | }, 167 | ], 168 | }, 169 | output: { 170 | library: "mxgraph-factory", 171 | libraryTarget: "commonjs2", 172 | path: path.resolve("dist"), 173 | }, 174 | performance: { 175 | hints: false, 176 | }, 177 | plugins: [ 178 | new CopyWebpackPlugin([ 179 | { 180 | context: "src", 181 | from: "*.d.ts", 182 | }, 183 | ]), 184 | ], 185 | resolve: { 186 | extensions: [".js", ".ts"], 187 | modules: ["./node_modules", "./src"], 188 | }, 189 | }; 190 | 191 | module.exports = [ 192 | { 193 | ...config, 194 | devtool: "none", 195 | mode: "development", 196 | output: { 197 | ...config.output, 198 | filename: "mxgraph-factory.js", 199 | }, 200 | }, 201 | { 202 | ...config, 203 | mode: "production", 204 | output: { 205 | ...config.output, 206 | filename: "mxgraph-factory.min.js", 207 | }, 208 | }, 209 | ]; 210 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------