Class Menu

The Menu object that handles the MathJax contextual menu and its actions

Index

Constructors

constructor

Accessors

isLoading loadingPromise

Constructors

constructor

new Menu(document: MenuMathDocument, options?: OptionList): Menu
Accept options in addition to the MathDocument, and set up the menu based on the defaults, the passed options, and the user's saved settings.
Parameters
- document: MenuMathDocument
  The MathDcument where this menu will post
- options: OptionList = {}
  The options for the menu
Returns Menu
- Defined in ts/ui/menu/Menu.ts:498

Properties

`Protected`about

about: Info = ...

The "About MathJax" info box

`Protected`annotationBox

annotationBox: SelectableInfo = ...

The "Show As Annotation" info box

`Protected`brailleText

brailleText: SelectableInfo = ...

The "Show As Speech Text" info box

current

current: HTMLElement = null

The current element being explored

defaultSettings

defaultSettings: MenuSettings = null

The original settings (with page options factored in) for use with the reset command

`Protected`document

document: MenuMathDocument

The MathDocument in which we are working

`Protected`errorMessage

errorMessage: SelectableInfo = ...

The "Show As Error Message" info box

`Protected`help

help: Info = ...

The "MathJax Help" info box

`Protected`jax

jax: JaxList = ...

Instances of the various output jax that we can switch to

`Protected`mathmlCode

mathmlCode: SelectableInfo = ...

The "Show As MathML" info box

menu: MJContextMenu = null

The contextual menu object that is managed by this Menu

MmlVisitor

MmlVisitor: MmlVisitor<HTMLElement, Text, Document> = ...

A MathML serializer that has options corresponding to the menu settings

options

options: OptionList

The options for this menu

`Protected`originalText

originalText: SelectableInfo = ...

The "Show As (original form)" info box

requiredExtensions

requiredExtensions: string[] = []

List of font extensions that were loaded via \require

`Protected`rerenderStart

rerenderStart: number = STATE.LAST

The minium initial state for pending rerender requests (so final rerender gets the right start)

settings

settings: MenuSettings = null

The current settings for this menu (the variables attached to the menu's pool)

`Protected`speechText

speechText: SelectableInfo = ...

The "Show As Speech Text" info box

`Protected`svgImage

svgImage: SelectableInfo = ...

The "Show As SVG Image" info box

`Protected`zoomBox

zoomBox: Info = ...

The info box for zoomed expressions

`Protected` `Static`_loadingFailed

_loadingFailed: (err: Error) => void = null

Function used to reject the _loadingPromise

`Protected` `Static`_loadingOK

_loadingOK: () => void = null

Function used to resolve the _loadingPromise

`Protected` `Static`_loadingPromise

_loadingPromise: Promise<void> = null

A promise that is resolved when all components are loaded

`Protected` `Static`loading

loading: number = 0

The number of startup modules that are currently being loaded

`Protected` `Static`loadingPromises

loadingPromises: Map<string, Promise<void>> = ...

Promises for the loading components

`Static`MENU_STORAGE

MENU_STORAGE: string = 'MathJax-Menu-Settings'

The key for the localStorage for the menu settings

`Static`OPTIONS

OPTIONS: OptionList = ...

The options for the menu, including the default settings, the various output jax and the list of annotation types and their encodings

`Static`SvgCss

SvgCss: string = ...

The CSS to include in SVG images

Accessors

isLoading

get isLoading(): boolean
Returns boolean
true when the menu is loading some component
- Defined in ts/ui/menu/Menu.ts:268

loadingPromise

get loadingPromise(): Promise<void>
Returns Promise<void>
A promise that is resolved when all pending loads are complete
- Defined in ts/ui/menu/Menu.ts:275

Methods

a11yVar

a11yVar<T extends string | boolean>(
name: keyof MenuSettings,
action?: (value: T) => void,
): object
Create JSON for an a11y specific variable.
Type Parameters
- T extends string | boolean
  The type of variable being defined
Parameters
- name: keyof MenuSettings
  The setting for which to make a variable
- Optionalaction: (value: T) => void
  The action to perform when the variable is updated
Returns object
The JSON for the variable
- Defined in ts/ui/menu/Menu.ts:1804

addMenu

addMenu(math: HTMLMATHITEM): void
Parameters
- math: HTMLMATHITEM
  The math to attach the context menu and zoom triggers to
Returns void
- Defined in ts/ui/menu/Menu.ts:1718

addRequiredExtensions

addRequiredExtensions(extensions: string[]): void
Add extensions that need to be loaded when the renderer changes
Parameters
- extensions: string[]
  The list of extensions
Returns void
- Defined in ts/ui/menu/Menu.ts:1166

`Protected`applySettings

applySettings(): void
Do what is needed to apply the initial user settings

Returns void
- Defined in ts/ui/menu/Menu.ts:1040

`Protected`attachDialogMenus

attachDialogMenus(menu: MJContextMenu): void
Parameters
- menu: MJContextMenu
  The menu to attach
Returns void
- Defined in ts/ui/menu/Menu.ts:902

checkbox

checkbox(id: string, content: string, variable: string, other?: object): object
Create JSON for a checkbox item
Parameters
- id: string
  The id for the item
- content: string
  The content for the item
- variable: string
  The (pool) variable to attach to this checkbox
- other: object = {}
  Other values to include in the generated JSON object
Returns object
The JSON for the checkbox item
- Defined in ts/ui/menu/Menu.ts:1881

checkComponent

checkComponent(name: string): void
Check if a component is loading, and restart if it is
Parameters
- name: string
  The name of the component to check if it is loading
Returns void
- Defined in ts/ui/menu/Menu.ts:1378

`Protected`checkLoadableItems

checkLoadableItems(): void
Check whether the startup and loader modules are available, and if not, disable the a11y modules (since we can't load them or know if they are available). Otherwise, check if any need to be loaded

Returns void
- Defined in ts/ui/menu/Menu.ts:921

clear

clear(): void
Clear the information about stored context menus

Returns void
- Defined in ts/ui/menu/Menu.ts:1762

command

command(id: string, content: string, action: () => void, other?: object): object
Create JSON for a command item
Parameters
- id: string
  The id for the item
- content: string
  The content for the item
- action: () => void
  The action function for the command
- other: object = {}
  Other values to include in the generated JSON object
Returns object
The JSON for the command item
- Defined in ts/ui/menu/Menu.ts:1863

`Protected`copyBrailleText

copyBrailleText(): void
Copy the speech text to the clipboard

Returns void
- Defined in ts/ui/menu/Menu.ts:1702

`Protected`copyErrorMessage

copyErrorMessage(): void
Copy the error message to the clipboard

Returns void
- Defined in ts/ui/menu/Menu.ts:1709

`Protected`copyMathML

copyMathML(): void
Copy the serialzied MathML to the clipboard

Returns void
- Defined in ts/ui/menu/Menu.ts:1672

`Protected`copyOriginal

copyOriginal(): void
Copy the original form to the clipboard

Returns void
- Defined in ts/ui/menu/Menu.ts:1679

`Protected`copySpeechText

copySpeechText(): void
Copy the speech text to the clipboard

Returns void
- Defined in ts/ui/menu/Menu.ts:1695

`Protected`copySvgImage

copySvgImage(): void
Copy the SVG image to the clipboard

Returns void
- Defined in ts/ui/menu/Menu.ts:1686

`Protected`enableAccessibilityItems

enableAccessibilityItems(name: string, enable: boolean): void
Enable/disable an assistive submenu's items
Parameters
- name: string
  The name of the item
- enable: boolean
  True to enable, false to disable
Returns void
- Defined in ts/ui/menu/Menu.ts:962

`Protected`formatSource

formatSource(text: string): string
Parameters
- text: string
  The text to be displayed in an Info box
Returns string
The text with HTML specials being escaped
- Defined in ts/ui/menu/Menu.ts:1486

`Protected`formatSvg

formatSvg(svg: string): string
Parameters
- svg: string
  The serialzied SVG to adjust
Returns string
The adjusted SVG string
- Defined in ts/ui/menu/Menu.ts:1573

`Protected`getA11y

getA11y(option: string): any
Get the the value of an a11y option
Parameters
- option: string
  The name of the ptions to get
Returns any
The value of the option
- Defined in ts/ui/menu/Menu.ts:1026

`Protected`initMenu

initMenu(): void
Create the menu object, attach the info boxes to it, and output any CSS needed for it

Returns void
- Defined in ts/ui/menu/Menu.ts:537

`Protected`initSettings

initSettings(): void
Set up the settings and jax objects, and transfer the output jax name and scale to the settings

Returns void
- Defined in ts/ui/menu/Menu.ts:513

`Protected`isZoomEvent

isZoomEvent(event: MouseEvent, zoom: string): boolean
Parameters
- event: MouseEvent
  The event triggering the zoom action
- zoom: string
  The type of event (click, dblclick) that occurred
Returns boolean
True if the event is the right type and has the needed modifiers
- Defined in ts/ui/menu/Menu.ts:1639

label

label(id: string, content: string): object
Create JSON for a label item
Parameters
- id: string
  The id for the item
- content: string
  The content for the item
Returns object
The JSON for the label item
- Defined in ts/ui/menu/Menu.ts:1927

loadA11y

loadA11y(component: string): void
Attempt to load an a11y component
Parameters
- component: string
  The name of the a11y component to load
Returns void
- Defined in ts/ui/menu/Menu.ts:1423

`Protected`loadComponent

loadComponent(name: string, callback: () => void): void
Attempt to load a component and perform a callback when done
Parameters
- name: string
  The name of the component to load
- callback: () => void
  The callback for after loading
Returns void
- Defined in ts/ui/menu/Menu.ts:1391

`Protected`loadRequiredExtensions

loadRequiredExtensions(): Promise<string[]>
Load the required extensions into the new output jax

Returns Promise<string[]>
The promise combining all loading promises
- Defined in ts/ui/menu/Menu.ts:1151

`Protected`mergeUserSettings

mergeUserSettings(): void
Look up the saved settings from localStorage and merge them into the menu settings

Returns void
- Defined in ts/ui/menu/Menu.ts:977

postSvgImage

postSvgImage(): void
Get the SVG image and post it

Returns void
- Defined in ts/ui/menu/Menu.ts:1604

radio

radio(id: string, content: string, variable: string, other?: object): object
Create JSON for a radio button item
Parameters
- id: string
  The id for the item
- content: string
  The content for the item
- variable: string
  The (pool) variable to attach to this radio button
- other: object = {}
  Other values to include in the generated JSON object
Returns object
The JSON for the radio button item
- Defined in ts/ui/menu/Menu.ts:1911

radioGroup

radioGroup(variable: string, radios: string[][]): object[]
Create JSON for a group of connected radio buttons
Parameters
- variable: string
  The (pool) variable to attach to each radio button
- radios: string[][]
  An array of [string] or [string, string], giving the id and content for each radio button (if only one string is given it is used for both)
Returns object[]
An array of JSON objects for radion buttons
- Defined in ts/ui/menu/Menu.ts:1898

`Protected`rerender

rerender(start?: number): void
Rerender the output if we aren't in the middle of loading a new component (in which case, we will rerender in the callback performed after it is loaded)
Parameters
- start: number = STATE.TYPESET
  The state at which to start rerendering
Returns void
- Defined in ts/ui/menu/Menu.ts:1655

`Protected`resetDefaults

resetDefaults(): void
Reset all menu settings to the (page) defaults

Returns void
- Defined in ts/ui/menu/Menu.ts:1349

rule

rule(): object
Create JSON for a menu rule

Returns object
The JSON for the rule item
- Defined in ts/ui/menu/Menu.ts:1936

`Protected`saveUserSettings

saveUserSettings(): void
Save any non-default menu settings in localStorage

Returns void
- Defined in ts/ui/menu/Menu.ts:991

`Protected`scaleAllMath

scaleAllMath(): void
Request the scaling value from the user and save it in the settings

Returns void
- Defined in ts/ui/menu/Menu.ts:1319

`Protected`setA11y

setA11y(options: { [key: string]: any }): void
Merge menu settings into the a11y document options.
Parameters
- options: { [key: string]: any }
  The options.
Returns void
- Defined in ts/ui/menu/Menu.ts:1014

`Protected`setAccessibilityMenus

setAccessibilityMenus(): void
Enable/disable assistive menus based on enrichment setting

Returns void
- Defined in ts/ui/menu/Menu.ts:1197

`Protected`setAssistiveMml

setAssistiveMml(mml: boolean): void
Parameters
- mml: boolean
  True to output hidden Mathml, false to not
Returns void
- Defined in ts/ui/menu/Menu.ts:1185

`Protected`setBraille

setBraille(braille: boolean): void
Parameters
- braille: boolean
  True to enable braille, false to not
Returns void
- Defined in ts/ui/menu/Menu.ts:1230

`Protected`setBrailleCode

setBrailleCode(code: string): void
Parameters
- code: string
  The Braille code format (nemeth or euro)
Returns void
- Defined in ts/ui/menu/Menu.ts:1243

`Protected`setCollapsible

setCollapsible(collapse: boolean): void
Parameters
- collapse: boolean
  True to enable collapsible math, false to not
Returns void
- Defined in ts/ui/menu/Menu.ts:1279

`Protected`setEnrichment

setEnrichment(enrich: boolean): void
Parameters
- enrich: boolean
  True to enable enriched math, false to not
Returns void
- Defined in ts/ui/menu/Menu.ts:1266

`Protected`setHighlight

setHighlight(value: string): void
Parameters
- value: string
  The value that highlighting should have
Returns void
- Defined in ts/ui/menu/Menu.ts:1301

`Protected`setInlineBreaks

setInlineBreaks(breaks: boolean): void
Parameters
- breaks: boolean
  The new in-line break value
Returns void
- Defined in ts/ui/menu/Menu.ts:1080

`Protected`setLocale

setLocale(locale: string): void
Parameters
- locale: string
  The speech locale
Returns void
- Defined in ts/ui/menu/Menu.ts:1251

`Protected`setOutputJax

setOutputJax(jax: string, rerender?: boolean): Promise<void>
Set up the new jax and link it to the document, load any needed extensions, and then rerender the math, if needed
Parameters
- jax: string
  The name of the jax to switch to
- rerender: boolean = true
  True if the document should be rerendered
Returns Promise<void>
A promise that is resolved when the renderer is set and rerendering complete
- Defined in ts/ui/menu/Menu.ts:1137

`Protected`setOverflow

setOverflow(overflow: string): void
Parameters
- overflow: string
  The new overflow value
Returns void
- Defined in ts/ui/menu/Menu.ts:1070

`Protected`setRenderer

setRenderer(jax: string, rerender?: boolean): Promise<void>
If the jax is already on record, just use it, otherwise load the new one
Parameters
- jax: string
  The name of the jax to switch to
- rerender: boolean = true
  True if the document should be rerendered
Returns Promise<void>
A promise that is resolved when the renderer is set and rerendering complete
- Defined in ts/ui/menu/Menu.ts:1105

`Protected`setRoleDescription

setRoleDescription(): void
Rerender when the role description changes

Returns void
- Defined in ts/ui/menu/Menu.ts:1259

`Protected`setScale

setScale(scale: string): void
Parameters
- scale: string
  The new scaling value
Returns void
- Defined in ts/ui/menu/Menu.ts:1090

`Protected`setSpeech

setSpeech(speech: boolean): void
Parameters
- speech: boolean
  True to enable speech, false to not
Returns void
- Defined in ts/ui/menu/Menu.ts:1217

`Protected`setTabOrder

setTabOrder(tab: boolean): void
Parameters
- tab: boolean
  True for including math in the tab order, false for not
Returns void
- Defined in ts/ui/menu/Menu.ts:1176

submenu

submenu(
    id: string,
    content: string,
    entries?: any[],
    disabled?: boolean,
): object
Create JSON for a submenu item
Parameters
- id: string
  The id for the item
- content: string
  The content for the item
- entries: any[] = []
  The JSON for the entries
- disabled: boolean = false
  True if this item is diabled initially
Returns object
The JSON for the submenu item
- Defined in ts/ui/menu/Menu.ts:1831

`Protected`toMML

toMML(math: HTMLMATHITEM): string
Parameters
- math: HTMLMATHITEM
  The MathItem to serialize as MathML
Returns string
The serialized version of the internal MathML
- Defined in ts/ui/menu/Menu.ts:1498

`Protected`toSVG

toSVG(math: HTMLMATHITEM): Promise<string>
Parameters
- math: HTMLMATHITEM
  The MathItem to serialize as SVG
Returns Promise<string>
A promise returning the serialized SVG
- Defined in ts/ui/menu/Menu.ts:1511

`Protected`transferMathList

transferMathList(document: MenuMathDocument): void
Parameters
- document: MenuMathDocument
  The original document whose list is to be transferred
Returns void
- Defined in ts/ui/menu/Menu.ts:1473

`Protected`typesetSVG

typesetSVG(math: HTMLMATHITEM, cache: string, breaks: boolean): Promise<string>
Parameters
- math: HTMLMATHITEM
  The MathItem to serialize as SVG
- cache: string
  The SVG font cache type
- breaks: boolean
  True if there are inline breaks
Returns Promise<string>
A promise returning the serialized SVG
- Defined in ts/ui/menu/Menu.ts:1542

variable

variable<T extends string | boolean>(
name: keyof MenuSettings,
action?: (value: T) => void,
): object
Create JSON for a variable controlling a menu setting
Type Parameters
- T extends string | boolean
  The type of variable being defined
Parameters
- name: keyof MenuSettings
  The setting for which to make a variable
- Optionalaction: (value: T) => void
  Optional function to perform after setting the value
Returns object
The JSON for the variable
- Defined in ts/ui/menu/Menu.ts:1777

`Protected`zoom

zoom(event: MouseEvent, type: string, math: HTMLMATHITEM): void
Parameters
- event: MouseEvent
  The event triggering the zoom (or null for from a menu pick)
- type: string
  The type of event occurring (click, dblclick)
- math: HTMLMATHITEM
  The MathItem triggering the event
Returns void
- Defined in ts/ui/menu/Menu.ts:1619

Class Menu

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Menu

Properties

Protectedabout

ProtectedannotationBox

ProtectedbrailleText

current

defaultSettings

Protecteddocument

ProtectederrorMessage

Protectedhelp

Protectedjax

ProtectedmathmlCode

menu

MmlVisitor

options

ProtectedoriginalText

requiredExtensions

ProtectedrerenderStart

settings

ProtectedspeechText

ProtectedsvgImage

ProtectedzoomBox

Protected Static_loadingFailed

Protected Static_loadingOK

Protected Static_loadingPromise

Protected Staticloading

Protected StaticloadingPromises

StaticMENU_STORAGE

StaticOPTIONS

StaticSvgCss

Accessors

isLoading

Returns boolean

loadingPromise

Returns Promise<void>

Methods

a11yVar

Type Parameters

Parameters

Returns object

addMenu

Parameters

Returns void

addRequiredExtensions

Parameters

Returns void

ProtectedapplySettings

Returns void

ProtectedattachDialogMenus

Parameters

Returns void

checkbox

Parameters

Returns object

checkComponent

Parameters

Returns void

ProtectedcheckLoadableItems

Returns void

clear

Returns void

command

Parameters

Returns object

ProtectedcopyBrailleText

Returns void

ProtectedcopyErrorMessage

Returns void

ProtectedcopyMathML

Returns void

ProtectedcopyOriginal

`Protected`about

`Protected`annotationBox

`Protected`brailleText

`Protected`document

`Protected`errorMessage

`Protected`help

`Protected`jax

`Protected`mathmlCode

`Protected`originalText

`Protected`rerenderStart

`Protected`speechText

`Protected`svgImage

`Protected`zoomBox

`Protected` `Static`_loadingFailed

`Protected` `Static`_loadingOK

`Protected` `Static`_loadingPromise

`Protected` `Static`loading

`Protected` `Static`loadingPromises

`Static`MENU_STORAGE

`Static`OPTIONS

`Static`SvgCss

`Protected`applySettings

`Protected`attachDialogMenus

`Protected`checkLoadableItems

`Protected`copyBrailleText

`Protected`copyErrorMessage

`Protected`copyMathML

`Protected`copyOriginal

`Protected`copySpeechText

`Protected`copySvgImage

`Protected`enableAccessibilityItems

`Protected`formatSource

`Protected`formatSvg

`Protected`getA11y

`Protected`initMenu

`Protected`initSettings

`Protected`isZoomEvent

`Protected`loadComponent

`Protected`loadRequiredExtensions

`Protected`mergeUserSettings

`Protected`rerender

`Protected`resetDefaults

`Protected`saveUserSettings

`Protected`scaleAllMath

`Protected`setA11y

`Protected`setAccessibilityMenus

`Protected`setAssistiveMml

`Protected`setBraille

`Protected`setBrailleCode