Orbit Knowledge Base 43:flashmap:publicinterface

Orbit FlashMap Public Interface Definition File

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Orbit FlashMap Public Interface Definition File /** *

Interface I_PublicInterface models the public interface object of OFM.

* @version 4.2 Sept 2006 */ interface com.orbitgis.ofm.I_PublicInterface { ////////////////////////////////////////////////////////////////////////////////////// // Compass Rose ////////////////////////////////////////////////////////////////////////////////////// /** Pans view 1/4 left */ function panLeft():Void; /** Pans view 1/4 right */ …

Public Interface 'Cockpit' Test Application

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Public Interface 'Cockpit' Test Application The public interface 'cockpit' application is a demo of FlashMap's public interface capabilities. It is bundled with your OFM download but can also be downloaded here (last updated 27 march 2006). The test project attempts to demonstrate as much functionality as possible. It is configured to work with the default OFM installation.

Examples

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Examples This page contains example code of how you can use FlashMap's public interface. Loading the interface object This is the most basic example. It just shows how to load the public interface, when embedding OFM using the ActionScript 2 MovieClipLoader class.

OFM Embedding FAQ (Flash)

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

OFM Embedding FAQ (Flash) Q: OFM does not render fonts when embedded. A: Did you apply a mask to OFM? If you do so, make sure the mask is not a scene-mask, but a mask defined using the actionscript setMask() call. OFM uses device fonts, which are not masked when using a scene mask. Also, the masquee may not be an externally loaded MovieClip. This means you'll need to load OFM as a child clip of a normal movieclip, for masking to function correctly.

Hyperlink mode

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Hyperlink mode This page details how events can be captured when OFM is in hyperlink mode. Hyperlink mode allows you to listen to hyperlink clicks (clicks near an object with hyperlink properties). You can retrieve the latest selected hyperlink using the

Public Interface

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Public Interface This document tries to give an overview of all the functionality made available by FlashMap's public interface API. It gives the reader an overview of its functions, grouped by topic : * Object selection - Capturing object selections * Map Modes - Capturing mode change events or set a new active mode

Layers

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Layers These functions allow you to retrieve a list of layer names and layer visibilities. * Use getLayerNames() and getLayerVisibilities() to get a list of the available layers. * Use toggleLayer(index, reload) to toggle a layer's visibility. If the second parameter is true, the view will reload).

Maptips

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Maptips If you are embedding OFM, you can use the setMapTipLayer() function to change the active maptip layer. Background Maptips in OFM are an extension of maptips in Orbit GIS. In OrbitGIS, each model of a dataset can be configured to have a maptip attribute, which is then used as a tooltip.

Measure

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Measure These functions allow you to control the measure component. The measure component keeps track of length and area of a user defined polyline. It keeps 2 sets of resulting length/area : * The measure set keeps length and area of the most current state (updated whenever the mouse moves).

Map Modes

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Map Modes The map mode related functions allow you to set the Active mode, read the currently active mode and listen for mode changes. The active mode defines how OFM interacts with the user. * Use the setActiveMode() and getActiveMode() functions to set and retrieve the active mode.

OFM Parameters

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

OFM Parameters During development, some internal parameters were added to OFM to make it more adaptable to different environments. This page documents these parameters. You can specify these parameters using the setOFMParameter() function of the public interface or using the UI configuration file

Object selection

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Object selection Objects are selected by clicking or dragging on the map. When objects were selected, OFM will load the first object's attribute rows from the server. Several events are fired during this procedure : * Selection changed event : The selected objects changed.

Session Parameters

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Session Parameters Session parameters are primarily used to influence server operations. Since session parameters require a connection to the server, you must wait until the client state is “ready” before setting it. You can do so using designated

Client State

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Client State These functions allow you to monitor OFM's state in two ways : * You can monitor its startup state : clientState. * You can monitor whether it's currently communicating with the server : busy. Busy state The busy state is expressed as a boolean (where true means busy). Use

Viewing

Anonymous (anonymous@undisclosed.example.com) — 2019-03-25T11:36:24+00:00

Viewing These functions allow you to get info on the current view definition and do something with the view. The following can be used to install a listener on user-initiated view events : * addNewViewListener() and removeNewViewListener() to add or remove listeners for new view events.