GXCSYMB class

class geosoft.gx.GXCSYMB
This class is used for generating and modifying colored symbol objects.
Symbol fills are assigned colors based on their Z values and a zone, Aggregate
or ITR file which defines what colors are associated with different ranges
of Z values. The position of a symbol is defined by its X,Y coordinates.
add_data((GXVV)arg1, (GXVV)arg2, (GXVV)arg3) → None:
Add x,y,z data to a color symbol object.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

static create((GXContext)ctx, (str)arg1) → GXCSYMB:
Create a CSYMB.
Parameters:
Returns:

CSYMB handle
Return type:

geosoft.gx.GXCSYMB

New in version 5.0.0.

is_null() → bool

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

Returns:True if this is a null instance of geosoft.gx.GXCSYMB, False otherwise.
Return type:bool`
static null() → GXCSYMB

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

Returns:A null geosoft.gx.GXCSYMB
Return type:geosoft.gx.GXCSYMB
set_angle((float)arg1) → None:
Set the symbol angle.
Parameters:arg1 (float) – Symbol angle
Returns:Nothing
Return type:None

New in version 5.0.0.

set_base((float)arg1) → None:
Set base value to subtract from Z values.
Parameters:arg1 (float) – Symbol Base
Returns:Nothing
Return type:None

New in version 5.0.0.

set_dynamic_col((int)arg1) → None:
Associate symbol edge or fill colors with Z data
and color transform.
Parameters:arg1 (int) – CSYMB_COLOR constants
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

Use this method after a call to geosoft.gx.GXCSYMB.set_static_col(). This method
reestablishes the symbol color association with their Z data
values and color transform.
set_fixed((int)arg1) → None:
Set symbol sizing to fixed (or proportionate)
Parameters:arg1 (int) – TRUE = Fixed symbol sizing FALSE = Proportionate sizing
Returns:Nothing
Return type:None

New in version 5.0.0.

set_font((str)arg1, (int)arg2, (int)arg3, (int)arg4) → None:
Set the symbol font name.
Parameters:
  • arg1 (str) – Font name
  • arg2 (int) – Geosoft font? (TRUE or FALSE)
  • arg3 (int) – MVIEW_FONT_WEIGHT constants
  • arg4 (int) – Italics? (TRUE or FALSE)
Returns:

Nothing
Return type:

None

New in version 5.0.0.

set_number((int)arg1) → None:
Set the symbol number.
Parameters:arg1 (int) – Symbol number (0x1-0x1ffff)
Returns:Nothing
Return type:None

New in version 5.0.0.

Note:

The lower 16 bits of the number is interpreted as UTF-16 with a valid Unicode character
code point. GFN fonts wil produce valid symbols depending on the font for 0x01-0x7f and the degree,
plus-minus and diameter symbol(latin small letter o with stroke) for 0xB0, 0xB1 and 0xF8 respectively.

It is possible to check if a character is valid using geosoft.gx.GXUNC.is_valid_utf16_char(). The high 16-bits are reserved
for future use. Also see: geosoft.gx.GXUNC.valid_symbol() and geosoft.gx.GXUNC.validate_symbols()
set_scale((float)arg1) → None:
Set the symbol scale.
Parameters:arg1 (float) – Symbol scale (> 0.0)
Returns:Nothing
Return type:None

New in version 5.0.0.

set_static_col((int)arg1, (int)arg2) → None:
Set a static color for the symbol edge or fill.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

Note:

Use this method to set a STATIC color for symbol edge or fill.
By default, both edge and fill colors vary according to their
Z data values and a color transform.

CSYMB_COLOR constants

Color Symbol filling defines
gx.CSYMB_COLOR_EDGE = 0
Draw Edges only
gx.CSYMB_COLOR_FILL = 1
Fill Symbols