MGMap.getApiVersion

Syntax

string getApiVersion()

Description

Gets the Autodesk MapGuide Viewer API version.

Returns

String - The version of the Autodesk MapGuide Viewer API, which will be one of the following:

• Autodesk MapGuide Release 2.5 uses API version 1.0
• Autodesk MapGuide Release 2.5.5 uses API version 1.1
• Autodesk MapGuide Release 3.0 uses API version 1.2
• Autodesk MapGuide Release 4.0.3.4 uses API version 1.3
• Autodesk MapGuide Release 4.0.3.6 uses API version 1.4
• Autodesk MapGuide Release 4.1 uses API version1.5
• Autodesk MapGuide Release 5.0 uses API version 5.0
• Autodesk MapGuide Release 6.0 uses API version 6.0

Error Codes

none

Example

The following example is designed to work with the Tutorial.mwf file that is included with Autodesk MapGuide Author. It displays a dialog box showing the API version:

function whatsTheApi()
{
    var msg = getMap().getApiVersion();
    alert("API version is: " + msg);
}

Here's another way to write the same function:

function whatsTheApi()
{
    alert("API version is: " + getMap().getApiVersion());
}

See Also

ApiVersion