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.

Properties

Name Type Description
[addDescendantsOnCopy] AddDescendantsOnCopy

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

[addParentOnCopy] AddParentOnCopy

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

[allowAutocapitalization] 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] AllowExpansionInContentView

Defines the availability of expansion of a table.

[allowMergingWith] 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] 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] BackgroundColor

Defines the backgroundColor visualization of a node

[baseline] Baseline

Defines the baseline visualization of a node

[blockAfter] Array<Widget> | Null

Defines the contents of this widget area

[blockAfterWidth] String

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

[blockBanner] Array<Widget> | Null

Defines the contents of this widget area

[blockBefore] Array<Widget> | Null

Defines the contents of this widget area

[blockBeforeWidth] String

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] Array<Widget> | Null

Defines the contents of this widget area

[blockHeaderLeft] Array<Widget> | Null

Defines the contents of this widget area

[blockHeaderRight] Array<Widget> | Null

Defines the contents of this widget area

[blockOutsideAfter] Array<Widget> | Null

Defines the contents of this widget area

[blockOutsideBefore] Array<Widget> | Null

Defines the contents of this widget area

[borders] Borders

Defines the borders visualization of a node

[case] Case

Defines the case visualization of a node

[clickOperation] ClickOperation

Defines the clickOperation of a node

[columnBefore] Array<Widget> | Null

To add column icon widgets by using createIconWidget. Any widget can be added but only icon widget is supported. See configureAsTableElements for an example.

[contextualOperations] Array<ContextualOperation> | Null

Contextual operations which should be configured for the selector

[delimiters] Object

Defines the delimiter visualization of a node

[doubleClickOperation] DoubleClickOperation

Defines the doubleClickOperation of a node

[emptyElementPlaceholderText] String

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

[endDelimiter] Delimiter

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

[expression] Expression

Defines the expression visualization of a node

[fontStack] FontStack

Defines the font stack to use for the node

[fontVariation] FontVariation

Defines the font variation for this node

[inlineAfter] Array<Widget> | Null

Defines the contents of this widget area

[inlineBefore] Array<Widget> | Null

Defines the contents of this widget area

[isAutoremovableIfEmpty] Boolean

Whether this node should automatically be removed if it is empty

[isMonospaced] IsMonospaced

Defines the isMonospaced visualization of a node

[lineThroughStyle] LineThroughStyle

Defines the lineThroughStyle visualization of a node

[markupLabel] String

The human friendly name of nodes matching the configured selector

[outputClass] OutputClass

Defines the outputClass visualization of a node

[outputClassQuery] OutputClassQuery

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

[overlineStyle] OverlineStyle

Defines the overlineStyle visualization of a node

[padding] Padding

Defines the padding visualization of a node

[popoverComponentName] PopoverComponentName

Defines the name of the popover component for this node

[popoverData] Object

Defines the data for the popover, used by the popover component

[priority] XPathPriority

May be used to override configuration using a less specific selector

[rowBefore] Array<Widget> | Null

To add row icon widgets by using createIconWidget. Any widget can be added but only icon widget is supported. See configureAsTableElements for an example.

[showWhen] ShowWhen

Defines the showWhen visualization of a node

[slant] Slant

Defines the slant visualization of a node

[startDelimiter] Delimiter

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

[tabNavigationItemSelector] XPathTest

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

[textAlign] TextAlign

Defines the text align of a node

[titleQuery] XPathQuery

A query resolving to a string title representing this selector

[tooltip] String

Defines the tooltip this node should have

[underlineStyle] UnderlineStyle

Defines the underlineStyle visualization of a node

[variation] Variation

Defines the variation visualization of a node

[weight] Weight

Defines the weight visualization of a node

[whitespace] Whitespace

Overrides the white space behavior of a node

Was this page helpful?