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

Package | org.openscales.core.control
Class | public class PanZoomBar
Inheritance | PanZoomBar PanZoom Control flash.display.Sprite

As the PanZoom control, it allows to pan and zoom in/out the map. It adds a vertical slider for zooming functionality

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | active : Boolean | Control
|  | buttons : Array | PanZoom
|  | map : Map [write-only] Get the existing map | PanZoomBar
|  | mouseDragStart : Pixel | PanZoomBar
|  | position : Pixel | Control
|  | slideFactor : int | PanZoom
|  | slider : DisplayObject | PanZoomBar
|  | startTop : Number | PanZoomBar
|  | X : int = 4 [static] | PanZoom
|  | Y : int = 4 [static] | PanZoom
|  | zoomBar : DisplayObject | PanZoomBar
|  | zoomStart : Pixel | PanZoomBar
|  | zoomStopHeight : Number | PanZoomBar
|  | zoomStopWidth : Number | PanZoomBar

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined by
--- | --- | ---
|  | _active : Boolean = false | Control
|  | eastMiniImg : Class | PanZoom
|  | _map : Map = null | Control
|  | northMiniImg : Class | PanZoom
|  | sliderImg : Class | PanZoom
|  | southMiniImg : Class | PanZoom
|  | westMiniImg : Class | PanZoom
|  | zoombarImg : Class | PanZoom
|  | zoomMinusMiniImg : Class | PanZoom
|  | zoomPlusMiniImg : Class | PanZoom
|  | zoomWorldMiniImg : Class | PanZoom

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined by
--- | --- | ---
|  | PanZoomBar(position:Pixel = null) | PanZoomBar
|  | _addButton(name:String, image:Bitmap, xy:Pixel, sz:Size, alt:String = null):void Add button | PanZoom
|  | _addZoomBar(centered:Pixel):Pixel Add zoom bar (slider) | PanZoomBar
|  | click(evt:Event):void | PanZoom
|  | destroy():void | PanZoomBar
|  | doubleClick(evt:Event):Boolean | PanZoom
|  | draw():void Draw buttons for zoom and pan of the map | PanZoomBar
|  | moveZoomBar(evt:Event = null):void | PanZoomBar
|  | passEventToSlider(evt:MouseEvent):void | PanZoomBar
|  | redraw(obt:Object = null):void Refresh | PanZoomBar
|  | resize(event:MapEvent):void | Control
|  | zoomBarClick(evt:MouseEvent):void | PanZoomBar
|  | zoomBarDown(evt:MouseEvent):void | PanZoomBar
|  | zoomBarDrag(evt:MouseEvent):void | PanZoomBar
|  | zoomBarUp(evt:MouseEvent):void | PanZoomBar

Property detail

map | property

`map:Map` [write-only]

Get the existing map

Implementation
`public function set map(value:Map):void`

mouseDragStart | property |

`mouseDragStart:Pixel` [read-write]Implementation
`public function get mouseDragStart():Pixel`
`public function set mouseDragStart(value:Pixel):void`

slider | property |

`slider:DisplayObject` [read-write]Implementation
`public function get slider():DisplayObject`
`public function set slider(value:DisplayObject):void`

startTop | property |

`startTop:Number` [read-write]Implementation
`public function get startTop():Number`
`public function set startTop(value:Number):void`

zoomBar | property |

`zoomBar:DisplayObject` [read-write]Implementation
`public function get zoomBar():DisplayObject`
`public function set zoomBar(value:DisplayObject):void`

zoomStart | property |

`zoomStart:Pixel` [read-write]Implementation
`public function get zoomStart():Pixel`
`public function set zoomStart(value:Pixel):void`

zoomStopHeight | property |

`zoomStopHeight:Number` [read-write]Implementation
`public function get zoomStopHeight():Number`
`public function set zoomStopHeight(value:Number):void`

zoomStopWidth | property |

`zoomStopWidth:Number` [read-write]Implementation
`public function get zoomStopWidth():Number`
`public function set zoomStopWidth(value:Number):void`
Constructor detail

PanZoomBar | () | constructor

`public function PanZoomBar(position:Pixel = null)`Parameters

| `position:Pixel` (default = `null`)``

Method detail

_addZoomBar | () | method

`public function _addZoomBar(centered:Pixel):Pixel`

Add zoom bar (slider)

Parameters

| `centered:Pixel`

Returns

| `Pixel` — Pixel

destroy | () | method |

`public override function destroy():void`

draw | () | method |

`public override function draw():void`

Draw buttons for zoom and pan of the map

moveZoomBar | () | method |

`public function moveZoomBar(evt:Event = null):void` Parameters

| `evt:Event` (default = `null`)``

passEventToSlider | () | method |

`public function passEventToSlider(evt:MouseEvent):void` Parameters

| `evt:MouseEvent`

redraw | () | method |

`public function redraw(obt:Object = null):void`

Refresh

Parameters

| `obt:Object` (default = `null`)``

zoomBarClick | () | method |

`public function zoomBarClick(evt:MouseEvent):void` Parameters

| `evt:MouseEvent`

zoomBarDown | () | method |

`public function zoomBarDown(evt:MouseEvent):void` Parameters

| `evt:MouseEvent`

zoomBarDrag | () | method |

`public function zoomBarDrag(evt:MouseEvent):void` Parameters

| `evt:MouseEvent`

zoomBarUp | () | method |

`public function zoomBarUp(evt:MouseEvent):void` Parameters

| `evt:MouseEvent`