configureAsInlineImageInFrame

How to get configureAsInlineImageInFrame

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

Type: Function

Use this family when inline images can contain other elements which should be rendered.

Their semantic unity is visualised through a colored border and a background.

Just like block frames, inline frames can’t be split in two and adjacent ones will not merge. Inline frames can be deleted by pressing Backspace or Delete twice: the first press selects the frame to help the author understand what will happen.

Use this family for inline images which can contain other elements which should be rendered. For example an desc element, which contains a description of the image. These images may be represented by a permanent id or a non-permanent id. By setting the option options.isPermanentId to true, the result of the query is interpreted as a permanent id, which will be resolved.

The optionsOrReferenceAttributeName parameter can be both the name of the attribute containing the permanent id, or the options object. This options object may then contain an XPath query resolving to the reference (either permanent or relative) which points to the image.

Deprecation

For backwards compatibility, the fourth argument to this function may be the name of an attribute. If the attribute name is passed as the fourth parameter, the image is assumed to use permanent ids. This is deprecated, using an options object as the fourth argument is preferred.

The following visualization options are visualized by this family:

  • backgroundColor

  • showWhen

The following widget areas are available:

  • inlineBefore

  • inlineAfter

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

  • defaultTextContainer

  • referenceQuery

  • isPermanentId

Arguments

# Name Type Description
1. sxModule SxModule
2. selector XPathTest
3. markupLabel String
4. options CvkOptions

The options, or the name of the attribute in which the permanent id referencing this image is located. The generic CvkOptions are expanded with two properties:

  Members

Members

Name Type Description
isPermanentId Boolean

Whether the reference is a permanent id.


  Default value
false
referenceQuery XPathQuery

An XPath query resulting in the reference of the image

5. oldOptionsParameter

Example

// Configure HTML images without permanent ids
configureAsInlineImageInFrame(sxModule, 'self::img', 'image', { referenceQuery: '@src', isPermanentId: false });

// Configure HTML images with permanent ids
configureAsInlineImageInFrame(sxModule, 'self::img', 'image', { referenceQuery: '@src', isPermanentId: true });

// Configure an other kind of image with the url as its text content
configureAsInlineImageInFrame(sxModule, 'self::img', 'image', { referenceQuery: 'string(.)', isPermanentId: true });

// Configure HTML images using the deprecated syntax. This forces permanent ids
configureAsInlineImageInFrame(sxModule, 'self::img', 'image', 'src');