This package has been deprecated

Author message:

migrate to @typed-mxgraph/typed-mxgraph

mxgraph-type-definitions
TypeScript icon, indicating that this package has built-in type declarations

1.0.6 • Public • Published

mxGraph Type Definitions

Build npm version

This project is typescript definitions for mxGraph.

This project provide global type definitions for mxgraph, if you are working with official mxgraph npm package, please see our new package typed-mxgraph which design for mxgraph npm package.

Usage

install mxgraph-type-definitions dependencie and append node_modules/mxgraph-type-definitions to typeRoots in tsconfig.json

npm install --save-dev mxgraph-type-definitions
{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "esModuleInterop": true,
    "typeRoots": [
      "node_modules/@types",
      "node_modules/mxgraph-type-definitions"
    ]
  }
}

As #29 said, mxClient will not work if installed via npm. It is recommended to add this project as a submodule to you project. Here is a demo. If you are using this npm package, typed-mxgraph may be more appropriate.

Progress

The definitions currently target mxGraph 4.1.1. See the implementation status in the following table.

  • progress: initial support
    • not yet: no support at all
    • partial: implementation started but some classes/fields/methods are missing
    • completed: all classes/fields/methods should exist (fill an issue and/or provide a Pull Request if you detect an issue) but
      • TSDoc is not fully accurate
      • some type declaration may be wrong
  • checked: a finest review has been conducted about TSDoc, mxGraph types used by functions/methods, fields, ...
Module Progress Checked
editor not yet no
handler completed no
io completed no
layout completed no
model completed no
shape completed no
util partial no
view partial no
mxClient.d.ts completed no

Also See

We are actively developing, if you want to be a contributor, please refer to the following links

Some Useful Regular Expressions

Readme

Keywords

Package Sidebar

Install

npm i mxgraph-type-definitions

Weekly Downloads

120

Version

1.0.6

License

Apache-2.0

Unpacked Size

931 kB

Total Files

153

Last publish

Collaborators

  • hungtcs