Interface EQN_EncompassGlyph

Encompass glyph options object.

A glyph can encompass (surround or overlay) an equation phrase (content). The glyph can also be annotated.


      gggggggggggggg
      gggCCCCCCCCggg
      gggCCCCCCCCggg
      gggCCCCCCCCggg
      gggCCCCCCCCggg
      gggggggggggggg

symbol string
annotation EQN_Annotation — use for one annotation only instead of property annotations
annotations EQN_Annotation[] — use for one or more annotations
space number — default space the glyph should extend beyond the top, right, left and bottom sides of the content (0)
topSpace number — space the glyph extends beyond the content top
rightSpace number — space the glyph extends beyond the content right
bottomSpace number — space the glyph extends beyond the content bottom
leftSpace number — space the glyph extends beyond the content left

Example

// surrounding content with a box glyph
figure.add({
  make: 'equation',
  elements: {
    box: { symbol: 'box', lineWidth: 0.005 },
  },
  forms: {
    form1: {
      annotate: {
        content: 'a',
        glyphs: {
          encompass: {
            symbol: 'box',
            space: 0.1, // e.g. only, this will be overwritten by next props
            topSpace: 0.1,
            rightSpace: 0.1,
            bottomSpace: 0.1,
            leftSpace: 0.1,
          },
        },
      },
    },
  },
});
@interface

Interface EQN_EncompassGlyph

Example

Settings