Properties Methods Events Direct Link

User

Class User (Wiki Page)

Defined In:	user.js
Class:	User
Extends:

Public Properties

Property		Defined By
	color : String (Wiki Page) Color assigned to this user's submissions... Color assigned to this user's submissions	User User
	drawing_way : Boolean (Wiki Page) Whether the user is in the process of drawing a way... Whether the user is in the process of drawing a way	User User
	follow_interval : Number (Wiki Page) How often the user's location is updated when following... How often the user's location is updated when following	User User
	following : Boolean (Wiki Page) Whether we are following the user, like a creepy stalker... Whether we are following the user, like a creepy stalker	User User
	following_executer : PeriodicalExecuter (Wiki Page) The PeriodicalExecuter that is responsible for updating the user's location... The PeriodicalExecuter that is responsible for updating the user's location	User User
	lat : Number (Wiki Page) Latitude of the user, from geolocation... Latitude of the user, from geolocation	User User
	line_width : Number (Wiki Page) Width of user-submitted lines... Width of user-submitted lines	User User
	loaded_node_ids : String[] (Wiki Page) Ids of user-submitted nodes that have already been loaded... Ids of user-submitted nodes that have already been loaded	User User
	lon : Number (Wiki Page) Longitude of the user, from geolocation... Longitude of the user, from geolocation	User User
	name : String (Wiki Page) Name of the user... Name of the user	User User
	node_radius : Number (Wiki Page) Radius of user-submitted nodes... Radius of user-submitted nodes	User User
	node_submit_uri : String (Wiki Page) URI to submit nodes to... URI to submit nodes to	User User
	node_updates_uri : String (Wiki Page) URI to get updated nodes from... URI to get updated nodes from	User User
	way_submit_uri : String (Wiki Page) URI to submit nodes to... URI to submit nodes to	User User
	way_update_uri : String (Wiki Page) URI to get way updates from... URI to get way updates from	User User
	x : Number (Wiki Page) X-coordinate of the user, from geolocation... X-coordinate of the user, from geolocation	User User
	y : Number (Wiki Page) Y-coordinate of the user, from geolocation... Y-coordinate of the user, from geolocation	User User

Public Methods

Method		Defined By
	add_node( `[Number x], [Number y]` ) : void (Wiki Page) Adds a node to the way that is currently being drawn... Adds a node to the way that is currently being drawn Parameters: `x` : Number (optional) X-coordinate of node to add `y` : Number (optional) Y-coordinate of node to add Returns: void	User User
	calculate_coords( ) : void (Wiki Page) Calculates the user's x and y based on the user's lon and lat... Calculates the user's x and y based on the user's lon and lat Parameters: Returns: void	User User
	center_map_on_user( ) : void (Wiki Page) Updates the user's location with geolocation and moves the map to be centered on the user.... Updates the user's location with geolocation and moves the map to be centered on the user. Parameters: Returns: void	User User
	create_node( `[Number x], [Number y], [Boolean draw], [String id]` ) : Node (Wiki Page) Creates a node... Creates a node Parameters: `x` : Number (optional) X-coordinate of node. Defaults to User.x `y` : Number (optional) Y-coordinate of node. Defaults to User.y `draw` : Boolean (optional) Whether this node should be drawn on the canvas. Defaults to false. If this is ture, the node is registered with Geohash. `id` : String (optional) Id of the node. Defaults to a random number below 1000000000 prefixed with "temp_" Returns: Node The created node	User User
	geolocate( ) : void (Wiki Page) Geolocates the user. Geolocation is asynchronous. Location is available as User.lat and User.lon once the asynchronous r... Geolocates the user. Geolocation is asynchronous. Location is available as User.lat and User.lon once the asynchronous request has completed. Returns true if geolocaion is supported by the user agent, else returns false. Parameters: Returns: void	User User
	init( ) : void (Wiki Page) Loads User-submitted data and sets up the periodical updater to reload data. Bound to cartagen:postinit... Loads User-submitted data and sets up the periodical updater to reload data. Bound to cartagen:postinit Parameters: Returns: void	User User
	mark( ) : void (Wiki Page) Draws a small circle of desired color centered on the user's latitude and longitude.... Draws a small circle of desired color centered on the user's latitude and longitude. Parameters: Returns: void	User User
	set_loc( `Location loc` ) : void (Wiki Page) Sets the user's location... Sets the user's location Parameters: `loc` : Location The Loction object passed by navigator.geolocation Returns: void	User User
	set_loc_and_center( `Location loc` ) : void (Wiki Page) Sets the user's location and centers the map on the new location... Sets the user's location and centers the map on the new location Parameters: `loc` : Location Location object from navigator.geolocation Returns: void	User User
	submit_node( `[Object x], [Object y]` ) : void (Wiki Page) Creates and submits a node to the server. The node is set to be drawn in each frame, and sets the id of the node to the ... Creates and submits a node to the server. The node is set to be drawn in each frame, and sets the id of the node to the server-generated id, prefixed with "cartagen_". Parameters: `x` : Object (optional) X-coordinate of the node. Defaults to user's x. `y` : Object (optional) Y-coordinate of the node. Defaults to user's y. Returns: void	User User
	submit_way( `Way way` ) : void (Wiki Page) Submits a way to the server and updates its id to the server-generated id, prefixed with "cartagen_"... Submits a way to the server and updates its id to the server-generated id, prefixed with "cartagen_" Parameters: `way` : Way Way to submit Returns: void	User User
	toggle_following( ) : void (Wiki Page) Toggles whether the map follows the user.... Toggles whether the map follows the user. Parameters: Returns: void	User User
	toggle_way_drawing( `[Number x], [Number y]` ) : void (Wiki Page) Toggles whether the user is drawing a way. When ending a way, submits the way to the server and updates the way's id to ... Toggles whether the user is drawing a way. When ending a way, submits the way to the server and updates the way's id to the server-generated id, prefixed with "cartagen_". When starting a way, the way is created with a node at the user's current position. Parameters: `x` : Number (optional) X-coordinate of the start or end node. Defaults to user's x. `y` : Number (optional) Y-coordinate of the start or end node. Defaults to user's y. Returns: void	User User
	update( ) : void (Wiki Page) Updates the map with other users' nodes and ways... Updates the map with other users' nodes and ways Parameters: Returns: void	User User

Public Events

This class has no events

Event		Defined By