configureAsImage

How to get configureAsImage

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

Type: Function

The image family is used for, as its name implies, images. Specifically images that are resolved from a permanent identifier on one of their attributes.

Images are displayed as themselves. If they are wider than the available block with, they are shown scaled.

As Fonto doesn't edit images, we define no keyboard flow inside them.

Images cannot be deleted by pressing Backspace or Delete.

Used for elements that represent images. 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 options 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 widget areas are available:

  • blockHeaderLeft

  • blockHeaderRight

  • blockBefore

  • blockAfter

  • blockFooter

  • blockOutsideBefore

  • blockOutsideAfter

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

  • 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
configureAsImage(sxModule, 'self::img', 'image', { referenceQuery: '@src', isPermanentId: false });

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

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

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