CvkOptions

Type: Object

All available visualization and behavioural options of the CVK families. Not all options apply to all CVK families. Please refer to the documentation pages of each CVK family to see which options apply. Please note that any properties you might find bundled in a ‘visualization’ property in your configuration can be put directly in the CvkOptions object.

Wrapping options in a visualization object is deprecated and will stop working in 7.16. Refer to the upgrade instructions of 7.14 (https://documentation.fontoxml.com/latest/upgrade-from-7-13-to-7-14) to upgrade your application.

Properties

addDescendantsOnCopy

Whether to automatically include all descendants on the clipboard if part of the element is copied.

addParentOnCopy

Whether to automatically include the parent on the clipboard if the element (or part of it) is copied.

allowAutocapitalization

Type: Boolean

Whether this node has autocapitalization enabled. This setting automatically applies to any descendants that do not define a value for this property. See the example in configureAsFrameWithBreakableBlock. This property is undefined by default, meaning autocapitalization will be enabled in an element if no ancestors define it.

allowExpansionInContentView

Defines the availability of expansion of a table.

allowMergingWith

Type: XPathTest

A selector matching nodes with which this node may be merged. This only has effect if the node may be automatically merged by its family configuration, like configureAsInlineFormatting. This may be used to prevent elements with different attributes to be merged. This impacts both normalization and merging with backspace.

allowMergingWithAncestor

Type: XPathTest

A selector matching nodes inside which this node may be collapsed. This may be used to prevent formatting elements from being nested inside equivalent elements.

backgroundColor

Defines the backgroundColor visualization of a node.

baseline

Type: Baseline

Defines the baseline visualization of a node.

blockAfter

Type: WidgetSubAreaByName | Array<Widget> | NULL

Defines the contents of this widget area.

blockAfterWidth

Defines the width of the block after widget area. This may be one of the 'wide', or 'extra-wide' strings.

blockBanner

Type: WidgetSubAreaByName | Array<Widget> | NULL

Defines the contents of this widget area. This is deprecated and will be removed in the 7.16 release of the editor.

blockBefore

Defines the contents of this widget area.

blockBeforeWidth

Defines the width of the block before widget area. This may be one of the 'medium-narrow', 'medium-wide', 'wide', or 'extra-wide' strings.

blockFooter

Type: WidgetSubAreaByName | Array<Widget> | NULL

Defines the contents of this widget area.

blockHeaderLeft

Type: WidgetSubAreaByName | Array<Widget> | NULL

Defines the contents of this widget area.

blockHeaderRight

Type: WidgetSubAreaByName | Array<Widget> | NULL

Defines the contents of this widget area.

blockOutsideAfter

Type: WidgetSubAreaByName | Array<Widget> | NULL

Defines the contents of this widget area.

blockOutsideBefore

Type: WidgetSubAreaByName | Array<Widget> | NULL

Defines the contents of this widget area.

borders

Type: Borders

Defines the borders visualization of a node.

case

Type: Case

Defines the case visualization of a node.

clickOperation

Defines the clickOperation of a node.

columnBefore

Type: WidgetSubAreaByName | Array<Widget> | NULL

Used to add one or multiple widgets before each. column. The context node for these widgets will be either the column specification element, or if that doesn't exist, the first cell of that column. All widgets are supported.

The contextual operations for the selector, see the linked type docs for details on the different properties for each type (of object) you can use.

defaultTextContainer

Defines the defaultTextContainer of a node.

delimiters

Type: Object

Defines the delimiter visualization of a node.

doubleClickOperation

Defines the doubleClickOperation of a node.

emptyElementPlaceholderText

Type: String

The text that should be inserted as a placeholder for the configured element.

endDelimiter

Type: Delimiter

Defines the endDelimiter visualization of a node. Is an alias for only providing the end of the delimiters option.

expression

Defines the expression visualization of a node.

fontStack

Type: FontStack

Defines the font stack to use for the node.

fontVariation

Defines the font variation for this node.

inlineAfter

Type: WidgetSubAreaByName | Array<Widget> | NULL

Defines the contents of this widget area.

inlineBefore

Type: WidgetSubAreaByName | Array<Widget> | NULL

Defines the contents of this widget area.

isAutoremovableIfEmpty

Type: Boolean

Whether this node should automatically be removed if it is empty.

isMonospaced

Defines the isMonospaced visualization of a node.

lineThroughStyle

Defines the lineThroughStyle visualization of a node.

markupLabel

Type: String

The human friendly name of nodes matching the configured selector.

outputClass

Defines the outputClass visualization of a node.

outputClassQuery

Defines the outputClass visualization of a node using a XPath query.

overlineStyle

Defines the overlineStyle visualization of a node.

padding

Type: Padding

Defines the padding visualization of a node.

popoverComponentName

Defines the name of the popover component for this node.

popoverData

Defines the data required by the popover component.

priority

May be used to override configuration using a less specific selector.

rowBefore

Type: WidgetSubAreaByName | Array<Widget> | NULL

Used To add a single icon widget before each row using createIconWidget. Any widget can be added but only icon widget is supported. See configureAsTableElements for an example.

showHighlightingWidget

Type: Boolean

To add highlighting bars which highlight columns and rows, and provide operations popover, default false.

showInsertionWidget

Type: Boolean

To add insertion buttons which insert a column or a row to a specific place, default false.

showWhen

Type: ShowWhen

Defines the showWhen visualization of a node.

slant

Type: Slant

Defines the slant visualization of a node.

startDelimiter

Type: Delimiter

Defines the startDelimiter visualization of a node. Is an alias for only providing the start of the delimiters option.

statusQuery

Defines the status for a node.

tabNavigationItemSelector

Type: XPathTest

A selector matching nodes which should be navigated to when using the tab key.

textAlign

Type: TextAlign

Defines the text align of a node.

titleQuery

A query resolving to a string title representing this selector. If this query needs to collect text from one or more nodes, then it is recommended to use curated-text-in-node or curated-text-in-range, as these functions take configuration into account.

tooltip

Type: Tooltip

Defines the tooltip this node should have.

tooltipQuery

Defines the tooltip this node should have using a XPath query.

underlineStyle

Defines the underlineStyle visualization of a node.

variation

Type: Variation

Defines the variation visualization of a node.

weight

Type: Weight

Defines the weight visualization of a node.

whitespace

Overrides the white space behavior of a node.