mlreportgen.dom.FlowDirection class

Package: mlreportgen.dom
Superclasses:

Direction of text or table column flow

Description

Specifies the direction for text to flow across a page or the order of columns.

Construction

flowDirectionObj = FlowDirection() causes text to flow from left to right and for the first column to be on the left side of a table.

flowDirectionObj = FlowDirection(flow) causes text to flow or column to appear in the specified direction (left-to-right or right-to-left).

Input Arguments

expand all

Direction for text to flow or for table columns to appear, specified as one of these values:.

  • 'ltr' — text flow or table column order is from left to right

  • 'rtl' — text flow or table column order is from right to left

Output Arguments

expand all

Text flow or table column order, represented by an mlreportgen.dom.FlowDirection 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.

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.

Text flow direction or column order direction, specified as one of these values:

  • 'ltr' — text flow or table column order is from left to right

  • 'rtl' — text flow or table column order is from right to left

Examples

collapse all

In this example, changing the text flow direction changes “stressed” into “desserts”.

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

p = Paragraph('desserts');
p.Style = {FlowDirection('rtl')};
append(d,p);

q = clone(p);
q.Style = {FlowDirection('ltr')};
append(d,q);

close(d);
rptview(d.OutputPath);