mlreportgen.dom.Strike class

Package: mlreportgen.dom
Superclasses:

Strike through text

Description

Specifies whether to use a strikethrough line for a text object. Strike appears as a single, horizontal line drawn through the text.

Construction

strikeObj = Strike() draws a single, horizontal line through text.

strikeObj = Strike(type) draws a line of the specified type through text.

Input Arguments

type — Strike type

'single' (default) | 'none' | 'double'

Strike type, specified as:

• 'single' — Single horizontal line (default)

• 'none' — No strikethrough line

• 'double' — Double horizontal line

Output Arguments

strike — Strike through text

mlreportgen.dom.Strike object

An mlreportgen.dom.Strike object representing strikethrough text.

Properties

Id — ID for this document element

character vector | string scalar

ID for this document element, specified as a character vector or string scalar. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Tag — Tag for this document element

character vector | string scalar

Tag for this document element, specified as a character vector or string scalar.

The DOM generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Specifying your own tag value can help you to identify where an issue occurred during document generation.

Value — Strike type

'single' | 'none' | 'double'

Strike type, specified as one of these values:

• 'single' — Single horizontal line (default)

• 'none' — No strikethrough line

• 'double' — Double horizontal line