GXMAPL class¶

class geosoft.gx.GXMAPL¶

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

static create((GXContext)ctx, (str)arg1, (str)arg2, (int)arg3) → GXMAPL:¶

Create a MAPL.

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context arg1 (str) – MAPL file name arg2 (str) – map base reference name arg3 (int) – start line number in file (0 is first)
Returns:	MAPL, aborts if creation fails
Return type:	`geosoft.gx.GXMAPL`

New in version 5.0.0.

Note:

The default map groups will use the reference name with
"_Data" and "_Base" added.  If no reference name is specified,
the name "MAPL" is used

static create_reg((GXContext)ctx, (str)arg1, (str)arg2, (int)arg3, (GXREG)arg4) → GXMAPL:¶

Create a MAPL with REG.

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context arg1 (str) – MAPL file name arg2 (str) – map base reference name arg3 (int) – start line number in file (0 is first) arg4 (`geosoft.gx.GXREG`) – REG
Returns:	MAPL, aborts if creation fails
Return type:	`geosoft.gx.GXMAPL`

New in version 5.0.0.

Note:

The default map groups will use the reference name with
"_Data" and "_Base" added.  If no reference name is specified,
the name "MAPL" is used

is_null() → bool¶

Check if the instance of geosoft.gx.GXMAPL is null (undefined)

Returns:	True if this is a null instance of `geosoft.gx.GXMAPL`, False otherwise.
Return type:	bool`

static null() → GXMAPL¶

A null (undefined) instance of geosoft.gx.GXMAPL

Returns:	A null `geosoft.gx.GXMAPL`
Return type:	`geosoft.gx.GXMAPL`

process((GXMAP)arg1) → None:¶

Process a MAPL

Parameters:	arg1 (`geosoft.gx.GXMAP`) – MAP
Returns:	Nothing
Return type:	None

New in version 5.0.0.

replace_string((str)arg1, (str)arg2) → None:¶

Adds a replacement string to a mapplot control file.

Parameters:	arg1 (str) – Variable arg2 (str) – Replacement
Returns:	Nothing
Return type:	None

New in version 5.0.0.