Title
- class wellcad.com.Title(dispatch)
Represents the title of a log.
A title object is represented by a box at the top of a log. Inside the title box are three sections: the title, the comments and the properties. For each of these sections, you can specify properties such as text, font, color, alignment etc. The title box frame and background can also be customized.
|-------------------|-----------------------------|-------------------| | | | | | Title | Title | | | | | | | | comment | Title | | | | | | properties | properties | | |-------------------|-----------------------------|-------------------| | | | | | | | | | log data | log data | log data | | | | |
Example
>>> borehole = app.get_active_borehole() >>> title = borehole.title("GR") >>> title.left_position 0.2 >>> title.box_height = 200
- property background_color
The background color of a group or log title.
Colours are specified as a 32 bit integer with an
xBGRstructure. Each of the blue (B), green (G) and red (R) components are 8 bit values.- Type
int
- property box_height
The title box height in mm.
- Type
float
- property comment_alignment
Index specifying the comment alignment within the partition.
Available options are:
0 = left
1 = center
2 = right
- Type
int
- property comment_bottom
The bottom of the comment partition of a group or log title box as a fraction of the box height (value between 0 and 1).
- Type
float
- property comment_color
The coment color of the title part of a group or log title.
Colours are specified as a 32 bit integer with an
xBGRstructure. Each of the blue (B), green (G) and red (R) components are 8 bit values.- Type
int
- property comment_horizontal_position
Index specifying the horizontal alignment of the comment.
Available options are:
0 = left
1 = center
2 = right
- Type
int
- property comment_orientation
Index specifying the comment orientation.
Available options are:
0 = horizontal
1 = rotated left
2 = reversed
3 = rotated right
- Type
int
- property comment_text
The text for the comment partition.
- Type
str
- property comment_top
The top of the comment partition of a group or log title box as a fraction of the box height (value between 0 and 1).
- Type
float
- property comment_vertical_position
Index specifying the vertical alignment of the comment.
Available options are:
0 = left
1 = center
2 = right
- Type
int
- property display_comment
Whether the comment partition is displayed.
- Type
bool
- property display_frame
Whether the title box frame is displayed.
- Type
bool
- property display_properties
Whether the property partition is displayed.
- Type
bool
- property display_title
Whether the title partition is displayed.
- Type
bool
- property frame_color
The color of the frame.
Colours are specified as a 32 bit integer with an
xBGRstructure. Each of the blue (B), green (G) and red (R) components are 8 bit values.- Type
int
- property frame_style
The frame’s display style.
Available styles are:
0 = solid
1 = dashed
2 = dotted
3 = dash-dot
4 = dash-dot-dot
- Type
int
- property frame_width
The line width of the frame in 1/10 mm.
- Type
int
- property left_position
The position of the left side of a title for a log or group, as a fraction of the document width.
If set for a group title, the logs that are a part of the group will be moved/scaled accordingly. In the case that this is set to be a value higher than
right_position, the two attributes will swap. Values will be clamped in the range [0.0, 1.0].- Type
float
- property properties_bottom
The bottom of the properties partition of a log title box as a fraction of the box height (value between 0 and 1).
- Type
float
- property properties_color
The font color of the property part of a group or log title.
Colours are specified as a 32 bit integer with an
xBGRstructure. Each of the blue (B), green (G) and red (R) components are 8 bit values.- Type
int
- property properties_top
The top of the properties partition of a log title box as a fraction of the box height (value between 0 and 1).
- Type
float
- property right_position
The position of the right side of a title for a log or group, as a fraction of the document width.
If set for a group title, the logs that are a part of the group will be moved/scaled accordingly. In the case that this is set to be a value lower than
left_position, the two attributes will swap. Values will be clamped in the range [0.0, 1.0].- Type
float
- property title_bottom
The bottom of the title partition of a group or log title box as a fraction of the box height (value between 0 and 1).
- Type
float
- property title_color
The font color of the title part of a group or log title.
Colours are specified as a 32 bit integer with an
xBGRstructure. Each of the blue (B), green (G) and red (R) components are 8 bit values.- Type
int
- property title_horizontal_position
Index specifying the horizontal alignment of the title.
Available options are:
0 = left
1 = center
2 = right
- Type
int
- property title_orientation
Index specifying the title orientation.
Available options are:
0 = horizontal
1 = rotated left
2 = reversed
3 = rotated right
- Type
int
- property title_text
The text for the title partition.
- Type
str
- property title_top
The top of the title partition of a group or log title box as a fraction of the box height (value between 0 and 1).
- Type
float
- property title_vertical_position
Index specifying the vertical alignment of the title.
Available options are:
0 = left
1 = center
2 = right
- Type
int
- property use_colored_background
Whether the colored background is used.
- Type
bool