mlreportgen.dom.CustomAttribute class

Package: mlreportgen.dom
Superclasses:

Custom element attribute

Description

Custom element attribute.

Construction

customAttributeObj = CustomAttribute() creates an empty custom attribute.

customAttributeObj = CustomAttribute(name) creates an attribute having the specified name.

customAttributeObj = CustomAttribute(name,value) creates an attribute having the specified name and value.

Input Arguments

name — Attribute name

character vector

Attribute name, specified as a character vector.

value — Attribute value

character vector

Attribute value, specified as a character vector.

Output Arguments

customAttributeObj — Custom attribute

mlreportgen.dom.CustomAttribute object

Custom attribute, represented by an mlreportgen.dom.CustomAttribute object.

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.

Attributes:

GetAccess

public

SetAccess

public

NonCopyable

true

Data Types: char | string

Name — Attribute name

character vector

Attribute name, specified as a character vector.

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.

Attributes:

GetAccess

public

SetAccess

public

NonCopyable

true

Data Types: char | string

Value — Value of this attribute

character vector

Value of this attribute, specified as a character vector.

Examples

Create Custom Attributes for a List

This example shows how to define custom attributes and append them to an unordered list.

import mlreportgen.dom.*;
d = Document('test');

ul = UnorderedList();

li = ListItem('Owl');
li.CustomAttributes = {CustomAttribute('data-animal-type','bird')};
append(ul,li);      

li = ListItem('Salmon');
li.CustomAttributes = {CustomAttribute('data-animal-type','fish')};
append(ul,li);

li = ListItem('Tarantula');
li.CustomAttributes = {CustomAttribute('data-animal-type','spider')};

append(ul,li);
append(d,ul);

close(d);
rptview('test','html');