[4053] | 1 | ================================================================================ |
---|
| 2 | ================================================================================ |
---|
| 3 | Protocol for geovis render server. |
---|
| 4 | |
---|
[4350] | 5 | Commands take the general form of command and arguments using Tcl syntax and are |
---|
[4053] | 6 | terminated by a newline. Some command arguments expect a Tcl list which can be |
---|
| 7 | sent by enclosing the list in curly braces to prevent the interpreter from |
---|
| 8 | splitting the list into multiple arguments. Likewise, strings with spaces |
---|
| 9 | should be quoted or enclosed in curly braces. In the documentation below, |
---|
| 10 | arguments are indicated by angle brackets and optional arguments are surrounded |
---|
| 11 | by question marks -- the brackets and question marks are not part of the |
---|
| 12 | protocol and should not be included in argument strings. The arguments shown |
---|
| 13 | in angle brackets should be replaced with a string (where there are fixed |
---|
| 14 | choices this document indicates valid values by separating them with pipe |
---|
| 15 | symbols), a list in Tcl syntax, or a numeric value. Boolean arguments can take |
---|
| 16 | the form of 0|1, true|false, or yes|no. Since the protocol commands are |
---|
| 17 | executed in a Tcl interpreter, Tcl code such as math expressions in expr |
---|
| 18 | commands enclosed in square brackets are also allowed. Since the interpreter |
---|
| 19 | is a "safe" interpreter, some Tcl commands that could cause security issues may |
---|
| 20 | not be available for use. |
---|
| 21 | |
---|
| 22 | When binary data is to be sent, it should follow the newline after a command |
---|
| 23 | that indicates incoming data including a byte count argument. |
---|
| 24 | ================================================================================ |
---|
| 25 | ================================================================================ |
---|
| 26 | Requests: |
---|
| 27 | ================================================================================ |
---|
| 28 | |
---|
[4350] | 29 | == General scene and renderer commands == |
---|
[4053] | 30 | |
---|
[4320] | 31 | camera delete <name> |
---|
| 32 | Delete named viewpoint |
---|
| 33 | camera dist <distance> |
---|
| 34 | Set camera distance from focal point |
---|
[5923] | 35 | camera extent <xmin> <ymin> <xmax> <ymax> <?duration?> <?srs?> |
---|
| 36 | Zoom to extent. Will fit the extent to the vertical FOV and center on |
---|
| 37 | the extent centroid. |
---|
| 38 | <xmin>,<ymin>,<xmax>,<ymax> = extent bounds in the specified SRS, |
---|
| 39 | or in the map's SRS if none is specified. |
---|
| 40 | <duration> = Duration of viewpoint move animation in seconds |
---|
| 41 | <srs> = The SRS of the extent bounds |
---|
[4320] | 42 | camera get |
---|
| 43 | Request camera parameters |
---|
[4333] | 44 | camera go <x> <y> <?zoomFactor?> <?duration?> |
---|
[4323] | 45 | Move camera to new focal point. |
---|
| 46 | <x>,<y> = Screen/mouse coordinates |
---|
[4333] | 47 | <zoomFactor> = Zoom distance multiplier, 1.0=no zoom |
---|
[4323] | 48 | <duration> = Duration of viewpoint move animation in seconds |
---|
[5923] | 49 | camera lextent <layerName> <?duration?> |
---|
| 50 | Zoom to layer extent. Will fit the extent to the vertical FOV and center |
---|
| 51 | on the extent centroid. |
---|
| 52 | <layerName> = Name of layer to use for extent. |
---|
| 53 | <duration> = Duration of viewpoint move animation in seconds |
---|
[4053] | 54 | camera orient <quatW> <quatX> <quatY> <quatZ> |
---|
| 55 | Set scene orientation using a quaternion |
---|
| 56 | camera pan <x> <y> |
---|
| 57 | <x,y> viewport coordinates (window center at 0,0). Positive x pan |
---|
| 58 | means pan object to right (camera to left). Positive y pan means |
---|
| 59 | pan object down (camera up). For example a pan of 0.5, 0.5 would |
---|
| 60 | move the object center to the lower right corner of the window |
---|
| 61 | camera reset <?all?> |
---|
| 62 | Option all resets orientation/rotation as well as pan/zoom/clip range |
---|
[4320] | 63 | camera restore <name> <?duration?> |
---|
[4350] | 64 | Set viewpoint to a named viewpoint, with optional animation duration in |
---|
| 65 | seconds |
---|
[4053] | 66 | camera rotate <x> <y> |
---|
| 67 | Specify relative rotation in viewport coordinates |
---|
[4320] | 68 | camera save <name> |
---|
| 69 | Save current viewpoint to a named viewpoint |
---|
| 70 | camera set <x> <y> <z> <heading> <pitch> <distance> <?duration?> <?srs?> <?vertDatum?> |
---|
[4350] | 71 | Explicitly set camera parameters, with optional animation duration in |
---|
| 72 | seconds |
---|
[4320] | 73 | <x>, <y> = Map coordinates of focal point |
---|
| 74 | <z> = Altitude of focal point (see vertDatum) |
---|
| 75 | <heading> = Azimuth in degrees |
---|
| 76 | <pitch> = Elevation in degrees |
---|
| 77 | <distance> = Distance of camera from focal point in map units(?) |
---|
| 78 | <srs> = coordinate system, defaults to map coordinate system |
---|
| 79 | <vertDatum> = vertical datum for interpreting z coordinate |
---|
[4350] | 80 | camera throw <bool> |
---|
| 81 | Enable/disable throw inertia for panning/rotating when using mouse events |
---|
| 82 | through protocol |
---|
[4320] | 83 | camera zoom <y> |
---|
| 84 | Specify zoom by viewport coordinates (i.e. normalized y mouse coords) |
---|
[4053] | 85 | |
---|
| 86 | clientinfo <list> |
---|
| 87 | |
---|
[5105] | 88 | colormap add <colorMapName> <colorMap> |
---|
[4350] | 89 | (Re-)define a colormap. If colorMapName doesn't exist, it is created, |
---|
| 90 | otherwise the colormap is redefined and all users will be updated. |
---|
[5105] | 91 | colorMap = Tcl list of {value r g b a} control points |
---|
| 92 | colormap define <colorMapName> <colorMap> |
---|
[4350] | 93 | (Re-)define a colormap (same as 'add') |
---|
| 94 | colormap delete <?colorMapName?> |
---|
| 95 | colormap res <numberOfTableEntries> |
---|
| 96 | Set the "resolution" or number of lookup table entries in the colormap |
---|
| 97 | <numberOfTableEntries> = integer or "default" |
---|
| 98 | |
---|
[5119] | 99 | legend <colormapName> <w> <h> <?opaque?> <?bgR?> <?bgG?> <?bgB?> |
---|
| 100 | Render a legend colorbar. |
---|
| 101 | <colormapName> - Name of the colormap defined with the colormap command |
---|
| 102 | <w>,<h> - width and height of colorbar |
---|
| 103 | <opaque> - If false, blend with background color |
---|
| 104 | <bgR>,<bgG>,<bgB> - Background color (defaults to black) |
---|
| 105 | |
---|
[4350] | 106 | renderer render |
---|
| 107 | Force a new image to be rendered |
---|
| 108 | |
---|
| 109 | screen bgcolor <r> <g> <b> |
---|
[4636] | 110 | screen coords <token> <coordList> <?srs?> <?verticalDatum?> |
---|
[4578] | 111 | Transate map coordinates to screen/mouse coordinates. |
---|
[4629] | 112 | <token> - String token, included in response |
---|
[4636] | 113 | <coordList> - A list of x,y,z map coordinates. If <srs> is not given, |
---|
| 114 | these are in the map's coordinate system. |
---|
[4578] | 115 | <srs> - Optional horizontal srs init string for coordinate system of |
---|
| 116 | x,y,z |
---|
| 117 | <verticalDatum> - Optional vertical srs init string for coordinate system |
---|
| 118 | of x,y,z |
---|
[4350] | 119 | screen size <width> <height> |
---|
| 120 | |
---|
| 121 | == Mouse and Keyboard Events == |
---|
| 122 | |
---|
[4320] | 123 | key press <key> |
---|
| 124 | key release <key> |
---|
| 125 | |
---|
[4053] | 126 | mouse click <button> <x> <y> |
---|
| 127 | mouse dblclick <button> <x> <y> |
---|
| 128 | mouse drag <button> <x> <y> |
---|
| 129 | mouse motion <x> <y> |
---|
| 130 | mouse release <button> <x> <y> |
---|
| 131 | mouse scroll <direction> |
---|
| 132 | |
---|
[5945] | 133 | == Interaction Configuration == |
---|
| 134 | |
---|
[5974] | 135 | placard config <attrlist> <style> <padding> <layerName> |
---|
| 136 | <attrlist> - List of attributes. The list should consist of alternating |
---|
| 137 | attribute names and attribute labels. The names are the column names of the |
---|
| 138 | attributes in the feature data and the corresponding labels will be |
---|
| 139 | displayed on the info placard |
---|
| 140 | <style> - CSS style attributes for TextSymbol and PolygonSymbol (fill for |
---|
| 141 | backing quad) |
---|
[5970] | 142 | <padding> - Pixels of padding between text and edge of backdrop quad. |
---|
[5945] | 143 | <layerName> - The name of the layer containing the feature data. |
---|
| 144 | |
---|
[6255] | 145 | placard enable <bool> <layerName> |
---|
| 146 | Enable/disable display of feature attribute placard on select. |
---|
| 147 | <layerName> - The name of the layer containing the feature data. |
---|
| 148 | |
---|
[6244] | 149 | select clear |
---|
| 150 | Clear any annotation or feature selection |
---|
| 151 | |
---|
| 152 | select fadd <featureIDList> <layerName> |
---|
| 153 | Add features to the selected set |
---|
| 154 | <featureIDList> - List of feature IDs to be selected. |
---|
| 155 | <layerName> - The name of the layer containing the feature data. |
---|
| 156 | |
---|
| 157 | select fdelete <featureIDList> <layerName> |
---|
| 158 | Remove features from the selected set |
---|
| 159 | <featureIDList> - List of feature IDs to be selected. |
---|
| 160 | <layerName> - The name of the layer containing the feature data. |
---|
| 161 | |
---|
[5980] | 162 | select feature <featureIDList> <layerName> |
---|
[6244] | 163 | Set/replace the set of currently selected features |
---|
[5980] | 164 | <featureIDList> - List of feature IDs to be selected. |
---|
| 165 | <layerName> - The name of the layer containing the feature data. |
---|
| 166 | |
---|
[6244] | 167 | select mode <mode> |
---|
| 168 | <mode> - boolean: Enable/disable click to select mode. |
---|
| 169 | |
---|
[4350] | 170 | == Map Commands == |
---|
[4053] | 171 | |
---|
[5026] | 172 | map attrib <string> |
---|
| 173 | <string> - Attribution/copyright to display in corner of map |
---|
| 174 | |
---|
[4636] | 175 | map coords <token> <coordList> <?srs?> <?verticalDatum?> |
---|
[4578] | 176 | Translate screen/mouse coordinates into map coordinates. |
---|
[4629] | 177 | <token> - String token, included in response |
---|
[4636] | 178 | <coordList> - A list of x,y screen/mouse coordinates |
---|
[4578] | 179 | <srs> - Optional horizontal srs init string for coordinate system to return |
---|
| 180 | <verticalDatum> - Optional vertical srs init string for coordinate system to |
---|
| 181 | return |
---|
[4320] | 182 | |
---|
[4350] | 183 | map grid <bool> <?type?> |
---|
| 184 | Toggle graticule and set type |
---|
| 185 | <type> = geodetic|utm|mgrs |
---|
| 186 | |
---|
[4246] | 187 | General form: |
---|
[5924] | 188 | map layer add <layerName> <type> <driver> <?url?> <?cache?> ... |
---|
[6512] | 189 | <type> = image|elevation|feature|icon|line|mask|model|point|polygon|text |
---|
[5958] | 190 | <driver> = arcgis|colorramp|db|debug|gdal|ogr|tfs|tms|wcs|wfs|wms|xyz |
---|
[5877] | 191 | <cache> = bool indicating if tiles should be cached on disk |
---|
[4282] | 192 | |
---|
[4350] | 193 | Specific image layer types: |
---|
[6350] | 194 | map layer add <layerName> image agglite <url> <cache> <coverage> <featuredriver> <format> <typeName> <styleLen> <?scriptLen?> <?selectorsLen?> |
---|
[5976] | 195 | Rasterize a feature source to an image layer using the AGGLite renderer |
---|
| 196 | <url> = URL of source |
---|
| 197 | <cache> = bool indicating if tiles should be cached on disk |
---|
| 198 | <coverage> = bool indicating if data should not be interpolated (true means |
---|
| 199 | no interpolation) |
---|
| 200 | <featuredriver> = Feature driver to read source (db, ogr, tfs, wfs) |
---|
| 201 | <format> = See Feature/model layers below |
---|
| 202 | <typeName> = See Feature/model layers below |
---|
[6350] | 203 | <styleLen> = See Feature/model layers below |
---|
| 204 | <scriptLen> = See Feature/model layers below |
---|
| 205 | <selectorsLen> = See Feature/model layers below |
---|
[5877] | 206 | map layer add <layerName> image colorramp <url> <cache> <coverage> <elevdriver> <profile> <colormapName> |
---|
[5107] | 207 | Add a colormapped image layer from a file or URL |
---|
| 208 | <url> = URL of source |
---|
| 209 | <cache> = bool indicating if tiles should be cached on disk |
---|
[5923] | 210 | <coverage> = bool indicating if data should not be interpolated (true means |
---|
| 211 | no interpolation) |
---|
[5107] | 212 | <elevdriver> = Elevation driver to read source |
---|
| 213 | <profile> = profile of source |
---|
| 214 | <colormapName> = Name of colormap |
---|
[5923] | 215 | map layer add <layerName> image arcgis <url> <?cache?> <?coverage?> <?token?> <?layers?> |
---|
| 216 | Add an ArcGIS MapServer image layer from a URL |
---|
| 217 | <url> = URL of source |
---|
| 218 | <cache> = bool indicating if tiles should be cached on disk |
---|
| 219 | <coverage> = bool indicating if data should not be interpolated (true means |
---|
| 220 | no interpolation) |
---|
| 221 | <token> = login credential |
---|
[5877] | 222 | map layer add <layerName> image gdal <url> <?cache?> <?coverage?> |
---|
[4053] | 223 | Add a GDAL image layer from a file or URL |
---|
[5923] | 224 | <url> = URL of source |
---|
| 225 | <cache> = bool indicating if tiles should be cached on disk |
---|
| 226 | <coverage> = bool indicating if data should not be interpolated (true means |
---|
| 227 | no interpolation) |
---|
[6549] | 228 | map layer add <layerName> image wms <url> <cache> <coverage> <layers> <format> <transparent> <?times?> <?frameSeconds?> |
---|
[4262] | 229 | Add a WMS image layer from a URL + layer string |
---|
[4246] | 230 | <url> = URL of WMS service |
---|
[5151] | 231 | <cache> = bool indicating if tiles may be cached on disk |
---|
[5923] | 232 | <coverage> = bool indicating if data should not be interpolated (true means |
---|
| 233 | no interpolation) |
---|
[4246] | 234 | <layers> = layers string for WMS server |
---|
| 235 | <format> = Image format to return (e.g. 'png') |
---|
| 236 | <transparent> = bool |
---|
[6549] | 237 | <times> = optional comma separated list of timestamps for WMS-T |
---|
| 238 | <frameSeconds> = time in seconds to display each animated frame for WMS-T |
---|
[5877] | 239 | map layer add <layerName> image tms <url> <cache> <coverage> |
---|
[4262] | 240 | Add a TMS image layer from a URL |
---|
| 241 | <url> = URL of TMS service |
---|
[4957] | 242 | <cache> = bool indicating if tiles should be cached on disk |
---|
[5923] | 243 | <coverage> = bool indicating if data should not be interpolated (true means |
---|
| 244 | no interpolation) |
---|
[5877] | 245 | map layer add <layerName> image xyz <urlPattern> <cache> <coverage> |
---|
[4350] | 246 | Add an image layer from a web map using a template URL |
---|
[5923] | 247 | <urlPattern> = URL template of source. '{x}', '{y}', '{z}' will be replaced |
---|
| 248 | with tile row (x), column (y) and zoom level (z). A block of characters in |
---|
| 249 | square braces can be used to specify round-robin server numbers, e.g. |
---|
| 250 | 'host[012]' will exand to 'host0', host1', 'host2'. |
---|
[4957] | 251 | <cache> = bool indicating if tiles should be cached on disk |
---|
[5923] | 252 | <coverage> = bool indicating if data should not be interpolated (true means |
---|
| 253 | no interpolation) |
---|
[4350] | 254 | |
---|
| 255 | Elevation layers: |
---|
[6489] | 256 | map layer add <layerName> elevation <driver> <url> <?cache?> <?verticalDatum?> |
---|
[4320] | 257 | Add an elevation image layer from a file or URL |
---|
[5940] | 258 | <driver> = gdal|tms|wcs |
---|
[6489] | 259 | <verticalDatum> = override vertical datum in file. This is required for |
---|
| 260 | the gdal driver if the vertical datum is a geoid (i.e. not geodetic HAE). |
---|
[4350] | 261 | |
---|
[6512] | 262 | Feature/model and mask layers: |
---|
[5873] | 263 | In the following: |
---|
[5958] | 264 | <driver> = db|ogr|tfs|wfs |
---|
[5974] | 265 | <url> = file/web service address, or for driver 'db' the postgis connection |
---|
| 266 | string |
---|
[5873] | 267 | <format> = json|gml (for tfs or wfs driver) |
---|
[5958] | 268 | <typeName> = layer name for db or wfs driver |
---|
[5877] | 269 | <clamping> = none|terrain|relative|absolute |
---|
| 270 | <clamptechnique> = drape|gpu|scene|map |
---|
[5873] | 271 | |
---|
[6518] | 272 | map layer add <layerName> feature <driver> <format> <typeName> <url> <cache> <styleLen> <?scriptLen?> <?selectorsLen?> <?terrainPatch?> <?visibilityRangeMin?> <?visibilityRangeMax?> |
---|
[6347] | 273 | Data payload follows command: style, then script, then selectors |
---|
| 274 | <styleLen> = Number of bytes in style sheet. Stylesheet payload consists of |
---|
| 275 | CSS-formatted styles (see: |
---|
[5974] | 276 | http://docs.osgearth.org/en/latest/user/features.html and |
---|
| 277 | http://docs.osgearth.org/en/latest/references/symbology.html) |
---|
[6347] | 278 | <scriptLen> = Number of bytes in scripts. Scripts payload consists of |
---|
| 279 | JavaScript code (see references above) |
---|
| 280 | <selectorsLen> = Number of bytes in selectors. Selectors payload consists |
---|
| 281 | of a Tcl list of name/value pairs |
---|
[6518] | 282 | <terrainPatch> = Boolean indicating if layer should be used for elevation |
---|
| 283 | queries. |
---|
[5877] | 284 | map layer add <layerName> icon <driver> <format> <typeName> <url> <cache> <icon> <scale> <heading> <declutter> <placement> <alignment> <?visibilityRangeMin?> <?visibilityRangeMax?> |
---|
[5873] | 285 | Add an icon feature layer from a file or URL |
---|
[5877] | 286 | <placement> = vertex|centroid|interval|random |
---|
| 287 | <alignment> = left_top|left_center|left_bottom|center_top|center_center|center_bottom|right_top|right_center|right_bottom |
---|
| 288 | map layer add <layerName> line <driver> <format> <typeName> <url> <cache> <r> <g> <b> <width> <?cap?> <?join?> <?stipplePattern?> <?stippleFactor?> <?clamping?> <?clamptechnique?> <?visibilityRangeMin?> <?visibilityRangeMax?> |
---|
| 289 | Add a line feature layer from a file or URL |
---|
| 290 | cap/join only used if width > 1 |
---|
| 291 | <cap> = flat|square|round |
---|
| 292 | <join> = mitre|round |
---|
| 293 | map layer add <layerName> point <driver> <format> <typeName> <url> <cache> <r> <g> <b> <size> <?clamping?> <?clamptechnique?> <?visibilityRangeMin?> <?visibilityRangeMax?> |
---|
[4246] | 294 | Add a point feature layer from a file or URL |
---|
[6524] | 295 | map layer add <layerName> polygon <driver> <format> <typeName> <url> <cache> <r> <g> <b> <?lineWidth?> <?strokeR?> <?strokeG?> <?strokeB?> <?clamping?> <?clamptechnique?> <?terrainPatch?> <?visibilityRangeMin?> <?visibilityRangeMax?> |
---|
[4246] | 296 | Add a polygon feature layer from a file or URL |
---|
[6564] | 297 | map layer add <layerName> text <driver> <format> <typeName> <url> <cache> <content> <priority> <fgR> <fgG> <fgB> <bgR> <bgG> <bgB> <haloWidth> <fontSize> <declutter> <alignment> <xoffset> <yoffset> <?visibilityRangeMin?> <?visibilityRangeMax?> |
---|
[4249] | 298 | Add a text symbol layer from a file or URL |
---|
[5877] | 299 | <alignment> = left_top|left_center|left_bottom|center_top|center_center|center_bottom|right_top|right_center|right_bottom|left_baseline|center|baseline|right_baseline|left_bottom_baseline|center_bottom_baseline|right_bottom_baseline |
---|
[4246] | 300 | |
---|
[6512] | 301 | map layer add <layerName> mask <driver> <format> <typeName> <url> <?minLOD?> |
---|
| 302 | Create a terrain mask layer to cut a hole in the terrain geometry. The |
---|
| 303 | first feature found is assumed to be a boundary polygon. |
---|
[6518] | 304 | <driver> = db|ogr|tfs|wfs|wkt|wkt_file |
---|
[6512] | 305 | <minLOD> minimum LOD to at which to apply the mask, defaults to 0. |
---|
[6518] | 306 | map layer add <layerName> mask wkt <format> <typeName> <length> <?minLOD?> |
---|
| 307 | Like generic mask layer command, but instead of a <url>, included data in |
---|
| 308 | the payload which is a WKT literal string. |
---|
| 309 | <format> and <typeName> are unused |
---|
| 310 | <length> = length of following data for inline WKT string |
---|
| 311 | map layer add <layerName> mask wkt_file <format> <typeName> <url> <?minLOD?> |
---|
| 312 | <url> = URL for a text file containing a WKT string |
---|
| 313 | <format> and <typeName> are unused |
---|
[6512] | 314 | |
---|
[6518] | 315 | map layer add <layerName> model simple <url> <x> <y> <?z?> <?rotx?> <?roty?> <?rotz?> <?terrainPatch?> |
---|
[6496] | 316 | <url> = Path to a 3D model file that OSG can load (e.g. .osg file) |
---|
| 317 | <x>,<y>,<z> = Map coordinates for placing the model |
---|
[6518] | 318 | <rotx>,<roty>,<rotz> = Rotations (in degrees) to apply to orient model |
---|
| 319 | <terrainPatch> = boolean indicating if model should be used for elevation |
---|
| 320 | queries. |
---|
[6496] | 321 | |
---|
[4053] | 322 | map layer delete <layerName> |
---|
| 323 | map layer opacity <opacity> <layerName> |
---|
| 324 | map layer move <pos> <layerName> |
---|
[6512] | 325 | map layer names <?type?> |
---|
| 326 | Generates a response listing the names of the given type (or all types if |
---|
| 327 | not specified) |
---|
| 328 | <type> = elevation|image|mask|model |
---|
[4053] | 329 | map layer visible <bool> <layerName> |
---|
[4350] | 330 | |
---|
[4053] | 331 | map load data follows <nbytes> |
---|
| 332 | Send an .earth file over the wire |
---|
| 333 | map load file <path> |
---|
| 334 | Load an .earth file from a filesystem mounted on the server |
---|
| 335 | map load url <url> |
---|
| 336 | Load an .earth file from a network address |
---|
[4350] | 337 | |
---|
| 338 | map posdisp <bool> <?format?> <?precision?> |
---|
| 339 | Toggle coordinate/position display, set format and precision |
---|
| 340 | <format> = latlong_decimal_degrees|latlong_degrees_decimal_minutes| |
---|
| 341 | latlong_degrees_minutes_seconds|mgrs |
---|
| 342 | <precision> = integer number of digits to display |
---|
| 343 | |
---|
[5107] | 344 | map reset <type> <r> <g> <b> <?profile?> <?xmin?> <?ymin?> <?xmax?> <?ymax?> |
---|
[4262] | 345 | Clear the scene and rebuild a new map from scratch. When resetting the |
---|
| 346 | map to geocentric, a profile and extents should be omitted. When the map |
---|
| 347 | type is projected, the profile is required and extents are optional. |
---|
[5107] | 348 | <type> = geocentric|projected |
---|
| 349 | <r>,<g>,<b> - Background color red, green and blue components [0,1] |
---|
| 350 | <profile> = Well known profile string, e.g. 'global-geodetic', |
---|
[4262] | 351 | 'global-mercator'. If specifying bounds (i.e. not global), use 'geodetic' |
---|
| 352 | or 'spherical-mercator' or an SRS init string (such as an EPSG code) |
---|
[4246] | 353 | xmin,ymin,xmax,ymax = map bounds (in profile projection/units) |
---|
[4053] | 354 | |
---|
[4350] | 355 | map scalebar <bool> <?units?> |
---|
| 356 | Toggle scale label/bar |
---|
| 357 | <units> = meters|feet|us_survey_feet|nautical_miles |
---|
| 358 | map setpos <x> <y> |
---|
| 359 | Set the coordinate/position display based on mouse coordinates |
---|
| 360 | map terrain edges <bool> |
---|
| 361 | *Not currently implemented* |
---|
| 362 | map terrain lighting <bool> |
---|
| 363 | map terrain linecolor <r> <g> <b> |
---|
| 364 | *Not currently implemented* |
---|
| 365 | map terrain vertscale <val> |
---|
| 366 | Set scale factor for terrain height |
---|
| 367 | map terrain wireframe <bool> |
---|
[4973] | 368 | map time <?hours?> <?day?> <?month?> <?year?> |
---|
| 369 | Set ephemeris time for sky. When args are omitted, set to current time. |
---|
[4976] | 370 | Time is interpreted as UTC. |
---|
[4350] | 371 | |
---|
[4053] | 372 | ================================================================================ |
---|
| 373 | Replies: |
---|
| 374 | ================================================================================ |
---|
| 375 | nv>image -type image -bytes <nbytes> |
---|
| 376 | <binary RGB data> |
---|
[5105] | 377 | nv>legend <colormapName> <rmin> <rmax> <nbytes> |
---|
| 378 | <binary RGB data> |
---|
[4636] | 379 | nv>map coords <token> <mapCoordList> <?srs?> <?verticalDatum?> |
---|
| 380 | Reply to query of map coordinates from screen coordinates. The mapCoordList |
---|
| 381 | is a list of x,y,z map coordinates. The srs of the map coordinates may be |
---|
| 382 | included if not in map's native coordinate system. NaN in the results |
---|
| 383 | indicates off-map input coordinates. |
---|
[6512] | 384 | nv> map names <list> |
---|
| 385 | Reply to query of layer names. <list> is a Tcl formatted list. |
---|
[4636] | 386 | nv>screen coords <token> <screenCoordList> |
---|
| 387 | Reply to query of screen coordinates from map coordinates. The |
---|
| 388 | screenCoordList is a list of x,y,z screen coordinates (z is the depth). NaN |
---|
| 389 | in the results indicates a point outside the view frustum or invalid input |
---|
| 390 | map coordinate |
---|
[5980] | 391 | nv>select annotation <guid> <annotationName> |
---|
| 392 | nv>select clear |
---|
| 393 | nv>select feature <guid> <featureIDList> <numFeatures> <layerName> |
---|
[6276] | 394 | nv>select region <xmin> <ymin> <xmax> <ymax> |
---|
[4053] | 395 | nv>ok -token <seqnum> |
---|
[4629] | 396 | Reply indicated commands through <seqnum> (numbered beginning at 0) have been |
---|
[4053] | 397 | processed, but no new image was rendered |
---|
| 398 | ================================================================================ |
---|
| 399 | Error Replies: |
---|
| 400 | ================================================================================ |
---|
| 401 | nv>viserror -bytes <nbytes> |
---|
| 402 | <multi-line error string of nbytes> |
---|
| 403 | ================================================================================ |
---|