<doc>
	<legacy_id>3508</legacy_id>
	<name>fillGradient</name>
	<type>property</type>

	<syntax>
		<example>set the fillGradient [of graphic] to <i>propertiesArray</i></example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Specifies the gradient to use to fill the graphic object. </summary>

	<examples>
<example>set the fillGradient of graphic 1 to tPropertiesArray</example>
<example><p>set the fillGradient["type"] of graphic 1 to "linear"</p><p></p></example>
<example><p>-- Create the properties array and then set the fillGradient</p><p>put "linear" into tGradientProperties["type"]</p><p>put "0.00000,204,0,106" &amp; return  &amp; "1.00000,0,156,157" into tGradientProperties["ramp"]</p><p>set the fillGradient of graphic 1 to tGradientProperties</p></example>
<example><p>-- Set the properties of the fillGradient individually</p><p>lock screen</p><p>set the fillGradient["type"] of graphic 1 to "linear"</p><p>set the fillGradient["ramp"] of graphic 1 to "0.00000,204,0,106" &amp; return  &amp; "1.00000,0,156,157"</p><p>unlock screen</p></example>
	</examples>

	<history>
		<introduced version="3.0">Added. </introduced>
		<deprecated version=""></deprecated>
		<removed version=""></removed>
		
		<experimental version=""></experimental>
		<nonexperimental version=""></nonexperimental>
	</history>

	<objects>
		<graphic/>
	</objects>

	<platforms>
		<mac/>
		<windows/>
		<linux/>
		<ios/>
		<android/>
	</platforms>

	<classes>
		<desktop/>
		<server/>
		<web/>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
	</classification>

	<references>
		<property tag="antialiased">antialiased Property</property>
		<property tag="opaque">opaque Property</property>
	</references>

	<description>
	<overview>use the <b>fillGradient</b> property to set a gradient background on an object.</overview>

		<parameters>
  <parameter>
    <name>propertiesArray</name>
    <description>An array. The array keys containing the gradient property to set with the corresponding array value containing the value to set the property to. The properties array should contain one of more of the following key|value pairs:</description>
    <options title="">
      <option>
        <item>type</item>
        <description>One of: linear, radial, conical, spiral, diamond, xy or sqrtxy</description>
      </option>
      <option>
        <item>ramp</item>
        <description>A return delimited list of gradient stops that define the layout of the of the gradient. A gradient stop is a comma delimited list with the following structure: position,color,alpa. For example the gradient stop "0.5,255,0,0,125" would add a stop half way along the gradient, it would be red and semi transparent.</description>



<values>

<value>
<name>position</name>
<description>A number between 0 and 1.</description>
</value>

<value>
<name>color</name>
<description>An RGB color value. 3 integers between 0 and 255 separated by a comma. For example "255,0,88".</description>
</value>

<value>
<name>alpha</name>
<description>A number between 0 (transparent) and 255 (opaque), if omitted it is assumed to be 255.</description>
</value>

</values>





      </option>
      <option>
        <item>from</item>
        <description>A coordinate specifying the starting point of the gradient.</description>
      </option>
      <option>
        <item>to</item>
        <description>A coordinate specifying the end point of the gradient.</description>
      </option>
      <option>
        <item>via</item>
        <description>A coordinate specifying the intermediate point of the gradient (affects scaling and shearing of the gradient).</description>
      </option>
      <option>
        <item>quality</item>
        <description>The quality can be set to normal or good (higher detail but slower). This property is normal by default. </description>
      </option>
      <option>
        <item>repeat</item>
        <description>A number between 1 and 255 that specifies the number of times the gradient ramp is repeated between the start and end points. This property is 1 by default.  </description>
      </option>
      <option>
        <item>mirror</item>
        <description>A boolean value specifying whether alternating repetitions of the ramp are reversed. This property is false by default. </description>
      </option>
  <option>
        <item>wrap</item>
        <description>A boolean value specifying whether the ramp is repeated to fill the entire graphic a object. This 
	property is false by default.</description>
      </option>

    </options>
  </parameter>		</parameters>

	<value>The <b>fillGradient</b> property returns an array keyed by the gradient properties set on the object.</value>
	<comments></comments>
	</description>
</doc>