Cvk Options
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
add Descendants On Copy
Type: AddDescendantsOnCopy
Whether to automatically include all descendants on the clipboard if part of the element is copied.
add Parent On Copy
Type: AddParentOnCopy
Whether to automatically include the parent on the clipboard if the element (or part of it) is copied.
allow Autocapitalization
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.
allow Expansion In Content View
Defines the availability of expansion of a table.
allow Merging With
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.
allow Merging With Ancestor
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.
background Color
Type: BackgroundColor
Defines the backgroundColor visualization of a node
baseline
Type: Baseline
Defines the baseline visualization of a node
block After
Type: Array<Widget> | NULL
Defines the contents of this widget area
block After Width
Type: BlockAfterWidth
Defines the width of the block after widget area. This may be one of the 'wide', or 'extra-wide' strings.
block Banner
Type: Array<Widget> | NULL
Defines the contents of this widget area
block Before
Type: Array<Widget> | NULL
Defines the contents of this widget area
block Before Width
Type: 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.
block Footer
Type: Array<Widget> | NULL
Defines the contents of this widget area
block Header Left
Type: Array<Widget> | NULL
Defines the contents of this widget area
block Header Right
Type: Array<Widget> | NULL
Defines the contents of this widget area
block Outside After
Type: Array<Widget> | NULL
Defines the contents of this widget area
block Outside Before
Type: 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
click Operation
Type: ClickOperation
Defines the clickOperation of a node
column Before
Type: 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.
contextual Operations
Type: Array<ContextualOperation> | NULL
Contextual operations which should be configured for the selector
delimiters
Type: Object
Defines the delimiter visualization of a node
double Click Operation
Type: DoubleClickOperation
Defines the doubleClickOperation of a node
empty Element Placeholder Text
Type: String
The text that should be inserted as a placeholder for the configured element
end Delimiter
Type: Delimiter
Defines the endDelimiter visualization of a node. Is an alias for only providing the end of the delimiters option
expression
Type: Expression
Defines the expression visualization of a node
font Stack
Type: FontStack
Defines the font stack to use for the node
font Variation
Type: FontVariation
Defines the font variation for this node
inline After
Type: Array<Widget> | NULL
Defines the contents of this widget area
inline Before
Type: Array<Widget> | NULL
Defines the contents of this widget area
is Autoremovable If Empty
Type: Boolean
Whether this node should automatically be removed if it is empty
is Monospaced
Type: IsMonospaced
Defines the isMonospaced visualization of a node
line Through Style
Type: LineThroughStyle
Defines the lineThroughStyle visualization of a node
markup Label
Type: String
The human friendly name of nodes matching the configured selector
output Class
Type: OutputClass
Defines the outputClass visualization of a node
output Class Query
Type: OutputClassQuery
Defines the outputClass visualization of a node using a XPath query.
overline Style
Type: OverlineStyle
Defines the overlineStyle visualization of a node
padding
Type: Padding
Defines the padding visualization of a node
popover Component Name
Type: PopoverComponentName
Defines the name of the popover component for this node
popover Data
Type: Object
Defines the data for the popover, used by the popover component
priority
Type: XPathPriority
May be used to override configuration using a less specific selector
row Before
Type: 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.
show When
Type: ShowWhen
Defines the showWhen visualization of a node
slant
Type: Slant
Defines the slant visualization of a node
start Delimiter
Type: Delimiter
Defines the startDelimiter visualization of a node. Is an alias for only providing the start of the delimiters option
status Query
Type: StatusQuery
Defines the status for a node
tab Navigation Item Selector
Type: XPathTest
A selector matching nodes which should be navigated to when using the tab key
text Align
Type: TextAlign
Defines the text align of a node
title Query
Type: XPathQuery
A query resolving to a string title representing this selector
tooltip
Type: String
Defines the tooltip this node should have
underline Style
Type: 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
Type: Whitespace
Overrides the white space behavior of a node