v3.2 provides a hierarchy of API objects as shown in the figure below.
Objects provide a
number of methods that may be roughly divided into three categories:
– obtain information about the state of the SDM or its data.
– modify the state SDM or its data
Methods – provide access to other API objects.
Most modifiers return a long integer value. This is a return code. A value of zero indicates no error. Other values indicate an error, a textual description of which can be obtained via ProgramAPI.getMessageText. Almost all errors indicate incorrect usage. Modifiers that do not return a value can not be used incorrectly.
ProgramAPI - controls or obtains general characteristics of the SDM, and provides access to:
MouseModeAPI - controls how the mouse behaves in SDM views, and obtains information about user actions with the mouse.
ViewMngrAPI - manages and provides access to a collection of
ViewAPIs - controls or obtains the characteristics of a view (a window displaying a map), and provides access to the view's:
OverviewAPI - controls the characteristics of (optional) overview window (small, child window within each view) that always shows the entire map.
MapAPI - controls or obtains the characteristics of the map displayed in the view, and provides access to the map's:
LayerAPIs- controls or obtains the characteristics of a data layer within the map.
FeatureAPI - manages the color, visibility, and disposal of transient features (temporary features added to the map by the client), and provides access to the type-specific transient feature APIs: PointAPI, LineAPI, ShapeAPI, TextAPI, and ImageAPI, which allow the client to add and modify features of the each type, respectively.
Migration note for v2.5 developers: for those migrating a client from SICOM v2.5 to v3.2, a complete correspondence between v2.5 and v3.2 methods is provided by the Quick Start Cross-Reference.