Type Alias TypeEquationPhrase

TypeEquationPhrase:
    | string
    | number
    | { frac: EQN_Fraction }
    | { strike: EQN_Strike }
    | { box: EQN_Box }
    | { tBox: EQN_TouchBox }
    | { root: EQN_Root }
    | { brac: EQN_Bracket }
    | { sub: EQN_Subscript }
    | { sup: EQN_Superscript }
    | { supSub: EQN_SuperscriptSubscript }
    | { topBar: EQN_Bar }
    | { bottomBar: EQN_Bar }
    | { annotate: EQN_Annotate }
    | { topComment: EQN_Comment }
    | { bottomComment: EQN_Comment }
    | { pad: EQN_Pad }
    | { bar: EQN_Bar }
    | { scale: EQN_Scale }
    | { container: EQN_Container }
    | { offset: EQN_Offset }
    | { matrix: EQN_Matrix }
    | { matrix: EQN_Lines }
    | { int: EQN_Integral }
    | { sumOf: EQN_SumOf }
    | { prodOf: EQN_ProdOf }
    | { topStrike: EQN_StrikeComment }
    | { bottomStrike: EQN_StrikeComment }
    | { color: EQN_Color }
    | { opacity: EQN_Opacity }
    | { back: EQN_Back }
    | { front: EQN_Front }
    | { make: string; name?: string; [key: string]: any }
    | TypeEquationPhrase[]
    | FigureElementPrimitive
    | FigureElementCollection
    | Elements
    | Element
    | BaseAnnotationFunction

An equation phrase is used to define an equation form and can be any of the below:

string (which represents the unique identifier of an equation element)
{ frac: EQN_Fraction }
{ strike: EQN_Strike }
{ box: EQN_Box }
{ tBox: EQN_TouchBox }
{ root: EQN_Root }
{ brac: EQN_Bracket }
{ sub: EQN_Subscript }
{ sup: EQN_Superscript }
{ supSub: EQN_SuperscriptSubscript }
{ topBar: EQN_Bar }
{ bottomBar: EQN_Bar }
{ annotate: EQN_Annotate }
{ topComment: EQN_Comment }
{ bottomComment: EQN_Comment }
{ pad: EQN_Pad }
{ bar: EQN_Bar }
{ scale: EQN_Scale }
{ container: EQN_Container }
{ offset: EQN_Offset }
{ matrix: EQN_Matrix `}
{ lines: {@link EQN_Lines} }
{ int: {@link EQN_Integral} }
{ sumOf: {@link EQN_SumOf} }
{ prodOf: {@link EQN_ProdOf} }
{ topStrike: {@link EQN_StrikeComment} }
{ bottomStrike: {@link EQN_StrikeComment} }
{ color: {@link EQN_Color} }
{ opacity: {@link EQN_Opacity} }
{ back: {@link EQN_Back} }
{ front: {@link EQN_Front} }
{ make: string, name?: string, ... } (inline element — creates any element type directly in a form using the same make values as {@link Figure.add}. If name is omitted, one is auto-generated.)
Array<TypeEquationPhrase>

Example

figure.add({
  name: 'eqn',
  make: 'equation',
  elements: { equals: ' = ' },
  forms: {
    form1: 'a',
    form2: ['a', 'equals', 'b'],
    form3: [{
      frac: {
        numerator: 'a',
        symbol: 'vinculum',
        denominator: 'c',
      },
    }, 'equals', 'b'],
    form4: { frac: ['a', 'vinculum', 'c'] },
  },
});

figure.getElement('eqn').animations.new()
  .goToForm({ target: 'form2', animate: 'move', delay: 1 })
  .goToForm({ target: 'form3', animate: 'move', delay: 1 })
  .goToForm({ target: 'form4', animate: 'move', delay: 1 })
  .start();

Example

// Inline element creation in forms
figure.add({
  make: 'equation',
  forms: {
    // Create a text element inline with a name
    form1: ['a', { make: 'text', name: 'B', text: { text: 'B' } }, 'c'],
    // Create any element type inline (e.g., polygon)
    form2: ['a', { make: 'polygon', name: 'p', radius: 0.05, sides: 4 }],
  },
});

Type Alias TypeEquationPhrase

Example

Example

Settings