annotationview

../../_images/ANNOTATIONVIEW.png

Provides a container for user-defined text boxes (mtext() objects).

Note

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

annotationview(**kwargs)

Provides a container for user-defined text boxes (mtext() objects).

Parameters

  • subpage_clipping ({"on", "off"}, default: "off") – Clips plot to subpage borders.

  • subpage_x_position (number, default: 0) – Specifies the X offset of the plot from the left side of the plot frame (any subdivision of the display area). This is expressed as a percentage of the X-dimension of the plot frame.

  • subpage_y_position (number, default: 0) – Specifies the Y offset of the plot from the bottom side of the plot frame (any subdivision of the display area). This is expressed as a percentage of the Y-dimension of the plot frame.

  • subpage_x_length (number, default: 100) – Specifies the X length of the plot. This is expressed as a percentage of the X-dimension of the plot frame. Hence the sum of this X length plus the X offset cannot exceed 100 (it is advised that it does not exceed 95 since you need some margin on the right for things like axis or map grid labels).

  • subpage_y_length (number, default: 100) – Same as subpage_x_length but for the Y length of the plot.

  • page_frame ({"on", "off"}, default: "off") – Toggles the plotting of a border line around the plot frame.

  • page_frame_colour (str, default: "charcoal") – Colour of the page frame. Available when page_frame is “on”.

  • page_frame_line_style ({"solid", "dot", "dash", "chain_dot", "chain_dash"}, default: "solid") – Line style of the page frame. Available when page_frame is “on”.

  • page_frame_thickness (number, default: 2) – Line thickness of the page frame. Available when page_frame is “on”.

  • page_id_line ({"on", "off"}, default: "off") – Toggles the plotting of plot identification line.

  • page_id_line_user_text (str) – Specifies user text to be added to the plot identification line. Only available when page_id_line is “on”.

  • subpage_frame ({"on", "off"}, default: "off") – Toggles the plotting of a border line around the plot itself. In most cases you will want this to be left “on”. When “off” the sides of the plot not equipped with axis will not be plotted.

  • subpage_frame_colour (str, default: "black") – Colour of the subpage frame. Available when subpage_frame is “on”.

  • subpage_frame_line_style ({"solid", "dot", "dash", "chain_dot", "chain_dash"}, default: "solid") – Line style of the subpage frame. Available when subpage_frame is “on”.

  • subpage_frame_thickness (int, default: 2) – Line thickness of the subpage frame. Available when subpage_frame is “on”.

  • subpage_background_colour (str, default: "white") – Specifies the colour of the background of the plot (i.e. not affected by visual definitions like contour shadings or lines).

Return type

Request