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

expand all

Attribute name, specified as a character vector.

Attribute value, specified as a character vector.

Output Arguments

expand all

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

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.

Attribute name, specified as a character vector.

Tag for the document element, specified as a character vector.

The DOM generates a session-unique tag when it creates the document element. Structure the tag as class:id, where class is the class of the element and id is the value of the Id property. You can specify a tag to replace the generated tag. Specifying your own tag can make it easier to identify where an issue occurred during document generation.

Value of this attribute, specified as a character vector.

Examples

collapse all

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');