<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<root>
    <NOTE>This XML file should only be used for documentation purposes.</NOTE>
    <doclet-version-NOT-library-version>0</doclet-version-NOT-library-version>
    <class>
        <name>xGauges</name>
        <shortname>xGauges</shortname>
        <event>Click</event>
        <event>LongClick</event>
        <method>
            <name>Initialize</name>
            <comment>Initializes a xGauge
Callback is the calling module
EventName is the generic event name, not used</comment>
            <returntype/>
            <parameter>
                <name>Callback</name>
                <type>Object</type>
            </parameter>
            <parameter>
                <name>EventName</name>
                <type>String</type>
            </parameter>
        </method>
        <method>
            <name>DesignerCreateView</name>
            <comment/>
            <returntype/>
            <parameter>
                <name>Base</name>
                <type>Object</type>
            </parameter>
            <parameter>
                <name>Lbl</name>
                <type>Label</type>
            </parameter>
            <parameter>
                <name>Props</name>
                <type>Map</type>
            </parameter>
        </method>
        <method>
            <name>AddToParent</name>
            <comment>adds the xGauge to the Parent view.
the parent object can be a B4XView or
an Activity or a Panel in B4A, a Panel in B4i or a Pane in B4J
there is no Height property, because the Height = Width</comment>
            <returntype/>
            <parameter>
                <name>Parent</name>
                <type>Object</type>
            </parameter>
            <parameter>
                <name>Left</name>
                <type>Int</type>
            </parameter>
            <parameter>
                <name>Top</name>
                <type>Int</type>
            </parameter>
            <parameter>
                <name>Width</name>
                <type>Int</type>
            </parameter>
        </method>
        <method>
            <name>RemoveView</name>
            <comment>removes the xGauge from its parent view</comment>
            <returntype/>
        </method>
        <method>
            <name>ReInitialize</name>
            <comment>reinitializes the gauge</comment>
            <returntype/>
        </method>
        <method>
            <name>BringToFront</name>
            <comment/>
            <returntype/>
        </method>
        <method>
            <name>SendToBack</name>
            <comment/>
            <returntype/>
        </method>
        <method>
            <name>AsView</name>
            <comment>Returns the base panel of the gauge as B4XView</comment>
            <returntype>B4XView</returntype>
        </method>
        <field>
            <name>Tag</name>
            <comment/>
            <returntype>Object</returntype>
        </field>
        <field>
            <name>mBase</name>
            <comment/>
            <returntype>B4XView</returntype>
        </field>
        <property>
            <name>GaugeType</name>
            <comment>sets or gets GaugeType property
possible values 90° Top, 180°, 270°, 90° Left, Custom scale angles
for Custom scale angles you can set the start and the end angle</comment>
            <returntype>String</returntype>
            <parameter>
                <name>GaugeType</name>
                <type>String</type>
            </parameter>
        </property>
        <property>
            <name>Value</name>
            <comment>sets the value of the gauge
the value must be between ValueMin and ValueMax</comment>
            <returntype/>
            <parameter>
                <name>Value</name>
                <type>Double</type>
            </parameter>
        </property>
        <property>
            <name>ValueMin</name>
            <comment>gets or sets the min value of the gauge</comment>
            <returntype>Double</returntype>
            <parameter>
                <name>ValueMin</name>
                <type>Double</type>
            </parameter>
        </property>
        <property>
            <name>ValueMax</name>
            <comment>gets or sets the max value of the gauge</comment>
            <returntype>Double</returntype>
            <parameter>
                <name>ValueMax</name>
                <type>Double</type>
            </parameter>
        </property>
        <property>
            <name>MainTickNumber</name>
            <comment>gets or sets the number of main ticks
for a scale from 0 to 10 then number must be 11</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>MainTickNumber</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>HalfTicks</name>
            <comment>gets or sets if half (intermedaite) tick are required
one tick between two main ticks</comment>
            <returntype>Boolean</returntype>
            <parameter>
                <name>HalfTicks</name>
                <type>Boolean</type>
            </parameter>
        </property>
        <property>
            <name>SmallTicksNumber</name>
            <comment/>
            <returntype>Int</returntype>
            <parameter>
                <name>SmallTicksNumber</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>TickText</name>
            <comment>gets or sets the texts for the ticks
the values between two || are displayed equally spaced on the scale
Example: 0|20|40|60|80|100 or E|1/2|F</comment>
            <returntype>String</returntype>
            <parameter>
                <name>TickText</name>
                <type>String</type>
            </parameter>
        </property>
        <property>
            <name>BackgroundColor</name>
            <comment>sets or gets the BackgroundColor
it must be an xui.Color
Example: xGauge1.BackgroundColor = xui.Color_White</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>Color</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>ScaleColor</name>
            <comment>sets or gets the ScaleColor
it must be an xui.Color
Example: xGauge1.ScaleColor = xui.Color_Black</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>ScaleColor</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>BorderWidth</name>
            <comment>sets or gets the BorderWidth
Example: xGauge1.BorderWidth = 5</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>BorderWidth</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>BorderColor</name>
            <comment>sets or gets the BorderColor property
it must be an xui.Color
Example: xGauge1.BorderColor = xui.Color_Gray</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>BorderColor</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>CornerRadius</name>
            <comment>sets or gets the CornerRadius property
this value must bee bigger than the BorderWidth.
if cCornerRadius &gt; 0 And cCornerRadius &lt; cBorderWidth + 1 Then cCornerRadius = cBorderWidth + 1
Example: xGauge1.CornerRadius = 5dip</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>CornerRadius</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>NeedleColor</name>
            <comment>sets or gets the NeedleColor property
it must be an xui.Color
Example: xGauge1.NeedleColor = xui.Color_Gray</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>NeedleColor</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>GaugeTitle</name>
            <comment>sets or gets the GaugeTitle property</comment>
            <returntype>String</returntype>
            <parameter>
                <name>GaugeTitle</name>
                <type>String</type>
            </parameter>
        </property>
        <property>
            <name>GaugeUnit</name>
            <comment>sets or gets the GaugeUnit property</comment>
            <returntype>String</returntype>
            <parameter>
                <name>GaugeUnit</name>
                <type>String</type>
            </parameter>
        </property>
        <property>
            <name>Width</name>
            <comment>sets or gets the width of the gauge
only the rectangular gauges have a Height property, all the others don't have Height property because the height is equal to the width</comment>
            <returntype>Double</returntype>
            <parameter>
                <name>Width</name>
                <type>Double</type>
            </parameter>
        </property>
        <property>
            <name>Height</name>
            <comment/>
            <returntype>Double</returntype>
        </property>
        <property>
            <name>Left</name>
            <comment>sets or gets the Left property</comment>
            <returntype>Double</returntype>
            <parameter>
                <name>Left</name>
                <type>Double</type>
            </parameter>
        </property>
        <property>
            <name>Top</name>
            <comment>sets or gets the Top property</comment>
            <returntype>Double</returntype>
            <parameter>
                <name>Top</name>
                <type>Double</type>
            </parameter>
        </property>
        <property>
            <name>ScaleLowLimitPerCent</name>
            <comment>sets or gets the ScaleLowLimitPerCent property
given in pecent of the scale
it drawn from the scale start to the given percent</comment>
            <returntype>Double</returntype>
            <parameter>
                <name>ScaleLowLimitPerCent</name>
                <type>Double</type>
            </parameter>
        </property>
        <property>
            <name>ScaleLowLimitColor</name>
            <comment>sets or gets the ScaleLowLimitColor property
it must be an xui.Color
Example: xGauge1.NeedleColor = xui.Color_RGB(255, 165, 0)</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>ScaleLowLimitColors</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>ScaleLowLimitColors</name>
            <comment>sets or gets the ScaleLowLimitColor property
it must be an Array of xui.Colors
Example: xGauge1.NeedleColor = Array As Int(xui.Color_RGB(255, 165, 0), xui.Color_Red)</comment>
            <returntype>Int()</returntype>
            <parameter>
                <name>ScaleLowLimitColors</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>ScaleHighLimitPerCent</name>
            <comment>sets or gets the ScaleHighLimitPerCent property
it is drawn from the given percent to the scale end
given in pecent of the scale</comment>
            <returntype>Double</returntype>
            <parameter>
                <name>ScaleHighLimitPerCent</name>
                <type>Double</type>
            </parameter>
        </property>
        <property>
            <name>ScaleHighLimitColor</name>
            <comment>sets or gets the ScaleHighLimitColor property
it must be an xui.Color
Example: xGauge1.ScaleHighLimitColor = xui.Color_Red</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>ScaleHighLimitColors</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>ScaleHighLimitColors</name>
            <comment>sets or gets the ScaleHighLimitColor property
it must be an xui.Color
Example: xGauge1.ScaleHighLimitColor = xui.Color_Red</comment>
            <returntype>Int()</returntype>
            <parameter>
                <name>ScaleHighLimitColors</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>ScaleMidLimitStartPerCent</name>
            <comment>sets or gets the ScaleMidLimitStartPerCent property
it is drawn from the given start percent over the sweep percent
given in percent of the scale</comment>
            <returntype>Double</returntype>
            <parameter>
                <name>ScaleMidLimitStartPerCent</name>
                <type>Double</type>
            </parameter>
        </property>
        <property>
            <name>ScaleMidLimitSweepPerCent</name>
            <comment>sets or gets the ScaleMidLimitSweepPerCent property
it is drawn from the given start percent over the sweep percent
given in percent of the scale</comment>
            <returntype>Double</returntype>
            <parameter>
                <name>ScaleMidLimitSweepPerCent</name>
                <type>Double</type>
            </parameter>
        </property>
        <property>
            <name>ScaleMidLimitColor</name>
            <comment>sets or gets the ScaleMidLimitColor property
it must be an xui.Color
Example: xGauge1.ScaleMidLimitColor = xui.Color_RGB(255, 165, 0)</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>ScaleMidLimitColor</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>ScaleMidLimitColors</name>
            <comment>sets or gets the ScaleMidLimitColors property
it must be an Array of xui.Colors
Example: xGauge1.ScaleMidLimitColors = Array As Int (xui.Color_RGB(255, 165, 0), xui.Color_Red)</comment>
            <returntype>Int()</returntype>
            <parameter>
                <name>ScaleMidLimitColors</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>ScaleMidLimit2StartPerCent</name>
            <comment>sets or gets the ScaleMidLimit2StartPerCent property
it is drawn from the given start percent over the sweep percent
given in percent of the scale</comment>
            <returntype>Double</returntype>
            <parameter>
                <name>ScaleMidLimit2StartPerCent</name>
                <type>Double</type>
            </parameter>
        </property>
        <property>
            <name>ScaleMidLimitSweep2PerCent</name>
            <comment>sets or gets the ScaleMidLimit2SweepPerCent2 property
it is drawn from the given start percent over the sweep percent
given in percent of the scale</comment>
            <returntype/>
            <parameter>
                <name>ScaleMidLimit2SweepPerCent</name>
                <type>Double</type>
            </parameter>
        </property>
        <property>
            <name>ScaleMidLimit2SweepPerCent</name>
            <comment/>
            <returntype>Double</returntype>
        </property>
        <property>
            <name>ScaleMidLimit2Color</name>
            <comment>sets or gets the ScaleMidLimit2Color property
it must be an xui.Color
Example: xGauge1.ScaleMidLimit2Color = xui.Color_RGB(255, 165, 0)</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>ScaleMidLimit2Color</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>ScaleMidLimit2Colors</name>
            <comment>sets or gets the ScaleMidLimit2Colors
it must be an Array of xui.Colors
Example: xGauge1.ScaleMidLimit2Color = Array As Int (xui.Color_RGB(255, 165, 0), xui.Color_Red)</comment>
            <returntype>Int()</returntype>
            <parameter>
                <name>ScaleMidLimit2Colors</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>NeedleBitmapFileName</name>
            <comment>sets or gets the NeedleBitmapFileName property
enter 'no file' without the quotes to use the default needle</comment>
            <returntype>String</returntype>
            <parameter>
                <name>NeedleBitmapFileName</name>
                <type>String</type>
            </parameter>
        </property>
        <property>
            <name>NeedleON</name>
            <comment>sets or gets the NeedleON property
shows or hides the needle
default value True</comment>
            <returntype>Boolean</returntype>
            <parameter>
                <name>NeedleON</name>
                <type>Boolean</type>
            </parameter>
        </property>
        <property>
            <name>CustomScaleStartAngle</name>
            <comment>sets or gets the CustomScaleStartAngle
Start angle for Custom scale angle gauge type.
trigonometric angles 0 at 3 o'clock
positive clockwise</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>CustomScaleStartAngle</name>
                <type>Int</type>
            </parameter>
        </property>
        <property>
            <name>CustomScaleEndAngle</name>
            <comment>sets or gets the CustomScaleEndAngle
Start angle for Custom scale angle gauge type.
trigonometric angles 0 at 3 o'clock
positive clockwise</comment>
            <returntype>Int</returntype>
            <parameter>
                <name>CustomScaleEndAngle</name>
                <type>Int</type>
            </parameter>
        </property>
    </class>
    <version>2.1</version>
    <author>Klaus CHRISTL</author>
</root>
