Interface ConfigOptions

Hierarchy

  • ConfigOptions

Index

Properties

Optional acceptFileDrops

acceptFileDrops: boolean

If true then views will accept files and text dragged and dropped from the host platform. If a file in the Math I Can Do document format is dropped, the document will be loaded into the editor. Default is true.

Optional experimentalFeatures

experimentalFeatures: boolean

If true, enables experimental features being tested for possible inclusion in a future release. Currently, the default is true but it will switch to false in an unspecified future version.

Optional helpTable

When running in "help" mode, this property can be assigned a HelpTableTemplate to customize the generated table.

see

mode

see

createHelpTable

Optional localAutosave

localAutosave: boolean

If true then the contents of the shared editor will automatically be saved to and restored from local storage. Only applies to "editor" mode. Default is false.

see

mode

Optional locale

locale: string

A string that describes the desired locale, such as "en-AU" or "de". The default value is the locale reported by the browser.

Optional mode

mode: "api" | "editor" | "help" | "test"

A string naming the global mode that the API will run in. Default is "api". Possible values:

  • "api": Loads and initializes the API, calling micd.onReady once the API is available, but takes no further action. This is the default mode.
  • "editor": Loads and initializes the API, then injects a full-page Shell into the page. The micd.onReady function is only called after the shell is injected. The shell can be accessed programmatically through micd.shell.shared.
  • "help": Injects a table of available commands with their keyboard shortcuts and abbreviations into the page. Only the parts of the API needed to produce the table will be loaded, so the API will not be fully functional and cannot be relied on for other purposes.
  • "test": Performs a low-level self-test of the API.

Optional radixPoint

radixPoint: "," | "."

A string, either "," or ".", indicating which symbol will separate the integer and fractional parts of numbers. This also determines the symbol used to separate items in a list (such as the contents of a set): If set to ".", then "," is used as the separator. Otherwise, ";" is used as the separator. The default value is chosen based on the locale.

see

locale

Optional theme

Options that affect the initial theme used to style Views and Shells.

see

changeTheme

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