API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class Rule

Package | org.openscales.core.style
Class | public class Rule

Public Properties

| Property | Defined by
--- | --- | ---
|  | abstract : String Human readable description that may be several paragraph long | Rule
|  | filter : IFilter A filter used to determine if the rule is active for given feature | Rule
|  | maxScaleDenominator : Number The maximum scale at which the rule is active | Rule
|  | minScaleDenominator : Number The minimum scale at which the rule is active | Rule
|  | name : String Name of the Rule | Rule
|  | symbolizers : Array The list of symbolizers defining the ruless | Rule
|  | title : String Human readable short description (a few words and less than one line preferably) | Rule

Public Methods

| Method | Defined by
--- | --- | ---
|  | Rule() | Rule
|  | getLegendGraphic(type:String):DisplayObject Renders the legend for the rule on given DisplayObject | Rule
|  | setStyle(symbolizer:Symbolizer, canvas:Sprite):void [static] | Rule

Protected Methods

| Method | Defined by
--- | --- | ---
|  | drawMark(mark:WellKnownMarker, canvas:Sprite):void | Rule

Public Constants

| Constant | Defined by
--- | --- | ---
|  | LEGEND_LINE : String = "Line" [static] | Rule
|  | LEGEND_POINT : String = "Point" [static] | Rule
|  | LEGENT_POLYGON : String = "Polygon" [static] | Rule

Property detail

abstract | property

`abstract:String` [read-write]

Human readable description that may be several paragraph long

Implementation
`public function get abstract():String`
`public function set abstract(value:String):void`

filter | property |

`filter:IFilter` [read-write]

A filter used to determine if the rule is active for given feature

Implementation
`public function get filter():IFilter`
`public function set filter(value:IFilter):void`

maxScaleDenominator | property |

`maxScaleDenominator:Number` [read-write]

The maximum scale at which the rule is active

Implementation
`public function get maxScaleDenominator():Number`
`public function set maxScaleDenominator(value:Number):void`

minScaleDenominator | property |

`minScaleDenominator:Number` [read-write]

The minimum scale at which the rule is active

Implementation
`public function get minScaleDenominator():Number`
`public function set minScaleDenominator(value:Number):void`

name | property |

`name:String` [read-write]

Name of the Rule

Implementation
`public function get name():String`
`public function set name(value:String):void`

symbolizers | property |

`symbolizers:Array` [read-write]

The list of symbolizers defining the ruless

Implementation
`public function get symbolizers():Array`
`public function set symbolizers(value:Array):void`

title | property |

`title:String` [read-write]

Human readable short description (a few words and less than one line preferably)

Implementation
`public function get title():String`
`public function set title(value:String):void`
Constructor detail

Rule | () | constructor

`public function Rule()`
Method detail

drawMark | () | method

`protected function drawMark(mark:WellKnownMarker, canvas:Sprite):void` Parameters

| `mark:WellKnownMarker`
| `canvas:Sprite`

getLegendGraphic | () | method |

`public function getLegendGraphic(type:String):DisplayObject`

Renders the legend for the rule on given DisplayObject

Parameters

| `type:String`

Returns

| `DisplayObject`

setStyle | () | method |

`public static function setStyle(symbolizer:Symbolizer, canvas:Sprite):void` Parameters

| `symbolizer:Symbolizer`
| `canvas:Sprite`

Constant detail

LEGEND_LINE | constant

`public static const LEGEND_LINE:String = "Line"`

LEGEND_POINT | constant |

`public static const LEGEND_POINT:String = "Point"`

LEGENT_POLYGON | constant |

`public static const LEGENT_POLYGON:String = "Polygon"`