mtext

../../_images/MTEXT.png

This is the visual definition for specifying how plot titles and text boxes are displayed.

Note

This function performs the same task as the Text Plotting icon in Metview’s user interface. It accepts its parameters as keyword arguments, described below.

mtext(**kwargs)

Defines the plot title and text boxes.

Parameters

  • text_line_count (number, default: 1) – The number of lines of text to be plotted.

  • text_line_1 (str, default: ["<magics_title", ">"]) – Text for line 1.

  • text_line_2 (str) – Text for line 2.

  • text_line_3 (str) – Text for line 3.

  • text_line_4 (str) – Text for line 4.

  • text_line_5 (str) – Text for line 5.

  • text_line_6 (str) – Text for line 6.

  • text_line_7 (str) – Text for line 7.

  • text_line_8 (str) – Text for line 8.

  • text_line_9 (str) – Text for line 9.

  • text_line_10 (str) – Text for line 10.

  • text_colour (str, default: "navy") – Colour of the text.

  • text_font ({"arial", "courier", "helvetica", "times", "serif", "sansserif", "symbol"}, default: "sansserif") – Font name.

  • text_font_style ({"normal", "bold", "italic", "bolditalic"}, default: "normal") – Font style.

  • text_font_size (str, default: "0.3") – Font size, specified in cm.

  • text_justification ({"left", "centre", "right"}, default: "centre") – How text is to be positioned in each line.

  • text_orientation ({"horizontal", "top_bottom", "bottom_top"}, default: "horizontal") – Orientation of the text.

  • text_lines (str or list[str]) – Specifies all the text lines in one go as a list. When it is set text_line_count and text_line_N are ignored.

  • text_mode ({"title", "positional"}, default: "title") – Specifies whether text will be a title or user positioned.

  • text_box_x_position (number, default: -1) – X coordinate of lower left corner of text box. (Relative to page_x_position in the parent view).

  • text_box_y_position (number, default: -1) – Y coordinate of lower left corner of text box. (Relative to page_Y_position in the parent view).

  • text_box_x_length (number, default: -1) – Length of text box in X direction.

  • text_box_y_length (number, default: -1) – Length of text box in Y direction.

  • text_box_blanking ({"on", "off"}, default: "off") – Enables blanking in the text box.

  • text_border ({"on", "off"}, default: "off") – Plots border around text box.

  • text_border_line_style ({"solid", "dash", "dot", "chain_dot", "chain_dash"}, default: "solid") – Line style of border around text box.

  • text_border_colour (str, default: "blue") – Colour of border around text box.

  • text_border_thickness (number, default: 1) – Thickness of text box border.

Return type

Request