GXMVG class

class geosoft.gx.GXMVG
The MVG class provides the ability to create view graphs.
axis_x((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:
Draw an X axis
Parameters:
  • arg1 (float) – Y location in plot units (mm)
  • arg2 (float) – left X (rescaling unit)
  • arg3 (float) – right X (rescaling unit)
  • arg4 (float) – major tick interval (rescaling unit). Ticks drawn in decades in LOG or LOGLINEAR scale
  • arg5 (float) – minor tick interval (rescaling unit). Not used in LOG/LOGLINEAR
  • arg6 (float) – tick size in view units (mm) (negative for down ticks)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

When Log annotation is applied, nice tick intervals will be
calculated

Obsolete
axis_y((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:
Draw a  Y axis
Parameters:
  • arg1 (float) – X location in plot units (mm)
  • arg2 (float) – bottom Y (rescaling unit)
  • arg3 (float) – top Y (rescaling unit)
  • arg4 (float) – major tick interval (rescaling unit). Ticks drawn in decades in LOG or LOGLINEAR scale
  • arg5 (float) – minor tick interval (rescaling unit). Not used in LOG/LOGLINEAR
  • arg6 (float) – tick size in plot units (mm)(negative for left ticks)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

When Log annotation is applied, nice tick intervals will be
calculated

Obsolete
static create((GXContext)ctx, (GXMAP)arg1, (str)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (float)arg7, (float)arg8, (float)arg9, (float)arg10) → GXMVG:
Create a MVG object
Parameters:
  • ctx (geosoft.gx.GXContext) – The GX execution context
  • arg1 (geosoft.gx.GXMAP) – H_MAP handle
  • arg2 (str) – View Name
  • arg3 (float) – Minimum X in map unit (mm)
  • arg4 (float) – Minimum Y in map unit (mm)
  • arg5 (float) – Maximum X in map unit (mm)
  • arg6 (float) – Maximum Y in map unit (mm)
  • arg7 (float) – Minimum X in view unit (m for example)
  • arg8 (float) – Minimum Y in view unit
  • arg9 (float) – Maximum X in view unit
  • arg10 (float) – Maximum Y in view unit
Returns:

MVG handle (NULL if error)
Return type:

geosoft.gx.GXMVG

New in version 5.0.0.

Note:

Obsolete
get_mview() → GXMVIEW:
Get the MVIEW Handle of the Object.
Returns:MVIEW Handle
Return type:geosoft.gx.GXMVIEW

New in version 5.0.0.

Note:

Obsolete
grid((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6, (int)arg7) → None:
Draw a grid in the current MVG
Parameters:
  • arg1 (float) – X position of 1st vertical grid line to draw (in rescaling unit)
  • arg2 (float) – Y position of 1st horizontal grid line to draw (in rescaling unit)
  • arg3 (float) – X grid increment of rescaled map unit (see above Rescaling functions)
  • arg4 (float) – Y grid increment of rescaled map unit (see above Rescaling functions)
  • arg5 (float) – X dot increment/cross X size of rescaled map unit
  • arg6 (float) – Y dot increment/cross Y size of rescaled map unit
  • arg7 (int) – MVG_GRID constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

The grid will be drawn in the current window.

In the LOG and LOGLINEAR rescaling modes, grids will be
drawn in decades and the X/Y grid increments will be
ignored.  In addition, grid lines at 0 (zero) and LOGMIN will be drawn.

Obsolete
is_null() → bool

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

Returns:True if this is a null instance of geosoft.gx.GXMVG, False otherwise.
Return type:bool`
label_x((float)arg1, (float)arg2, (float)arg3, (float)arg4, (int)arg5, (int)arg6, (int)arg7) → None:
Label annotations on the X axis
Parameters:
  • arg1 (float) – Y location in plot units (mm)
  • arg2 (float) – left X (rescaling unit)
  • arg3 (float) – right X (rescaling unit)
  • arg4 (float) – major tick interval (ignored if in LOG or LOGLINEAR rescaling)
  • arg5 (int) – label justification MVG_LABEL_JUST constants
  • arg6 (int) – edge label bounding MVG_LABEL_BOUND constants
  • arg7 (int) – label orientation MVG_LABEL_ORIENT constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Label bounding will justify edge labels to be inside
the bar limits.

When Log annotation is applied, labels will be drawn in decades.

Obsolete

See also

sAxisX_MVG

label_y((float)arg1, (float)arg2, (float)arg3, (float)arg4, (int)arg5, (int)arg6, (int)arg7) → None:
Label annotations on the Y axis
Parameters:
  • arg1 (float) – X location in plot units (mm)
  • arg2 (float) – bottom Y (rescaling unit)
  • arg3 (float) – top Y (rescaling unit)
  • arg4 (float) – label interval (ignored if in LOG or LOGLINEAR rescaling)
  • arg5 (int) – label justification MVG_LABEL_JUST constants
  • arg6 (int) – edge label bounding MVG_LABEL_BOUND constants
  • arg7 (int) – label orientation MVG_LABEL_ORIENT constants
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Label bounding will justify edge labels to be inside
the bar limits.

When Log annotation is applied, labels will be drawn in decades.

Obsolete

See also

sAxisY_MVG

static null() → GXMVG

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

Returns:A null geosoft.gx.GXMVG
Return type:geosoft.gx.GXMVG
poly_line_va((int)arg1, (int)arg2, (GXVV)arg3, (GXVA)arg4, (GXVV)arg5) → None:
Creates PolyLines/polygons from VV and VA.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

If the VV contains dummies, the polylines
will break at the dummies; the polygons
will skip the dummies.

If wrapping is applied, POLYGON parameter is ignored and
only POLYLINES are drawn.

Obsolete
poly_line_vv((int)arg1, (int)arg2, (GXVV)arg3, (GXVV)arg4) → None:
Creates PolyLines/polygons from VV and VV.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

If the VV contains dummies, the polylines
will break at the dummies; the polygons
will skip the dummies.

If wrapping is applied, POLYGON parameter is ignored and
only POLYLINES are drawn.

Obsolete
rescale_x_range((int)arg1, (float)arg2, (float)arg3, (float)arg4) → None:
Re-scale horizontal axis
Parameters:
  • arg1 (int) – MVG_SCALE constants
  • arg2 (float) – Scale information: new minimum X
  • arg3 (float) – Scale information: new maximum X
  • arg4 (float) – Scale information: minimum X to apply log10, it is defined only for LOGLINEAR scale
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

When RescaleX_MVG is used, only the scaling information
related to X axis will be considered

Obsolete
rescale_y_range((int)arg1, (float)arg2, (float)arg3, (float)arg4) → None:
Re-scale vertical axis
Parameters:
  • arg1 (int) – MVG_SCALE constants
  • arg2 (float) – Scale information: new minimum Y
  • arg3 (float) – Scale information: new maximum Y
  • arg4 (float) – Scale information: minimum Y to apply log10, it is defined only for LOGLINEAR scale
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

When RescaleY_MVG is used, only the scaling information
related to Y axis will be considered

Obsolete

MVG_DRAW constants

MVG draw define
gx.MVG_DRAW_POLYLINE = 0
gx.MVG_DRAW_POLYGON = 1

MVG_GRID constants

MVG grid define
gx.MVG_GRID_DOT = 0
gx.MVG_GRID_LINE = 1
gx.MVG_GRID_CROSS = 2

MVG_LABEL_BOUND constants

MVG label bound define
gx.MVG_LABEL_BOUND_NO = 0
gx.MVG_LABEL_BOUND_YES = 1

MVG_LABEL_JUST constants

MVG label justification define
gx.MVG_LABEL_JUST_TOP = 0
gx.MVG_LABEL_JUST_BOTTOM = 1
gx.MVG_LABEL_JUST_LEFT = 2
gx.MVG_LABEL_JUST_RIGHT = 3

MVG_LABEL_ORIENT constants

MVG label orientation
gx.MVG_LABEL_ORIENT_HORIZONTAL = 0
gx.MVG_LABEL_ORIENT_TOP_RIGHT = 1
gx.MVG_LABEL_ORIENT_TOP_LEFT = 2

MVG_SCALE constants

MVG scale define
gx.MVG_SCALE_LINEAR = 0
gx.MVG_SCALE_LOG = 1
gx.MVG_SCALE_LOGLINEAR = 2

MVG_WRAP constants

MVG wrap define
gx.MVG_WRAP_NO = 0
gx.MVG_WRAP_YES = 1