Page

class wellcad.com.Page(dispatch)

The Page class manages properties for the document print out.

Example

>>> import wellcad.com
>>> app = wellcad.com.Application()
>>> app.new_borehole()
<wellcad.com._borehole.Borehole object at 0x0000018B3DAF9D30>
>>> borehole = app.get_active_borehole()
>>> page = borehole.page

add_depth_range(top, bottom)

Adds a new depth range to be printed in current master depth units.

Parameters:

top (float) – Top depth of the interval that will be added to the print list.
bottom (float) – Bottom depth of the interval that will be added to the print list.

property bottom_margin

The bottom margin of the page to print in mm.

Type:: int

property depth_range

Identify the depth range mode

The available modes are the following:

0 = depth range not defined (maximum depth range to be printed)
1 = depth range defined by the user

Type:: int

property document_height

The document height in mm.

Type:: float

property document_width

The document width in mm.

Type:: float

property left_margin

The left margin of the page to print in mm.

Type:: int

property nb_of_depth_range

The number of defined depth ranges.

Type:: double

property numbering

The page numbering mode

The available modes are the following:

0 = none
1 = left
2 = right
3 = center
4 = alternating

Type:: int

property paper_mode

0 for page-by-page and 1 for fanfold.

Type:: int

property print_header

Option to print the document header or not.

Type:: bool

property print_titles_on_bottom

Show the log titles at the bottom of the printout.

Type:: bool

property print_titles_on_bottom_on_each_page

Repeat the log titles at the bottom of each printed page.

Type:: bool

property print_titles_on_top

Show the log titles at the top of the printout.

Type:: bool

property print_titles_on_top_on_each_page

Repeat the log titles at the top of each printed page.

Type:: bool

remove_depth_range(index)

Remove an entry from the list of depth ranges.

Parameters:: index (int) – Zero based index of the entry to be removed from the list.

property right_margin

The right margin of the page to print in mm.

Type:: int

property top_margin

The top margin of the page to print in mm.

Type:: int