pyplotUtils functions

This package define options for matplotlib.

geos.pv.pyplotUtils.matplotlibOptions module

class geos.pv.pyplotUtils.matplotlibOptions.FontStyleEnum(value)

Bases: OptionSelectionEnum

An enumeration.

Define the enumeration to options for Paraview selectors.

Parameters:

• displayName (str) – name displayed in the selector

• optionValue (str) –

  value used by matplotlib.

  Defaults to None (same optionName as displayName)

ITALIC = ('italic', 'italic')

NORMAL = ('normal', 'normal')

OBLIQUE = ('oblique', 'oblique')

class geos.pv.pyplotUtils.matplotlibOptions.FontWeightEnum(value)

Bases: OptionSelectionEnum

An enumeration.

Define the enumeration to options for Paraview selectors.

Parameters:

• displayName (str) – name displayed in the selector

• optionValue (str) –

  value used by matplotlib.

  Defaults to None (same optionName as displayName)

BOLD = ('bold', 'bold')

HEAVY = ('heavy', 'heavy')

LIGHT = ('light', 'light')

NORMAL = ('normal', 'normal')

class geos.pv.pyplotUtils.matplotlibOptions.LegendLocationEnum(value)

Bases: OptionSelectionEnum

An enumeration.

Define the enumeration to options for Paraview selectors.

Parameters:

• displayName (str) – name displayed in the selector

• optionValue (str) –

  value used by matplotlib.

  Defaults to None (same optionName as displayName)

BEST = ('best', 'best')

CENTER = ('center', 'center')

CENTER_LEFT = ('center left', 'center left')

CENTER_RIGHT = ('center right', 'center right')

LOWER_CENTER = ('lower center', 'lower center')

LOWER_LEFT = ('lower left', 'lower left')

LOWER_RIGHT = ('lower right', 'lower right')

UPPER_CENTER = ('upper center', 'upper center')

UPPER_LEFT = ('upper left', 'upper left')

UPPER_RIGHT = ('upper right', 'upper right')

class geos.pv.pyplotUtils.matplotlibOptions.LineStyleEnum(value)

Bases: OptionSelectionEnum

An enumeration.

Define the enumeration to options for Paraview selectors.

Parameters:

• displayName (str) – name displayed in the selector

• optionValue (str) –

  value used by matplotlib.

  Defaults to None (same optionName as displayName)

DASHDOT = ('dashdot', '-.')

DASHED = ('dashed', '--')

DOTTED = ('dotted', ':')

NONE = ('None', 'None')

SOLID = ('solid', '-')

class geos.pv.pyplotUtils.matplotlibOptions.MarkerStyleEnum(value)

Bases: OptionSelectionEnum

An enumeration.

Define the enumeration to options for Paraview selectors.

Parameters:

• displayName (str) – name displayed in the selector

• optionValue (str) –

  value used by matplotlib.

  Defaults to None (same optionName as displayName)

CIRCLE = ('circle', 'o')

DIAMOND = ('diamond', 'D')

NONE = ('None', '')

PLUS = ('plus', '+')

POINT = ('point', '.')

SQUARE = ('square', 's')

STAR = ('star', '*')

TRIANGLE = ('triangle', '^')

X = ('x', 'x')

class geos.pv.pyplotUtils.matplotlibOptions.OptionSelectionEnum(value)

Bases: Enum

An enumeration.

Define the enumeration to options for Paraview selectors.

Parameters:

• displayName (str) – name displayed in the selector

• optionValue (str) –

  value used by matplotlib.

  Defaults to None (same optionName as displayName)

geos.pv.pyplotUtils.matplotlibOptions.optionEnumToXml(enumObj)

Creates an enumeration domain from an OptionSelectionEnum object.

Dedicated to the dropdown widgets of paraview plugin.

Parameters:

enumObj (OptionSelectionEnum) – Enumeration values to put in the dropdown widget.

Returns:

the XML string.

Return type:

str