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

expand all

Strike type, specified as:

  • 'single' — Single horizontal line (default)

  • 'none' — No strikethrough line

  • 'double' — Double horizontal line

Output Arguments

expand all

An mlreportgen.dom.Strike object representing strikethrough text.

Properties

expand all

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

Tag for document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.

Strike type, specified as one of these values:

  • 'single' — Single horizontal line (default)

  • 'none' — No strikethrough line

  • 'double' — Double horizontal line