Context Navigation

Changes between Version 13 and Version 14 of Help/RemoteControlCommands

Timestamp:: 2020-06-09T14:31:35+02:00 (4 years ago)
Author:: skyper
Comment:: add info about new_layer #19308; center one table column

Legend:

: Unmodified
: Added
: Removed
: Modified

Help/RemoteControlCommands

-              v13
+              v14
 == List of Commands ==
 A complete list of commands and mandatory/optional parameters is shown at http://127.0.0.1:8111/ (when JOSM is running).
 …
 }}}
 where
+||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
+|| `bottom` || R || Minimum latitude ||
+|| `top` || R || Maximum latitude ||
+|| `left` || R || Minimum longitude ||
+|| `right` || R || Maximum longitude ||
+|| `new_layer` || O || If '''true''', downloads to a new layer ||
+|| `layer_name` || O || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
+|| `layer_locked` || O || Only valid when the data is loaded in a new layer; If '''true''', new layer is [[Action/LockedLayer|locked]] ||
+|| `download_policy` || O || Only valid when the data is loaded in a new layer; If '''never''' , download is [[Help/Action/BlockDownload|blocked]] ||
+|| `upload_policy` || O || Only valid when the data is loaded in a new layer; If '''never''' or '''false''', upload is [[Help/Action/EncourageDiscourageUpload|blocked or discouraged]] ||
+|| `addtags` || O || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+|| `select` || O || Comma-separated list of objects that should be selected. Object specifiers are combinations of the words "way", "node", or "relation", and the numerical object id. Example: {{{select=way38473,node12399,node54646}}}. Since r13212 the special value **currentselection** let JOSM keep its previous selection. ||
+|| `zoom_mode` || O || '''download''' | '''selection''', defaults to selection ||
+|| `changeset_comment` || O || Comment of the changeset ||
+|| `changeset_source` || O || Source of the changeset ||
+|| `changeset_hashtags` || O || Hashtags of the changeset (since r13109) ||
+|| `changeset_tags` || O || Optional parameter to add changeset tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". This command uses the same syntax as the [#addtags addtags] parameter. `changeset_comment` and `changeset_source` currently override the `comment` and `source` tags passed in this parameter, but this may change in the future. First available in r15316. ||
+|| `search` || O || Search objects in the current data layer. See [wiki:/Help/Action/Search Search] ||
+==== Example ====
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `bottom` ||  R  || Minimum latitude ||
+|| `top` ||  R  || Maximum latitude ||
+|| `left` ||  R  || Minimum longitude ||
+|| `right` ||  R  || Maximum longitude ||
+|| `new_layer` ||  O  || If '''true''', downloads to a new layer. (Overwrites user preference, see #19308) ||
+|| `layer_name` ||  O  || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
+|| `layer_locked` ||  O  || Only valid when the data is loaded in a new layer; If '''true''', new layer is [[Action/LockedLayer|locked]] ||
+|| `download_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' , download is [[Help/Action/BlockDownload|blocked]] ||
+|| `upload_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' or '''false''', upload is [[Help/Action/EncourageDiscourageUpload|blocked or discouraged]] ||
+|| `addtags` ||  O  || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+|| `select` ||  O  || Comma-separated list of objects that should be selected. Object specifiers are combinations of the words "way", "node", or "relation", and the numerical object id. Example: {{{select=way38473,node12399,node54646}}}. Since r13212 the special value **currentselection** let JOSM keep its previous selection. ||
+|| `zoom_mode` ||  O  || '''download''' | '''selection''', defaults to selection ||
+|| `changeset_comment` ||  O  || Comment of the changeset ||
+|| `changeset_source` ||  O  || Source of the changeset ||
+|| `changeset_hashtags` ||  O  || Hashtags of the changeset (since r13109) ||
+|| `changeset_tags` ||  O  || Optional parameter to add changeset tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". This command uses the same syntax as the [#addtags addtags] parameter. `changeset_comment` and `changeset_source` currently override the `comment` and `source` tags passed in this parameter, but this may change in the future. First available in r15316. ||
+|| `search` ||  O  || Search objects in the current data layer. See [wiki:/Help/Action/Search Search] ||
+==== Example ====
 Start JOSM (don't forget to enable the !RemoteControl feature), then click on:
 …
 JOSM should now load an area in the German Schwarzwald and have the specified node selected.
 === {{{zoom}}} ===
 …
 **Hint**: This command can also be used to select objects only. Just enter a small arbitrary area to the left..bottom entries and add the object list to the select= option.
 === {{{import}}} ===
 Instructs JOSM to download the specified OSM file and add it to the current data set.
 …
 }}}
 where
 ||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
 || `url` || R || The Request URL, including patterns. Must be the last parameter, everything after "&url=" is interpreted as URL, even if it contains "&" characters. ||
 || `new_layer` || O || If '''true''', downloads to a new layer ||
 || `layer_name` || O || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
 || `layer_locked` || O || Only valid when the data is loaded in a new layer; If '''true''', new layer is [[Action/LockedLayer|locked]] ||
 || `download_policy` || O || Only valid when the data is loaded in a new layer; If '''never''' , download is [[Help/Action/BlockDownload|blocked]] ||
 || `upload_policy` || O || Only valid when the data is loaded in a new layer; If '''never''' or '''false''', upload is [[Help/Action/EncourageDiscourageUpload|blocked or discouraged]] ||
 || `changeset_tags` || O || Optional parameter to add changeset tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". This command uses the same syntax as the [#addtags addtags] parameter. First available in r16324. ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `url` ||  R  || The Request URL, including patterns. Must be the last parameter, everything after "&url=" is interpreted as URL, even if it contains "&" characters. ||
+|| `new_layer` ||  O  || If '''true''', downloads to a new layer. (Overwrites user preference, see #19308) ||
+|| `layer_name` ||  O  || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
+|| `layer_locked` ||  O  || Only valid when the data is loaded in a new layer; If '''true''', new layer is [[Action/LockedLayer|locked]] ||
+|| `download_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' , download is [[Help/Action/BlockDownload|blocked]] ||
+|| `upload_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' or '''false''', upload is [[Help/Action/EncourageDiscourageUpload|blocked or discouraged]] ||
+|| `changeset_tags` ||  O  || Optional parameter to add changeset tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". This command uses the same syntax as the [#addtags addtags] parameter. First available in r16324. ||
 === {{{load_data}}} ===
 …
 }}}
 where
 ||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
 || `data` || R || The XML data to load, this should be URL encoded in a way that also encodes the special characters &, = and ? to resp. %26, %3D and %3F. The JS [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeUriComponent()] method provides this functionality out of the box. ||
 || `new_layer` || O || Chose to load the data in a new layer ||
 || `mime_type` || O || Mime type of the data, by default this is "application/x-osm+xml", which is currently the only supported mime type, but in the future other mime types could be supported ||
 || `layer_name` || O || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
 || `layer_locked` || O || Only valid when the data is loaded in a new layer; If '''true''', new layer is [[Action/LockedLayer|locked]] ||
 || `download_policy` || O || Only valid when the data is loaded in a new layer; If '''never''' , download is [[Help/Action/BlockDownload|blocked]] ||
 || `upload_policy` || O || Only valid when the data is loaded in a new layer; If '''never''' or '''false''', upload is [[Help/Action/EncourageDiscourageUpload|blocked or discouraged]] ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `data` ||  R  || The XML data to load, this should be URL encoded in a way that also encodes the special characters &, = and ? to resp. %26, %3D and %3F. The JS [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent encodeUriComponent()] method provides this functionality out of the box. ||
+|| `new_layer` ||  O  || Choose to load the data in a new layer. (Overwrites user preference, see #19308) ||
+|| `mime_type` ||  O  || Mime type of the data, by default this is "application/x-osm+xml", which is currently the only supported mime type, but in the future other mime types could be supported ||
+|| `layer_name` ||  O  || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
+|| `layer_locked` ||  O  || Only valid when the data is loaded in a new layer; If '''true''', new layer is [[Action/LockedLayer|locked]] ||
+|| `download_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' , download is [[Help/Action/BlockDownload|blocked]] ||
+|| `upload_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' or '''false''', upload is [[Help/Action/EncourageDiscourageUpload|blocked or discouraged]] ||
 === {{{open_file }}} ===
 …
 }}}
 where
 ||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
 || `filename` || R || The local file to open in JOSM (Ie: /tmp/test.osm) ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `filename` ||  R  || The local file to open in JOSM (Ie: /tmp/test.osm) ||
 …
 }}}
 where
 ||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
 || `url` || R || The Request URL, including patterns. Must be the last parameter, everything after "&url=" is interpreted as URL, even if it contains "&" characters.  ||
 || `title` || O || The display name of the layer ||
 || `type` || O || Type of the layer. Possible values are `wms`, `tms` and `bing` [[BR]] (since !RemoteControl Version 1.3) ||
 || `cookies` || O ||  ||
 || `min_zoom` || O || The minimum zoom level [[BR]] (since !RemoteControl Version 1.4) ||
 || `max_zoom` || O || The maximum zoom level. For higher scales, the images of the maximum level is enlarged [[BR]] (since !RemoteControl Version 1.4) ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `url` ||  R  || The Request URL, including patterns. Must be the last parameter, everything after "&url=" is interpreted as URL, even if it contains "&" characters.  ||
+|| `title` ||  O  || The display name of the layer ||
+|| `type` ||  O  || Type of the layer. Possible values are `wms`, `tms` and `bing` [[BR]] (since !RemoteControl Version 1.3) ||
+|| `cookies` ||  O  ||  ||
+|| `min_zoom` ||  O  || The minimum zoom level [[BR]] (since !RemoteControl Version 1.4) ||
+|| `max_zoom` ||  O  || The maximum zoom level. For higher scales, the images of the maximum level is enlarged \\ (since !RemoteControl Version 1.4) ||
 …
 [http://localhost:8111/imagery?title=landsat&type=wms&url=http://irs.gis-lab.info/?layers=landsat&SRS=%7Bproj%7D&WIDTH=%7Bwidth%7D&HEIGHT=%7Bheight%7D&BBOX=%7Bbbox%7D]
 === {{{load_object}}} ===
 Instructs JOSM to download objects with a given id.
 {{{
 …
 }}}
 where
+||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
+|| `objects` || R || Comma separated list of object ids, e.g. "{{{n1234,n1235,w84,r958493}}}" ||
+|| `new_layer` || O || If '''true''', downloads to a new layer ||
+|| `addtags` || O || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+|| `relation_members` || O || If '''true''', downloads objects members of the relations as well. ||
+|| `referrers` || O || If '''true''', downloads referrers of the object as well. I.e. parent relations, and for nodes, additionally, parent ways. (since r6782) ||
+|| `layer_name` || O || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
+|| `layer_locked` || O || Only valid when the data is loaded in a new layer; If '''true''', new layer is [[Action/LockedLayer|locked]] ||
+|| `download_policy` || O || Only valid when the data is loaded in a new layer; If '''never''' , download is [[Help/Action/BlockDownload|blocked]] ||
+|| `upload_policy` || O || Only valid when the data is loaded in a new layer; If '''never''' or '''false''', upload is [[Help/Action/EncourageDiscourageUpload|blocked or discouraged]] ||
+==== Example ====
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `objects` ||  R  || Comma separated list of object ids, e.g. "{{{n1234,n1235,w84,r958493}}}" ||
+|| `new_layer` ||  O  || If '''true''', downloads to a new layer. (Overwrites user preference, see #19308) ||
+|| `addtags` ||  O  || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+|| `relation_members` ||  O  || If '''true''', downloads objects members of the relations as well. ||
+|| `referrers` ||  O  || If '''true''', downloads referrers of the object as well. I.e. parent relations, and for nodes, additionally, parent ways. (since r6782) ||
+|| `layer_name` ||  O  || Only valid when the data is loaded in a new layer; Gives JOSM a hint on how to name the layer ||
+|| `layer_locked` ||  O  || Only valid when the data is loaded in a new layer; If '''true''', new layer is [[Action/LockedLayer|locked]] ||
+|| `download_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' , download is [[Help/Action/BlockDownload|blocked]] ||
+|| `upload_policy` ||  O  || Only valid when the data is loaded in a new layer; If '''never''' or '''false''', upload is [[Help/Action/EncourageDiscourageUpload|blocked or discouraged]] ||
+==== Example ====
 [http://localhost:8111/load_object?new_layer=true&objects=w106159509]
 === {{{add_node}}} ===
 Instructs JOSM to create a new node at the given coordinates.
 …
 }}}
 where
 ||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
 || `lon` || R || The longitude of the node ||
 || `lat` || R || The latitude of the node ||
 || `addtags` since v1.5|| O || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `lon` ||  R  || The longitude of the node ||
+|| `lat` ||  R  || The latitude of the node ||
+|| `addtags` \\ ''(since v1.5)'' ||  O  || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
 ==== Example ====
 http://localhost:8111/add_node?lon=13.3&lat=53.2
 === {{{add_way}}} ===
 Instructs JOSM to create a new way with new way nodes at given coordinates.
 …
 }}}
 where
+||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
+|| `way` || R || Pairs of latitude, longitude coordinates separated by semicolon. ||
+|| `addtags` since v1.5|| O || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+==== Example ====
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `way` ||  R  || Pairs of latitude, longitude coordinates separated by semicolon. ||
+|| `addtags` ''(since v1.5)'' ||  O  || Optional parameter to add tags. The key and value is separated by "=" and multiple tags can be separated by a Pipe "|". See [#addtags details]. ||
+==== Example ====
 http://localhost:8111/add_way?way=53.2,13.3;53.3,13.3;53.3,13.2
 …
 === {{{version}}} ===
 This command returns the current protocol version of the installed !RemoteControl interface. Developers can use it to query for a running instance of JOSM and also determine whether the requested functionality is available in the client.
 {{{
 GET /version[?jsonp=callback]
 }}}
 where
 ||= **Parameter** =||= **Required/Optional** =||= **Meaning** =||
 || `jsonp` || O|| Jsonp callback for older browsers not implementing Cross-Origin Resource Sharing (CORS) ||
+||= **Parameter** =||= **Required/ \\ Optional** =||= **Meaning** =||
+|| `jsonp` ||  O  || Jsonp callback for older browsers not implementing Cross-Origin Resource Sharing (CORS) ||
 The command returns a json object containing an application identifier that is always "JOSM !RemoteControl", a major number and a minor number. Compatible protocol changes result in an increase of the minor number. Incompatible changes increase the major number. So a client application knowing of protocol version 1.0 can still talk to JOSM having 1.1. But it's not guaranteed to be working with 2.0. So the client should verify the major number.
 …
 ----
+Back to [[Help/Preferences/RemoteControl]][[br]]
+Back to [[Help/Preferences]][[br]]
+Back to [[Help]]
+Back to [wikitr:/Help/Preferences/RemoteControl Remote control preferences] \\
+Back to [wikitr:/Help/Preferences Preferences] \\
+Back to [wikitr:/Help Main Help]