.. oe:namespace:: OEGrapheme


.. oe:constnamespace:: OE2DPropMapSetup

   This namespace encodes symbolic constants used as bit-masks to 
   indicate which property map parameters are being 
   created when invoking the  
   :oe:func:`OEGrapheme::OEConfigure2DPropMap` function.

   .. ################################################################
      #
      ################################################################
  
   .. oe:constant:: All

      The combination of following constants:

      * :oe:const:`OEGrapheme::OE2DPropMapSetup::Legend`
      * :oe:const:`OEGrapheme::OE2DPropMapSetup::MaxValue`
      * :oe:const:`OEGrapheme::OE2DPropMapSetup::MinValue`
      * :oe:const:`OEGrapheme::OE2DPropMapSetup::NegativeColor`
      * :oe:const:`OEGrapheme::OE2DPropMapSetup::PositiveColor`
      * :oe:const:`OEGrapheme::OE2DPropMapSetup::RadiusRatio`
      * :oe:const:`OEGrapheme::OE2DPropMapSetup::Resolution`


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Legend

      Passing this constant to the  
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results
      in generating the following default interface to configure
      the location of the legend.

      ::

         Contents of parameter -legend
             Aliases : -l
             Type : string
             Allow list : false
             Default : Bottom
             Simple : true
             Required : false
             Legal values : Hidden Top Bottom Left Right
             Brief : Location of the legend
             Detail

      .. seealso::

         * :oe:constns:`OEGrapheme::OELegendLocation` namespace
         * :oe:meth:`OEGrapheme::OE2DPropMap::SetLegendLocation` method


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MaxValue

      Passing this constant to the  
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results 
      in generating the following default interface to configure
      the maximum value of the property map.

      ::

         Contents of parameter -maxvalue
             Aliases : -maxv
             Type : float
             Allow list : false
             Default : (parameter does not have a default)
             Simple : true
             Required : false
             Brief : Maximum property limit

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetMaxValue` method


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: MinValue

      Passing this constant to the  
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results
      in generating the following default interface to configure
      the minimum value of the property map.

      ::

         Contents of parameter -minvalue
             Aliases : -minv
             Type : float
             Allow list : false
             Default : (parameter does not have a default)
             Simple : true
             Required : false
             Brief : Minimum property limit

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetMinValue` method


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NegativeColor

      Passing this constant to the
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results
      in generating the following default interface to configure
      the color used to represent negative values in the property map.

      ::

         Contents of parameter -negcolor
             Aliases : -negc
             Type : string
             Allow list : false
             Default : red
             Simple : true
             Required : false
             Legal values : black blue bluetint brown cyan darkblue darkbrown
             darkcyan darkgreen darkgrey darkmagenta darkorange darkpurple darkred
             darkrose darksalmon darkyellow gold green greenblue greentint grey
             hotpink lightblue lightbrown lightgreen lightgrey lightorange
             lightpurple lightsalmon limegreen magenta mediumblue mediumbrown
             mediumgreen mediumorange mediumpurple mediumsalmon mediumyellow
             olivebrown olivegreen olivegrey orange pink pinktint purple red
             redorange royalblue seagreen skyblue violet white yellow yellowtint
             Brief : Color of the negative values

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetNegativeColor` method


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: PositiveColor

      Passing this constant to the  
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results
      in generating the following default interface to configure
      the color used to represent positive values in the property map.

      ::

         Contents of parameter -poscolor
             Aliases : -posc
             Type : string
             Allow list : false
             Default : blue
             Simple : true
             Required : false
             Legal values : black blue bluetint brown cyan darkblue darkbrown
             darkcyan darkgreen darkgrey darkmagenta darkorange darkpurple darkred
             darkrose darksalmon darkyellow gold green greenblue greentint grey
             hotpink lightblue lightbrown lightgreen lightgrey lightorange
             lightpurple lightsalmon limegreen magenta mediumblue mediumbrown
             mediumgreen mediumorange mediumpurple mediumsalmon mediumyellow
             olivebrown olivegreen olivegrey orange pink pinktint purple red
             redorange royalblue seagreen skyblue violet white yellow yellowtint
             Brief : Color of the positive values

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetPositiveColor` method


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: RadiusRatio

      Passing this constant to the
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results
      in generating the following default interface to configure
      the Gaussian radius of the property map.

      ::

         Contents of parameter -radiusratio
             Aliases : -rad
             Type : float
             Allow list : false
             Default : 1.0
             Simple : true
             Required : false
             Legal ranges :
                 2.0 to 0.5
             Brief : Ratio to scale the gaussian radius

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetRadiusRatio` method


   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Resolution

      Passing this constant to the
      :oe:func:`OEGrapheme::OEConfigure2DPropMap` function results
      in generating the following default interface to configure
      the resolution of the property map.

      ::

         Contents of parameter -resolution
             Aliases : -res
             Type : int
             Allow list : false
             Default : 2
             Simple : true
             Required : false
             Legal ranges :
                 20 to 2
             Brief : Resolution of the property map

      .. seealso::

         * :oe:meth:`OEGrapheme::OE2DPropMap::SetResolution` method

