Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
GraphicsUtilities

Package | mx.charts.chartClasses
Class | public class GraphicsUtilities
Inheritance | GraphicsUtilities Object

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A set of internal graphics rendering utilities used by the various chart classes.

Public Methods

| Method | Defined By
--- | --- | ---
|  | colorFromFill(f:Object):uint [static] Converts a fill value into a solid color. | GraphicsUtilities
|  | drawArc(g:Graphics, x:Number, y:Number, startAngle:Number, arc:Number, radius:Number, yRadius:Number, continueFlag:Boolean = false):void [static] Draws an arc in the target Graphics object. | GraphicsUtilities
|  | drawPolyLine(g:Graphics, pts:Array, start:int, end:int, hProp:String, vProp:String, stroke:IStroke, form:Object, moveToStart:Boolean = true):void [static] Draws a line connecting the datapoints using one of various forms. | GraphicsUtilities
|  | fillFromStyle(v:Object):IFill [static] Converts a style value into a Fill object. | GraphicsUtilities
|  | fillRect(g:Graphics, left:Number, top:Number, right:Number, bottom:Number, fill:Object = null, ls:Object = null):void [static] Fill a rectangle using the provided IFill and IStroke objects. | GraphicsUtilities
|  | setLineStyle(g:Graphics, ls:IStroke):void [static] Applies the values in a Stroke to the provded Graphics object. | GraphicsUtilities

Method Detail

colorFromFill | () | method

`public static function colorFromFill(f:Object):uint`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Converts a fill value into a solid color. This convenience method pulls a color value out of a Fill that best approximates the Fill on the screen.

Parameters

| `f:Object` — The Fill object to extract a color from.

Returns

| `uint` — A color value representing the Fill.

drawArc | () | method |

`public static function drawArc(g:Graphics, x:Number, y:Number, startAngle:Number, arc:Number, radius:Number, yRadius:Number, continueFlag:Boolean = false):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Draws an arc in the target Graphics object.

Parameters

| `g:Graphics` — The Graphics object to draw into.
| `x:Number` — The horizontal origin of the arc.
| `y:Number` — The vertical origin of the arc.
| `startAngle:Number` — The starting angle, in radians, of the arc.
| `arc:Number` — The sweep, in radians, of the arc.
| `radius:Number` — The horizontal radius, in pixels, of the arc
| `yRadius:Number` (default = `NaN`)`` — The vertical radius, in pixels, of the arc. If unspecified, it is assumed to be the same as the radius
| `continueFlag:Boolean` (default = `false`)`` — Indicates whether the routine should move the graphics pen to the beginning of the arc before drawing. Set to `true` to continue drawing a line that is already in progress.

drawPolyLine | () | method |

`public static function drawPolyLine(g:Graphics, pts:Array, start:int, end:int, hProp:String, vProp:String, stroke:IStroke, form:Object, moveToStart:Boolean = true):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Draws a line connecting the datapoints using one of various forms.

Parameters

| `g:Graphics` — The Graphics object to draw into.
| `pts:Array` — An Array of datapoints that define the line.
| `start:int` — The index of the first point in the `pts` Array to use when drawing the line.
| `end:int` — The index of the last point, exclusive, to use when drawing the line.
| `hProp:String` — The name of the property in the objects contained in the `pts` Array that defines the horizontal position of the points in the line.
| `vProp:String` — The name of the property in the objects contained in the `pts` Array that defines the vertical position of the points in the line.
| `stroke:IStroke` — The Stroke used to render the line.
| `form:Object` — The form to render the line with. Valid values are "segment","horizontal","vertical","step","reverseStep", or "curve". These forms are similar to the LineSeries class's `form` property.
| `moveToStart:Boolean` (default = `true`)`` — Indicates whether to first move the pen to the beginning of the line before drawing. Pass `false` to use this function to continue a line in progress.

fillFromStyle | () | method |

`public static function fillFromStyle(v:Object):IFill`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Converts a style value into a Fill object. This convenience method converts a value assigned through styles into a Fill object that can be used to fill an area on the screen. If the value is numeric, this function converts it into a corresponding SolidColor.

Parameters

| `v:Object` — The value to convert into a Fill.

Returns

| `IFill` — The corresponding IFill object.

fillRect | () | method |

`public static function fillRect(g:Graphics, left:Number, top:Number, right:Number, bottom:Number, fill:Object = null, ls:Object = null):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Fill a rectangle using the provided IFill and IStroke objects. This utility function fills the provided rectangle in the Graphics object with the provided Fill and Stroke. If no Stroke is provided, the rectangle is filled with no border. If no Fill is provided, the rectangle is drawn with no fill.

Parameters

| `g:Graphics` — The Graphics object to draw into.
| `left:Number` — The left of the rectangle to fill.
| `top:Number` — The top of the rectangle to fill.
| `right:Number` — The right of the rectangle to fill.
| `bottom:Number` — The bottom of the rectangle to fill.
| `fill:Object` (default = `null`)`` — The IFill object to fill the rectangle with. Set this parameter to null to draw a rectangle with no Fill.
| `ls:Object` (default = `null`)`` — The stroke object to draw the rectangle with. Set this parameter to null to draw a rectangle with no Stroke.

setLineStyle | () | method |

`public static function setLineStyle(g:Graphics, ls:IStroke):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Applies the values in a Stroke to the provded Graphics object. This utility function applies the Stroke passed in, or clears the line style of the provided Graphics object if the `ls` parameter is set to `null`.

Parameters

| `g:Graphics` — The Graphics object to modify.
| `ls:IStroke` — The IStroke instance to apply; set to `null` to render with no Stroke.

Wed Nov 15 2017, 09:50 AM +01:00