Sample entry for Zoomify API elements

The following sample Reference entry explains the conventions used for Zoomify API elements that are not classes. These conventions closely match those of the Macromedia ActionScript Dictionary conventions for ActionScript elements. The following descriptions match those of the Macromedia ActionScript Dictionary.

Entry title

All entries are listed alphabetically. The alphabetization ignores capitalization, leading underscores, and so on.

Availability

This section tells which versions of Flash Player support the element. This is not the same as the version of Flash used to author the content. For example, if you use Macromedia Flash MX 2004 or Macromedia Flash MX Professional 2004 to create content for Flash Player 6, you can use only ActionScript elements that are available to Flash Player 6.

Usage

This section provides correct syntax for using the ActionScript element in your code. The required portion of the syntax is in code font, and the code that you provide is in italicized code font. Brackets ([]) indicate optional parameters.

Parameters

This section describes any parameters listed in the syntax.

Returns

This section identifies the values the element returns, if any.

Description

This section identifies the type of element (for example, operator, method, function, and so on) and then describes how to use the element.

Example

This section provides a code sample demonstrating how to use the element.