| API Documentation | All Packages | All Classes | Index | Frames | |
| Interface IImagePyramidDescriptor | Properties | Methods | |
| Package | org.openzoom.flash.descriptors |
| Interface | public interface IImagePyramidDescriptor extends IMultiScaleImageDescriptor |
| Implementors | DeepZoomImageDescriptor, DjatokaDescriptor, GigaPanDescriptor, OpenStreetMapDescriptor, OpenZoomDescriptor, RosettaDiskBackDescriptor, RosettaDiskFrontDescriptor, VirtualEarthDescriptor, ZoomifyDescriptor |
| Property | Defined by | ||
|---|---|---|---|
 | height : uint
Returns the intrinsic height of the image in pixels.
| IMultiScaleImageDescriptor | |
| numLevels : int [read-only]
Returns the number of levels of this object.
| IImagePyramidDescriptor | ||
| origin : String [read-only]
Returns the origin of the coordinate system for addressing tiles.
| IImagePyramidDescriptor | ||
| sources : Array
Returns an array of IImageSourceDescriptor objects.
| IMultiScaleImageDescriptor | |
| tileHeight : uint [read-only]
Returns the height of a single tile of the image pyramid in pixels.
| IImagePyramidDescriptor | ||
| tileOverlap : uint [read-only]
Returns the tile overlap in pixels.
| IImagePyramidDescriptor | ||
| tileWidth : uint [read-only]
Returns the width of a single tile of the image pyramid in pixels.
| IImagePyramidDescriptor | ||
| type : String [read-only]
Returns the mime-type of the image pyramid tiles, e.g.
| IImagePyramidDescriptor | ||
| width : uint
Returns the intrinsic width of the image in pixels.
| IMultiScaleImageDescriptor | |
| Method | Defined by | ||
|---|---|---|---|
|
Returns a copy of this object.
| IImagePyramidDescriptor | ||
|
existsTile(level:int, column:int, row:int):Boolean
Returns a Boolean indicating if the tile at the given level, row and column exists.
| IImagePyramidDescriptor | ||
|
getLevelAt(index:int):IImagePyramidLevel
Returns the image pyramid level that exists at the specified index.
| IImagePyramidDescriptor | ||
|
getLevelForSize(width:Number, height:Number):IImagePyramidLevel
Returns the minimum pyramid level that has a greater or equal size
than specified by the arguments width and height.
| IImagePyramidDescriptor | ||
|
getTileAtPoint(level:int, point:Point):Point
Returns the tile at the given level under the given point.
| IImagePyramidDescriptor | ||
|
getTileBounds(level:int, column:int, row:int):Rectangle
Returns the bounds (position and dimensions) of the tile specified
by the level, column and row.
| IImagePyramidDescriptor | ||
|
getTileURL(level:int, column:int, row:int):String
Returns the URL of the tile specified by its level, column and row.
| IImagePyramidDescriptor | ||
| numLevels | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesnumLevels:int [read-only]Returns the number of levels of this object.
Implementation public function get numLevels():int
| origin | property |
origin:String [read-only]Returns the origin of the coordinate system for addressing tiles.
The default value is topLeft.
public function get origin():String
| tileHeight | property |
tileHeight:uint [read-only]Returns the height of a single tile of the image pyramid in pixels.
Implementation public function get tileHeight():uint
| tileOverlap | property |
tileOverlap:uint [read-only]Returns the tile overlap in pixels.
The default value is 0.
public function get tileOverlap():uint
| tileWidth | property |
tileWidth:uint [read-only]Returns the width of a single tile of the image pyramid in pixels.
Implementation public function get tileWidth():uint
| type | property |
type:String [read-only]Returns the mime-type of the image pyramid tiles, e.g. <image/jpeg> or <image/png>.
Implementation public function get type():String
| clone | () | method |
public function clone():IImagePyramidDescriptorReturns a copy of this object.
ReturnsIImagePyramidDescriptor |
| existsTile | () | method |
public function existsTile(level:int, column:int, row:int):BooleanReturns a Boolean indicating if the tile at the given level, row and column exists.
Parameterslevel:int |
|
column:int |
|
row:int |
Boolean |
| getLevelAt | () | method |
public function getLevelAt(index:int):IImagePyramidLevelReturns the image pyramid level that exists at the specified index.
Parametersindex:int |
IImagePyramidLevel |
| getLevelForSize | () | method |
public function getLevelForSize(width:Number, height:Number):IImagePyramidLevelReturns the minimum pyramid level that has a greater or equal size than specified by the arguments width and height.
Parameterswidth:Number |
|
height:Number |
IImagePyramidLevel |
| getTileAtPoint | () | method |
public function getTileAtPoint(level:int, point:Point):PointReturns the tile at the given level under the given point.
Parameterslevel:int |
|
point:Point |
Point |
| getTileBounds | () | method |
public function getTileBounds(level:int, column:int, row:int):RectangleReturns the bounds (position and dimensions) of the tile specified by the level, column and row.
Parameterslevel:int |
|
column:int |
|
row:int |
Rectangle |
| getTileURL | () | method |
public function getTileURL(level:int, column:int, row:int):StringReturns the URL of the tile specified by its level, column and row.
Parameterslevel:int |
|
column:int |
|
row:int |
String |