"semantic-math-editor" | Semantic Math Editor

Index

Namespaces

API Enumerations

Model Enumerations

API Classes

Model Classes

API Interfaces

Type aliases

ExtendedNotifyObject

API Functions

Type aliases

ExtendedNotifyObject

ExtendedNotifyObject: SemanticNotifyObject | NotifyObject

API Functions

acceptMathNode

acceptMathNode<T>(node: MathNode, visitor: MathNodeVisitor<T>): T

Applies visitor to the given semantic math tree.

Type parameters
- T
Parameters
- node: MathNode
- visitor: MathNodeVisitor<T>
Returns T

acceptMathNodes

acceptMathNodes<T>(nodes: MathNode[], visitor: MathNodeVisitor<T>): T[]

Applies visitor to the all given semantic math tries.

Type parameters
- T
Parameters
- nodes: MathNode[]
- visitor: MathNodeVisitor<T>
Returns T[]

createAPI

createAPI(): MathEditorAPI

Factory method that creates MathEditorAPI.

Returns MathEditorAPI

createEditor

createEditor(element: HTMLElement, multiLine?: boolean): MathEditor

Factory method that creates MathEditor.

Parameters
- element: HTMLElement
  
  to mount math editor
- Optional multiLine: boolean
  
  true for multiline expression, for example system of equations or matrix.
Returns MathEditor

createRenderableEditor

createRenderableEditor(renderer: Renderer): MathEditorRenderable

Factory method that creates MathEditorRenderable using given renderer. Currently there is only one renderer that uses Katex.

Parameters
- renderer: Renderer
Returns MathEditorRenderable

enclosingRect

enclosingRect(...rects: ClientRect[]): ClientRect

Return ClientReact that includes all the given ClientRects.

Parameters
- Rest ...rects: ClientRect[]
Returns ClientRect

handleSymbols

handleSymbols(mathNode: MathStructure, callback: (symbol: MathSymbol) => void): void

Executes callback for every MathSymbol in a given MathStructure.

Parameters
- mathNode: MathStructure
  
  given semantic tree
- callback: (symbol: MathSymbol) => void
  - - (symbol: MathSymbol): void
    - Parameters
      - symbol: MathSymbol
      Returns void
Returns void

isKeyboardShown

isKeyboardShown(): boolean

Returns true if the virtual keyboard is shown.

Returns boolean

showKeyboard

showKeyboard(editor: MathEditor, dontHide?: boolean): void

Shows virtual keyboard for the given editor.

Parameters
- editor: MathEditor
- Optional dontHide: boolean
  
  whether hide the virtual keyboard on blur or not
Returns void

speakSemantic

speakSemantic(mathNode: MathStructure): string

Returns a description of the current expression as human readable math text.

Parameters
- mathNode: MathStructure
Returns string

traverseStructures

traverseStructures(mathNode: MathStructure, callback: (structure: MathStructure) => void): void

Recursively traverse given math tree and executes callback on every MathStructure.

Parameters
- mathNode: MathStructure
  
  given semantic tree
- callback: (structure: MathStructure) => void
  - - (structure: MathStructure): void
    - Parameters
      - structure: MathStructure
      Returns void
Returns void

traverseSymbols

traverseSymbols(mathNode: MathStructure, callback: (symbol: MathSymbol) => void): void

Recursively traverse given math tree and executes callback on every MathSymbol.

Parameters
- mathNode: MathStructure
  
  given semantic tree
- callback: (symbol: MathSymbol) => void
  - - (symbol: MathSymbol): void
    - Parameters
      - symbol: MathSymbol
      Returns void
Returns void

Generated using TypeDoc