How to get configureAsInlineAnchorToStructureWithBlock

import configureAsInlineAnchorToStructureWithBlock from 'fontoxml-families/src/configureAsInlineAnchorToStructureWithBlock.js'

Type: Function

This is for markup that is normally displayed somewhere else than its position in the XML and which can contain multiple elements or breaktokens.

All text formatting visualization options apply to the default anchor presentation. The anchor can be customized by specifying either the innerJsonMl visualization option as a fragment of JsonML, or by setting the createInnerJsonMl option to a callback to create the JsonML fragment when the node is rendered.

The anchor can be deleted by pressing Backspace or Delete twice: the first press selects it to help the author understand what will happen. The associated node in the structure will be deleted as well.

The clearest example is a footnote, for which a number in brackets is its anchor, and the structure where the actual content of the footnote appears.

When using this family, make sure to specify either withNewlineBreakToken or breakElements as this family requires one of the two options to be set at any time.

The following visualization options are visualized by this family:

  • baseline

  • case

  • endDelimiter

  • fontStack

  • isMonospaced

  • lineThroughStyle

  • overlineStyle

  • slant

  • startDelimiter

  • underlineStyle

  • weight

  • numberingStyle

Set withNewlineBreakToken to true to indicate a newline character should be used to break blocks. This will automatically set whitespace to 'preserve'. Alternatively, set breakElements to an array of the qualified names of elements that are used to define boundaries between blocks inside this element. Make sure to configure these elements themselves using configureAsBreakElement. Using break elements has no effect on whitespace handling.

The following widget areas are available:

  • inlineBefore

  • inlineAfter

This family has a number of additional options which affect how it behaves:

  • defaultTextContainer

  • createInnerJsonMl

  • containerSelectorOrNodeSpec: This is an XPath test pointing to the container of the numbering of these nodes.

  • numberingItemSelector: This is an XPath test pointing to the nodes which must be considered for the numbering of these nodes. This defaults to the provided selector parameter.


# Name Type Description
1. sxModule SxModule
2. selector XPathTest
3. markupLabel String
4. [options] CvkOptions
Was this page helpful?