GXMAPL class¶

class GXMAPL(handle=0)[source]¶

GXMAPL class.

The GXMAPL class is the interface with the MAPPLOT program, which reads a MAPPLOT control file and plots graphical entities to a map. The GXMAPL object is created for a given control file, then passed to the MAPPLOT program, along with the target GXMAP object on which to do the drawing

__init__(handle=0)[source]¶: Initialize self. See help(type(self)) for accurate signature.

classmethod create(name, ref_name, line)[source]¶

Create a GXMAPL.

Parameters

name (str) – GXMAPL file name
ref_name (str) – Map base reference name
line (int) – Start line number in file (0 is first)

Returns

GXMAPL, aborts if creation fails

Return type

GXMAPL

New in version 5.0.

License: Geosoft Open License

Note: The default map groups will use the reference name with “_Data” and “_Base” added. If no reference name is specified, the name “GXMAPL” is used

classmethod create_reg(name, ref_name, line, reg)[source]¶

Create a GXMAPL with GXREG.

Parameters

name (str) – GXMAPL file name
ref_name (str) – Map base reference name
line (int) – Start line number in file (0 is first)

Returns

GXMAPL, aborts if creation fails

Return type

GXMAPL

New in version 5.0.

License: Geosoft Open License

Note: The default map groups will use the reference name with “_Data” and “_Base” added. If no reference name is specified, the name “GXMAPL” is used

is_null()[source]¶

Check if this is a null (undefined) instance

Returns: True if this is a null (undefined) instance, False otherwise.
Return type: bool

classmethod null()[source]¶

A null (undefined) instance of GXMAPL

Returns: A null GXMAPL
Return type: GXMAPL

process(map)[source]¶

Process a GXMAPL

New in version 5.0.

License: Geosoft Open License

replace_string(var, repl)[source]¶

Adds a replacement string to a mapplot control file.

Parameters

var (str) – Variable
repl (str) – Replacement

New in version 5.0.

License: Geosoft Open License