Namespace micd

When loaded as an ES6 or Node.js module, the exported createApi function returns a Promise that resolves to the micd namespace root once the API is loaded and initialized. When loaded directly by <script> tag, the micd module is available as an object in the loading page's global (window) scope. The principal classes that make up the MICD API are all found directly under this namespace. For example, a new math editor can be created using let editor = new micd.Editor().

Index

Variables

config

Properties defined in micd.config before loading the API will modify the API configuration. After the API is loaded, micd.config will contain the actual runtime configuration of the API, including any defaulted values, and further changes will have no effect. If loading the API as an ES6 or Node.js module, configuration options can be passed to createApi instead.

key

key: string

When the API is loaded by <script> tag, this must be set to a valid API key before loading the API. If you need a key or have lost your key, please contact us for help. A key consisting of 22 zeroes can be used for development and testing only on localhost.

Functions

onReady

  • onReady(): any
  • When the API is loaded by <script> tag, this should be set to a callback function. The function will be invoked once the API is completely loaded and ready for use. No arguments are passed to it, and any return value is ignored.

    Returns any

This API is still under development and is subject to change. Copyright © Math I Can Do Solutions Incorporated and/or its licensors.