Options
All
  • Public
  • Public/Protected
  • All
Menu

mxGraph Typescript Declarations

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

FormFieldType

FormFieldType: HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement

StyleMap

StyleMap: {}

Type declaration

  • [key: string]: any

mxDialectConstants

mxDialectConstants: "svg" | "vml" | "mixedHtml" | "preferHtml" | "strictHtml"

Variables

Let mxBasePath

mxBasePath: string

Basepath for all URLs in the core without trailing slash. Default is ‘.’. Set mxBasePath prior to loading the mxClient library as follows to override this setting:

default

'.'

example
<script type="text/javascript">
  mxBasePath = '/path/to/core/directory';
</script>
<script type="text/javascript" src="/path/to/core/directory/js/mxClient.js"></script>

When using a relative path, the path is relative to the URL of the page that contains the assignment. Trailing slashes are automatically removed.

Let mxDefaultLanguage

mxDefaultLanguage: string

Defines the default language which is used in the common resource files. Any resources for this language will only load the common resource file, but not the language-specific resource file. Set mxDefaultLanguage prior to loading the mxClient library as follows to override this setting:

default

'en'

example
<script type="text/javascript">
  mxDefaultLanguage = 'de';
</script>
<script type="text/javascript" src="js/mxClient.js"></script>

Let mxForceIncludes

mxForceIncludes: boolean

Optional global config variable to force loading the JavaScript files in development mode. Default is undefined. NOTE: This is a global variable, not a variable of mxClient.

default

undefined

example
<script type="text/javascript">
  var mxLoadResources = true;
</script>
<script type="text/javascript" src="/path/to/core/directory/js/mxClient.js"></script>

Const mxHierarchicalEdgeStyle

mxHierarchicalEdgeStyle: { CURVE: 4; ORTHOGONAL: 1; POLYLINE: 2; STRAIGHT: 3 }

Type declaration

  • CURVE: 4
  • ORTHOGONAL: 1
  • POLYLINE: 2
  • STRAIGHT: 3

Let mxImageBasePath

mxImageBasePath: string

Basepath for all images URLs in the core without trailing slash. Default is mxClient.basePath + ‘/images’. Set mxImageBasePath prior to loading the mxClient library as follows to override this setting:

default

mxClient.basePath + ‘/images’

example
<script type="text/javascript">
  mxImageBasePath = '/path/to/image/directory';
</script>
<script type="text/javascript" src="/path/to/core/directory/js/mxClient.js"></script>

When using a relative path, the path is relative to the URL of the page that contains the assignment. Trailing slashes are automatically removed.

Let mxLanguage

mxLanguage: string

Defines the language of the client, eg. en for english, de for german etc. The special value ‘none’ will disable all built-in internationalization and resource loading. See mxResources.getSpecialBundle for handling identifiers with and without a dash.

Set mxLanguage prior to loading the mxClient library as follows to override this setting:

example
<script type="text/javascript">
  mxLanguage = 'en';
</script>
<script type="text/javascript" src="js/mxClient.js"></script>

Let mxLanguages

mxLanguages: string[]

Defines the optional array of all supported language extensions. The default language does not have to be part of this list.

see

mxResources.isLanguageSupported.

example
<script type="text/javascript">
  mxLanguages = ['de', 'it', 'fr'];
</script>
<script type="text/javascript" src="js/mxClient.js"></script>

This is used to avoid unnecessary requests to language files, ie. if a 404 will be returned.

Let mxLoadResources

mxLoadResources: boolean

Optional global config variable to toggle loading of the two resource files in mxGraph and mxEditor. Default is true. NOTE: This is a global variable, not a variable of mxClient. If this is false, you can use mxClient.loadResources with its callback to load the default bundles asynchronously.

default

true

example
<script type="text/javascript">
  var mxLoadResources = false;
</script>
<script type="text/javascript" src="/path/to/core/directory/js/mxClient.js"></script>

Let mxLoadStylesheets

mxLoadStylesheets: boolean

Optional global config variable to toggle loading of the CSS files when the library is initialized. Default is true. NOTE: This is a global variable, not a variable of mxClient.

default

true

example
<script type="text/javascript">
  var mxLoadStylesheets = false;
</script>
<script type="text/javascript" src="/path/to/core/directory/js/mxClient.js"></script>

Let mxResourceExtension

mxResourceExtension: string | boolean

Optional global config variable to specify the extension of resource files. Default is true. NOTE: This is a global variable, not a variable of mxClient.

default

true

example
<script type="text/javascript">
  var mxResourceExtension = '.txt';
</script>
<script type="text/javascript" src="/path/to/core/directory/js/mxClient.js"></script>

Functions

mxGenericChangeCodec

  • mxGenericChangeCodec(obj: any, variable: string): mxObjectCodec

Generated using TypeDoc