| API Documentation | All Packages | All Classes | Index | Frames | |
| Class DeepZoomImageDescriptor | Properties | Methods | |
| Package | org.openzoom.flash.descriptors.deepzoom |
| Class | public final class DeepZoomImageDescriptor |
| Inheritance | DeepZoomImageDescriptor  org.openzoom.flash.descriptors.ImagePyramidDescriptorBase |
| Implements | IImagePyramidDescriptor |
| Property | Defined by | ||
|---|---|---|---|
| collection : DeepZoomCollectionDescriptor [read-only]
Returns the collection this image belongs to or null
if it does not belong to a collection.
| DeepZoomImageDescriptor | ||
| format : String [read-only]
Returns the format of the image pyramid.
| DeepZoomImageDescriptor | ||
| mortonNumber : uint [read-only]
Returns the Morton number of this image within the collection.
| DeepZoomImageDescriptor | ||
| tileSize : uint [read-only]
Returns the size of a single tile of the image pyramid in pixels.
| DeepZoomImageDescriptor | ||
| Method | Defined by | ||
|---|---|---|---|
|
DeepZoomImageDescriptor(source:String, width:uint, height:uint, tileSize:uint, tileOverlap:uint, format:String, displayRects:Array = null, mortonNumber:uint = 0, collection:DeepZoomCollectionDescriptor = null)
Constructor.
| DeepZoomImageDescriptor | ||
|
Returns a copy of this object.
| DeepZoomImageDescriptor | ||
|
existsTile(level:int, column:int, row:int):Boolean
| DeepZoomImageDescriptor | ||
|
fromXML(source:String, xml:XML):DeepZoomImageDescriptor
[static]
Create descriptor from XML.
| DeepZoomImageDescriptor | ||
|
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.
| DeepZoomImageDescriptor | ||
|
getTileURL(level:int, column:int, row:int):String
Returns the URL of the tile specified by its level, column and row.
| DeepZoomImageDescriptor | ||
|
toString():String
| DeepZoomImageDescriptor | ||
| collection | property |
collection:DeepZoomCollectionDescriptor [read-only]Returns the collection this image belongs to or null if it does not belong to a collection.
Implementation public function get collection():DeepZoomCollectionDescriptor
| format | property |
format:String [read-only]Returns the format of the image pyramid.
Implementation public function get format():String
| mortonNumber | property |
mortonNumber:uint [read-only]
Returns the Morton number of this image within the collection.
The Morton number is only valid if collection is not null.
public function get mortonNumber():uint
| tileSize | property |
tileSize:uint [read-only]Returns the size of a single tile of the image pyramid in pixels.
Implementation public function get tileSize():uint
| DeepZoomImageDescriptor | () | constructor |
public function DeepZoomImageDescriptor(source:String, width:uint, height:uint, tileSize:uint, tileOverlap:uint, format:String, displayRects:Array = null, mortonNumber:uint = 0, collection:DeepZoomCollectionDescriptor = null)Constructor.
Parameterssource:String |
|
width:uint |
|
height:uint |
|
tileSize:uint |
|
tileOverlap:uint |
|
format:String |
|
displayRects:Array (default = null) |
|
mortonNumber:uint (default = 0) |
|
collection:DeepZoomCollectionDescriptor (default = null) |
| clone | () | method |
public function clone():IImagePyramidDescriptorReturns a copy of this object.
ReturnsIImagePyramidDescriptor |
| existsTile | () | method |
public override function existsTile(level:int, column:int, row:int):BooleanParameters
level:int |
|
column:int |
|
row:int |
Boolean |
| fromXML | () | method |
public static function fromXML(source:String, xml:XML):DeepZoomImageDescriptorCreate descriptor from XML.
Parameterssource:String |
|
xml:XML |
DeepZoomImageDescriptor |
| 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 |
| 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 |
| toString | () | method |
public override function toString():StringReturns
String |