configureAsInlineAnchorToFrame

How to get configureAsInlineAnchorToFrame

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

Type: Function

This is for markup that is normally displayed somewhere else than its position in the XML, and where the ‘elsewhere’ portion of the markup should be displayed as a frame.

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.

The following visualization options are visualized by this family:

  • baseline

  • case

  • endDelimiter

  • fontStack

  • isMonospaced

  • lineThroughStyle

  • overlineStyle

  • slant

  • startDelimiter

  • underlineStyle

  • weight

  • numberingStyle

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.

Arguments

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