Listing of GISDK Functions

GISDK function names are not case sensitive. The listing for each GISDK function contains the following sections:

Section	Contents
Summary	A concise summary of the GISDK function
Changes	A description of how the function has changed in this version
Syntax	The syntax for using the GISDK function and a description of all arguments
Return Value	The type and contents of any values returned by the GISDK function
Notes	Information you need to make use of the GISDK function effectively
Example	Sample Caliper Script code that makes use of the GISDK function
Error Codes	A listing of errors that the GISDK function may signal
See Also	Cross-references to related GISDK functions that may be of interest

Note that sections are omitted if they are not relevant. For example, the Return Value section is omitted for those GISDK functions that do not return a value.

Also note that the Changes sections only show more recent changes. Earlier changes have been removed, and most changes (such as adding a new function or adding an option to an existing function) will not affect compiling or running functions. Please contact Tech Support if you encounter problems with old code that is not compiling or running properly under the latest version.

Most examples can be copied and pasted into the Immediate Execution dialog box, which you display by clicking $image\ebx_1052477643.gif$ on the GISDK toolbar. For more information, see Compiling and Testing with the GISDK Toolbar. Some of these examples have comments about what you need to do before running the example. Other examples are just illustrative, using fictitious file names, such as C:\MYFIRST.WRKZ.

The following GISDK functions were added to Versions 2016 through 2024:

GISDK Function	Summary
AddMSSQLLayer()	Add layer to map after exporting it to MSSQL spatial database
AddMSSQLLayerToWorkspace()	Add layer to current workspace after exporting it to MSSQL spatial database
ArrayIntersect()	Creates an array that contains the elements of the array a that are also in array b
ArrayToJson()	Converts an options array to a proper JSON literal object
CompactPath()	Shortens a file's pathname to the listed length for purposes of display
CreateHullDB()	Creates an area or a line DBD database based on a TIN
Deserialize()	Deserializes an options array into a GISDK object
ExportSheetsToExcelX()	Export multiple views to an ExcelX file.
ExportMSSQL()	Export map data to MSSQL spatial database
SetDisplayUnits()	Set the display names for units, to be used in drop-down lists and legends
GetAbsolutePath()	Converts a relative pathname to an absolute pathname
GetAreaUnitNames()	Gets a list of the available area measurement units
GetAreaUnits()	Gets the current area measurement units
GetDistances()	Computes distances and statistics from each point in a set of origins to each point in a set of destinations
GetFeatureArea()	Returns the area of the feature in current map units
GetFeatureLength()	Returns the length of the feature in current map units
GetFieldSets()	Gets the field sets for a Standard Caliper Geographic file
GetImageLayerOptions()	Gets the display and interpolation specifications of an image layer
GetNumberOfPolygons()	Gets the number of polygons in an area feature
GetRandFileName()	Generates a valid and unused file name with a given specification, but does not delete such files on shutdown
GetRelativePath()	Converts an absolute pathname to a relative pathname
ImportKML()	Imports features from one or more KML files into a geographic file
IsPathAbsolute()	Tests to see if the pathname is an absolute pathname
JsonToArray()	Converts a proper JSON literal object to an options array
MoransI()	Computes statistics for Moran's I, a measure of spatial autocorrelation
RandSamples()	Return an array of random samples of the given type of random distribution and parameters defined in the options array
SearchFilePath()	Searches for the path for a filename
Serialize()	Serializes a GISDK object into an options array
SetAreaUnits()	Sets the current area measurement units
SelectByLinks()	Selects links based on a set of nodes from its associated node layer.
SelectByNodes()	Selects records based on an SQL query that is stored in a file.
SetCancelButton()	Sets the Cancel button for the dialog box
SetDefaultButton()	Sets the Default button for the dialog box
SetFieldSets()	Sets the field sets for a Standard Caliper Geographic file
SetImageLayerOptions()	Sets the display and interpolation specifications of an image layer
SnapPointsToArea()	Produces a new point database where the points are all moved into or out of polygons in an area layer.
SubstituteChars()	Returns the input string with all occurrences of the characters listed in the find string replaced with the characters in the replacement string
TaskDialog()	Creates an enhanced version of a standard Windows MessageBox

The following GISDK Classes were added for 2020:

GISDK Class	Summary
AddTables	Opens, joins and adds table(s) to a workspace.
AddDBLayers	Opens and adds a layer to a workspace.
CC.Table	Creates a table.
CC.odifyTableOperation	Provides methods to modify a table.
Caliper.Charts	Creates charts and graphics
DeSelectAnnotation()	Deselects an annotation
DeSelectAllAnnotations()	Deselects all annotations
FindAnnotations()	Finds annotations near a coordinate
Utilities.Mail	Send mails
Routing.Router	Optimiize a route over mutliple stops points
Routing.Path	Handles the result of an optimized path
Routing.Bands	Creates drive time and drive distance polygons

The following GISDK functions were changed for Version 2016 through 2024:

GISDK Function	Summary
AddAnnotation()	Adds an annotation to a map or layout window
CalculateTables	Deprecated in Maptitude 2023
CloseDbox()	Closes a toolbox or toolbar
CreateChartTheme()	Creates a pie or bar chart theme on the current layer
CreateSet()	Creates a new, empty set on the current view
CreateTable()	Creates an empty table and opens it as a viewselectbynod
ExportTableTranslation()	Creates a new table containing the codes and values from an existing translation table
ExportView()	Exports the contents of a view to a new table
GetDataVector()	Creates a vector from a field in a view\|set
GetDataVectors()	Creates vectors from fields in a view\|set
GetLayerNames()	Gets a list of all layers in the system
GetLayers()	Gets information on layers in the system and the current layer
GetMapUnitNames()	Gets a list of the available map measurement units
GetMapUnits()	Gets the current map measurement units
GetPaperUnitNames()	Gets a list of the available paper measurement units
GetPaperUnits()	Gets the current paper measurement unit
GetPointOnLine()	Returns the coordinate along a line at a given position
GetProgram()	Gets information about the program
GetTheme()	Gets information about a theme
LaunchProgram()	Starts a Windows program
LoadArray()	Loads an array from a file
OpenTable()	Opens a table from a file on disk and creates a view
SaveArray()	Saves an array to a file
SelectAll()	Selects all the records in the current view
SelectNone()	Removes all records from a selection set
SelectByQuery()	Selects records based on an SQL query
SetDefaults()	Sets default menus, toolbars, and macros
SetDisplayUnits()	Set the display names for units, to be used in drop-down lists and legends
SetMapUnits()	Sets the current map measurement units
SetPaperUnits()	Sets the current paper measurement unit
SetRecordsValues()	Writes a value or sequence of numbers into a range of cells in a view on a table

The following functions for manual labels are still available but will now do nothing if called:

GISDK Function	Summary
ConvertAutomaticToManualLabels()	Converts all the automatic labels on all layers and sets in a map into manual labels, i.e., text annotations at the same location and size
GetManualLabelOptions()	Gets the manual label settings for a layer
GetMapLabelOptions()	Gets the automatic label option settings for a map
SetManualLabels()	Changes the manual label settings for a layer
SetMapLabelOptions()	Controls whether automatic labels on a map can overlap