Fusiondeclare global namespace object for Fusion library to use Summary | declare global namespace object for Fusion library to use | | A set of utility classes that provide common tools for applications | | A set of classes that implement the functionlity required for applications | | A class to provide for event handling at application runtime | | A set of classes to provide core funtionality | | A set of classes that implement layer functionality for various server technologies. | | Application scope constants | | | | Initialize the Fusion application. | | Initialize the Strings hash with the requested locale. | | set the current initialization state of the application. | | load any scripts that have been queued for loading. | | Insert a new script into the loading queue. | | Called when a script fails to load for some reason. | | | | check if scripts have loaded. | | asynchronously load the application definition. | | the server has returned the application configuration file that contains enough information to bootstrap the application. | | the server has returned the application configuration file that contains enough information to bootstrap the application. | | the application failed to load the application configuration file. | | convenience function to issue an XmlHttpRequest to the server relative to the Fusion installation. | | trap exceptions produced in handling an ajax response. | | Convert XML to JSON using a server-side script for requests that aren’t available in JSON. | | Callback method to convert the XNR response into an actual json object and triggers the call to the callback method | | return a map widget with the given name | | return a map widget that is associated with the given DOM element by id. | | return the map widget at the given index if there are more than one map elements specified in the AppDef | | return a reference to a widget by the id of the DOM Element that it was created in. | | returns the applicaiton’s absolute URL minus the filename.html part | | returns the application’s absolute URL minus the filename.html part | | returns individual elements out of the Fusion config.json file | | Accessor to return the server-side script language | | Accessor to return the URL of the redirect script | | Accessor to return the broker object (for MapGuide only). | | Marks a JavaScript file as required which puts it into the queue for loading during Fusion initialization. | | Triggers the Fusion.Event.FUSION_ERROR and passes along the error object to the callback functions registered for this event. | | returns index into the units array for the given unit name or abbreviation | | imperial, metric, degrees or device units | | Given a unit, this method returns the units name | | Given a unit, this method returns the units abbreviation | | Converts a length value from native units into meters. | | Converts a length value from meters into native units. | | Converts a length value from one unit system into another. | | initializes the meters per unit values when a new map is loaded. | | find the OpenLayers units identifier given the Fusion metersPerUnit value | | Dynamically load a CSS stylesheet. | | An initialization time function to parse the application URL parameters and stores them in an array. | | Returns the query parameter value for a given parameter name | | {String} Relative path of this script. | | Return the path to this script for bootstrapping Fusion. | | Pre-create a session to avoid the 401 Unauthorized dialog | | The OpenLayers object provides a namespace for all things OpenLayers | | | | {String} Relative path of this script. | | | | Return the path to this script. | | | | | | | | | | This is the old $() from prototype | | Remove an object from an array. | | | | Seems to exist already in FF, but not in MOZ. | | Modifies many properties of a DOM element all at once. | | Creates a new div and optionally set some standard attributes. | | Creates an img element with specific attribute values. | | | | Bound to image load events. | | {String} The color tiles with load errors will turn. | | {Integer} How many times should we try to reload an image before giving up? | | | | {Boolean} true if the png alpha hack is necessary and possible, false otherwise. | | Checks whether it’s necessary (and possible) to use the png alpha hack which allows alpha transparency for png images under Internet Explorer. | | | | | | Creates a new hashtable and copies over all the keys from the passed-in object, but storing them under an uppercased version of the key at which they were stored. | | Takes an object and copies any properties that don’t exist from another properties, by analogy with OpenLayers.Util.extend() from Prototype.js. | | | | | | {String} The fully formatted image location string | | Execute functions until one of them doesn’t throw an error. | | These could/should be made namespace aware? | | | | | | | | | | {Number} The number of significant digits to retain to avoid floating point precision errors. | | Convenience method to cast an object to a Number, rounded to the desired floating point precision. | | | | Given two objects representing points with geographic coordinates, this calculates the distance between those points on the surface of an ellipsoid. | | Parse the parameters from a URL or from the current page itself into a JavaScript Object. | | | | {Integer} The ever-incrementing count variable. | | Create a unique identifier for this session. | | | | | | {Integer} 72 (A sensible default) | | | | | | | | | | | | Calculates the position of an element on the page. | | Test two URLs for equivalence. | | | | Takes a url and removes everything after the ? | | {String} A string which specifies which is the current browser in which we are running. | | Renders the contentHTML offscreen to determine actual dimensions for popup sizing. | | The OpenLayers.Console namespace is used for debugging and error logging. | | | | OpenLayers custom string, number and function functions are described here. | | Contains convenience functions for string manipulation. | | | | Used to find tokens in a string. | | Used to test strings as numbers. | | Contains convenience functions for manipulating numbers. | | | | Decimal separator to use when formatting numbers. | | Thousands separator to use when formatting numbers. | | Contains convenience functions for function manipulation. | | Contains convenience functions for array manipulation. | | | | Base class used to construct all other classes. | | | | | | Instances of this class represent a width/height pair | | | | Create an instance of OpenLayers.Size | | Return the string representation of a size object | | Instances of this class represent bounding boxes. | | | | {Number} Minimum horizontal coordinate. | | {Number} Minimum vertical coordinate. | | {Number} Maximum horizontal coordinate. | | {Number} Maximum vertical coordinate. | | | | | | Construct a new bounds object. | | Create a cloned instance of this bounds. | | Test a two bounds for equivalence. | | Scales the bounds around a pixel or lonlat. | | Get the opposite quadrant for a given quadrant string. | | | | | | Tests if an element has the given CSS class name. | | Add a CSS class name to an element. | | Remove a CSS class name from an element. | | Remove a CSS class name from an element if it exists. | | This class represents a longitude and latitude pair | | | | Create a new map location. | | Return a readable string version of the lonlat | | | | This class represents a screen coordinate, in x and y coordinates | | | | Create a new OpenLayers.Pixel instance | | Cast this object into a string | | The icon represents a graphical icon on the screen. | | | | | | | | | | | | | | | | | | Creates an icon, which is an image tag in a div. | | Nullify references and remove event listeners to prevent circular references and memory leaks | | | | | | | | Move the div to the given pixel. | | Erase the underlying image element. | | Change the icon’s opacity | | move icon to passed in px. | | | | A popup is a small div that can opened and closed on the map. | | | | | | {String} the unique identifier assigned to this popup. | | | | {DOMElement} the div that contains this popup. | | | | | | {String} An HTML string for this popup to display. | | {String} the background color used by the popup. | | {float} the opacity of this popup (between 0.0 and 1.0) | | {String} the border size of the popup. | | {DOMElement} a reference to the element that holds the content of the div. | | {DOMElement} First and only child of ‘div’. | | {DOMElement} the optional closer image | | {String} The CSS class of the popup. | | {String} The CSS class of the popup content div. | | {int or OpenLayers.Bounds} An extra opportunity to specify internal padding of the content div inside the popup. | | {Boolean} The hack for overflow in Firefox causes all elements to be re-drawn, which causes Flash elements to be re-initialized, which is troublesome. | | To be removed in 3.0, this function merely helps us to deal with the case where the user may have set an integer value for padding, instead of an OpenLayers.Bounds object. | | { OpenLayers.Map} this gets set in Map.js when the popup is added to the map | | | | nullify references to prevent circular references and memory leaks | | Constructs the elements that make up the popup. | | if the popup has a lonlat and its map members set, then have it move itself to its proper position | | | | {Boolean} Boolean indicating whether or not the popup is visible | | Toggles visibility of the popup. | | | | Makes the popup invisible. | | Used to adjust the size of the popup. | | Sets the background color of the popup. | | Sets the opacity of the popup. | | Sets the border style of the popup. | | Allows the user to set the HTML content of the popup. | | Called when an image contained by the popup loaded. | | Glorious, oh glorious hack in order to determine the css ‘padding’ of the contentDiv. | | | | Pans the map such that the popup is totaly viewable (if necessary) | | Registers events on the popup. | | When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside) | | If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside) | | When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside | | Ignore clicks, but allowing default browser handling | | When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused. | | Ignore double-clicks, but allowing default browser handling | | Abstract vector layer protocol class. | | | | | | {Object} Any options sent to the constructor. | | {Boolean} The creator of the protocol can set autoDestroy to false to fully control when the protocol is destroyed. | | | | Abstract class for vector protocols. | | Abort an ongoing request. | | Protocols return Response objects to their users. | | | | | | {String} The type of request this response corresponds to. | | | | | | | | | | | | | | | | This is the base class for all renderers. | | | | | | | | | | {Boolean} If the renderer is currently in a state where many things are changing, the ‘locked’ property is set to true. | | | | {Float} cache of current map resolution | | { OpenLayers.Map} Reference to the map -- this is set in Vector’s setMap() | | | | | | Set the visible part of the layer. | | Sets the size of the drawing surface. | | Uses cached copy of resolution if available to minimize computing | | | | | | Function for drawing text labels. | | Function for removing text labels. | | Clear all vectors from the renderer. | | Returns a feature id from an event on the renderer. | | This is called by the layer to erase features | | Remove a geometry from the renderer (by id). | | moves this renderer’s root to a (different) renderer. | | Gets the layer that this renderer’s output appears on. | | Abstract vector layer strategy class. | | | | | | {Object} Any options sent to the constructor. | | {Boolean} The control is active. | | {Boolean} The creator of the strategy can set autoActivate to false to fully control when the protocol is activated and deactivated. | | {Boolean} The creator of the strategy can set autoDestroy to false to fully control when the strategy is destroyed. | | | | Abstract class for vector strategies. | | Called to set the layer property. | | | | | | Controls affect the display or behavior of the map. | | | | | | { OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map | | | | {OpenLayers.Control.TYPES} Controls can have a ‘type’. | | {Boolean} By deafault, controls do not allow selection, because it may interfere with map dragging. | | {string} This property is used for CSS related to the drawing of the Control. | | {string} This property is used for showing a tooltip over the Control. | | {Boolean} The control is active. | | | | | | | | {Array(String)} Supported application event types. | | | | Create an OpenLayers Control. | | The destroy method is used to perform any clean up before the control is dereferenced. | | Set the map property for the control. | | The draw method is called when the control is ready to be displayed on the page. | | Sets the left and top style attributes to the passed in pixel coordinates. | | Explicitly activates a control and it’s associated handler if one has been set. | | Deactivates a control and it’s associated handler if any. | | Internationalization namespace. | | | | {String} Current language code to use in OpenLayers. | | | | | | | | Since the popup is moving to a new px, it might need also to be moved relative to where the marker is. | | | | The popup has been moved to a new relative location, so we may want to make some cosmetic adjustments to it. | | | | A renderer based on the 2D ‘canvas’ drawing element.element | | | | {Canvas} The canvas context object. | | {Object} Internal object of feature/style pairs for use in redrawing the layer. | | {Object} Geometry -> Feature lookup table. | | | | | | Erase a geometry from the renderer. | | Set the visible part of the layer. | | Sets the size of the drawing surface. | | | | Used when looping (in redraw) over the features; draws the canvas. | | Called to draw External graphics. | | Prepare the canvas for drawing by setting various global settings. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | transform geographic xy into pixel xy | | Clear all vectors from the renderer. | | Returns a feature id from an event on the renderer. | | This is called by the layer to erase features; removes the feature from the list, then redraws the layer. | | The real ‘meat’ of the function: any time things have changed, redraw() can be called to loop over all the data and (you guessed it) redraw it. | | | | | | This class takes care of figuring out which order elements should be placed in the DOM based on given indexing methods. | | | | {Integer} This is the largest-most z-index value for a node contained within the indexer. | | {Array<String>} This is an array of node id’s stored in the order that they should show up on screen. | | {Object} This is a hash that maps node ids to their z-index value stored in the indexer. | | {Function} This is the function used to determine placement of of a new node within the indexer. | | | | Determine the z-index for the current node if there isn’t one, and set the maximum value if we’ve found a new maximum. | | These are the compare methods for figuring out where a new node should be placed within the indexer. | | | | This compare method is used by other comparison methods. | | This is another virtual class in that it should never be instantiated by itself as a Renderer. | | | | | | | | | | | | | | {<OpenLayers.ElementIndexer>} An instance of OpenLayers.ElementsIndexer created upon initialization if the zIndexing or yOrdering options passed to this renderer’s constructor are set to true. | | | | | | | | | | | | | | | | | | Remove all the elements from the root | | This function is in charge of asking the specific renderer which type of node to create for the given geometry and style. | | Draw the geometry, creating new nodes, setting paths, setting style, setting featureId on the node. | | | | Redraws the node using special ‘background’ style properties. | | Given a node, draw a geometry on the specified layer. | | Things that have do be done after the geometry node is appended to its parent node. | | Virtual function for drawing Point Geometry. | | Virtual function for drawing LineString Geometry. | | Virtual function for drawing LinearRing Geometry. | | Virtual function for drawing Polygon Geometry. | | Virtual function for drawing Rectangle Geometry. | | Virtual function for drawing Circle Geometry. | | Virtual function for drawing Surface Geometry. | | | | | | Erase a geometry from the renderer. | | Create new node of the specified type, with the (optional) specified id. | | | | | | moves this renderer’s root to a different renderer. | | Gets the layer that this renderer’s output appears on. | | Determines if a symbol cannot be rendered using drawCircle | | | | Coordinate arrays for well known (named) symbols. | | A simple strategy that requests features once and never requests new data. | | | | Create a new Fixed strategy. | | Activate the strategy: load data or add listener to load when visible | | | | Tells protocol to load data and unhooks the visibilitychanged event | | Add all features to the layer. | | | | | | {int} Interval in milliseconds between 2 steps | | | | | | {int} Interval id returned by window.setInterval | | {Boolean} Tells if the easing is currently playing | | | | | | Calls the appropriate easing method | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The ArgParser control adds location bar querystring parsing functionality to an OpenLayers Map. | | | | | | Set the map property for the control. | | As soon as a baseLayer has been loaded, we center and zoom ...and remove the handler. | | As soon as all the layers are loaded, cycle through them and hide or show them. | | The PanZoom is a visible control, composed of a <OpenLayers.Control.PanPanel> and a <OpenLayers.Control.ZoomPanel>. | | | | {Array(DOMElement)} Array of Button Divs | | | | | | | | | | | | | | | | | | | | | | | | | | The ScaleLine displays a small line indicator representing the current map scale on the map. | | | | {Integer} Maximum width of the scale line in pixels. | | {String} Units for zoomed out on top bar. | | {String} Units for zoomed in on top bar. | | {String} Units for zoomed out on bottom bar. | | {String} Units for zoomed in on bottom bar. | | | | | | | | Create a new scale line control. | | | | Given a number, round it down to the nearest 1,2,5 times a power of 10. | | Update the size of the bars, and the labels they contain. | | Utility functions for event handling. | | | | {Object} A hashtable cache of the event observers. | | | | | | | | | | | | | | | | | | | | | | | | Cross browser event element detection. | | Determine whether event was caused by a left click. | | Determine whether event was caused by a right mouse click. | | Stops an event from propagating. | | | | | | Given the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed. | | | | | | Cycle through all the element entries in the events cache and call stopObservingElement on each. | | | | | | {Array(String)} supported events | | | | {Object} Hashtable of Array(Function): events listener functions | | {Object} the code object issuing application events | | {DOMElement} the DOM element receiving browser events | | {Array(String)} list of support application events | | {Function} bound event handler attached to elements | | | | | | Construct an OpenLayers.Events object. | | | | Convenience method for registering listeners with a common scope. | | Convenience method for unregistering listeners with a common scope. | | Remove all listeners for a given event type. | | Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position. | | | | Base class for format reading/writing a variety of formats. | | | | {Object} A reference to options passed to the constructor. | | | | Instances of this class are not useful. | | Read data from a string, and return an object whose type depends on the subclass. | | Accept an object, and return a string. | | | | | | | | {Boolean} Has the popup been rounded yet? | | | | | | | | The popup has been moved to a new relative location, in which case we will want to re-do the rico corners. | | | | Update RICO corners according to the popup’s current relative postion. | | {String} The proper corners string (“tr tl bl br”) for rico to round. | | | | | | Class for coordinate transforms between coordinate systems. | | | | {Object} Proj4js.Proj instance. | | | | | | This class offers several methods for interacting with a wrapped pro4js projection object. | | Convert projection to string (getCode wrapper). | | Test equality of two projection instances. | | Destroy projection object. | | | | Transforms is an object, with from properties, each of which may have a to property. | | | | | | | | | | | | {Integer} Firefox has a limitation where values larger or smaller than about 15000 in an SVG document lock the browser up. | | | | {Object} Hash with “x” and “y” properties | | {Object} Cache for symbol sizes according to their svg coordinate space | | | | | | | | See #669 for more information | | | | Transforms the SVG coordinate system | | Sets the size of the drawing surface. | | | | Use to set all the style attributes to a SVG node. | | | | | | | | {DOMElement} The specific render engine’s root element | | | | {DOMElement} The element to which we’ll add the symbol definitions | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | | | Given two points (one inside the valid range, and one outside), clips the line betweeen the two points so that the new points are both inside the valid range. | | | | Finds the position of an svg node. | | add a new symbol definition from the rendererer’s symbol hash | | | | | | | | Render vector features in browsers with VML capability. | | | | {String} XML Namespace URN | | {DOMElement} node holding symbols. | | {Object} Hash with “x” and “y” properties | | | | Create a new VML renderer. | | Set the renderer’s extent | | Set the size of the drawing surface | | Get the node type for a geometry and style | | Use to set all the style attributes to a VML node. | | If a point is to be styled with externalGraphic and rotation, VML fills cannot be used to display the graphic, because rotation of graphic fills is not supported by the VML implementation of Internet Explorer. | | Some versions of Internet Explorer seem to be unable to set fillcolor and strokecolor to “none” correctly before the fill node is appended to a visible vml node. | | Get the geometry’s bounds, convert it to our vml coordinate system, then set the node’s position, size, and local coordinate system. | | | | | | Determine whether a node is of a given type | | | | Create the main root element | | | | | | | | | | | | | | | | This method is only called by the renderer itself. | | | | moves this renderer’s root to a different renderer. | | add a new symbol definition from the rendererer’s symbol hash | | | | | | This is a class designed to designate a single tile, however it is explicitly designed to do relatively little. | | | | {Array(String)} Supported application event types | | | | | | | | {String} url of the request. | | | | | | {Boolean} Is the tile loading? | | | | | | Call immediately before destroying if you are listening to tile events, so that counters are properly handled if tile is still loading at destroy-time. | | | | Clear whatever is currently in the tile, then return whether or not it should actually be re-drawn. | | | | Clear the tile of any bounds/position-related data so that it can be reused in a new location. | | Take the pixel locations of the corner of the tile, and pass them to the base layer and ask for the location of those pixels, so that displaying tiles over Google works fine. | | Show the tile only if it should be drawn. | | | | | | | | | | {Object} Mapping of namespace aliases to namespace URIs. | | {Object} Mapping of namespace URI to namespace alias. | | {String} The default namespace alias for creating element nodes. | | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. | | {XMLDom} If this browser uses ActiveX, this will be set to a XMLDOM object. | | | | | | Set a namespace alias and URI for the format. | | Shorthand for creating namespaced elements with optional attributes and child text nodes. | | Set multiple attributes given key value pairs from an object. | | Shorthand for applying one of the named readers given the node namespace and local name. | | Shorthand for applying the named readers to all children of a node. | | Shorthand for applying one of the named writers and appending the results to a node. | | Return this node or the next element node. | | Base class to construct a higher-level handler for event sequences. | | | | | | | | | | {Event} This property references the last event handled by the handler. | | | | | | | | Check the keyMask on the handler. | | Trigger the control’s named callback with the given arguments | | register an event on the map | | unregister an event from the map | | With each registered browser event, the handler sets its own evt property. | | | | | | If set as the <keyMask>, checkModifiers returns false if any key is down. | | If set as the <keyMask>, checkModifiers returns false if Shift is down. | | If set as the <keyMask>, checkModifiers returns false if Ctrl is down. | | | | Instances of OpenLayers.Map are interactive maps embedded in a web page. | | | | {Object} Base z-indexes for different classes of thing | | {Array(String)} Supported application event types. | | | | {String} Unique identifier for the map | | {Boolean} For a base layer that supports it, allow the map resolution to be set to a value between one of the values in the resolutions array. | | | | {Boolean} The map is currently being dragged. | | | | {HTMLDivElement} The element that represents the map viewport | | { OpenLayers.LonLat} The lonlat at which the later container was re-initialized (on-zoom) | | {HTMLDivElement} The element that contains the layers. | | | | | | | | {Float} The resolution of the map. | | {Integer} The current zoom level of the map | | {Float} The ratio of the current extent within which panning will tween. | | {String} Used to store a unique identifier that changes when the map view changes. | | {OpenLayers.Tween} Animated panning tween object, see panTo() | | {Integer} The number of steps to be passed to the OpenLayers.Tween.start() method when the map is panned. | | | | | | Constructor for a new OpenLayers.Map instance. | | Function that is called to destroy the map on page unload. | | When the map is destroyed, we need to stop listening to updateSize events: this method stores the function we need to unregister in non-IE browsers. | | | | Reset each layer’s z-index based on layer’s array index | | | | | | | | | | This function takes care to recenter the layerContainerDiv. | | | | | | | | | | | | {Integer} 256 Default tile width (unless otherwise specified) | | {Integer} 256 Default tile height (unless otherwise specified) | | | | | | | | | | | | | | | | | | Calls draw on the icon, and returns that output. | | Erases any drawn elements for this marker. | | Move the marker to the new location. | | {Boolean} Whether or not the marker is currently visible on screen. | | Englarges the markers icon by the specified ratio. | | Change the opacity of the marker by changin the opacity of its icon | | Change URL of the Icon Image. | | | | | | The OpenLayers.Request namespace contains convenience methods for working with XMLHttpRequests. | | | | {Object} Default configuration for all requests. | | Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers. | | | | {String} The URL of the image being requested. | | {DOMElement} The div element which wraps the image. | | {DOMElement} The image element is appended to the frame. | | {Boolean} True if the png alpha hack needs to be applied on the layer’s div. | | {Boolean} Is this tile a back buffer tile? | | {Float} Used in transition code only. | | {Boolean} Is this the first time the tile is being drawn? | | { OpenLayers.Tile} A clone of the tile used to create transition effects when the tile is moved or changes resolution. | | | | | | | | Check that a tile should be drawn, and draw it. | | Triggered by two different events, layer loadend, and tile loadend. | | Internal function to actually initialize the image tile, position it correctly, and set its url. | | Using the properties currenty set on the layer, position the tile correctly. | | Clear the tile of any bounds/position-related data so that it can be reused in a new location. | | Creates the imgDiv property on the tile. | | Make sure that the image that just loaded is the one this tile is meant to display, since panning/zooming might have changed the tile’s URL in the meantime. | | This method is invoked on tiles that are backBuffers for tiles in the grid. | | Show the tile by showing its frame. | | Hide the tile by hiding its frame. | | The OverMap control creates a small overview map, useful to display the extent of a zoomed map and your main map and provide additional navigation options to the User. | | | | {DOMElement} The DOM element that contains the overview map | | | | | | | | Create a new overview map | | Render the control in the browser. | | | | Handle extent rectangle drag | | | | | | Hide all the contents of the control, shrink the size, add the maximize icon | | Hide/Show the toggle depending on whether the control is minimized | | Update the overview map after layers move. | | Determines if the overview map is suitable given the extent and resolution of the main map. | | Construct the map that this control contains | | Updates the extent rectangle position and size to match the map extent | | Updates the map extent to match the extent rectangle position and size | | Set extent rectangle pixel bounds. | | Get the rect bounds from the map bounds. | | Get the map bounds from the rect bounds. | | Get a map location from a pixel location | | Get a pixel location from a map location | | Features are combinations of geography and attributes. | | | | | | | | | | | | | | | | | | Constructor for features. | | nullify references to prevent circular references and memory leaks | | {Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property) | | Based on the data associated with the Feature, create and return a marker object. | | | | Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data. | | Destroys the popup created via createPopup. | | A handler for mouse clicks. | | | | {Number} The id of the timeout waiting to clear the delayedCall. | | | | {Number} The id of the right mouse timeout waiting to clear the <delayedEvent>. | | | | Create a new click handler. | | | | | | | | | | | | | | Determine whether the event is within the optional pixel tolerance. | | Clear the timer and set timerId to null. | | | | The drag handler is used to deal with sequences of browser events related to dragging. | | | | {Boolean} When a mousedown event is received, we want to record it, but not set ‘dragging’ until the mouse moves after starting. | | {Boolean} Stop propagation of mousedown events from getting to listeners on the same element. | | | | | | | | | | {Integer} In order to increase performance, an interval (in milliseconds) can be set to reduce the number of drag events called. | | {String} The id of the timeout used for the mousedown interval. | | | | Returns OpenLayers.Handler.Drag | | This method is called during the handling of the mouse down event. | | This method is called during the handling of the mouse move event. | | This method is called during the handling of the mouse up event. | | This method is called during the handling of the mouse out event. | | | | | | | | | | | | The drag handler captures the click event. | | | | | | Handler to respond to mouse events related to a drawn feature. | | | | {Object} A object mapping the browser events to objects with callback keys for in and out. | | | | | | | | | | {Number} The number of pixels the mouse can move between mousedown and mouseup for the event to still be considered a click. | | To restrict dragging to a limited set of geometry types, send a list of strings corresponding to the geometry class names. | | {Boolean} If stopClick is set to true, handled clicks do not propagate to other click listeners. | | {Boolean} If stopDown is set to true, handled mousedowns do not propagate to other mousedown listeners. | | {Boolean} If stopUp is set to true, handled mouseups do not propagate to other mouseup listeners. | | | | | | | | | | | | | | | | Return true if the geometry type of the passed feature matches one of the geometry types in the geometryTypes array. | | | | Call the callback keyed in the event map with the supplied arguments. | | | | | | Moves the layer for this handler to the top, so mouse events can reach it. | | Moves the layer back to the position determined by the map’s layers array. | | The hover handler is to be used to emulate mouseovers on objects on the map that aren’t DOM elements. | | | | | | | | | | Construct a hover handler. | | Called when the mouse moves on the map. | | Called when the mouse goes out of the map. | | Determine whether the mouse move is within the optional pixel tolerance. | | Clear the timer and set timerId to null. | | | | Handler for wheel up/down events. | | | | | | { OpenLayers.Pixel} mousePosition is necessary because evt.clientX/Y is buggy in Moz on wheel events, so we cache and use the value from the last mousemove. | | | | | | | | Catch the wheel event and handle it xbrowserly | | Given the wheel event, we carry out the appropriate zooming in or out, based on the ‘wheelDelta’ or ‘detail’ property of the event. | | Update the stored mousePosition on every move. | | | | | | | | | | {Float} The layer’s opacity. | | | | {Array(String)} Supported application event types. | | | | {Boolean} The layer’s images have an alpha channel. | | {Boolean} The current map resolution is within the layer’s min/max range. | | { OpenLayers.Pixel} For layers with a gutter, the image offset represents displacement due to the gutter. | | {Object} An optional object whose properties will be set on the layer. | | {Array} An immutable (that means don’t change it!) | | | | | | Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own. | | | | | | Set the map property for the layer. | | Called at the end of the map.addLayer sequence. | | This method’s responsibility is to set up the ‘resolutions’ array for the layer -- this array is what the layer will use to interface between the zoom levels of the map and the resolution display of the layer. | | Calculates the max extent which includes all of the data for the layer. | | {Integer} the z-index of this layer | | | | This function will take a bounds, and if wrapDateLine option is set on the layer, it will return a bounds which is wrapped around the world. | | | | | | | | | | | | | | | | Allow the user to change the box’s color and border width | | | | {Boolean} Whether or not the marker is currently visible on screen. | | | | Standard-compliant (W3C) cross-browser implementation of the XMLHttpRequest object. | | | | | | Parse XML into a doc structure | | | | | | | | {Object} Transport mechanism for whichever browser we’re in, or false if none available. | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If the optional onException function is set, execute it and then dispatch the call to any other listener registered for onException. | | | | | | | | | | | | | | | | | | | | | | | | | | | | Wrapper function around XMLSerializer, which doesn’t exist/work in IE/Safari. | | The DragPan control pans the map with a drag of the mouse. | | | | {OpenLayers.Control.TYPES} | | | | {Integer} The number of milliseconds that should ellapse before panning the map again. | | | | | | | | Finish the panning operation. | | Vector features use the OpenLayers.Geometry classes as geometry description. | | | | | | { OpenLayers.Bounds} The box bounding that feature’s geometry, that property can be set by an OpenLayers.Format object when deserializing the feature, so in most cases it represents an information set by the server. | | | | {String} rendering intent currently being used | | | | | | nullify references to prevent circular references and memory leaks | | Create a clone of this vector feature. | | Determine whether the feature is within the map viewport. | | | | | | | | Determins whether the feature intersects with the specified location. | | | | Moves the feature and redraws it at its new location | | | | | | OpenLayers features can have a number of style attributes. | | Handler for dragging a rectangle across the map. | | | | | | {Object} Caches some box characteristics from css. | | | | | | | | | | | | | | Remove the zoombox from the screen and nullify our reference to it. | | | | | | Determines offset and box model for a box. | | Handler to draw a regular polygon on the map. | | | | {Float} The angle from the origin (mouse down) to the current mouse position, in radians. | | {Boolean} The polygon has a fixed radius. | | | | | | | | | | Create a new regular polygon handler. | | Start drawing a new feature | | Respond to drag move events | | Finish drawing the feature | | Finish drawing the feature. | | Create the new polygon geometry. | | Modify the polygon geometry in place. | | Calculate the angle based on settings. | | Finish the geometry and call the “done” callback. | | Trigger the control’s named callback with the given arguments | | Base class for 3rd party layers. | | | | {Boolean} EventPaned layers are always base layers, by necessity. | | {DOMElement} A reference to the element that controls the events. | | {Object} This is the object which will be used to load the 3rd party library in the case of the google layer, this will be of type GMap, in the case of the ve layer, this will be of type VEMap | | | | Create a new event pane layer | | Set the map property for the layer. | | If we can’t load the map lib, then display an error message to the user and tell them where to go for help. | | To be implemented by subclasses. | | Set the display on the pane | | Set the z-index order for the pane. | | Handle calls to move the layer. | | Get a map location from a pixel location | | Get a pixel location from a map location | | Get an OL style map location from a 3rd party style map location | | Get a 3rd party map location from an OL map location. | | Get an OL pixel location from a 3rd party pixel location. | | Get a 3rd party pixel location from an OL pixel location | | Some Layers will already have established zoom levels (like google or ve). | | | | Create a new fixed zoom levels layer. | | Populate the resolutions array | | Get the zoom level for a given resolution | | Get the OL zoom index from the map object zoom level | | Get the map object zoom level from the OL zoom level | | | | | | {Float} Used to hash URL param strings for multi-WMS server selection. | | | | {Array(String) or String} This is either an array of url strings or a single url string. | | {Object} Hashtable of key/value parameters | | | | | | selectUrl() implements the standard floating-point multiplicative hash function described by Knuth, and hashes the contents of the given param string into a float between 0 and 1. | | Combine url with layer’s params and these newParams. | | | | | | {Boolean} internal state of drawing. | | | | | | | | This method removes all markers from a layer. | | Calculate the pixel location for the marker, create it, and add it to the layer’s div | | A mixin for layers that wraps up the pieces neccesary to have a coordinate conversion for working with commercial APIs which use a spherical mercator projection. | | | | | | Set up the mercator parameters on the layer: resolutions, projection, units. | | Given an object with x and y properties in EPSG:4326, modify the x,y properties on the object to be the Spherical Mercator projected coordinates. | | Given an object with x and y properties in Spherical Mercator, modify the x,y properties on the object to be the unprojected coordinates. | | Transforms from EPSG:4326 to EPSG:900913 and from EPSG:900913 to EPSG:4326 are set by this class. | | The DrawFeature control draws point, line or polygon features on a vector layer when active. | | | | | | {Object} The functions that are sent to the handler for callback | | | | | | | | | | | | Allows for drawing of features for measurements. | | | | {Array(String)} Supported application event types. | | | | {Object} The functions that are sent to the handler for callback | | {String} Display system for output measurements. | | {Boolean} Calculate geodesic metrics instead of planar metrics. | | {Object} Units for various measurement systems. | | {Number} Number of milliseconds between clicks before the event is considered a double-click. | | {Number} Timeout id of trigger for measurepartial. | | | | | | | | Called when the measurement sketch is done. | | Called each time a new point is added to the measurement sketch. | | | | | | | | | | | | The ZoomBox control enables zooming directly to a given extent, by drawing a box on the map. | | | | {OpenLayers.Control.TYPE} | | {Boolean} Should the control be used for zooming out? | | {Boolean} Always zoom in/out, when box drawed | | | | | | | | Class for reading and writing Well-Known Text. | | | | Create a new parser for WKT | | Deserialize a WKT string and return a vector feature or an array of vector features. | | Serialize a feature or array of features into a WKT string. | | | | | | | | | | {Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projection | | | | {GDraggableObject} Since 2.93, Google has exposed the ability to get the maps GDraggableObject. | | {DOMElement} Div for Google’s copyright and terms of use link | | {DOMElement} Div for Google’s powered by logo and link | | | | | | Load the GMap and register appropriate event listeners. | | The map has been centered, and a map type was specified, so we set the map type on the gmap object, then unregister the listener so that we dont keep doing this every time the map moves. | | | | Hack-on function because GMAPS does not give it to us | | Base class for layers that use a lattice of tiles. | | | | {Array(Array( OpenLayers.Tile))} This is an array of rows, each row is an array of tiles. | | | | | | Go through and remove all tiles from the grid, calling destroy() on each of them to kill circular references | | This function is called whenever the map is moved. | | | | | | Generate parameters for the grid layout. | | | | Starts at the top right corner of the grid and proceeds in a spiral towards the center, adding tiles one at a time to the beginning of a queue. | | This function takes a tile as input and adds the appropriate hooks to the tile so that the layer can keep track of the loading tiles. | | This function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks() | | | | | | Shift grid work in the other dimension | | When the size of the map or the buffer changes, we may need to remove some excess rows and columns. | | For singleTile layers, this will set a new tile size according to the dimensions of the map pane. | | | | | | | | | | {Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projection | | | | | | | | | | | | | | | | | | {Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projection | | | | | | | | | | The map has been centered, so the mysterious yahoo eventpane has been added. | | A basic HTTP protocol for vector layers. | | | | {String} Service URL, read-only, set through the options passed to constructor. | | {Object} HTTP request headers, read-only, set through the options passed to the constructor, Example: {‘Content-Type’: ‘plain/text’} | | {Object} Parameters of GET requests, read-only, set through the options passed to the constructor, Example: {‘bbox’: ‘5,5,5,5’} | | {Object} Function to be called when the <read>, <create>, <update>, <delete> or <commit> operation completes, read-only, set through the options passed to the constructor. | | {Object} Callback execution scope, read-only, set through the options passed to the constructor. | | {Boolean} true if read operations are done with POST requests instead of GET, defaults to false. | | | | A class for giving layers generic HTTP protocol. | | Returns a function that applies the given public method with resp and options arguments. | | Individual callbacks are created for read, create and update, should a subclass need to override each one separately. | | Called the the request issued by <create> is complete. | | Called the the request issued by <update> is complete. | | Called the the request issued by <delete> is complete. | | Called by CRUD specific handlers. | | Read HTTP response body and return features. | | This method is used from within the commit method each time an an HTTP response is received from the server, it is responsible for calling the user-supplied callbacks. | | This class represents a UserStyle obtained from a SLD, containing styling rules. | | | | {String} Title of this style (set if included in SLD) | | {String} Description of this style (set if abstract is included in SLD) | | | | {Object} An optional object with properties that symbolizers’ property values should be evaluated against. | | {Object} hash of style properties to use as default for merging rule-based style symbolizers onto. | | {Boolean} If set to true, the defaultStyle will extend the symbolizer of every rule. | | {Hash of Boolean} cache of style properties that need to be parsed for propertyNames. | | | | | | creates a style by applying all feature-dependent rules to the base style. | | | | creates literals for all style properties that have an entry in <this.propertyStyles>. | | Looks into all rules for this style and the defaultStyle to collect all the style hash property names containing ${...} | | | | Returns the correct symbolizer prefix according to the geometry type of the passed geometry | | converts a style value holding a combination of PropertyName and Literal into a Literal, taking the property values from the passed features. | | | | {Array} prefixes of the sld symbolizers. | | The navigation control handles map browsing with mouse events (dragging, double-clicking, and scrolling the wheel). | | | | | | | | | | Create a new navigation control | | The destroy method is used to perform any clean up before the control is dereferenced. | | | | | | | | | | | | | | User spun scroll wheel up | | User spun scroll wheel down | | | | | | A Geometry is a description of a geographic object. | | | | {String} A unique identifier for this geometry. | | | | | | | | Creates a geometry object. | | | | Nullify this components bounds and that of its parent as well. | | Extend the existing bounds to include the new bounds. | | | | Calculate the length of this geometry. | | Calculate the area of this geometry. | | Returns the Well-Known Text representation of a geometry | | Generate a geometry given a Well-Known Text string. | | Determine whether two line segments intersect. | | | | Instances of OpenLayers.Layer.MapGuide are used to display data from a MapGuide OS instance. | | | | {Object} Hashtable of default parameter key/value pairs for tiled layer | | {Object} Hashtable of default parameter key/value pairs for untiled layer | | {Object} Hashtable of default parameter key/value pairs for untiled layer | | {Object} Hashtable of parameter key/value pairs which describe the folder structure for tiles as configured in the mapguide serverconfig.ini section [TileServiceProperties] | | | | | | | | Create a new Mapguide layer, either tiled or untiled. | | factor that are different than the defaults used in OpenLayers, so these must be adjusted accordingly in your application. | | Create a clone of this layer | | Creates a tile, initializes it, and adds it to the layer div. | | Return a query string for this layer | | getFullRequestString on MapGuide layers is special, because we do a regular expression replace on ‘,’ in parameters to ‘+’. | | special handler to request mapguide tiles from an http exposed tilecache | | Generate parameters for the grid layout. | | Instances of OpenLayers.Layer.MapServer are used to display data from a MapServer CGI instance. | | | | {Object} Hashtable of default parameter key/value pairs | | | | Create a new MapServer layer object | | Create a clone of this layer | | Creates a tile, initializes it, and adds it to the layer div. | | Return a query string for this layer | | combine the layer’s url with its params and these newParams. | | Instances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services. | | | | {Object} Hashtable of default parameter key/value pairs | | | | | | | | Create a new WMS layer object | | | | Create a clone of this layer | | Return a GetMap query string for this layer | | addTile creates a tile, initializes it, and adds it to the layer div. | | This class represents an SLD Rule, as being used for rule-based SLD styling. | | | | {String} A unique id for this session. | | {String} Title of this rule (set if included in SLD) | | {String} Description of this rule (set if abstract is included in SLD) | | {Object} An optional object with properties that the rule should be evaluated against. | | {<OpenLayers.Filter>} Optional filter for the rule. | | {Boolean} Determines whether this rule is only to be applied only if no other rules match (ElseFilter according to the SLD specification). | | {Object} Symbolizer or hash of symbolizers for this rule. | | | | | | Gets the context for evaluating this rule | | | | | | Hash of { OpenLayers.Style}, keyed by names of well known rendering intents (e.g. | | {Boolean} if true, every render intent will extend the symbolizers specified for the “default” intent at rendering time. | | | | | | | | Creates the symbolizer for a feature for a render intent. | | Convenience method to create comparison rules for unique values of a property. | | A Collection is exactly what it sounds like: A collection of different Geometries. | | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | Creates a Geometry Collection -- a list of geoms. | | Get a string representing the components for this collection | | Add a new component (geometry) to the collection. | | Remove a component from this geometry. | | | | | | Construct a point geometry. | | Create a new Bounds based on the lon/lat | | {String} Shortened String representation of Point object. | | Instances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources. | | | | {Array(String)} Supported application event types. | | | | | | {Object} hash of features, keyed by feature.id, that the renderer failed to draw | | | | | | | | {Array(String)} List of supported Renderer classes. | | | | {Boolean} Whether the Vector Layer features have been drawn yet. | | | | Create a new vector layer | | Ask the layer to request features again and redraw them. | | Iterates through the available renderer implementations and selects and assigns the first one whose “supported()” function returns true. | | Let the user know their browser isn’t supported. | | The layer has been added to the map. | | Called at the end of the map.addLayer sequence. | | The layer has been removed from the map. | | Notify the renderer of the change in size. | | Reset the vector layer’s div so that it once again is lined up with the map. | | Erase features from the layer. | | Given an event, return a feature if the event occurred over one. | | MultiPoint is a collection of Points. | | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | Create a new MultiPoint Geometry | | Handler to draw a point on the map. | | | | | | | | {Boolean} Cast features to multi-part geometries before passing to the layer. | | {Boolean} A point is being drawn | | {Boolean} The mouse is down | | | | | | {Object} Any optional properties to be set on the sketch layer. | | | | Create a new point handler. | | | | Destroy the temporary geometries | | Finish the geometry and call the “done” callback. | | | | | | Modify the existing geometry given a pixel location. | | Render features on the temporary layer. | | Return the sketch geometry. | | Return a clone of the relevant geometry. | | | | | | | | A Curve is a MultiPoint, whose points are assumed to be connected. | | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | | | A LineString is a Curve which, once two points have been added to it, can never be less than two points long. | | | | Create a new LineString geometry | | {Array} An array of segment objects. | | Split this geometry with the given segment. | | Use this geometry (the source) to attempt to split a target geometry. | | Split this geometry (the target) with the given geometry (the source). | | A Linear Ring is a special LineString which is closed. | | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | Linear rings are constructed with an array of points. | | Test if a point is inside a linear ring. | | | | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | Constructor for a MultiLineString Geometry. | | Use this geometry (the source) to attempt to split a target geometry. | | Split this geometry (the target) with the given geometry (the source). | | Handler to draw a path on the map. | | | | | | {Boolean} In freehand mode, the handler starts the path on mouse down, adds a point for every mouse move, and finishes the path on mouse up. | | {String} If set, freehandToggle is checked on mouse events and will set the freehand mode to the opposite of this.freehand. | | | | | | | | Destroy temporary geometries | | Destroy the temporary point. | | | | Determine whether to behave in freehand mode or not. | | Modify the existing geometry given the new point | | Render geometries on the temporary layer. | | Return the sketch feature. | | Return the sketch geometry. | | | | | | | | | | Polygon is a collection of Geometry.LinearRings. | | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | Constructor for a Polygon geometry. | | Test if a point is inside a polygon. | | | | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | Create a new MultiPolygon geometry | | Handler to draw a polygon on the map. | | | | Create a Polygon Handler. | | | | Destroy temporary geometries | | Render geometries on the temporary layer. | | Return the sketch feature. | | Return the sketch geometry. | | | | | | | | Create a new parser for GML. | | This function is the core of the GML parsing code in OpenLayers. | | Properties of this object are the functions that parse geometries based on their type. | | Given a GML node representing a point geometry, create an OpenLayers point geometry. | | Given a GML node representing a multipoint geometry, create an OpenLayers multipoint geometry. | | Given a GML node representing a linestring geometry, create an OpenLayers linestring geometry. | | Given a GML node representing a multilinestring geometry, create an OpenLayers multilinestring geometry. | | Given a GML node representing a polygon geometry, create an OpenLayers polygon geometry. | | Given a GML node representing a multipolygon geometry, create an OpenLayers multipolygon geometry. | | | | Accept an OpenLayers.Feature.Vector, and build a GML node for it. | | Object containing methods to do the actual geometry node building based on geometry type. | | Given an OpenLayers point geometry, create a GML point. | | Given an OpenLayers multipoint geometry, create a GML multipoint. | | Given an OpenLayers linestring geometry, create a GML linestring. | | Given an OpenLayers multilinestring geometry, create a GML multilinestring. | | Given an OpenLayers linearring geometry, create a GML linearring. | | Given an OpenLayers polygon geometry, create a GML polygon. | | Given an OpenLayers multipolygon geometry, create a GML multipolygon. | | Given an OpenLayers bounds, create a GML box. | | builds the coordinates XmlNode | | Superclass for GML parsers. | | | | {Object} Mapping of namespace aliases to namespace URIs. | | | | {String} Schema location for a particular minor version. | | {Object} Maps OpenLayers geometry class names to GML element names. | | {Boolean} True if there is only 1 featureType, and not an array of featuretypes. | | Compiled regular expressions for manipulating strings. | | Instances of this class are not created directly. | | | | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | | | | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. | | | | | | | | {String} Schema location for a particular minor version. | | Create a parser for GML v2. | | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | | | | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. | | | | | | {String} Schema location for a particular minor version. | | {Boolean} Write gml:Curve instead of gml:LineString elements. | | {Boolean} Write gml:MultiCurve instead of gml:MultiLineString. | | {Boolean} Write gml:Surface instead of gml:Polygon elements. | | {Boolean} Write gml:multiSurface instead of gml:MultiPolygon. | | Create a parser for GML v3. | | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | | | | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. | | Sets the <geometryTypes> mapping. | | | | | | | | Contains Array Prototypes like each, contains, and erase. | | Contains Function Prototypes like create, bind, pass, and delay. | | Contains Number Prototypes like limit, round, times, and ceil. | | Contains String Prototypes like camelCase, capitalize, test, and toInt. | | Contains Hash Prototypes. | | Contains the Event Native, to make the event object completely crossbrowser. | | Contains the Class Function for easily creating, extending, and implementing reusable Classes. | | Contains Utility Classes that can be implemented into your own Classes to ease the execution of many common tasks. | | One of the most important items in MooTools. | | Contains Element methods for dealing with events, and custom Events. | | Contains methods for interacting with the styles of Elements in a fashionable way. | | Contains methods to work with size, scroll, or positioning of Elements and the window object. | | Adds advanced CSS Querying capabilities for targeting elements. | | Contains the domready custom event. | | JSON encoder and decoder. | | Class for creating, loading, and saving browser Cookies. | | Wrapper for embedding SWF movies. | | Contains the basic animation logic to be extended by all other Fx Classes. | | Contains the CSS animation logic. | | Formerly Fx.Style, effect to transition any CSS property for an element. | | Formerly Fx.Styles, effect to transition any number of CSS properties for an element using an object of rules, or CSS based selector rules. | | Contains a set of advanced transitions to be used with any of the Fx Classes. | | Powerful all purpose Request Class. | | Extends the basic Request Class with additional methods for sending and receiving JSON data. | | A css-class based form validation system. | | Additional validators for the FormValidator class. | | Defines Fx.Reveal, a class that shows and hides elements with a transition. | | Effect to slide an element in and out of view. | | Class for creating a smooth scrolling effect to all internal links on the page. | | A Drag extension that provides support for the constraining of draggables to containers and droppables. | | Class for creating horizontal and vertical slider controls. | | Defines Request.JSONP, a class for cross domain javascript via script injection. | | Requests the same url at a time interval that increases when no data is returned from the requested server | | Class for monitoring collections of events | | Class for creating, reading, and deleting Cookies in JSON format. | | Jx is a global singleton object that contains the entire Jx library within it. | | | | This is the URL that Jx was loaded from, it is automatically calculated from the script tag src property that included Jx. | | | | Static method that applies the PNG Filter Hack for IE browsers when showing 24bit PNG’s. | | Request that an image be set to a DOM IMG element src attribute. | | An internal method that ensures no more than 2 images are loading at a time. | | An internal method actually populate the DOM element with the image source. | | Creates a new iframe element that is intended to fill a container to mask out other operating system controls (scrollbars, inputs, buttons, etc) when HTML elements are supposed to be above them. | | safely parse a number and return its integer value. | | return the dimensions of the browser client area. | | Element is a global object provided by the mootools library. | | | | return the size of the content area of an element. | | return the size of the border area of an element. | | return the size of the margin area of an element. | | set either or both of the width and height of an element to the provided size. | | set either or both of the width and height of an element to the provided size. | | returns the padding for each edge of an element | | returns the border size for each edge of an element | | determines if the element is a descendent of the reference node. | | search the parentage of the element to find an element of the given tag name. | | ContentLoader is a mix-in class that provides a consistent mechanism for other Jx controls to load content in one of four different ways: | | | | tracks the load state of the content, specifically useful in the case of remote content. | | | | triggers loading of content based on options set for the current object. | | Is fired after a delay to check the request to make sure it’s not failing in AIR. | | Mix-in class that provides a method for positioning elements relative to other elements. | | | | positions an element relative to another element based on the provided options. | | A mix-in class that provides chrome helper functions. | | | | the DOM element that contains the chrome | | | | create chrome on an element. | | show the chrome on an element. | | removes the chrome from the DOM. | | A mix-in class that provides a helper function that allows an object to be added to an existing element on the page. | | | | adds the object to the DOM relative to another element. | | | | | | | | triggered when the user clicks the button, processes the actionPerformed event | | This returns true if the button is enabled, false otherwise | | enable or disable the button. | | For toggle buttons, this returns true if the toggle button is currently active and false otherwise. | | Set the active state of the button | | set the image of this button to a new image URL | | sets the text of the button. | | returns the text of the button. | | sets the tooltip displayed by the button | | capture the keyboard focus on this button | | remove the keyboard focus from this button | | | | | | the HTML element that contains the flyout content | | | | construct a new instance of a flyout button. | | | | Closes the flyout if open | | | | | | Create a new instance of Jx.Layout. | | when the window is resized, any Jx.Layout controlled elements that are direct children of the BODY element are resized | | resize the element controlled by this Jx.Layout object. | | | | | | {HTMLElement} The content area that is displayed when the tab is active. | | | | Create a new instance of Jx.Button.Tab. | | triggered when the user clicks the button, processes the actionPerformed event | | | | | | the HTML element representing the color panel | | | | initialize a new instance of Jx.ColorPalette | | handle the mouse moving over a colour swatch by updating the preview | | handle mouse click on a swatch by updating the color and hiding the panel. | | handle the user entering a new colour value manually by updating the selected colour if the entered value is valid HEX. | | handle the user entering a new alpha value manually by updating the selected alpha if the entered value is valid alpha (0-100). | | set the colour represented by this colour panel | | set the alpha represented by this colour panel | | update the colour panel user interface based on the current colour and alpha values | | | | | | initialize a new color button. | | | | | | set the color represented by this color panel | | set the alpha represented by this color panel | | handle the color changing in the palette by updating the preview swatch in the button and firing the change event. | | Update the swatch color for the current color | | | | | | {HTMLElement} The HTML element containing the menu. | | { Jx.Button} The button that represents this menu in a toolbar and opens the menu. | | {HTMLElement} the HTML element that contains the menu items within the menu. | | {Array} the items in this menu | | | | Create a new instance of Jx.Menu. | | Add menu items to the sub menu. | | Deactivate the menu by hiding it. | | Handle the user moving the mouse over the button for this menu by showing this menu and hiding the other menu. | | determine if an event happened inside this menu or a sub menu of this menu. | | | | | | Set the sub menu that is currently open | | | | | | {Array} array of buttons that are managed by this button set | | | | | | | | Remove a button from this Button. | | Set the active button to the one passed to this method | | Handle selection changing on the buttons themselves and activate the appropriate button in response. | | | | | | the currently selected button | | {Array} the buttons added to this multi button | | | | construct a new instance of Jx.Button.Multi. | | adds one or more buttons to the Multi button. | | remove a button from a multi button | | update the menu item to be the requested button. | | update the active button in the menu item, trigger the button’s action and hide the flyout that contains the buttons. | | | | | | {<Jx.SubMenu> or Jx.Menu} the menu that contains the menu item. | | | | Create a new instance of Jx.Menu.Item | | Set the owner of this menu item | | | | | | Handle the user clicking on the menu item, overriding the Jx.Button::clicked method to facilitate menu tracking | | handle the mouse moving over the menu item | | | | | | {Object} current selection in the list | | | | create a new instance of Jx.Combo | | enable or disable the combo button. | | invoked when the current value is changed | | Handle the user pressing a key by looking for an ENTER key to set the value. | | add a new item to the pick list | | Remove the item at the given index. | | set the value of the Combo | | | | | | | | Initialize a new Jx.Panel instance | | the sizeChange event of the Jx.Layout that manages the outer container is intercepted and passed through this method to handle resizing of the panel contents because we need to do some calculations if the panel is collapsed and if there are toolbars to put around the content area. | | Set the label in the title bar of this panel | | Get the label of the title bar of this panel | | | | | | set the content of this panel to some HTML | | Set the content of this panel to come from some URL. | | When the content of the panel is loaded from a remote URL, this method is called when the ajax request returns. | | Set the panel as busy or not busy, which displays a loading image in the title bar. | | sets or toggles the collapsed state of the panel. | | Closes the panel (completely hiding it). | | | | | | modal dialogs prevent interaction with the rest of the application while they are open, this element is displayed just under the dialog to prevent the user from clicking anything. | | | | Construct a new instance of Jx.Dialog | | | | overload panel’s sizeChanged method | | sets or toggles the collapsed state of the panel. | | show the dialog, external code should use the Jx.Dialog::open method to make the dialog visible. | | hide the dialog, external code should use the Jx.Dialog::close method to hide the dialog. | | open the dialog and load content from the provided url. | | | | close the dialog and trigger the onClose callback function if necessary | | | | | | {HTMLElement} the element being split | | {Array} an array of elements that are displayed in each of the split areas | | {Array} an array of the bars between each of the elements used to resize the split areas. | | {Boolean} track the first resize event so that unexposed Jx things can be forced to calculate their size the first time they are exposed. | | | | Create a new instance of Jx.Splitter | | Prepare a new, empty element to go into a split area. | | Prepare a new, empty bar to go into between split areas. | | Setup the initial set of constraints that set the behaviour of the bars between the elements in the split area. | | In a horizontally split container, handle a bar being dragged left or right by resizing the elements on either side of the bar. | | In a vertically split container, handle a bar being dragged up or down by resizing the elements on either side of the bar. | | handle the size of the container being changed. | | Resize a horizontally layed-out container | | Resize a vertically layed out container. | | | | | | {Array} the panels being managed by the set | | {Integer} the height of the container, cached for speed | | {Boolean} true until the panel set has first been resized | | | | Create a new instance of Jx.PanelSet. | | Maximize a panel, taking up all available space (taking into consideration any minimum or maximum values) | | | | | | construct a new instance of Jx.Grid within the domObj | | handle the grid scrolling by updating the position of the headers | | resize the grid to fit inside its container. | | set the model for the grid to display. | | destroy the contents of the grid safely | | create the grid for the current model | | | | called through the grid listener interface when data has changed in the underlying model | | apply the jxGridRowHeaderPrelight style to the header cell of a row. | | apply the jxGridColumnHeaderPrelight style to the header cell of a column. | | apply the jxGridRowPrelight style to row. | | apply the jxGridColumnPrelight style to a column. | | apply the jxGridCellPrelight style to a cell. | | Select a cell and apply the jxGridCellSelected style to it. | | Apply the jxGridRowHeaderSelected style to the row header cell of a selected row. | | Select a row and apply the jxGridRowSelected style to it. | | Apply the jxGridColumnHeaderSelected style to the column header cell of a selected column. | | | | handle the mouse moving over the main grid. | | handle the mouse moving over the row header cells. | | handle the mouse moving over the column header cells. | | handle the user clicking on the grid. | | handle the user clicking on the row header. | | handle the user clicking on the column header. | | retrieve the row and column indexes from an event click. | | | | This function returns the number of columns of data in the model as an integer value. | | This function returns an HTML string to be placed in the column header for the given column index. | | This function returns an integer which is the height of the column header row in pixels. | | This function returns an integer which is the width of the given column in pixels. | | This function returns an HTML string to be placed in the row header for the given row index | | This function returns an integer which is the width of the row header column in pixels. | | This function returns an integer which is the height of the given row in pixels. | | This function returns the number of rows of data in the model as an integer value. | | This function returns an HTML string which is the text to place in the cell at the given row and column. | | This function is called with a column index and width in pixels when a column is resized. | | This function returns a boolean value to indicate if a given cell is editable by the user. | | This function is called with the row and column of a cell and a new value for the cell. | | This function is called by the grid to indicate that the user has selected a row by clicking on the row header. | | This function is called by the grid to indicate that the user has selected a column by clicking on the column header. | | This function is called by the grid to indicate that the user has selected a cell by clicking on the cell in the grid. | | | | | | create a new context menu | | Show the context menu at the location of the mouse click | | | | | | {HTMLElement} the HTML element that the separator is contained within | | | | | | Create a new instance of a menu separator | | Set the ownder of this menu item | | | | | | | | | | {HTMLElement} the HTML container for the sub menu. | | | | {<Jx.MenuItem>} the visible item within the menu | | {Array} the menu items that are in this sub menu. | | | | Create a new instance of Jx.SubMenu | | Set the owner of this sub menu | | | | | | Add menu items to the sub menu. | | Insert a menu item before another menu item. | | Remove a single menu item from the menu. | | | | Indicate if this sub menu is active | | Set the active state of the Jx.Menu that contains this sub menu | | Set a sub menu of this menu to be visible and hide the previously visible one. | | | | | | {HTMLElement} the DOM element of the snap (the thing that gets clicked). | | {HTMLElement} An element of the Jx.Splitter that gets controlled by this snap | | { Jx.Splitter} the splitter that this snap is associated with. | | {String} track the layout of the splitter for convenience. | | | | Create a new Jx.Splitter.Snap | | Snap the element open or closed. | | Handle the size of the element changing to see if the toggle state has changed. | | | | | | {Array} an array of the things in the toolbar. | | {HTMLElement} the HTML element that the toolbar lives in | | When a toolbar contains Jx.Menu instances, they want to know if any menu in the toolbar is active and this is how they find out. | | | | Create a new instance of Jx.Toolbar. | | add this toolbar to a DOM element automatically creating a toolbar container if necessary | | Add an item to the toolbar. | | remove an item from a toolbar. | | Deactivate the Toolbar (when it is acting as a menu bar). | | Indicate if the toolbar is currently active (as a menu bar) | | Set the active state of the toolbar (for menus) | | For menus, they want to know which menu is currently open. | | | | | | {Array} array of tabs that are managed by this tab set | | {HTMLElement} The HTML element that represents this tab set in the DOM. | | | | Create a new instance of Jx.TabSet within a specific element of the DOM. | | Resize the tab set content area and propogate the changes to each of the tabs managed by the tab set. | | | | Remove a tab from this TabSet. | | Set the active tab to the one passed to this method | | | | | | | | | | | | Create a new instance of a TabBox. | | Add one or more <Jx.Tab>s to the TabBox. | | Remove a tab from the TabSet. | | | | | | {HTMLElement} the HTML element that the container lives in | | | | Create a new instance of Jx.Toolbar.Container | | Add a toolbar to the container. | | remove an item from a toolbar. | | scrolls an item in one of the toolbars into the currently visible area of the container if it is not already fully visible | | | | | | {HTMLElement} an element to contain the thing to be placed in the toolbar. | | | | Create a new instance of Jx.Toolbar.Item. | | | | | | {HTMLElement} The DOM element that goes in the Jx.Toolbar | | | | Create a new Jx.Toolbar.Separator | | | | | | {HTMLElement} a reference to the HTML element that is the TreeItem in the DOM | | {Object} the folder or tree that this item belongs to | | | | Create a new instance of Jx.TreeItem with the associated options | | Clean up the TreeItem and remove all DOM references | | Clean up the TreeItem and remove all DOM references | | Create a clone of the TreeItem | | Update the CSS of the TreeItem’s DOM element in case it has changed position | | Called when the DOM element for the TreeItem is clicked, the node is selected. | | Get the label associated with a TreeItem | | A property of an object has changed, synchronize the state of the TreeItem with the state of the object | | | | | | {HTMLElement} an HTML container for the things inside the folder | | {Array} an array of references to the javascript objects that are children of this folder | | | | Create a new instance of Jx.TreeFolder | | | | Internal method to clean up folder-related stuff. | | Create a clone of the TreeFolder | | Indicates if a node is the last thing in the folder. | | Update the CSS of the TreeFolder’s DOM element in case it has changed position. | | append a node at the end of the sub-tree | | insert a node after refNode. | | remove the specified node from the tree | | Replace a node with another node | | handle the user clicking on this folder by expanding or collapsing it. | | | | | | Get a reference to a child node by recursively searching the tree | | | | | | Create a new instance of Jx.Tree | | Clean up a Jx.Tree instance | | Clear the tree of all child nodes | | Update the CSS of the Tree’s DOM element in case it has changed position | | Append a node at the end of the sub-tree | | General purpose Error object | | an internal class for managing generic events. | | | | | | Utility class to parse an application definition | | | | array of map groups, parsed from ApplicationDefinition. | | array of widget sets (each one corresponding to a map) parsed from the ApplicationDefinition. | | A Broker object that can communicate with a MapGuide instance in the case we are running against a MapGuide server | | An array of search definitions | | An array of search categories | | | | construct a new instance of the ApplicationDefinition object. | | start parsing the ApplicationDefinition file. | | parse the ApplicationDefinition file into the appropriate Fusion objects | | Create the application definition. | | return a map widget with the given name | | return a map widget with the given id | | return the map widget at the given index | | return the specified map group from the application definition | | Holds an internal representation of MapGroup objects as defined in the AppDef | | Holds an internal representation of Map objects as defined in the AppDef | | Holds an internal representation of WidgetSet objects as defined in the AppDef | | | | keep track of live widgets created in this widgetSet | | return the map widget for this widget set | | create all the things required by this widgetSet, including containers and widgets. | | return the map widget from this widget set if the map’s name matches the requested name, or null. | | Holds an internal representation of Container objects as defined in the AppDef | | Holds an internal representation of Widget objects as defined in the AppDef | | | | creates a new instance of the widget, optionally using a different name during instantiation to accomodate containers | | Holds an internal representation of Menu Item objects as defined in the AppDef | | Holds an internal representation of Flyout objects as defined in the AppDef | | Holds an internal representation of Multi objects as defined in the AppDef | | Holds an internal representation of SearchDefinition objects as defined in the AppDef | | Holds an internal representation of SearchJoin objects as defined in the AppDef | | Holds an internal representation of SearchRule objects as defined in the AppDef | | Holds an internal representation of SearchCondition objects as defined in the AppDef | | MGBroker is used to broker requests to the MapGuide Open Source mapagent interface. | | MGRequest is the base class for all broker-compatible requests. | | encapsulate a request to the server to enumerate resources in the library. | | encapsulate a request to the server to get resource contents from the library. | | encapsulate a request to the server to get resource header from the library. | | encapsulate a request to the server to create a new session on the server. | | encapsulate a request to the server to copy a resource. | | encapsulate a request to the server to delete a resource. | | encapsulate a request to the server to move a resource in the repository. | | encapsulate a request to the server to set the content XML of a resource. | | encapsulate a request to the server to describe the schema of a FeatureSource. | | encapsulate a request to the server to retrieve the spatial context of a resource. | | encapsulate a request to the server to enumerate the references to a resource id. | | encapsulate a request to the server to enumerate the data associated with a FeatureSource N.B. | | encapsulate a request to the server to enumerate the data associated with a FeatureSource N.B. | | encapsulate a request to the server to query map features on selectable layers | | encapsulate a request to the server to query map features on selectable layers | | This is the base class for all widgets. | | | | returns the location of this widget relative to the installation of fusion. | | The Fusion search mechanism defines a common capability for searches that link individual searches to a common search set maintained for all search-based widgets. | | generic class for map widgets. | | | | Callback for when all maps have been loaded | | Attaches a context menu as defined in the AppDef to the map | | Controls the creation of Layers based on the MapGroup object passed in | | Called after each layer is loaded in the OL viewport. | | handles mouse wheel events by accummulating the events and setting a timer to do the actual zoom in/out | | Carries out the actual map zoom based on the wheel movement | | User spun scroll wheel up | | User spun scroll wheel down | | returns the dom element for this widget | | returns the name of the baselayer map | | returns the Title of the baselayer map. | | returns the server session ID | | returns the ID of dom element for this widget | | sets options on the OpenLayers map object, a wrapper for the OL function | | adds a map/Layer to the map and registers some event handlers on the map | | returns the array of map objects | | Called to reload all the map objects. | | Loads the ScaleRange objects separate from the LoadMap sequence since this also generates sprites and is a relatively expensive operation. | | dispatch query requests to the maps | | handle selection events from maps and republish for widgets as appropriate | | cehck to see if any of the maps have an active selection | | clear the selection on all maps | | initiates a call to get the current selection asynchronously in case we need to retrieve the details from the server | | sets a Selection XML back to the server for each of the maps | | accumulate the selection results from each map and when all have reported in, pass the results to the callback function | | sets the active layer for selection/manipulation | | returns the active layer for selection/manipulation | | indicate that a new asynchronous process has started and make sure the visual indicator is visible for the user. | | indicate that an asynchronous process has completed and hide the visual indicator if no remaining processes are active. | | OpenLayers event handler for whenever the map changes either zoom level of the center has changed. | | check to see if there are any outstanding requests to the server | | callback for when the browser window size changes, simply calls resize on the map viewport layout object | | handles the resizing of the maps and triggers a Fusion event | | redraws the map using current extents and zoom level. | | sets the background color for the map | | handle selection events from maps and republish for widgets as appropriate | | | | gets the intitial extents from all maps with or without including the extent of any Generic/commercial layers | | sets the extent of the map to the max as returned by loadMap | | returns if the map has finished loading (based on setting the _oCurrentExtent value) | | sets the map zoom and extent. | | sets the map zoom and extent. | | sets the map zoom and extent. | | sets the map zoom and extent. | | returns the current center of the map view | | returns the Extent of the map given a center point and a scale (optional) | | Implements Layers for Fusion. | | | | This function should be called after the map has loaded. | | Returns true if the Map has been laoded succesfully form the server | | Implements the map layer groups | | Implements individual map legend layers | | Implements a scale range object | | Implements the legend style items to get a legend icon from the server | | Dictionary for Catalan, UTF8 encoding. | | | | | | | | Dictionary for English-CA. | | | | Dictionary for Spanish, UTF8 encoding. | | | | Dictionary for Hungarian. | | | | | | Dictionary for norwegian bokm�l (Norway). | | | | Dictionary for Brazilian Portuguese. | | Dictionary for swedish (Sweden). | | Dictionary for Simplified Chinese. | | Dictionary for Traditional Chinese. | | About widget to display a pop-up window about the application. | | | | | | opens a pop-up window with the about information when invoked | | AcitivityIndicator is a widget that shows or hides its DOM element based on whether the map widget is busy or not. | | A widget to allow selection of the basemaps display under the overlay MapGuide layer Currently, Google Street, Google Satellite, Google Hybrid, Yahoo Street, Yahoo Satellite, Yahoo Hybrid, Bing Street, Bing Satellite and Bing Hybrid is supported. | | The Buffer widget prompts the user for some inputs and then creates a buffer around the current selection based on those inputs. | | | | The BufferPanel widget prompts the user for some inputs and then creates a buffer around the current selection based on those inputs. | | Center the current selection, if any, but maintain the current scale if possible. | | Clears the current selection, if any. | | The user can pick from a palette of web-safe colours or enter a hex value. | | Displays the geographic position of the cursor when it is over the map. | | The user can manually type in a new scale | | Maintain and navigate through a history of extents | | The FeatureInfo widget displays information about selected polygons. | | Display a user help page. | | Restore the map to it’s full extents determined when it was initially loaded. | | Executes an arbitrary piece of JavaScript code | | A widget that will open the configured URL in the target element. | | Displays a LayerManager of all the layers in the map as a collapsable tree. | | A widget to display a legend of all layers. | | | | {String} The default image for DWF layer | | {String} The default image for Raster layer | | {String} The default image for layers that are currently themed. | | {String} The default image for layers that are out of scale. | | {String} The default image for the root folder | | {String} The default image for layer info | | {String} The default image for groupd info | | This is a class designed to help users to create their own renderer for customize the legend. | | | | | | {Groups} The groups of all layers. | | | | Abstract method that have the main purpose to draw the legend. | | Abstract method that handle the event: Fusion.Event.MAP_LOADED. | | Abstract method that handle the event: Fusion.Event.MAP_RELOADED. | | Helper method to obtains the map. | | This class provide a default legend as a collapsable tree. | | | | {Boolean} This controls whether the tree will have a single root node that contains the name of the map as its label. | | {Jx.TreeNode} The current selected node. | | {Boolean} Determine if the map is drawn. | | {Jx.TreeFolder} The current TreeFolder that the mouse will interact with. | | {Boolean} Determine if non-visible layer must be draw in the legend. | | A widget that displays a link to the currently displayedd map view. | | A widget that displays a selection of maps that can be loaded into the application. | | Displays tooltips over the map when the mouse is hovered for some time. | | The Measure widget allows the user to measure distances or areas on the map in one or more segments. | | A widget that immplements an in-map navigation control with zoom and pan. | | A widget that displays an overview map showing the current view of the primary map. | | A widget that allows for naviagtion by panning | | Pans the map a fixed amount in a particular direction | | A widget that combines pan and query functionality. | | | | The Query widget prompts the user for some inputs and then executes a query on the map. | | Allows the user to create a temporary OpenLayers Vector layer and draw POINT, LINE and POLYGON features on that layer. | | Refreshes the current map view without changing zoom or center. | | Save the current map image on the client’s computer | | A dynamically generated cartographic scalebar | | A dynamically generated cartographic scalebar that looks like the Google scalebar | | A widget that displays a pre-configured search form to the user and then runs the search. | | perform a selection on map features | | perform a selection using a polygon | | perform a selection by radius from a point | | A widget to allow the user to specify the radius to use for a SelectRadius widget. | | A widget to perform a selection within a currently selected set of features. | | Displays the number of features and number of layers in the current selection. | | A widget to display information about the currently selected set of features. | | | | {String} The default image for Previous page button. | | {String} The default image for Previous page button. | | This is a class designed to help users to create their own renderer for customize display results. | | | | | | {Array(int)} The index of the current position for pagination. | | {int} The number of results per page for pagination. | | | | | | Helper method to update the aiCurrentIndex array for pagination. | | Get the next batches of features. | | Get the previous batches of features. | | Helper method to obtains the map. | | Get a batches of features in a selection. | | Abstract method that handle the event: Fusion.Event.MAP_SELECTION_ON. | | Abstract method that handle the event: Fusion.Event.MAP_SELECTION_OFF. | | This class provide a default behavior for the selection panel. | | This class provide a alternate behavior for the selection panel. | | A utility widget that holds output from other widgets. | | The Theme widget prompts the user for some inputs and then creates a new themed layer based on one of the existing map layers. | | A widget to allow selection of the display units for various widgets | | Display the size of the current view in user-definable units | | A widget that will zoom the map in or out. | | | | | | Zoom the map by a fixed amount when a button is clicked | | Zoom to the current selection, if any | | Implements the map layer for Generic mapping services. | | Implements the map widget for MapGuide Open Source services. | | | | This function should be called after the map has loaded. | | Returns an OpenLayers MapGuide layer object | | Returns the MapGuide layer object as identified by the layer name | | Returns the MapGuide layer object as identified by the layer unique id | | Implementation of the map widget for MapServer CGI interface services | | | | This function should be called after the map has loaded. |
Fusion. ToolsA set of utility classes that provide common tools for applications Fusion. WidgetA set of classes that implement the functionlity required for applications Fusion. EventA class to provide for event handling at application runtime Fusion.LibA set of classes to provide core funtionality Fusion. LayersA set of classes that implement layer functionality for various server technologies. Fusion. ConstantApplication scope constants Summary | | | Initialize the Fusion application. | | Initialize the Strings hash with the requested locale. | | set the current initialization state of the application. | | load any scripts that have been queued for loading. | | Insert a new script into the loading queue. | | Called when a script fails to load for some reason. | | | | check if scripts have loaded. | | asynchronously load the application definition. | | the server has returned the application configuration file that contains enough information to bootstrap the application. | | the server has returned the application configuration file that contains enough information to bootstrap the application. | | the application failed to load the application configuration file. | | convenience function to issue an XmlHttpRequest to the server relative to the Fusion installation. | | trap exceptions produced in handling an ajax response. | | Convert XML to JSON using a server-side script for requests that aren’t available in JSON. | | Callback method to convert the XNR response into an actual json object and triggers the call to the callback method | | return a map widget with the given name | | return a map widget that is associated with the given DOM element by id. | | return the map widget at the given index if there are more than one map elements specified in the AppDef | | return a reference to a widget by the id of the DOM Element that it was created in. | | returns the applicaiton’s absolute URL minus the filename.html part | | returns the application’s absolute URL minus the filename.html part | | returns individual elements out of the Fusion config.json file | | Accessor to return the server-side script language | | Accessor to return the URL of the redirect script | | Accessor to return the broker object (for MapGuide only). | | Marks a JavaScript file as required which puts it into the queue for loading during Fusion initialization. | | Triggers the Fusion.Event.FUSION_ERROR and passes along the error object to the callback functions registered for this event. | | returns index into the units array for the given unit name or abbreviation | | imperial, metric, degrees or device units | | Given a unit, this method returns the units name | | Given a unit, this method returns the units abbreviation | | Converts a length value from native units into meters. | | Converts a length value from meters into native units. | | Converts a length value from one unit system into another. | | initializes the meters per unit values when a new map is loaded. | | find the OpenLayers units identifier given the Fusion metersPerUnit value | | Dynamically load a CSS stylesheet. | | An initialization time function to parse the application URL parameters and stores them in an array. | | Returns the query parameter value for a given parameter name | | {String} Relative path of this script. | | Return the path to this script for bootstrapping Fusion. | | Pre-create a session to avoid the 401 Unauthorized dialog |
initialize| initialize: function( | options | ) |
|
Initialize the Fusion application. This method must be called from the template’s onload method once all script files have been loaded. Applications can register for the event Fusion.Event.FUSION_INITIALIZED to carry out further application initialization when all the Fusion objects have been created and are available. @param {Object} options Optional paramters that can be passed to initialize are| {String} applicationDefinitionURL | a URL or resource ID for an ApplicationDefinition file | | {String} sessionId | a session id to start the application with. Normally, applications are started without a session id and create one. However, sometimes it is desirable to use an existing session. |
initializeLocale| initializeLocale: function( | locale | ) |
|
Initialize the Strings hash with the requested locale. This method simply extends the OpenLayers strings hash with strings specific to Fusion. Add strings to the files in fusion/text/[locale].json. This method can be called before Fusion.initialize() if localized strings are required in the template initialization. | @param {String} locale | the locale value e.g. ‘en-CA’ or simply ‘en’ for English |
setLoadState| setLoadState: function( | state | ) |
|
set the current initialization state of the application. Depending on the state, this will cause various scripts to be loaded. Parameter {Integer} state the new loading state loadQueuedScripts| loadQueuedScripts: function() |
load any scripts that have been queued for loading. As the scripts load, they are removed. When all queued scripts have been loaded, the load state is advanced. If any of the loaded scripts require other scripts (for inheritance), they will be queued and loaded before the load state is advanced. queueScript| queueScript: function( | url | ) |
|
Insert a new script into the loading queue. The URL should be relative to the Fusion base url. The script will not actually be loaded until loadQueuedScripts is called. Parameter: {String} url The url of the script. scriptFailed| scriptFailed: function( | url | ) |
|
Called when a script fails to load for some reason. Parameter: url {String} the url that failed to load TODO: the application probably won’t work if a script fails to load so we need to decide how to inform the user and fail gracefully. scriptLoaded| scriptLoaded: function( | url | ) |
|
a script has loaded. It is removed from the various tracking arrays. When all requested scripts have been loaded, we check to see if any scripts where required by the ones just loaded. If yes, then we loadQueuedScripts again, otherwise we advance the load state. Parameter: url {String} the url of the script that was loaded. checkLoadingScripts| checkLoadingScripts: function() |
check if scripts have loaded. In IE, scripts don’t seem to fire the onload event. Safari also seems to have some problems. loadConfigasynchronously load the application definition. For MapGuide, also set up the broker object. Once the AppDef is loaded/created advance the laod state. getConfigCBthe server has returned the application configuration file that contains enough information to bootstrap the application. Parameter {Object} r an XMLHttpRequest object serverSetthe server has returned the application configuration file that contains enough information to bootstrap the application. Parameter {Object} r an XMLHttpRequest object serverFailed| serverFailed: function( | r | ) |
|
the application failed to load the application configuration file. Not much point in continuing, but we can inform the user why this happened. Parameter: {Object} r the XMLHttpRequest object TODO: do something more useful in here? ajaxRequest| ajaxRequest: function( | scriptURL, | | options | ) |
|
convenience function to issue an XmlHttpRequest to the server relative to the Fusion installation. Parameter: {String} scriptURL the URL (relative to Fusion) to request Parameter: {Object} options optional parameters to send with the request, passed directly to the OpenLayers Ajax.Request function ajaxException| ajaxException: function( | r, | | e | ) |
|
trap exceptions produced in handling an ajax response. Parameter: {XmlHttpRequest} r Parameter: {Exception} e getXmlAsJson| getXmlAsJson: function( | url, | | callback | ) |
|
Convert XML to JSON using a server-side script for requests that aren’t available in JSON. | Parameter: {String} url | the URL of the XML object to be converted; this can be any URL and is not prepended with the Fusion URL | | Parameter: {Function} callback | a callback function to be called if the request is successful |
boolean indicator if the content is JSON or not. xml2json| xml2json: function( | callback, | | r, | | json | ) |
|
Callback method to convert the XNR response into an actual json object and triggers the call to the callback method Parameter: callback callback method to be executed on success and will be passed a parsed json object Parameter: {XmlHttpRequest} r the XmlHttpRequest object Parameter: json boolean indicator if the content is JSON or not (set by OpenLayers) getMapByName| getMapByName: function( | name | ) |
|
return a map widget with the given name Parameter: {String} name The map name to return Returns: {Object} a map object or null if not found. getMapByIdreturn a map widget that is associated with the given DOM element by id. Parameter: {String} id The map id to return Returns: {Object} a map object or null if not found. getMapByIndice| getMapByIndice: function( | indice | ) |
|
return the map widget at the given index if there are more than one map elements specified in the AppDef Parameter: {String} indice The map indice to return Returns: {Object} a map object or null if not found. getWidgetById| getWidgetById: function( | id | ) |
|
return a reference to a widget by the id of the DOM Element that it was created in. Parameter: {String} id the DOM id to get the widget for Returns: {Fusion.Widget} the widget or null getApplicationURL| getApplicationURL: function() |
returns the applicaiton’s absolute URL minus the filename.html part Returns: {String} a URL getFusionURLreturns the application’s absolute URL minus the filename.html part Returns: {String} a URL getConfigurationItem| getConfigurationItem: function( | arch, | | key | ) |
|
returns individual elements out of the Fusion config.json file | Parameter: {String} arch | the server architecture (mapguide or mapserver) | | Parameter: {String} key | the config item to be returned |
Returns: {String} a the value for the key of null if not found getScriptLanguage| getScriptLanguage: function() |
Accessor to return the server-side script language Returns: {String} the script language e.g. ‘php’ getRedirectScript| getRedirectScript: function() |
Accessor to return the URL of the redirect script Returns: {String} a URL getBrokerAccessor to return the broker object (for MapGuide only). The broker is used to prepare various queries to the MapGuide server. Returns: {Object} the broker object requireMarks a JavaScript file as required which puts it into the queue for loading during Fusion initialization. Widget code is included through this mecahnism | Parameter: {String} url | the URL of the JS file to be loaded |
Returns: none reportErrorTriggers the Fusion.Event.FUSION_ERROR and passes along the error object to the callback functions registered for this event. Widgets call Fusion.reportError(o) to inform the system of errors. Applications will typically register an event listener for the error event and do something to report the error to the user. By default, errors are not reported since there is no listener | Parameter: {Object} o | the error object which is typically a string |
Returns: none unitFromName| unitFromName: function( | unit | ) |
|
returns index into the units array for the given unit name or abbreviation | Parameter: {String} unit | the units name to look up |
Returns: {Integer} index into the units array unitFromNameGiven a unit, this method returns if the units system is one ofimperial, metric, degrees or device units | Parameter: {Integer} unit | the units array index |
Returns: {String} the units system unitNameGiven a unit, this method returns the units name | Parameter: {Integer} unit | the units array index |
Returns: {String} the units name unitAbbrGiven a unit, this method returns the units abbreviation | Parameter: {Integer} unit | the units array index |
Returns: {String} the units abbreviation toMeter| toMeter: function( | unit, | | value | ) |
|
Converts a length value from native units into meters. This is the identity transform if the input units are meters | Parameter: {Integer} unit | the units array index | | Parameter: {Float} value | the value to be converted |
Returns: {Float} the value in meters fromMeter| fromMeter: function( | unit, | | value | ) |
|
Converts a length value from meters into native units. This is the identity transform if the native units are meters | Parameter: {Integer} unit | the units array index | | Parameter: {Float} value | the value to be converted |
Returns: {Float} the value in native units convert| convert: function( | unitsIn, | | unitsOut, | | value | ) |
|
Converts a length value from one unit system into another. | Parameter: {Integer} unitsIn | the units array index of the input | | Parameter: {Integer} unitsOut | the units array index of the output | | Parameter: {Float} value | the value to be converted |
Returns: {Float} the value in output units initUnits| initUnits: function( | metersPerUnit | ) |
|
initializes the meters per unit values when a new map is loaded. Some systems make different assumptions for the conversion of degrees to meters so this makes sure both Fusion and OpenLayers are using the same value. | Parameter: {Float} metersPerUnit | the value returned by LoadMap.php for meters per unit |
getClosestUnits| getClosestUnits: function( | metersPerUnit | ) |
|
find the OpenLayers units identifier given the Fusion metersPerUnit value @param metersPerUnit the value returned by LoadMap.php for meters per unit addWidgetStyleSheet| addWidgetStyleSheet: function( | url | ) |
|
Dynamically load a CSS stylesheet. The url will be prepended with the Fusion URL. | Parameter: {String} url | the URL of the CSS file to be loaded |
Returns: none parseQueryString| parseQueryString: function() |
An initialization time function to parse the application URL parameters and stores them in an array. They can be retrieved using Fusion.getQueryParam(key). Returns: {Array} an array of the query params from when the page was loaded getQueryParam| getQueryParam: function( | p | ) |
|
Returns the query parameter value for a given parameter name | Parameter: {String} p | the parameter to lookup |
Returns: parameter value or the empty string ‘’ if not found _scriptName{String} Relative path of this script. _getScriptLocation| _getScriptLocation: function () |
Return the path to this script for bootstrapping Fusion. Returns{String} Path to this script createSessionId| var createSessionId = function() |
Pre-create a session to avoid the 401 Unauthorized dialog OpenLayersThe OpenLayers object provides a namespace for all things OpenLayers Summary | | | {String} Relative path of this script. | | | | Return the path to this script. | | | | |
_scriptName{String} Relative path of this script. _getScriptLocation| _getScriptLocation: function () |
Return the path to this script. Returns{String} Path to this script UtilSummary | | | This is the old $() from prototype | | Remove an object from an array. | | | | Seems to exist already in FF, but not in MOZ. | | Modifies many properties of a DOM element all at once. | | Creates a new div and optionally set some standard attributes. | | Creates an img element with specific attribute values. | | | | Bound to image load events. | | {String} The color tiles with load errors will turn. | | {Integer} How many times should we try to reload an image before giving up? | | | | {Boolean} true if the png alpha hack is necessary and possible, false otherwise. | | Checks whether it’s necessary (and possible) to use the png alpha hack which allows alpha transparency for png images under Internet Explorer. | | | | | | Creates a new hashtable and copies over all the keys from the passed-in object, but storing them under an uppercased version of the key at which they were stored. | | Takes an object and copies any properties that don’t exist from another properties, by analogy with OpenLayers.Util.extend() from Prototype.js. | | | | | | {String} The fully formatted image location string | | Execute functions until one of them doesn’t throw an error. | | These could/should be made namespace aware? | | | | | | | | | | {Number} The number of significant digits to retain to avoid floating point precision errors. | | Convenience method to cast an object to a Number, rounded to the desired floating point precision. | | | | Given two objects representing points with geographic coordinates, this calculates the distance between those points on the surface of an ellipsoid. | | Parse the parameters from a URL or from the current page itself into a JavaScript Object. | | | | {Integer} The ever-incrementing count variable. | | Create a unique identifier for this session. | | | | | | {Integer} 72 (A sensible default) | | | | | | | | | | | | Calculates the position of an element on the page. | | Test two URLs for equivalence. | | | | Takes a url and removes everything after the ? | | {String} A string which specifies which is the current browser in which we are running. | | Renders the contentHTML offscreen to determine actual dimensions for popup sizing. |
getElement| OpenLayers.Util.getElement = function() |
This is the old $() from prototype removeItem| OpenLayers.Util.removeItem = function( | array, | | item | ) |
|
Remove an object from an array. Iterates through the array to find the item, then removes it. ParametersReturn {Array} A reference to the array clearArray| OpenLayers.Util.clearArray = function( | array | ) |
|
Deprecated. This function will disappear in 3.0. Please use “array.length = 0” instead. ParametersindexOf| OpenLayers.Util.indexOf = function( | array, | | obj | ) |
|
Seems to exist already in FF, but not in MOZ. ParametersReturns{Integer} The index at, which the object was found in the array. If not found, returns -1. modifyDOMElement| OpenLayers.Util.modifyDOMElement = function( | element, | | id, | | px, | | sz, | | position, | | border, | | overflow, | | opacity | ) |
|
Modifies many properties of a DOM element all at once. Passing in null to an individual parameter will avoid setting the attribute. Parameters| id | {String} The element id attribute to set. | | px | {OpenLayers.Pixel} The left and top style position. | | sz | {OpenLayers.Size} The width and height style attributes. | | position | {String} The position attribute. eg: absolute, relative, etc. | | border | {String} The style.border attribute. eg: solid black 2px | | overflow | {String} The style.overview attribute. | | opacity | {Float} Fractional value (0.0 - 1.0) |
createDiv| OpenLayers.Util.createDiv = function( | id, | | px, | | sz, | | imgURL, | | position, | | border, | | overflow, | | opacity | ) |
|
Creates a new div and optionally set some standard attributes. Null may be passed to each parameter if you do not wish to set a particular attribute. Note - zIndex is NOT set on the resulting div. Parameters| id | {String} An identifier for this element. If no id is passed an identifier will be created automatically. | | px | {OpenLayers.Pixel} The element left and top position. | | sz | {OpenLayers.Size} The element width and height. | | imgURL | {String} A url pointing to an image to use as a background image. | | position | {String} The style.position value. eg: absolute, relative etc. | | border | {String} The the style.border value. eg: 2px solid black | | overflow | {String} The style.overflow value. Eg. hidden | | opacity | {Float} Fractional value (0.0 - 1.0) |
Returns{DOMElement} A DOM Div created with the specified attributes. createImage| OpenLayers.Util.createImage = function( | id, | | px, | | sz, | | imgURL, | | position, | | border, | | opacity, | | delayDisplay | ) |
|
Creates an img element with specific attribute values. Parameters| id | {String} The id field for the img. If none assigned one will be automatically generated. | | px | {OpenLayers.Pixel} The left and top positions. | | sz | {OpenLayers.Size} The style.width and style.height values. | | imgURL | {String} The url to use as the image source. | | position | {String} The style.position value. | | border | {String} The border to place around the image. | | opacity | {Float} Fractional value (0.0 - 1.0) | | delayDisplay | {Boolean} If true waits until the image has been loaded. |
Returns{DOMElement} A DOM Image created with the specified attributes. setOpacity| OpenLayers.Util.setOpacity = function( | element, | | opacity | ) |
|
Deprecated. This function has been deprecated. Instead, please use <OpenLayers.Util.modifyDOMElement> or <OpenLayers.Util.modifyAlphaImageDiv> Set the opacity of a DOM Element Note that for this function to work in IE, elements must “have layout” according to: http://msdn.microsoft.com- /workshop- /author- /dhtml- /reference- /properties- /haslayout.asp Parameters| element | {DOMElement} Set the opacity on this DOM element | | opacity | {Float} Opacity value (0.0 - 1.0) |
onImageLoad| OpenLayers.Util.onImageLoad = function() |
Bound to image load events. For all images created with createImage or createAlphaImageDiv, this function will be bound to the load event. onImageLoadErrorColor{String} The color tiles with load errors will turn. Default is “pink” IMAGE_RELOAD_ATTEMPTS{Integer} How many times should we try to reload an image before giving up? Default is 0 onImageLoadError| OpenLayers.Util.onImageLoadError = function() |
alphaHackNeeded{Boolean} true if the png alpha hack is necessary and possible, false otherwise. alphaHack| OpenLayers.Util.alphaHack = function() |
Checks whether it’s necessary (and possible) to use the png alpha hack which allows alpha transparency for png images under Internet Explorer. Returns{Boolean} true if the png alpha hack is necessary and possible, false otherwise. modifyAlphaImageDiv| OpenLayers.Util.modifyAlphaImageDiv = function( | div, | | id, | | px, | | sz, | | imgURL, | | position, | | border, | | sizing, | | opacity | ) |
|
| div | {DOMElement} Div containing Alpha-adjusted Image | | id | {String} | | px | {OpenLayers.Pixel} | | sz | {OpenLayers.Size} | | imgURL | {String} | | position | {String} | | border | {String} sizing {String} ‘crop’, ‘scale’, or ‘image’. Default is “scale” | | opacity | {Float} Fractional value (0.0 - 1.0) |
createAlphaImageDiv| OpenLayers.Util.createAlphaImageDiv = function( | id, | | px, | | sz, | | imgURL, | | position, | | border, | | sizing, | | opacity, | | delayDisplay | ) |
|
| id | {String} | | px | {OpenLayers.Pixel} | | sz | {OpenLayers.Size} | | imgURL | {String} | | position | {String} | | border | {String} | | sizing | {String} ‘crop’, ‘scale’, or ‘image’. Default is “scale” | | opacity | {Float} Fractional value (0.0 - 1.0) | | delayDisplay | {Boolean} If true waits until the image has been loaded. |
Returns{DOMElement} A DOM Div created with a DOM Image inside it. If the hack is needed for transparency in IE, it is added. upperCaseObject| OpenLayers.Util.upperCaseObject = function ( | object | ) |
|
Creates a new hashtable and copies over all the keys from the passed-in object, but storing them under an uppercased version of the key at which they were stored. ParametersReturns{Object} A new Object with all the same keys but uppercased applyDefaults| OpenLayers.Util.applyDefaults = function ( | to, | | from | ) |
|
Takes an object and copies any properties that don’t exist from another properties, by analogy with OpenLayers.Util.extend() from Prototype.js. Parameters| to | {Object} The destination object. | | from | {Object} The source object. Any properties of this object that are undefined in the to object will be set on the to object. |
Returns{Object} A reference to the to object. Note that the to argument is modified in place and returned by this function. getParameterString| OpenLayers.Util.getParameterString = function( | params | ) |
|
ParametersReturns{String} A concatenation of the properties of an object in http parameter notation. (ex. <i>”key1=value1&key2=value2&key3=value3”</i>) If a parameter is actually a list, that parameter will then be set to a comma-seperated list of values (foo,bar) instead of being URL escaped (foo%3Abar). getImagesLocation| OpenLayers.Util.getImagesLocation = function() |
Returns{String} The fully formatted image location string Try| OpenLayers.Util.Try = function() |
Execute functions until one of them doesn’t throw an error. Capitalized because “try” is a reserved word in JavaScript. Taken directly from OpenLayers.Util.Try() Parameters| [*] | {Function} Any number of parameters may be passed to Try() It will attempt to execute each of them until one of them successfully executes. If none executes successfully, returns null. |
Returns{*} The value returned by the first successfully executed function. getNodes| OpenLayers.Util.getNodes=function( | p, | | tagName | ) |
|
These could/should be made namespace aware? ParametersReturns{Array} _getNodes| OpenLayers.Util._getNodes=function( | nodes, | | tagName | ) |
|
Parameters| nodes | {Array} | | tagName | {String} |
Returns{Array} getTagText| OpenLayers.Util.getTagText = function ( | parent, | | item, | | index | ) |
|
Parameters| parent | {} | | item | {String} | | index | {Integer} |
Returns{String} getXmlNodeValue| OpenLayers.Util.getXmlNodeValue = function( | node | ) |
|
ParametersReturns{String} The text value of the given node, without breaking in firefox or IE mouseLeft| OpenLayers.Util.mouseLeft = function ( | evt, | | div | ) |
|
Parameters| evt | {Event} | | div | {HTMLDivElement} |
Returns{Boolean} precision{Number} The number of significant digits to retain to avoid floating point precision errors. We use 14 as a “safe” default because, although IEEE 754 double floats (standard on most modern operating systems) support up to about 16 significant digits, 14 significant digits are sufficient to represent sub-millimeter accuracy in any coordinate system that anyone is likely to use with OpenLayers. If DEFAULT_PRECISION is set to 0, the original non-truncating behavior of OpenLayers <2.8 is preserved. Be aware that this will cause problems with certain projections, e.g. spherical Mercator. toFloat| OpenLayers.Util.toFloat = function ( | number, | | precision | ) |
|
Convenience method to cast an object to a Number, rounded to the desired floating point precision. Parameters| number | {Number} The number to cast and round. | | precision | {Number} An integer suitable for use with Number.toPrecision(). Defaults to OpenLayers.Util.DEFAULT_PRECISION. If set to 0, no rounding is performed. |
Returns{Number} The cast, rounded number. rad| OpenLayers.Util.rad = function( | x | ) |
|
ParametersReturns{Float} distVincenty| OpenLayers.Util.distVincenty=function( | p1, | | p2 | ) |
|
Given two objects representing points with geographic coordinates, this calculates the distance between those points on the surface of an ellipsoid. ParametersReturns{Float} The distance (in km) between the two input points as measured on an ellipsoid. Note that the input point objects must be in geographic coordinates (decimal degrees) and the return distance is in kilometers. getParameters| OpenLayers.Util.getParameters = function( | url | ) |
|
Parse the parameters from a URL or from the current page itself into a JavaScript Object. Note that parameter values with commas are separated out into an Array. Parameters| url | {String} Optional url used to extract the query string. If null, query string is taken from page location. |
Returns{Object} An object of key/value pairs from the query string. getArgs| OpenLayers.Util.getArgs = function( | url | ) |
|
Deprecated. Will be removed in 3.0. Please use instead <OpenLayers.Util.getParameters> Parameters| url | {String} Optional url used to extract the query string. If null, query string is taken from page location. |
Returns{Object} An object of key/value pairs from the query string. lastSeqID{Integer} The ever-incrementing count variable. Used for generating unique ids. createUniqueID| OpenLayers.Util.createUniqueID = function( | prefix | ) |
|
Create a unique identifier for this session. Each time this function is called, a counter is incremented. The return will be the optional prefix (defaults to “id_”) appended with the counter value. Parametersprefix {String} Optionsal string to prefix unique id. Default is “id_”. Returns{String} A unique id string, built on the passed in prefix. DOTS_PER_INCH{Integer} 72 (A sensible default) normalizeScale| OpenLayers.Util.normalizeScale = function ( | scale | ) |
|
ParametersReturns{Float} A normalized scale value, in 1 / X format. This means that if a value less than one ( already 1/x) is passed in, it just returns scale directly. Otherwise, it returns 1 / scale getResolutionFromScale| OpenLayers.Util.getResolutionFromScale = function ( | scale, | | units | ) |
|
Parameters| scale | {Float} | | units | {String} Index into OpenLayers.INCHES_PER_UNIT hashtable. Default is degrees |
Returns{Float} The corresponding resolution given passed-in scale and unit parameters. getScaleFromResolution| OpenLayers.Util.getScaleFromResolution = function ( | resolution, | | units | ) |
|
Parameters| resolution | {Float} | | units | {String} Index into OpenLayers.INCHES_PER_UNIT hashtable. Default is degrees |
Returns{Float} The corresponding scale given passed-in resolution and unit parameters. safeStopPropagation| OpenLayers.Util.safeStopPropagation = function( | evt | ) |
|
Deprecated. This function has been deprecated. Please use directly OpenLayers.Event.stop passing ‘true’ as the 2nd argument (preventDefault) Safely stop the propagation of an event without preventing the default browser action from occurring. ParameterpagePositonCalculates the position of an element on the page. ParametersReturns{Array} two item array, L value then T value. isEquivalentUrl| OpenLayers.Util.isEquivalentUrl = function( | url1, | | url2, | | options | ) |
|
Test two URLs for equivalence. Setting ‘ignoreCase’ allows for case-independent comparison. Comparison is based on- Protocol
- Host (evaluated without the port)
- Port (set ‘ignorePort80’ to ignore “80” values)
- Hash ( set ‘ignoreHash’ to disable)
- Pathname (for relative <-> absolute comparison)
- Arguments (so they can be out of order)
Parameters| url1 | {String} | | url2 | {String} | | options | {Object} Allows for customization of comparison: | | ’ignoreCase’ | Default is True | | ’ignorePort80’ | Default is True | | ’ignoreHash’ | Default is True |
Returns{Boolean} Whether or not the two URLs are equivalent createUrlObject| OpenLayers.Util.createUrlObject = function( | url, | | options | ) |
|
Parameters| url | {String} | | options | {Object} A hash of options. Can be one of: ignoreCase: lowercase url, ignorePort80: don’t include explicit port if port is 80, ignoreHash: Don’t include part of url after the hash (#). |
Returns{Object} An object with separate url, a, port, host, and args parsed out and ready for comparison removeTail| OpenLayers.Util.removeTail = function( | url | ) |
|
Takes a url and removes everything after the ? and # Parameters| url | {String} The url to process |
Returns{String} The string with all queryString and Hash removed getBrowserName| OpenLayers.Util.getBrowserName = function() |
Returns{String} A string which specifies which is the current browser in which we are running. Currently-supported browser detection and codes- ’opera’ -- Opera
- ’msie’ -- Internet Explorer
- ’safari’ -- Safari
- ’firefox’ -- FireFox
- ’mozilla’ -- Mozilla
If we are unable to property identify the browser, we return an empty string. getRenderedDimensions| OpenLayers.Util.getRenderedDimensions = function( | contentHTML, | | size, | | options | ) |
|
Renders the contentHTML offscreen to determine actual dimensions for popup sizing. As we need layout to determine dimensions the content is rendered -9999px to the left and absolute to ensure the scrollbars do not flicker ParameterscontentHTML size - {OpenLayers.Size} If either the ‘w’ or ‘h’ properties is specified, we fix that dimension of the div to be measured. This is useful in the case where we have a limit in one dimension and must therefore meaure the flow in the other dimension. options - {Object} displayClass - {String} Optional parameter. A CSS class name(s) string to provide the CSS context of the rendered content. containerElement - {DOMElement} Optional parameter. Insert the HTML to this node instead of the body root when calculating dimensions. Returns{OpenLayers.Size} OpenLayers. ConsoleThe OpenLayers.Console namespace is used for debugging and error logging. If the Firebug Lite (../Firebug/firebug.js) is included before this script, calls to OpenLayers.Console methods will get redirected to window.console. This makes use of the Firebug extension where available and allows for cross-browser debugging Firebug style. NoteNote that behavior will differ with the Firebug extention and Firebug Lite. Most notably, the Firebug Lite console does not currently allow for hyperlinks to code or for clicking on object to explore their properties. Summary | | | OpenLayers custom string, number and function functions are described here. |
OpenLayers Base TypesOpenLayers custom string, number and function functions are described here. OpenLayers. StringContains convenience functions for string manipulation. Summary | | | Used to find tokens in a string. | | Used to test strings as numbers. |
OpenLayers. String. tokenRegExUsed to find tokens in a string. Examples: ${a}, ${a.b.c}, ${a-b}, ${5} OpenLayers. String. numberRegExUsed to test strings as numbers. OpenLayers. NumberContains convenience functions for manipulating numbers. Summary | | | Decimal separator to use when formatting numbers. | | Thousands separator to use when formatting numbers. |
decimalSeparatorDecimal separator to use when formatting numbers. thousandsSeparatorThousands separator to use when formatting numbers. OpenLayers. FunctionContains convenience functions for function manipulation. OpenLayers. ArrayContains convenience functions for array manipulation. Summary | | | Base class used to construct all other classes. | | | | |
OpenLayers. Class| OpenLayers.Class = function() |
Base class used to construct all other classes. Includes support for multiple inheritance. This constructor is new in OpenLayers 2.5. At OpenLayers 3.0, the old syntax for creating classes and dealing with inheritance will be removed. To create a new OpenLayers-style class, use the following syntaxvar MyClass = OpenLayers.Class(prototype);
To create a new OpenLayers-style class with multiple inheritance, use the following syntax: var MyClass = OpenLayers.Class(Class1, Class2, prototype);
Note that instanceof reflection will only reveil Class1 as superclass. Class2 ff are mixins. isPrototypeDeprecated. This is no longer needed and will be removed at 3.0. OpenLayers.SizeInstances of this class represent a width/height pair Summary | | | Create an instance of OpenLayers.Size | | Return the string representation of a size object |
OpenLayers.SizeCreate an instance of OpenLayers.Size Parameters| w | {Number} width | | h | {Number} height |
toStringReturn the string representation of a size object Returns{String} The string representation of OpenLayers.Size object. (ex. <i>”w=55,h=66”</i>) OpenLayers. BoundsInstances of this class represent bounding boxes. Data stored as left, bottom, right, top floats. All values are initialized to null, however, you should make sure you set them before using the bounds for anything. Possible use casebounds = new OpenLayers.Bounds();
bounds.extend(new OpenLayers.LonLat(4,5));
bounds.extend(new OpenLayers.LonLat(5,6));
bounds.toBBOX(); // returns 4,5,5,6
Summary | | | {Number} Minimum horizontal coordinate. | | {Number} Minimum vertical coordinate. | | {Number} Maximum horizontal coordinate. | | {Number} Maximum vertical coordinate. | | | | | | Construct a new bounds object. | | Create a cloned instance of this bounds. | | Test a two bounds for equivalence. | | Scales the bounds around a pixel or lonlat. | | Get the opposite quadrant for a given quadrant string. |
left{Number} Minimum horizontal coordinate. bottom{Number} Minimum vertical coordinate. right{Number} Maximum horizontal coordinate. top{Number} Maximum vertical coordinate. centerLonLat{OpenLayers.LonLat} A cached center location. This should not be accessed directly. Use <getCenterLonLat> instead. OpenLayers. BoundsConstruct a new bounds object. Parameters| left | {Number} The left bounds of the box. Note that for width calculations, this is assumed to be less than the right value. | | bottom | {Number} The bottom bounds of the box. Note that for height calculations, this is assumed to be more than the top value. | | right | {Number} The right bounds. | | top | {Number} The top bounds. |
cloneCreate a cloned instance of this bounds. Returns{OpenLayers.Bounds} A fresh copy of the bounds equalsTest a two bounds for equivalence. ParametersReturns{Boolean} The passed-in bounds object has the same left, right, top, bottom components as this. Note that if bounds passed in is null, returns false. scale| scale: function( | ratio, | | origin | ) |
|
Scales the bounds around a pixel or lonlat. Note that the new bounds may return non-integer properties, even if a pixel is passed. ParametersReturns{<OpenLayers.Bound>} A new bounds that is scaled by ratio from origin. oppositeQuadrant| OpenLayers.Bounds.oppositeQuadrant = function( | quadrant | ) |
|
Get the opposite quadrant for a given quadrant string. Parameters| quadrant | {String} two character quadrant shortstring |
Returns{String} The opposing quadrant (“br” “tr” “tl” “bl”). For Example, if you pass in “bl” it returns “tr”, if you pass in “br” it returns “tl”, etc. OpenLayers. ElementSummary | | | Tests if an element has the given CSS class name. | | Add a CSS class name to an element. | | Remove a CSS class name from an element. | | Remove a CSS class name from an element if it exists. |
hasClass| hasClass: function( | element, | | name | ) |
|
Tests if an element has the given CSS class name. Parameters| element | {DOMElement} A DOM element node. | | name | {String} The CSS class name to search for. |
Returns{Boolean} The element has the given class name. addClass| addClass: function( | element, | | name | ) |
|
Add a CSS class name to an element. Safe where element already has the class name. Parameters| element | {DOMElement} A DOM element node. | | name | {String} The CSS class name to add. |
Returns{DOMElement} The element. removeClass| removeClass: function( | element, | | name | ) |
|
Remove a CSS class name from an element. Safe where element does not have the class name. Parameters| element | {DOMElement} A DOM element node. | | name | {String} The CSS class name to remove. |
Returns{DOMElement} The element. toggleClass| toggleClass: function( | element, | | name | ) |
|
Remove a CSS class name from an element if it exists. Add the class name if it doesn’t exist. Parameters| element | {DOMElement} A DOM element node. | | name | {String} The CSS class name to toggle. |
Returns{DOMElement} The element. OpenLayers. LonLatThis class represents a longitude and latitude pair Summary | | | Create a new map location. | | Return a readable string version of the lonlat | | |
OpenLayers. LonLatCreate a new map location. Parameters| lon | {Number} The x-axis coordinate in map units. If your map is in a geographic projection, this will be the Longitude. Otherwise, it will be the x coordinate of the map location in your map units. | | lat | {Number} The y-axis coordinate in map units. If your map is in a geographic projection, this will be the Latitude. Otherwise, it will be the y coordinate of the map location in your map units. |
toStringReturn a readable string version of the lonlat Returns{String} String representation of OpenLayers.LonLat object. (ex. <i>”lon=5,lat=42”</i>) fromString| OpenLayers.LonLat.fromString = function( | str | ) |
|
Alternative constructor that builds a new OpenLayers.LonLat from a parameter string Parameters| str | {String} Comma-separated Lon,Lat coordinate string. (ex. <i>”5,40”</i>) |
Returns{OpenLayers.LonLat} New OpenLayers.LonLat object built from the passed-in String. OpenLayers. PixelThis class represents a screen coordinate, in x and y coordinates Summary | | | Create a new OpenLayers.Pixel instance | | Cast this object into a string |
OpenLayers. PixelCreate a new OpenLayers.Pixel instance Parameters| x | {Number} The x coordinate | | y | {Number} The y coordinate |
ReturnsAn instance of OpenLayers.Pixel toStringCast this object into a string Returns{String} The string representation of Pixel. ex: “x=200.4,y=242.2” OpenLayers.IconThe icon represents a graphical icon on the screen. Typically used in conjunction with a OpenLayers.Marker to represent markers on a screen. An icon has a url, size and position. It also contains an offset which allows the center point to be represented correctly. This can be provided either as a fixed offset or a function provided to calculate the desired offset. Summary | | | | | | | | | | | | | | | | | Creates an icon, which is an image tag in a div. | | Nullify references and remove event listeners to prevent circular references and memory leaks | | | | | | | | Move the div to the given pixel. | | Erase the underlying image element. | | Change the icon’s opacity | | move icon to passed in px. | | |
offset{OpenLayers.Pixel} distance in pixels to offset the image when being rendered calculateOffset{OpenLayers.Pixel} Function to calculate the offset (based on the size) OpenLayers.IconCreates an icon, which is an image tag in a div. destroyNullify references and remove event listeners to prevent circular references and memory leaks drawMove the div to the given pixel. ParametersReturns{DOMElement} A new DOM Image of this icon set at the location passed-in eraseErase the underlying image element. setOpacity| setOpacity: function( | opacity | ) |
|
Change the icon’s opacity ParametersmoveTomove icon to passed in px. Parametersdisplay| display: function( | display | ) |
|
Hide or show the icon ParametersOpenLayers. PopupA popup is a small div that can opened and closed on the map. Typically opened in response to clicking on a marker. See OpenLayers.Marker. Popup’s don’t require their own layer and are added the the map using the <OpenLayers.Map.addPopup> method. Examplepopup = new OpenLayers.Popup("chicken",
new OpenLayers.LonLat(5,40),
new OpenLayers.Size(200,200),
"example popup",
true);
map.addPopup(popup);
Summary | | | | | {String} the unique identifier assigned to this popup. | | | | {DOMElement} the div that contains this popup. | | | | | | {String} An HTML string for this popup to display. | | {String} the background color used by the popup. | | {float} the opacity of this popup (between 0.0 and 1.0) | | {String} the border size of the popup. | | {DOMElement} a reference to the element that holds the content of the div. | | {DOMElement} First and only child of ‘div’. | | {DOMElement} the optional closer image | | {String} The CSS class of the popup. | | {String} The CSS class of the popup content div. | | {int or OpenLayers.Bounds} An extra opportunity to specify internal padding of the content div inside the popup. | | {Boolean} The hack for overflow in Firefox causes all elements to be re-drawn, which causes Flash elements to be re-initialized, which is troublesome. | | To be removed in 3.0, this function merely helps us to deal with the case where the user may have set an integer value for padding, instead of an OpenLayers.Bounds object. | | { OpenLayers.Map} this gets set in Map.js when the popup is added to the map | | | | nullify references to prevent circular references and memory leaks | | Constructs the elements that make up the popup. | | if the popup has a lonlat and its map members set, then have it move itself to its proper position | | | | {Boolean} Boolean indicating whether or not the popup is visible | | Toggles visibility of the popup. | | | | Makes the popup invisible. | | Used to adjust the size of the popup. | | Sets the background color of the popup. | | Sets the opacity of the popup. | | Sets the border style of the popup. | | Allows the user to set the HTML content of the popup. | | Called when an image contained by the popup loaded. | | Glorious, oh glorious hack in order to determine the css ‘padding’ of the contentDiv. | | | | Pans the map such that the popup is totaly viewable (if necessary) | | Registers events on the popup. | | When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside) | | If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside) | | When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside | | Ignore clicks, but allowing default browser handling | | When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused. | | Ignore double-clicks, but allowing default browser handling |
id{String} the unique identifier assigned to this popup. div{DOMElement} the div that contains this popup. contentHTML{String} An HTML string for this popup to display. backgroundColor{String} the background color used by the popup. opacity{float} the opacity of this popup (between 0.0 and 1.0) border{String} the border size of the popup. (eg 2px) contentDiv{DOMElement} a reference to the element that holds the content of the div. groupDiv{DOMElement} First and only child of ‘div’. The group Div contains the ‘contentDiv’ and the ‘closeDiv’. closeDiv{DOMElement} the optional closer image displayClass{String} The CSS class of the popup. contentDisplayClass{String} The CSS class of the popup content div. padding{int or OpenLayers.Bounds} An extra opportunity to specify internal padding of the content div inside the popup. This was originally confused with the css padding as specified in style.css’s ‘olPopupContent’ class. We would like to get rid of this altogether, except that it does come in handy for the framed and anchoredbubble popups, who need to maintain yet another barrier between their content and the outer border of the popup itself. Note that in order to not break API, we must continue to support this property being set as an integer. Really, though, we’d like to have this specified as a Bounds object so that user can specify distinct left, top, right, bottom paddings. With the 3.0 release we can make this only a bounds. disableFirefoxOverflowHack{Boolean} The hack for overflow in Firefox causes all elements to be re-drawn, which causes Flash elements to be re-initialized, which is troublesome. With this property the hack can be disabled. fixPaddingTo be removed in 3.0, this function merely helps us to deal with the case where the user may have set an integer value for padding, instead of an OpenLayers.Bounds object. map{OpenLayers.Map} this gets set in Map.js when the popup is added to the map OpenLayers. PopupCreate a popup. Parameters| id | {String} a unqiue identifier for this popup. If null is passed an identifier will be automatically generated. | | lonlat | {OpenLayers.LonLat} The position on the map the popup will be shown. | | contentSize | {OpenLayers.Size} The size of the content. | | contentHTML | {String} An HTML string to display inside the popup. | | closeBox | {Boolean} Whether to display a close box inside the popup. | | closeBoxCallback | {Function} Function to be called on closeBox click. |
destroynullify references to prevent circular references and memory leaks drawConstructs the elements that make up the popup. ParametersReturns{DOMElement} Reference to a div that contains the drawn popup updatePosition| updatePosition: function() |
if the popup has a lonlat and its map members set, then have it move itself to its proper position visibleReturns{Boolean} Boolean indicating whether or not the popup is visible toggleToggles visibility of the popup. hideMakes the popup invisible. setSize| setSize:function( | contentSize | ) |
|
Used to adjust the size of the popup. Parameters| contentSize | {OpenLayers.Size} the new size for the popup’s contents div (in pixels). |
setBackgroundColor| setBackgroundColor:function( | color | ) |
|
Sets the background color of the popup. Parameters| color | {String} the background color. eg “#FFBBBB” |
setOpacity| setOpacity:function( | opacity | ) |
|
Sets the opacity of the popup. Parameters| opacity | {float} A value between 0.0 (transparent) and 1.0 (solid). |
setBorder| setBorder:function( | border | ) |
|
Sets the border style of the popup. Parameters| border | {String} The border style value. eg 2px |
setContentHTML| setContentHTML:function( | contentHTML | ) |
|
Allows the user to set the HTML content of the popup. Parameters| contentHTML | {String} HTML for the div. |
registerImageListeners| registerImageListeners: function() |
Called when an image contained by the popup loaded. this function updates the popup size, then unregisters the image load listener. getContentDivPadding| getContentDivPadding: function() |
Glorious, oh glorious hack in order to determine the css ‘padding’ of the contentDiv. IE/Opera return null here unless we actually add the popup’s main ‘div’ element (which contains contentDiv) to the DOM. So we make it invisible and then add it to the document temporarily. Once we’ve taken the padding readings we need, we then remove it from the DOM (it will actually get added to the DOM in Map.js’s addPopup) Returns{OpenLayers.Bounds} addCloseBox| addCloseBox: function( | callback | ) |
|
Parameters| callback | {Function} The callback to be called when the close button is clicked. |
panIntoViewPans the map such that the popup is totaly viewable (if necessary) registerEvents| registerEvents:function() |
Registers events on the popup. Do this in a separate function so that subclasses can choose to override it if they wish to deal differently with mouse events Note in the following handler functions that some special care is needed to deal correctly with mousing and popups. Because the user might select the zoom-rectangle option and then drag it over a popup, we need a safe way to allow the mousemove and mouseup events to pass through the popup when they are initiated from outside. Otherwise, we want to essentially kill the event propagation for all other events, though we have to do so carefully, without disabling basic html functionality, like clicking on hyperlinks or drag-selecting text. onmousedown| onmousedown: function ( | evt | ) |
|
When mouse goes down within the popup, make a note of it locally, and then do not propagate the mousedown (but do so safely so that user can select text inside) Parametersonmousemove| onmousemove: function ( | evt | ) |
|
If the drag was started within the popup, then do not propagate the mousemove (but do so safely so that user can select text inside) Parametersonmouseup| onmouseup: function ( | evt | ) |
|
When mouse comes up within the popup, after going down in it, reset the flag, and then (once again) do not propagate the event, but do so safely so that user can select text inside ParametersonclickIgnore clicks, but allowing default browser handling Parametersonmouseout| onmouseout: function ( | evt | ) |
|
When mouse goes out of the popup set the flag to false so that if they let go and then drag back in, we won’t be confused. Parametersondblclick| ondblclick: function ( | evt | ) |
|
Ignore double-clicks, but allowing default browser handling ParametersOpenLayers. ProtocolAbstract vector layer protocol class. Not to be instantiated directly. Use one of the protocol subclasses instead. Summary | | | | | {Object} Any options sent to the constructor. | | {Boolean} The creator of the protocol can set autoDestroy to false to fully control when the protocol is destroyed. | | | | Abstract class for vector protocols. | | Abort an ongoing request. |
options{Object} Any options sent to the constructor. autoDestroy{Boolean} The creator of the protocol can set autoDestroy to false to fully control when the protocol is destroyed. Defaults to true. OpenLayers. ProtocolAbstract class for vector protocols. Create instances of a subclass. Parameters| options | {Object} Optional object whose properties will be set on the instance. |
abort| abort: function( | response | ) |
|
Abort an ongoing request. ParametersOpenLayers. Protocol. ResponseProtocols return Response objects to their users. Summary | | | | | {String} The type of request this response corresponds to. | | | | | | | | | | | | | | |
code| {Number} | OpenLayers.Protocol.Response.SUCCESS or OpenLayers.Protocol.Response.FAILURE |
requestType{String} The type of request this response corresponds to. Either “create”, “read”, “update” or “delete”. last| {Boolean} | true if this is the last response expected in a commit, false otherwise, defaults to true. |
OpenLayers. Protocol. ResponseParameters| options | {Object} Optional object whose properties will be set on the instance. |
successReturns| {Boolean} | true on success, false otherwise |
OpenLayers. RendererThis is the base class for all renderers. This is based on a merger code written by Paul Spencer and Bertil Chapuis. It is largely composed of virtual functions that are to be implemented in technology-specific subclasses, but there is some generic code too. The functions that are implemented here merely deal with the maintenance of the size and extent variables, as well as the cached ‘resolution’ value. A note to the user that all subclasses should use getResolution() instead of directly accessing this.resolution in order to correctly use the cacheing system. Summary | | | | | | | | | {Boolean} If the renderer is currently in a state where many things are changing, the ‘locked’ property is set to true. | | | | {Float} cache of current map resolution | | { OpenLayers.Map} Reference to the map -- this is set in Vector’s setMap() | | | | | | Set the visible part of the layer. | | Sets the size of the drawing surface. | | Uses cached copy of resolution if available to minimize computing | | | | | | Function for drawing text labels. | | Function for removing text labels. | | Clear all vectors from the renderer. | | Returns a feature id from an event on the renderer. | | This is called by the layer to erase features | | Remove a geometry from the renderer (by id). | | moves this renderer’s root to a (different) renderer. | | Gets the layer that this renderer’s output appears on. |
locked{Boolean} If the renderer is currently in a state where many things are changing, the ‘locked’ property is set to true. This means that renderers can expect at least one more drawFeature event to be called with the ‘locked’ property set to ‘true’: In some renderers, this might make sense to use as a ‘only update local information’ flag. resolution{Float} cache of current map resolution map{OpenLayers.Map} Reference to the map -- this is set in Vector’s setMap() OpenLayers. RendererParameters| containerID | {String} | | options | {Object} options for this renderer. See sublcasses for supported options. |
setExtent| setExtent: function( | extent, | | resolutionChanged | ) |
|
Set the visible part of the layer. Resolution has probably changed, so we nullify the resolution cache (this.resolution) -- this way it will be re-computed when next it is needed. We nullify the resolution cache (this.resolution) if resolutionChanged is set to true - this way it will be re-computed on the next getResolution() request. ParameterssetSizeSets the size of the drawing surface. Resolution has probably changed, so we nullify the resolution cache (this.resolution) -- this way it will be re-computed when next it is needed. ParametersgetResolution| getResolution: function() |
Uses cached copy of resolution if available to minimize computing ReturnsThe current map’s resolution drawFeature| drawFeature: function( | feature, | | style | ) |
|
Draw the feature. The optional style argument can be used to override the feature’s own style. This method should only be called from layer.drawFeature(). ParametersReturns{Boolean} true if the feature has been drawn completely, false if not, undefined if the feature had no geometry drawGeometry| drawGeometry: function( | geometry, | | style, | | featureId | ) |
|
Draw a geometry. This should only be called from the renderer itself. Use layer.drawFeature() from outside the renderer. virtual function ParametersdrawText| drawText: function( | featureId, | | style, | | location | ) |
|
Function for drawing text labels. This method is only called by the renderer itself. ParametersremoveText| removeText: function( | featureId | ) |
|
Function for removing text labels. This method is only called by the renderer itself. ParametersclearClear all vectors from the renderer. virtual function. getFeatureIdFromEvent| getFeatureIdFromEvent: function( | evt | ) |
|
Returns a feature id from an event on the renderer. How this happens is specific to the renderer. This should be called from layer.getFeatureFromEvent(). Virtual function. ParametersReturns{String} A feature id or null. eraseFeatures| eraseFeatures: function( | features | ) |
|
This is called by the layer to erase features ParameterseraseGeometry| eraseGeometry: function( | geometry | ) |
|
Remove a geometry from the renderer (by id). virtual function. ParametersmoveRoot| moveRoot: function( | renderer | ) |
|
moves this renderer’s root to a (different) renderer. To be implemented by subclasses that require a common renderer root for feature selection. ParametersgetRenderLayerId| getRenderLayerId: function() |
Gets the layer that this renderer’s output appears on. If moveRoot was used, this will be different from the id of the layer containing the features rendered by this renderer. Returns{String} the id of the output layer. OpenLayers. StrategyAbstract vector layer strategy class. Not to be instantiated directly. Use one of the strategy subclasses instead. Summary | | | | | {Object} Any options sent to the constructor. | | {Boolean} The control is active. | | {Boolean} The creator of the strategy can set autoActivate to false to fully control when the protocol is activated and deactivated. | | {Boolean} The creator of the strategy can set autoDestroy to false to fully control when the strategy is destroyed. | | | | Abstract class for vector strategies. | | Called to set the layer property. | | | | |
options{Object} Any options sent to the constructor. active{Boolean} The control is active. autoActivate{Boolean} The creator of the strategy can set autoActivate to false to fully control when the protocol is activated and deactivated. Defaults to true. autoDestroy{Boolean} The creator of the strategy can set autoDestroy to false to fully control when the strategy is destroyed. Defaults to true. OpenLayers. StrategyAbstract class for vector strategies. Create instances of a subclass. Parameters| options | {Object} Optional object whose properties will be set on the instance. |
activateActivate the strategy. Register any listeners, do appropriate setup. Returns{Boolean} True if the strategy was successfully activated or false if the strategy was already active. deactivateDeactivate the strategy. Unregister any listeners, do appropriate tear-down. Returns{Boolean} True if the strategy was successfully deactivated or false if the strategy was already inactive. OpenLayers. ControlControls affect the display or behavior of the map. They allow everything from panning and zooming to displaying a scale indicator. Controls by default are added to the map they are contained within however it is possible to add a control to an external div by passing the div in the options parameter. ExampleThe following example shows how to add many of the common controls to a map. var map = new OpenLayers.Map('map', { controls: [] });
map.addControl(new OpenLayers.Control.PanZoomBar());
map.addControl(new OpenLayers.Control.MouseToolbar());
map.addControl(new OpenLayers.Control.LayerSwitcher({'ascending':false}));
map.addControl(new OpenLayers.Control.Permalink());
map.addControl(new OpenLayers.Control.Permalink('permalink'));
map.addControl(new OpenLayers.Control.MousePosition());
map.addControl(new OpenLayers.Control.OverviewMap());
map.addControl(new OpenLayers.Control.KeyboardDefaults());
The next code fragment is a quick example of how to intercept shift-mouse click to display the extent of the bounding box dragged out by the user. Usually controls are not created in exactly this manner. See the source for a more complete example: var control = new OpenLayers.Control();
OpenLayers.Util.extend(control, {
draw: function () {
// this Handler.Box will intercept the shift-mousedown
// before Control.MouseDefault gets to see it
this.box = new OpenLayers.Handler.Box( control,
{"done": this.notice},
{keyMask: OpenLayers.Handler.MOD_SHIFT});
this.box.activate();
},
notice: function (bounds) {
OpenLayers.Console.userError(bounds);
}
});
map.addControl(control);
Summary | | | | | { OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map | | | | {OpenLayers.Control.TYPES} Controls can have a ‘type’. | | {Boolean} By deafault, controls do not allow selection, because it may interfere with map dragging. | | {string} This property is used for CSS related to the drawing of the Control. | | {string} This property is used for showing a tooltip over the Control. | | {Boolean} The control is active. | | | | | | | | {Array(String)} Supported application event types. | | | | Create an OpenLayers Control. | | The destroy method is used to perform any clean up before the control is dereferenced. | | Set the map property for the control. | | The draw method is called when the control is ready to be displayed on the page. | | Sets the left and top style attributes to the passed in pixel coordinates. | | Explicitly activates a control and it’s associated handler if one has been set. | | Deactivates a control and it’s associated handler if any. |
map{OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map type{OpenLayers.Control.TYPES} Controls can have a ‘type’. The type determines the type of interactions which are possible with them when they are placed into a toolbar. allowSelection{Boolean} By deafault, controls do not allow selection, because it may interfere with map dragging. If this is true, OpenLayers will not prevent selection of the control. Default is false. displayClass{string} This property is used for CSS related to the drawing of the Control. title{string} This property is used for showing a tooltip over the Control. active{Boolean} The control is active. EVENT_TYPES{Array(String)} Supported application event types. Register a listener for a particular event with the following syntax: control.events.register(type, obj, listener);
Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened. All event objects have at least the following properties| object | {Object} A reference to control.events.object (a reference to the control). | | element | {DOMElement} A reference to control.events.element (which will be null unless documented otherwise). |
Supported map event types| activate | Triggered when activated. | | deactivate | Triggered when deactivated. |
OpenLayers. ControlCreate an OpenLayers Control. The options passed as a parameter directly extend the control. For example passing the following: var control = new OpenLayers.Control({div: myDiv});
Overrides the default div attribute value of null. ParametersdestroyThe destroy method is used to perform any clean up before the control is dereferenced. Typically this is where event listeners are removed to prevent memory leaks. setMapSet the map property for the control. This is done through an accessor so that subclasses can override this and take special action once they have their map variable set. ParametersdrawThe draw method is called when the control is ready to be displayed on the page. If a div has not been created one is created. Controls with a visual component will almost always want to override this method to customize the look of control. ParametersReturns{DOMElement} A reference to the DIV DOMElement containing the control moveToSets the left and top style attributes to the passed in pixel coordinates. ParametersactivateExplicitly activates a control and it’s associated handler if one has been set. Controls can be deactivated by calling the deactivate() method. Returns{Boolean} True if the control was successfully activated or false if the control was already active. deactivateDeactivates a control and it’s associated handler if any. The exact effect of this depends on the control itself. Returns{Boolean} True if the control was effectively deactivated or false if the control was already inactive. OpenLayers.LangInternationalization namespace. Contains dictionaries in various languages and methods to set and get the current language. Summary | | | {String} Current language code to use in OpenLayers. |
code{String} Current language code to use in OpenLayers. Use the <setCode> method to set this value and the <getCode> method to retrieve it. OpenLayers. Popup. AnchoredInherits fromSummary | | | | | Since the popup is moving to a new px, it might need also to be moved relative to where the marker is. | | | | The popup has been moved to a new relative location, so we may want to make some cosmetic adjustments to it. | | |
OpenLayers. Popup. AnchoredmoveToSince the popup is moving to a new px, it might need also to be moved relative to where the marker is. We first calculate the new relativePosition, and then we calculate the new px where we will put the popup, based on the new relative position. If the relativePosition has changed, we must also call updateRelativePosition() to make any visual changes to the popup which are associated with putting it in a new relativePosition. ParameterscalculateRelativePosition| calculateRelativePosition:function( | px | ) |
|
ParametersReturns{String} The relative position (“br” “tr” “tl” “bl”) at which the popup should be placed. updateRelativePosition| updateRelativePosition: function() |
The popup has been moved to a new relative location, so we may want to make some cosmetic adjustments to it. Note that in the classic Anchored popup, there is nothing to do here, since the popup looks exactly the same in all four positions. Subclasses such as the AnchoredBubble and Framed, however, will want to do something special here. calculateNewPx| calculateNewPx:function( | px | ) |
|
ParametersReturns{OpenLayers.Pixel} The the new px position of the popup on the screen relative to the passed-in px. OpenLayers. Renderer. CanvasA renderer based on the 2D ‘canvas’ drawing element.element InheritsSummary | | | {Canvas} The canvas context object. | | {Object} Internal object of feature/style pairs for use in redrawing the layer. | | {Object} Geometry -> Feature lookup table. | | | | | | Erase a geometry from the renderer. | | Set the visible part of the layer. | | Sets the size of the drawing surface. | | | | Used when looping (in redraw) over the features; draws the canvas. | | Called to draw External graphics. | | Prepare the canvas for drawing by setting various global settings. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | transform geographic xy into pixel xy | | Clear all vectors from the renderer. | | Returns a feature id from an event on the renderer. | | This is called by the layer to erase features; removes the feature from the list, then redraws the layer. | | The real ‘meat’ of the function: any time things have changed, redraw() can be called to loop over all the data and (you guessed it) redraw it. | | | | |
canvas{Canvas} The canvas context object. features{Object} Internal object of feature/style pairs for use in redrawing the layer. geometryMap{Object} Geometry -> Feature lookup table. Used by eraseGeometry to lookup features to remove from our internal table (this.features) when erasing geoms. OpenLayers. Renderer. CanvaseraseGeometry| eraseGeometry: function( | geometry | ) |
|
Erase a geometry from the renderer. Because the Canvas renderer has ‘memory’ of the features that it has drawn, we have to remove the feature so it doesn’t redraw. ParameterssetExtent| setExtent: function( | extent | ) |
|
Set the visible part of the layer. Resolution has probably changed, so we nullify the resolution cache (this.resolution), then redraw. ParameterssetSizeSets the size of the drawing surface. Once the size is updated, redraw the canvas. ParametersdrawFeature| drawFeature: function( | feature, | | style | ) |
|
Draw the feature. Stores the feature in the features list, then redraws the layer. ParametersdrawGeometry| drawGeometry: function( | geometry, | | style | ) |
|
Used when looping (in redraw) over the features; draws the canvas. ParametersdrawExternalGraphic| drawExternalGraphic: function( | pt, | | style | ) |
|
Called to draw External graphics. ParameterssetCanvasStyle| setCanvasStyle: function( | type, | | style | ) |
|
Prepare the canvas for drawing by setting various global settings. Parameters| type | {String} one of ‘stroke’, ‘fill’, or ‘reset’ | | style | {Object} Symbolizer hash |
drawPoint| drawPoint: function( | geometry, | | style | ) |
|
This method is only called by the renderer itself. ParametersdrawLineString| drawLineString: function( | geometry, | | style | ) |
|
This method is only called by the renderer itself. ParametersdrawLinearRing| drawLinearRing: function( | geometry, | | style | ) |
|
This method is only called by the renderer itself. ParametersdrawPolygon| drawPolygon: function( | geometry, | | style | ) |
|
This method is only called by the renderer itself. ParametersdrawText| drawText: function( | location, | | style | ) |
|
This method is only called by the renderer itself. Parameters| location | {<OpenLayers.Point>} | | style | {Object} |
getLocalXY| getLocalXY: function( | point | ) |
|
transform geographic xy into pixel xy ParametersclearClear all vectors from the renderer. virtual function. getFeatureIdFromEvent| getFeatureIdFromEvent: function( | evt | ) |
|
Returns a feature id from an event on the renderer. ParametersReturns{String} A feature id or null. eraseFeatures| eraseFeatures: function( | features | ) |
|
This is called by the layer to erase features; removes the feature from the list, then redraws the layer. ParametersredrawThe real ‘meat’ of the function: any time things have changed, redraw() can be called to loop over all the data and (you guessed it) redraw it. Unlike Elements-based Renderers, we can’t interact with things once they’re drawn, to remove them, for example, so instead we have to just clear everything and draw from scratch. OpenLayers. Renderer. Canvas. LABEL_ALIGNOpenLayers. ElementsIndexerThis class takes care of figuring out which order elements should be placed in the DOM based on given indexing methods. Summary | | | {Integer} This is the largest-most z-index value for a node contained within the indexer. | | {Array<String>} This is an array of node id’s stored in the order that they should show up on screen. | | {Object} This is a hash that maps node ids to their z-index value stored in the indexer. | | {Function} This is the function used to determine placement of of a new node within the indexer. | | | | Determine the z-index for the current node if there isn’t one, and set the maximum value if we’ve found a new maximum. |
maxZIndex{Integer} This is the largest-most z-index value for a node contained within the indexer. order{Array<String>} This is an array of node id’s stored in the order that they should show up on screen. Id’s higher up in the array (higher array index) represent nodes with higher z-indeces. indices{Object} This is a hash that maps node ids to their z-index value stored in the indexer. This is done to make finding a nodes z-index value O(1). compare{Function} This is the function used to determine placement of of a new node within the indexer. If null, this defaults to to the Z_ORDER_DRAWING_ORDER comparison method. determineZIndex| determineZIndex: function( | node | ) |
|
Determine the z-index for the current node if there isn’t one, and set the maximum value if we’ve found a new maximum. ParametersOpenLayers. ElementsIndexer. IndexingMethodsThese are the compare methods for figuring out where a new node should be placed within the indexer. These methods are very similar to general sorting methods in that they return -1, 0, and 1 to specify the direction in which new nodes fall in the ordering. Summary | | | This compare method is used by other comparison methods. |
Z_ORDER| Z_ORDER: function( | indexer, | | newNode, | | nextNode | ) |
|
This compare method is used by other comparison methods. It can be used individually for ordering, but is not recommended, because it doesn’t subscribe to drawing order. ParametersReturns{Integer} OpenLayers. Renderer. ElementsThis is another virtual class in that it should never be instantiated by itself as a Renderer. It exists because there is tons of shared functionality between different vector libraries which use nodes/elements as a base for rendering vectors. The highlevel bits of code that are implemented here are the adding and removing of geometries, which is essentially the same for any element-based renderer. The details of creating each node and drawing the paths are of course different, but the machinery is the same. InheritsSummary | | | | | | | | | | | | | {<OpenLayers.ElementIndexer>} An instance of OpenLayers.ElementsIndexer created upon initialization if the zIndexing or yOrdering options passed to this renderer’s constructor are set to true. | | | | | | | | | | | | | | | | | | Remove all the elements from the root | | This function is in charge of asking the specific renderer which type of node to create for the given geometry and style. | | Draw the geometry, creating new nodes, setting paths, setting style, setting featureId on the node. | | | | Redraws the node using special ‘background’ style properties. | | Given a node, draw a geometry on the specified layer. | | Things that have do be done after the geometry node is appended to its parent node. | | Virtual function for drawing Point Geometry. | | Virtual function for drawing LineString Geometry. | | Virtual function for drawing LinearRing Geometry. | | Virtual function for drawing Polygon Geometry. | | Virtual function for drawing Rectangle Geometry. | | Virtual function for drawing Circle Geometry. | | Virtual function for drawing Surface Geometry. | | | | | | Erase a geometry from the renderer. | | Create new node of the specified type, with the (optional) specified id. | | | | | | moves this renderer’s root to a different renderer. | | Gets the layer that this renderer’s output appears on. | | Determines if a symbol cannot be rendered using drawCircle | | | | Coordinate arrays for well known (named) symbols. |
Indexer{<OpenLayers.ElementIndexer>} An instance of OpenLayers.ElementsIndexer created upon initialization if the zIndexing or yOrdering options passed to this renderer’s constructor are set to true. OpenLayers. Renderer. ElementsParameters| containerID | {String} | | options | {Object} options for this renderer. Supported options are: |
- yOrdering - {Boolean} Whether to use y-ordering
- zIndexing - {Boolean} Whether to use z-indexing. Will be ignored if yOrdering is set to true.
clearRemove all the elements from the root getNodeType| getNodeType: function( | geometry, | | style | ) |
|
This function is in charge of asking the specific renderer which type of node to create for the given geometry and style. All geometries in an Elements-based renderer consist of one node and some attributes. We have the nodeFactory() function which creates a node for us, but it takes a ‘type’ as input, and that is precisely what this function tells us. ParametersReturns{String} The corresponding node type for the specified geometry drawGeometry| drawGeometry: function( | geometry, | | style, | | featureId | ) |
|
Draw the geometry, creating new nodes, setting paths, setting style, setting featureId on the node. This method should only be called by the renderer itself. ParametersReturns{Boolean} true if the geometry has been drawn completely; null if incomplete; false otherwise redrawNode| redrawNode: function( | id, | | geometry, | | style, | | featureId | ) |
|
ParametersReturns{Boolean} true if the complete geometry could be drawn, null if parts of the geometry could not be drawn, false otherwise redrawBackgroundNode| redrawBackgroundNode: function( | id, | | geometry, | | style, | | featureId | ) |
|
Redraws the node using special ‘background’ style properties. Basically just calls redrawNode(), but instead of directly using the ‘externalGraphic’, ‘graphicXOffset’, ‘graphicYOffset’, and ‘graphicZIndex’ properties directly from the specified ‘style’ parameter, we create a new style object and set those properties from the corresponding ‘background’-prefixed properties from specified ‘style’ parameter. ParametersReturns{Boolean} true if the complete geometry could be drawn, null if parts of the geometry could not be drawn, false otherwise drawGeometryNode| drawGeometryNode: function( | node, | | geometry, | | style | ) |
|
Given a node, draw a geometry on the specified layer. node and geometry are required arguments, style is optional. This method is only called by the render itself. ParametersReturns{Object} a hash with properties “node” (the drawn node) and “complete” (null if parts of the geometry could not be drawn, false if nothing could be drawn) postDrawThings that have do be done after the geometry node is appended to its parent node. To be overridden by subclasses. ParametersdrawPoint| drawPoint: function( | node, | | geometry | ) |
|
Virtual function for drawing Point Geometry. Should be implemented by subclasses. This method is only called by the renderer itself. ParametersReturns{DOMElement} or false if the renderer could not draw the point drawLineString| drawLineString: function( | node, | | geometry | ) |
|
Virtual function for drawing LineString Geometry. Should be implemented by subclasses. This method is only called by the renderer itself. ParametersReturns{DOMElement} or null if the renderer could not draw all components of the linestring, or false if nothing could be drawn drawLinearRing| drawLinearRing: function( | node, | | geometry | ) |
|
Virtual function for drawing LinearRing Geometry. Should be implemented by subclasses. This method is only called by the renderer itself. ParametersReturns{DOMElement} or null if the renderer could not draw all components of the linear ring, or false if nothing could be drawn drawPolygon| drawPolygon: function( | node, | | geometry | ) |
|
Virtual function for drawing Polygon Geometry. Should be implemented by subclasses. This method is only called by the renderer itself. ParametersReturns{DOMElement} or null if the renderer could not draw all components of the polygon, or false if nothing could be drawn drawRectangle| drawRectangle: function( | node, | | geometry | ) |
|
Virtual function for drawing Rectangle Geometry. Should be implemented by subclasses. This method is only called by the renderer itself. ParametersReturns{DOMElement} or false if the renderer could not draw the rectangle drawCircle| drawCircle: function( | node, | | geometry | ) |
|
Virtual function for drawing Circle Geometry. Should be implemented by subclasses. This method is only called by the renderer itself. ParametersReturns{DOMElement} or false if the renderer could not draw the circle drawSurface| drawSurface: function( | node, | | geometry | ) |
|
Virtual function for drawing Surface Geometry. Should be implemented by subclasses. This method is only called by the renderer itself. ParametersReturns{DOMElement} or false if the renderer could not draw the surface removeText| removeText: function( | featureId | ) |
|
Removes a label ParametersgetFeatureIdFromEvent| getFeatureIdFromEvent: function( | evt | ) |
|
ParametersReturns{OpenLayers.Geometry} A geometry from an event that happened on a layer. eraseGeometry| eraseGeometry: function( | geometry | ) |
|
Erase a geometry from the renderer. In the case of a multi-geometry, we cycle through and recurse on ourselves. Otherwise, we look for a node with the geometry.id, destroy its geometry, and remove it from the DOM. ParametersnodeFactory| nodeFactory: function( | id, | | type | ) |
|
Create new node of the specified type, with the (optional) specified id. If node already exists with same ID and a different type, we remove it and then call ourselves again to recreate it. Parameters| id | {String} | | type | {String} type Kind of node to draw. |
Returns{DOMElement} A new node of the given type and id. nodeTypeCompare| nodeTypeCompare: function( | node, | | type | ) |
|
Parameters| node | {DOMElement} | | type | {String} Kind of node |
Returns{Boolean} Whether or not the specified node is of the specified type This function must be overridden by subclasses. createNode| createNode: function( | type, | | id | ) |
|
Parameters| type | {String} Kind of node to draw. | | id | {String} Id for node. |
Returns{DOMElement} A new node of the given type and id. This function must be overridden by subclasses. moveRoot| moveRoot: function( | renderer | ) |
|
moves this renderer’s root to a different renderer. ParametersgetRenderLayerId| getRenderLayerId: function() |
Gets the layer that this renderer’s output appears on. If moveRoot was used, this will be different from the id of the layer containing the features rendered by this renderer. Returns{String} the id of the output layer. isComplexSymbol| isComplexSymbol: function( | graphicName | ) |
|
Determines if a symbol cannot be rendered using drawCircle ParametersReturns {Boolean} true if the symbol is complex, false if not OpenLayers. Renderer. symbolCoordinate arrays for well known (named) symbols. OpenLayers. Strategy. FixedA simple strategy that requests features once and never requests new data. Inherits fromSummary | | | Create a new Fixed strategy. | | Activate the strategy: load data or add listener to load when visible | | | | Tells protocol to load data and unhooks the visibilitychanged event | | Add all features to the layer. |
OpenLayers. Strategy. FixedCreate a new Fixed strategy. Parameters| options | {Object} Optional object whose properties will be set on the instance. |
activateActivate the strategy: load data or add listener to load when visible Returns{Boolean} True if the strategy was successfully activated or false if the strategy was already active. deactivateDeactivate the strategy. Undo what is done in activate. Returns{Boolean} The strategy was successfully deactivated. loadTells protocol to load data and unhooks the visibilitychanged event Parameters| options | {Object} options to pass to protocol read. |
mergeAdd all features to the layer. OpenLayers. TweenSummary | | | {int} Interval in milliseconds between 2 steps | | | | | | {int} Interval id returned by window.setInterval | | {Boolean} Tells if the easing is currently playing | | | | | | Calls the appropriate easing method |
INTERVAL{int} Interval in milliseconds between 2 steps interval{int} Interval id returned by window.setInterval playing{Boolean} Tells if the easing is currently playing OpenLayers. TweenCreates a Tween. Parameters| easing | {<OpenLayers.Easing>(Function)} easing function method to use |
playCalls the appropriate easing method OpenLayers. Easing. LineareaseIn| easeIn: function( | t, | | b, | | c, | | d | ) |
|
Parameters| t | {Float} time | | b | {Float} beginning position | | c | {Float} total change | | d | {Float} duration of the transition |
easeOut| easeOut: function( | t, | | b, | | c, | | d | ) |
|
Parameters| t | {Float} time | | b | {Float} beginning position | | c | {Float} total change | | d | {Float} duration of the transition |
easeInOut| easeInOut: function( | t, | | b, | | c, | | d | ) |
|
Parameters| t | {Float} time | | b | {Float} beginning position | | c | {Float} total change | | d | {Float} duration of the transition |
easeIn| easeIn: function( | t, | | b, | | c, | | d | ) |
|
Parameters| t | {Float} time | | b | {Float} beginning position | | c | {Float} total change | | d | {Float} duration of the transition |
easeOut| easeOut: function( | t, | | b, | | c, | | d | ) |
|
Parameters| t | {Float} time | | b | {Float} beginning position | | c | {Float} total change | | d | {Float} duration of the transition |
easeInOut| easeInOut: function( | t, | | b, | | c, | | d | ) |
|
Parameters| t | {Float} time | | b | {Float} beginning position | | c | {Float} total change | | d | {Float} duration of the transition |
easeIn| easeIn: function( | t, | | b, | | c, | | d | ) |
|
Parameters| t | {Float} time | | b | {Float} beginning position | | c | {Float} total change | | d | {Float} duration of the transition |
easeOut| easeOut: function( | t, | | b, | | c, | | d | ) |
|
Parameters| t | {Float} time | | b | {Float} beginning position | | c | {Float} total change | | d | {Float} duration of the transition |
easeInOut| easeInOut: function( | t, | | b, | | c, | | d | ) |
|
Parameters| t | {Float} time | | b | {Float} beginning position | | c | {Float} total change | | d | {Float} duration of the transition |
OpenLayers. Control. ArgParserThe ArgParser control adds location bar querystring parsing functionality to an OpenLayers Map. When added to a Map control, on a page load/refresh, the Map will automatically take the href string and parse it for lon, lat, zoom, and layers information. Inherits fromSummary | | | | | Set the map property for the control. | | As soon as a baseLayer has been loaded, we center and zoom ...and remove the handler. | | As soon as all the layers are loaded, cycle through them and hide or show them. |
OpenLayers. Control. ArgParsersetMapSet the map property for the control. ParameterssetCenterAs soon as a baseLayer has been loaded, we center and zoom ...and remove the handler. configureLayers| configureLayers: function() |
As soon as all the layers are loaded, cycle through them and hide or show them. OpenLayers. Control. PanZoomThe PanZoom is a visible control, composed of a <OpenLayers.Control.PanPanel> and a <OpenLayers.Control.ZoomPanel>. By default it is drawn in the upper left corner of the map. Inherits fromSummary | | | {Array(DOMElement)} Array of Button Divs | | | | | | | | | | | | | | | | | | | | | | | | |
buttons{Array(DOMElement)} Array of Button Divs OpenLayers. Control. PanZoomdrawParametersReturns{DOMElement} A reference to the container div for the PanZoom control. _addButton| _addButton:function( | id, | | img, | | xy, | | sz | ) |
|
ParametersReturns{DOMElement} A Div (an alphaImageDiv, to be precise) that contains the image of the button, and has all the proper event handlers set. _removeButton| _removeButton: function( | btn | ) |
|
ParametersremoveButtons| removeButtons: function() |
doubleClick| doubleClick: function ( | evt | ) |
|
ParametersReturns{Boolean} buttonDown| buttonDown: function ( | evt | ) |
|
ParametersOpenLayers. Control. ScaleLineThe ScaleLine displays a small line indicator representing the current map scale on the map. By default it is drawn in the lower left corner of the map. Inherits fromIs a very close copy of- <OpenLayers.Control.Scale>
Summary | | | {Integer} Maximum width of the scale line in pixels. | | {String} Units for zoomed out on top bar. | | {String} Units for zoomed in on top bar. | | {String} Units for zoomed out on bottom bar. | | {String} Units for zoomed in on bottom bar. | | | | | | | | Create a new scale line control. | | | | Given a number, round it down to the nearest 1,2,5 times a power of 10. | | Update the size of the bars, and the labels they contain. |
maxWidth{Integer} Maximum width of the scale line in pixels. Default is 100. topOutUnits{String} Units for zoomed out on top bar. Default is km. topInUnits{String} Units for zoomed in on top bar. Default is m. bottomOutUnits{String} Units for zoomed out on bottom bar. Default is mi. bottomInUnits{String} Units for zoomed in on bottom bar. Default is ft. OpenLayers. Control. ScaleLineCreate a new scale line control. Parameters| options | {Object} An optional object whose properties will be used to extend the control. |
getBarLen| getBarLen: function( | maxLen | ) |
|
Given a number, round it down to the nearest 1,2,5 times a power of 10. That seems a fairly useful set of number groups to use. Parameters| maxLen | {float} the number we’re rounding down from |
Returns{Float} the rounded number (less than or equal to maxLen) updateUpdate the size of the bars, and the labels they contain. OpenLayers. EventUtility functions for event handling. Summary | | | {Object} A hashtable cache of the event observers. | | | | | | | | | | | | | | | | | | | | | | | | Cross browser event element detection. | | Determine whether event was caused by a left click. | | Determine whether event was caused by a right mouse click. | | Stops an event from propagating. | | | | | | Given the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed. | | | | | | Cycle through all the element entries in the events cache and call stopObservingElement on each. |
observers{Object} A hashtable cache of the event observers. Keyed by element._eventCacheID elementCross browser event element detection. ParametersReturns{DOMElement} The element that caused the event isLeftClick| isLeftClick: function( | event | ) |
|
Determine whether event was caused by a left click. ParametersReturns{Boolean} isRightClick| isRightClick: function( | event | ) |
|
Determine whether event was caused by a right mouse click. ParametersReturns{Boolean} stop| stop: function( | event, | | allowDefault | ) |
|
Stops an event from propagating. Parameters| event | {Event} | | allowDefault | {Boolean} If true, we stop the event chain but still allow the default browser behaviour (text selection, radio-button clicking, etc) Default false |
findElement| findElement: function( | event, | | tagName | ) |
|
Parameters| event | {Event} | | tagName | {String} |
Returns{DOMElement} The first node with the given tagName, starting from the node the event was triggered on and traversing the DOM upwards observe| observe: function( | elementParam, | | name, | | observer, | | useCapture | ) |
|
Parameters| elementParam | {DOMElement || String} | | name | {String} | | observer | {function} | | useCapture | {Boolean} |
stopObservingElement| stopObservingElement: function( | elementParam | ) |
|
Given the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed. parameters| elementParam | {DOMElement || String} |
_removeElementObservers| _removeElementObservers: function( | elementObservers | ) |
|
Parameters| elementObservers | {Array(Object)} Array of (element, name, observer, usecapture) objects, taken directly from hashtable |
stopObserving| stopObserving: function( | elementParam, | | name, | | observer, | | useCapture | ) |
|
Parameters| elementParam | {DOMElement || String} | | name | {String} | | observer | {function} | | useCapture | {Boolean} |
Returns{Boolean} Whether or not the event observer was removed unloadCacheCycle through all the element entries in the events cache and call stopObservingElement on each. OpenLayers. EventsSummary | | | {Array(String)} supported events | | | | {Object} Hashtable of Array(Function): events listener functions | | {Object} the code object issuing application events | | {DOMElement} the DOM element receiving browser events | | {Array(String)} list of support application events | | {Function} bound event handler attached to elements | | | | | | Construct an OpenLayers.Events object. | | | | Convenience method for registering listeners with a common scope. | | Convenience method for unregistering listeners with a common scope. | | Remove all listeners for a given event type. | | Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position. | | |
BROWSER_EVENTS{Array(String)} supported events listeners{Object} Hashtable of Array(Function): events listener functions object{Object} the code object issuing application events element{DOMElement} the DOM element receiving browser events eventTypes{Array(String)} list of support application events eventHandler{Function} bound event handler attached to elements OpenLayers. EventsConstruct an OpenLayers.Events object. Parameters| object | {Object} The js object to which this Events object is being | | added element | {DOMElement} A dom element to respond to browser events | | eventTypes | {Array(String)} Array of custom application events | | fallThrough | {Boolean} Allow events to fall through after these have been handled? | | options | {Object} Options for the events object. |
attachToElement| attachToElement: function ( | element | ) |
|
Parameters| element | {HTMLDOMElement} a DOM element to attach browser events to |
onConvenience method for registering listeners with a common scope. Example useevents.on({
"loadstart": loadStartListener,
"loadend": loadEndListener,
scope: object
});
unConvenience method for unregistering listeners with a common scope. Example useevents.un({
"loadstart": loadStartListener,
"loadend": loadEndListener,
scope: object
});
removeRemove all listeners for a given event type. If type is not registered, does nothing. ParametershandleBrowserEvent| handleBrowserEvent: function ( | evt | ) |
|
Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position. ParametersgetMousePosition| getMousePosition: function ( | evt | ) |
|
ParametersReturns{OpenLayers.Pixel} The current xy coordinate of the mouse, adjusted for offsets OpenLayers. FormatBase class for format reading/writing a variety of formats. Subclasses of OpenLayers.Format are expected to have read and write methods. Summary | | | {Object} A reference to options passed to the constructor. | | | | Instances of this class are not useful. | | Read data from a string, and return an object whose type depends on the subclass. | | Accept an object, and return a string. |
options{Object} A reference to options passed to the constructor. OpenLayers. FormatInstances of this class are not useful. See one of the subclasses. Parameters| options | {Object} An optional object with properties to set on the format |
Valid options| keepData | {Boolean} If true, upon read, the data property will be set to the parsed object (e.g. the json or xml object). |
ReturnsAn instance of OpenLayers.Format readRead data from a string, and return an object whose type depends on the subclass. Parameters| data | {string} Data to read/parse. |
ReturnsDepends on the subclass writeAccept an object, and return a string. Parameters| object | {Object} Object to be serialized |
Returns{String} A string representation of the object. OpenLayers. Lang[“en”]Dictionary for English. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Popup. AnchoredBubbleInherits fromSummary | | | {Boolean} Has the popup been rounded yet? | | | | | | | | The popup has been moved to a new relative location, in which case we will want to re-do the rico corners. | | | | Update RICO corners according to the popup’s current relative postion. | | {String} The proper corners string (“tr tl bl br”) for rico to round. | | | | |
rounded{Boolean} Has the popup been rounded yet? OpenLayers. Popup. AnchoredBubbledrawParametersReturns{DOMElement} Reference to a div that contains the drawn popup. updateRelativePosition| updateRelativePosition: function() |
The popup has been moved to a new relative location, in which case we will want to re-do the rico corners. setBorder| setBorder:function( | border | ) |
|
Always sets border to 0. Bubble Popups can not have a border. ParameterssetRicoCorners| setRicoCorners:function() |
Update RICO corners according to the popup’s current relative postion. getCornersToRound| getCornersToRound:function() |
Returns{String} The proper corners string (“tr tl bl br”) for rico to round. CORNER_SIZE{Integer} 5. Border space for the RICO corners. OpenLayers. ProjectionClass for coordinate transforms between coordinate systems. Depends on the proj4js library. If proj4js is not available, then this is just an empty stub. Summary | | | {Object} Proj4js.Proj instance. | | | | | | This class offers several methods for interacting with a wrapped pro4js projection object. | | Convert projection to string (getCode wrapper). | | Test equality of two projection instances. | | Destroy projection object. | | | | Transforms is an object, with from properties, each of which may have a to property. |
proj{Object} Proj4js.Proj instance. OpenLayers. ProjectionThis class offers several methods for interacting with a wrapped pro4js projection object. Parameters| projCode | {String} A string identifying the Well Known Identifier for the projection. | | options | {Object} An optional object to set additional properties on the layer. |
Returns{OpenLayers.Projection} A projection object. toStringConvert projection to string (getCode wrapper). Returns{String} The projection code. equals| equals: function( | projection | ) |
|
Test equality of two projection instances. Determines equality based soley on the projection code. Returns{Boolean} The two projections are equivalent. destroyDestroy projection object. transformsTransforms is an object, with from properties, each of which may have a to property. This allows you to define projections without requiring support for proj4js to be included. This object has keys which correspond to a ‘source’ projection object. The keys should be strings, corresponding to the projection.getCode() value. Each source projection object should have a set of destination projection keys included in the object. Each value in the destination object should be a transformation function, where the function is expected to be passed an object with a .x and a .y property. The function should return the object, with the .x and .y transformed according to the transformation function. | Note | Properties on this object should not be set directly. To add a transform method to this object, use the <addTransform> method. For an example of usage, see the OpenLayers.Layer.SphericalMercator file. |
OpenLayers. Renderer.SVGInheritsSummary | | | | | | | | | {Integer} Firefox has a limitation where values larger or smaller than about 15000 in an SVG document lock the browser up. | | | | {Object} Hash with “x” and “y” properties | | {Object} Cache for symbol sizes according to their svg coordinate space | | | | | | | | See #669 for more information | | | | Transforms the SVG coordinate system | | Sets the size of the drawing surface. | | | | Use to set all the style attributes to a SVG node. | | | | | | | | {DOMElement} The specific render engine’s root element | | | | {DOMElement} The element to which we’ll add the symbol definitions | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | This method is only called by the renderer itself. | | | | Given two points (one inside the valid range, and one outside), clips the line betweeen the two points so that the new points are both inside the valid range. | | | | Finds the position of an svg node. | | add a new symbol definition from the rendererer’s symbol hash | | | | | | |
MAX_PIXEL{Integer} Firefox has a limitation where values larger or smaller than about 15000 in an SVG document lock the browser up. This works around it. translationParameters{Object} Hash with “x” and “y” properties symbolSize{Object} Cache for symbol sizes according to their svg coordinate space inValidRange| inValidRange: function( | x, | | y, | | xyOnly | ) |
|
See #669 for more information Parameters| x | {Integer} | | y | {Integer} | | xyOnly | {Boolean} whether or not to just check for x and y, which means to not take the current translation parameters into account if true. |
Returns{Boolean} Whether or not the ‘x’ and ‘y’ coordinates are in the valid range. setExtent| setExtent: function( | extent, | | resolutionChanged | ) |
|
ParametersReturns{Boolean} true to notify the layer that the new extent does not exceed the coordinate range, and the features will not need to be redrawn. False otherwise. translateTransforms the SVG coordinate system ParametersReturns{Boolean} true if the translation parameters are in the valid coordinates range, false otherwise. setSizeSets the size of the drawing surface. ParametersgetNodeType| getNodeType: function( | geometry, | | style | ) |
|
ParametersReturns{String} The corresponding node type for the specified geometry setStyle| setStyle: function( | node, | | style, | | options | ) |
|
Use to set all the style attributes to a SVG node. Takes care to adjust stroke width and point radius to be resolution-relative Parameters| node | {SVGDomElement} An SVG element to decorate | | style | {Object} | | options | {Object} Currently supported options include ‘isFilled’ {Boolean} and ‘isStroked’ {Boolean} |
dashStyle| dashStyle: function( | style, | | widthFactor | ) |
|
Parameters| style | {Object} | | widthFactor | {Number} |
Returns{String} A SVG compliant ‘stroke-dasharray’ value createNode| createNode: function( | type, | | id | ) |
|
Parameters| type | {String} Kind of node to draw | | id | {String} Id for node |
Returns{DOMElement} A new node of the given type and id nodeTypeCompare| nodeTypeCompare: function( | node, | | type | ) |
|
Parameters| node | {SVGDomElement} An SVG element | | type | {String} Kind of node |
Returns{Boolean} Whether or not the specified node is of the specified type createRenderRoot| createRenderRoot: function() |
Returns{DOMElement} The specific render engine’s root element createRoot| createRoot: function( | suffix | ) |
|
Parameter| suffix | {String} suffix to append to the id |
Returns{DOMElement} createDefsReturns{DOMElement} The element to which we’ll add the symbol definitions drawPoint| drawPoint: function( | node, | | geometry | ) |
|
This method is only called by the renderer itself. ParametersReturns{DOMElement} or false if the renderer could not draw the point drawCircle| drawCircle: function( | node, | | geometry, | | radius | ) |
|
This method is only called by the renderer itself. ParametersReturns{DOMElement} or false if the renderer could not draw the circle drawLineString| drawLineString: function( | node, | | geometry | ) |
|
This method is only called by the renderer itself. ParametersReturns{DOMElement} or null if the renderer could not draw all components of the linestring, or false if nothing could be drawn drawLinearRing| drawLinearRing: function( | node, | | geometry | ) |
|
This method is only called by the renderer itself. ParametersReturns{DOMElement} or null if the renderer could not draw all components of the linear ring, or false if nothing could be drawn drawPolygon| drawPolygon: function( | node, | | geometry | ) |
|
This method is only called by the renderer itself. ParametersReturns{DOMElement} or null if the renderer could not draw all components of the polygon, or false if nothing could be drawn drawRectangle| drawRectangle: function( | node, | | geometry | ) |
|
This method is only called by the renderer itself. ParametersReturns{DOMElement} or false if the renderer could not draw the rectangle drawSurface| drawSurface: function( | node, | | geometry | ) |
|
This method is only called by the renderer itself. ParametersReturns{DOMElement} or false if the renderer could not draw the surface drawText| drawText: function( | featureId, | | style, | | location | ) |
|
This method is only called by the renderer itself. ParametersgetComponentStringParameters| components | {Array(OpenLayers.Geometry.Point)} Array of points | | separator | {String} character between coordinate pairs. Defaults to “,” |
Returns{Object} hash with properties “path” (the string created from the components and “complete” (false if the renderer was unable to draw all components) clipLine| clipLine: function( | badComponent, | | goodComponent | ) |
|
Given two points (one inside the valid range, and one outside), clips the line betweeen the two points so that the new points are both inside the valid range. Parameters| badComponent | {OpenLayers.Geometry.Point)} original geometry of the invalid point | | goodComponent | {OpenLayers.Geometry.Point)} original geometry of the valid point Returns {String} the SVG coordinate pair of the clipped point (like getShortString), or an empty string if both passed componets are at the same point. |
getShortString| getShortString: function( | point | ) |
|
ParametersReturns{String} or false if point is outside the valid range getPosition| getPosition: function( | node | ) |
|
Finds the position of an svg node. ParametersReturns{Object} hash with x and y properties, representing the coordinates within the svg coordinate system importSymbol| importSymbol: function ( | graphicName | ) |
|
add a new symbol definition from the rendererer’s symbol hash Parameters| graphicName | {String} name of the symbol to import |
Returns| {String} | id of the imported symbol |
OpenLayers. Renderer. SVG. LABEL_ALIGNOpenLayers. Renderer. SVG. LABEL_VSHIFTOpenLayers. Renderer.VMLRender vector features in browsers with VML capability. Construct a new VML renderer with the OpenLayers.Renderer.VML constructor. Note that for all calculations in this class, we use toFixed() to round a float value to an integer. This is done because it seems that VML doesn’t support float values. Inherits fromSummary | | | {String} XML Namespace URN | | {DOMElement} node holding symbols. | | {Object} Hash with “x” and “y” properties | | | | Create a new VML renderer. | | Set the renderer’s extent | | Set the size of the drawing surface | | Get the node type for a geometry and style | | Use to set all the style attributes to a VML node. | | If a point is to be styled with externalGraphic and rotation, VML fills cannot be used to display the graphic, because rotation of graphic fills is not supported by the VML implementation of Internet Explorer. | | Some versions of Internet Explorer seem to be unable to set fillcolor and strokecolor to “none” correctly before the fill node is appended to a visible vml node. | | Get the geometry’s bounds, convert it to our vml coordinate system, then set the node’s position, size, and local coordinate system. | | | | | | Determine whether a node is of a given type | | | | Create the main root element | | | | | | | | | | | | | | | | This method is only called by the renderer itself. | | | | moves this renderer’s root to a different renderer. | | add a new symbol definition from the rendererer’s symbol hash | | | | |
xmlns{String} XML Namespace URN symbolCache{DOMElement} node holding symbols. This hash is keyed by symbol name, and each value is a hash with a “path” and an “extent” property. offset{Object} Hash with “x” and “y” properties OpenLayers. Renderer.VMLCreate a new VML renderer. Parameters| containerID | {String} The id for the element that contains the renderer |
setExtent| setExtent: function( | extent, | | resolutionChanged | ) |
|
Set the renderer’s extent ParametersReturns{Boolean} true to notify the layer that the new extent does not exceed the coordinate range, and the features will not need to be redrawn. setSizeSet the size of the drawing surface ParametersgetNodeType| getNodeType: function( | geometry, | | style | ) |
|
Get the node type for a geometry and style ParametersReturns{String} The corresponding node type for the specified geometry setStyle| setStyle: function( | node, | | style, | | options, | | geometry | ) |
|
Use to set all the style attributes to a VML node. Parameters| node | {DOMElement} An VML element to decorate | | style | {Object} | | options | {Object} Currently supported options include ‘isFilled’ {Boolean} and ‘isStroked’ {Boolean} | | geometry | {OpenLayers.Geometry} |
graphicRotate| graphicRotate: function( | node, | | xOffset, | | yOffset | ) |
|
If a point is to be styled with externalGraphic and rotation, VML fills cannot be used to display the graphic, because rotation of graphic fills is not supported by the VML implementation of Internet Explorer. This method creates a olv:imagedata element inside the VML node, DXImageTransform.Matrix and BasicImage filters for rotation and opacity, and a 3-step hack to remove rendering artefacts from the graphic and preserve the ability of graphics to trigger events. Finally, OpenLayers methods are used to determine the correct insertion point of the rotated image, because DXImageTransform.Matrix does the rotation without the ability to specify a rotation center point. Parameters| node | {DOMElement} | | xOffset | {Number} rotation center relative to image, x coordinate | | yOffset | {Number} rotation center relative to image, y coordinate |
postDrawSome versions of Internet Explorer seem to be unable to set fillcolor and strokecolor to “none” correctly before the fill node is appended to a visible vml node. This method takes care of that and sets fillcolor and strokecolor again if needed. ParameterssetNodeDimension| setNodeDimension: function( | node, | | geometry | ) |
|
Get the geometry’s bounds, convert it to our vml coordinate system, then set the node’s position, size, and local coordinate system. ParametersdashStyle| dashStyle: function( | style | ) |
|
ParametersReturns{String} A VML compliant ‘stroke-dasharray’ value createNode| createNode: function( | type, | | id | ) |
|
Create a new node Parameters| type | {String} Kind of node to draw | | id | {String} Id for node |
Returns{DOMElement} A new node of the given type and id nodeTypeCompare| nodeTypeCompare: function( | node, | | type | ) |
|
Determine whether a node is of a given type Parameters| node | {DOMElement} An VML element | | type | {String} Kind of node |
Returns{Boolean} Whether or not the specified node is of the specified type createRenderRoot| createRenderRoot: function() |
Create the renderer root Returns{DOMElement} The specific render engine’s root element createRoot| createRoot: function( | suffix | ) |
|
Create the main root element Parameters| suffix | {String} suffix to append to the id |
Returns{DOMElement} drawPoint| drawPoint: function( | node, | | geometry | ) |
|
Render a point ParametersReturns{DOMElement} or false if the point could not be drawn drawCircle| drawCircle: function( | node, | | geometry, | | radius | ) |
|
Render a circle. Size and Center a circle given geometry (x,y center) and radius ParametersReturns{DOMElement} or false if the circle could not ne drawn drawLineString| drawLineString: function( | node, | | geometry | ) |
|
Render a linestring. ParametersReturns{DOMElement} drawLinearRing| drawLinearRing: function( | node, | | geometry | ) |
|
Render a linearring ParametersReturns{DOMElement} DrawLineRender a line. Parameters| node | {DOMElement} | | geometry | {OpenLayers.Geometry} | | closeLine | {Boolean} Close the line? (make it a ring?) |
Returns{DOMElement} drawPolygon| drawPolygon: function( | node, | | geometry | ) |
|
Render a polygon ParametersReturns{DOMElement} drawRectangle| drawRectangle: function( | node, | | geometry | ) |
|
Render a rectangle ParametersReturns{DOMElement} drawText| drawText: function( | featureId, | | style, | | location | ) |
|
This method is only called by the renderer itself. ParametersdrawSurface| drawSurface: function( | node, | | geometry | ) |
|
ParametersReturns{DOMElement} moveRoot| moveRoot: function( | renderer | ) |
|
moves this renderer’s root to a different renderer. Parameters| renderer | {OpenLayers.Renderer} target renderer for the moved root | | root | {DOMElement} optional root node. To be used when this renderer holds roots from multiple layers to tell this method which one to detach |
Returns{Boolean} true if successful, false otherwise importSymbol| importSymbol: function ( | graphicName | ) |
|
add a new symbol definition from the rendererer’s symbol hash Parameters| graphicName | {String} name of the symbol to import |
Returns| {Object} | hash of {DOMElement} “symbol” and {Number} “size” |
OpenLayers. Renderer. VML. LABEL_SHIFTOpenLayers.TileThis is a class designed to designate a single tile, however it is explicitly designed to do relatively little. Tiles store information about themselves -- such as the URL that they are related to, and their size - but do not add themselves to the layer div automatically, for example. Create a new tile with the OpenLayers.Tile constructor, or a subclass. | TBD 3.0 | remove reference to url in above paragraph |
Summary | | | {Array(String)} Supported application event types | | | | | | | | {String} url of the request. | | | | | | {Boolean} Is the tile loading? | | | | | | Call immediately before destroying if you are listening to tile events, so that counters are properly handled if tile is still loading at destroy-time. | | | | Clear whatever is currently in the tile, then return whether or not it should actually be re-drawn. | | | | Clear the tile of any bounds/position-related data so that it can be reused in a new location. | | Take the pixel locations of the corner of the tile, and pass them to the base layer and ask for the location of those pixels, so that displaying tiles over Google works fine. | | Show the tile only if it should be drawn. | | | | |
EVENT_TYPES{Array(String)} Supported application event types url{String} url of the request. TBD 3.0 Deprecated. The base tile class does not need an url. This should be handled in subclasses. Does not belong here. isLoading{Boolean} Is the tile loading? unloadCall immediately before destroying if you are listening to tile events, so that counters are properly handled if tile is still loading at destroy-time. Will only fire an event if the tile is still loading. drawClear whatever is currently in the tile, then return whether or not it should actually be re-drawn. Returns{Boolean} Whether or not the tile should actually be drawn. Note that this is not really the best way of doing things, but such is the way the code has been developed. Subclasses call this and depend on the return to know if they should draw or not. moveTo| moveTo: function ( | bounds, | | position, | | redraw | ) |
|
Reposition the tile. ParametersclearClear the tile of any bounds/position-related data so that it can be reused in a new location. To be implemented by subclasses. getBoundsFromBaseLayer| getBoundsFromBaseLayer: function( | position | ) |
|
Take the pixel locations of the corner of the tile, and pass them to the base layer and ask for the location of those pixels, so that displaying tiles over Google works fine. ParametersReturnsshowTileShow the tile only if it should be drawn. showShow the tile. To be implemented by subclasses. hideHide the tile. To be implemented by subclasses. OpenLayers. Format.XMLRead and write XML. For cross-browser XML generation, use methods on an instance of the XML format class instead of on <code>document<end>. The DOM creation and traversing methods exposed here all mimic the W3C XML DOM methods. Create a new parser with the OpenLayers.Format.XML constructor. Inherits fromSummary | | | {Object} Mapping of namespace aliases to namespace URIs. | | {Object} Mapping of namespace URI to namespace alias. | | {String} The default namespace alias for creating element nodes. | | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. | | {XMLDom} If this browser uses ActiveX, this will be set to a XMLDOM object. | | | | | | Set a namespace alias and URI for the format. | | Shorthand for creating namespaced elements with optional attributes and child text nodes. | | Set multiple attributes given key value pairs from an object. | | Shorthand for applying one of the named readers given the node namespace and local name. | | Shorthand for applying the named readers to all children of a node. | | Shorthand for applying one of the named writers and appending the results to a node. | | Return this node or the next element node. |
namespaces{Object} Mapping of namespace aliases to namespace URIs. Properties of this object should not be set individually. Read-only. All XML subclasses should have their own namespaces object. Use setNamespace to add or set a namespace alias after construction. namespaceAlias{Object} Mapping of namespace URI to namespace alias. This object is read-only. Use setNamespace to add or set a namespace alias. defaultPrefix{String} The default namespace alias for creating element nodes. readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. The function will be applied in the scope of this parser with two arguments: the node being read and a context object passed from the parent. writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. xmldom{XMLDom} If this browser uses ActiveX, this will be set to a XMLDOM object. It is not intended to be a browser sniffing property. Instead, the xmldom property is used instead of <code>document<end> where namespaced node creation methods are not supported. In all other browsers, this remains null. OpenLayers. Format.XMLConstruct an XML parser. The parser is used to read and write XML. Reading XML from a string returns a DOM element. Writing XML from a DOM element returns a string. Parameters| options | {Object} Optional object whose properties will be set on the object. |
setNamespace| setNamespace: function( | alias, | | uri | ) |
|
Set a namespace alias and URI for the format. Parameters| alias | {String} The namespace alias (prefix). | | uri | {String} The namespace URI. |
createElementNSPlus| createElementNSPlus: function( | name, | | options | ) |
|
Shorthand for creating namespaced elements with optional attributes and child text nodes. Parameters| name | {String} The qualified node name. | | options | {Object} Optional object for node configuration. |
Valid options| uri | {String} Optional namespace uri for the element - supply a prefix instead if the namespace uri is a property of the format’s namespace object. | | attributes | {Object} Optional attributes to be set using the setAttributes method. | | value | {String} Optional text to be appended as a text node. |
Returns{Element} An element node. setAttributes| setAttributes: function( | node, | | obj | ) |
|
Set multiple attributes given key value pairs from an object. Parameters| node | {Element} An element node. | | obj | {Object || Array} An object whose properties represent attribute names and values represent attribute values. If an attribute name is a qualified name (“prefix:local”), the prefix will be looked up in the parsers {namespaces} object. If the prefix is found, setAttributeNS will be used instead of setAttribute. |
readNode| readNode: function( | node, | | obj | ) |
|
Shorthand for applying one of the named readers given the node namespace and local name. Readers take two args (node, obj) and generally extend or modify the second. Parameters| node | {DOMElement} The node to be read (required). | | obj | {Object} The object to be modified (optional). |
Returns{Object} The input object, modified (or a new one if none was provided). readChildNodes| readChildNodes: function( | node, | | obj | ) |
|
Shorthand for applying the named readers to all children of a node. For each child of type 1 (element), <readSelf> is called. Parameters| node | {DOMElement} The node to be read (required). | | obj | {Object} The object to be modified (optional). |
Returns{Object} The input object, modified. writeNode| writeNode: function( | name, | | obj, | | parent | ) |
|
Shorthand for applying one of the named writers and appending the results to a node. If a qualified name is not provided for the second argument (and a local name is used instead), the namespace of the parent node will be assumed. Parameters| name | {String} The name of a node to generate. If a qualified name (e.g. “pre:Name”) is used, the namespace prefix is assumed to be in the writers group. If a local name is used (e.g. “Name”) then the namespace of the parent is assumed. If a local name is used and no parent is supplied, then the default namespace is assumed. | | obj | {Object} Structure containing data for the writer. | | parent | {DOMElement} Result will be appended to this node. If no parent is supplied, the node will not be appended to anything. |
Returns{DOMElement} The child node. getThisOrNextEl| getThisOrNextEl: function( | node, | | name, | | uri | ) |
|
Return this node or the next element node. Optionally get the first sibling with the given local name or namespace URI. Parameters| node | {DOMElement} The node. | | name | {String} Optional local name of the sibling to search for. | | uri | {String} Optional namespace URI of the sibling to search for. |
Returns{DOMElement} The next sibling element. Returns null if no element is found, something significant besides an element is found, or the found element does not match the query. OpenLayers. HandlerBase class to construct a higher-level handler for event sequences. All handlers have activate and deactivate methods. In addition, they have methods named like browser events. When a handler is activated, any additional methods named like a browser event is registered as a listener for the corresponding event. When a handler is deactivated, those same methods are unregistered as event listeners. Handlers also typically have a callbacks object with keys named like the abstracted events or event sequences that they are in charge of handling. The controls that wrap handlers define the methods that correspond to these abstract events - so instead of listening for individual browser events, they only listen for the abstract events defined by the handler. Handlers are created by controls, which ultimately have the responsibility of making changes to the the state of the application. Handlers themselves may make temporary changes, but in general are expected to return the application in the same state that they found it. Summary | | | | | | | | | {Event} This property references the last event handled by the handler. | | | | | | | | Check the keyMask on the handler. | | Trigger the control’s named callback with the given arguments | | register an event on the map | | unregister an event from the map | | With each registered browser event, the handler sets its own evt property. | | | | | | If set as the <keyMask>, checkModifiers returns false if any key is down. | | If set as the <keyMask>, checkModifiers returns false if Shift is down. | | If set as the <keyMask>, checkModifiers returns false if Ctrl is down. | | |
evt{Event} This property references the last event handled by the handler. Note that this property is not part of the stable API. Use of the evt property should be restricted to controls in the library or other applications that are willing to update with changes to the OpenLayers code. OpenLayers. HandlerConstruct a handler. Parameters| control | {OpenLayers.Control} The control that initialized this handler. The control is assumed to have a valid map property; that map is used in the handler’s own setMap method. | | callbacks | {Object} An object whose properties correspond to abstracted events or sequences of browser events. The values for these properties are functions defined by the control that get called by the handler. | | options | {Object} An optional object whose properties will be set on the handler. |
checkModifiers| checkModifiers: function ( | evt | ) |
|
Check the keyMask on the handler. If no <keyMask> is set, this always returns true. If a <keyMask> is set and it matches the combination of keys down on an event, this returns true. Returns{Boolean} The keyMask matches the keys down on an event. callback| callback: function ( | name, | | args | ) |
|
Trigger the control’s named callback with the given arguments Parameters| name | {String} The key for the callback that is one of the properties of the handler’s callbacks object. | | args | {Array(*)} An array of arguments (any type) with which to call the callback (defined by the control). |
register| register: function ( | name, | | method | ) |
|
register an event on the map unregister| unregister: function ( | name, | | method | ) |
|
unregister an event from the map setEventWith each registered browser event, the handler sets its own evt property. This property can be accessed by controls if needed to get more information about the event that the handler is processing. This allows modifier keys on the event to be checked (alt, shift, and ctrl cannot be checked with the keyboard handler). For a control to determine which modifier keys are associated with the event that a handler is currently processing, it should access (code)handler.evt.altKey || handler.evt.shiftKey || handler.evt.ctrlKey(end). Parameters| evt | {Event} The browser event. |
OpenLayers. Handler. MOD_NONEIf set as the <keyMask>, checkModifiers returns false if any key is down. OpenLayers. Handler. MOD_SHIFTIf set as the <keyMask>, checkModifiers returns false if Shift is down. OpenLayers. Handler. MOD_CTRLIf set as the <keyMask>, checkModifiers returns false if Ctrl is down. OpenLayers. Handler. MOD_ALTIf set as the <keyMask>, checkModifiers returns false if Alt is down. OpenLayers.MapInstances of OpenLayers.Map are interactive maps embedded in a web page. Create a new map with the OpenLayers.Map constructor. On their own maps do not provide much functionality. To extend a map it’s necessary to add controls (OpenLayers.Control) and layers (OpenLayers.Layer) to the map. Summary | | | {Object} Base z-indexes for different classes of thing | | {Array(String)} Supported application event types. | | | | {String} Unique identifier for the map | | {Boolean} For a base layer that supports it, allow the map resolution to be set to a value between one of the values in the resolutions array. | | | | {Boolean} The map is currently being dragged. | | | | {HTMLDivElement} The element that represents the map viewport | | { OpenLayers.LonLat} The lonlat at which the later container was re-initialized (on-zoom) | | {HTMLDivElement} The element that contains the layers. | | | | | | | | {Float} The resolution of the map. | | {Integer} The current zoom level of the map | | {Float} The ratio of the current extent within which panning will tween. | | {String} Used to store a unique identifier that changes when the map view changes. | | {OpenLayers.Tween} Animated panning tween object, see panTo() | | {Integer} The number of steps to be passed to the OpenLayers.Tween.start() method when the map is panned. | | | | | | Constructor for a new OpenLayers.Map instance. | | Function that is called to destroy the map on page unload. | | When the map is destroyed, we need to stop listening to updateSize events: this method stores the function we need to unregister in non-IE browsers. | | | | Reset each layer’s z-index based on layer’s array index | | | | | | | | | | This function takes care to recenter the layerContainerDiv. | | | | | | | | | | | | {Integer} 256 Default tile width (unless otherwise specified) | | {Integer} 256 Default tile height (unless otherwise specified) |
Z_INDEX_BASE{Object} Base z-indexes for different classes of thing EVENT_TYPES{Array(String)} Supported application event types. Register a listener for a particular event with the following syntax: map.events.register(type, obj, listener);
Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened. All event objects have at least the following properties- object {Object} A reference to map.events.object.
- element {DOMElement} A reference to map.events.element.
Browser events have the following additional properties- xy {OpenLayers.Pixel} The pixel location of the event (relative to the the map viewport).
- other properties that come with browser events
Supported map event types- preaddlayer triggered before a layer has been added. The event object will include a layer property that references the layer to be added.
- addlayer triggered after a layer has been added. The event object will include a layer property that references the added layer.
- removelayer triggered after a layer has been removed. The event object will include a layer property that references the removed layer.
- changelayer triggered after a layer name change, order change, or visibility change (due to resolution thresholds). Listeners will receive an event object with layer and property properties. The layer property will be a reference to the changed layer. The property property will be a key to the changed property (name, visibility, or order).
- movestart triggered after the start of a drag, pan, or zoom
- move triggered after each drag, pan, or zoom
- moveend triggered after a drag, pan, or zoom completes
- zoomend triggered after a zoom completes
- addmarker triggered after a marker has been added
- removemarker triggered after a marker has been removed
- clearmarkers triggered after markers have been cleared
- mouseover triggered after mouseover the map
- mouseout triggered after mouseout the map
- mousemove triggered after mousemove the map
- dragstart Does not work. Register for movestart instead.
- drag Does not work. Register for move instead.
- dragend Does not work. Register for moveend instead.
- changebaselayer triggered after the base layer changes
id{String} Unique identifier for the map fractionalZoom{Boolean} For a base layer that supports it, allow the map resolution to be set to a value between one of the values in the resolutions array. Default is false. When fractionalZoom is set to true, it is possible to zoom to an arbitrary extent. This requires a base layer from a source that supports requests for arbitrary extents (i.e. not cached tiles on a regular lattice). This means that fractionalZoom will not work with commercial layers (Google, Yahoo, VE), layers using TileCache, or any other pre-cached data sources. If you are using fractionalZoom, then you should also use <getResolutionForZoom> instead of layer.resolutions[zoom] as the former works for non-integer zoom levels. If you calling <render> after map construction, do not use<maxResolution> auto. Instead, divide your <maxExtent> by your maximum expected dimension. dragging{Boolean} The map is currently being dragged. viewPortDiv{HTMLDivElement} The element that represents the map viewport layerContainerOrigin{OpenLayers.LonLat} The lonlat at which the later container was re-initialized (on-zoom) layerContainerDiv{HTMLDivElement} The element that contains the layers. controls{Array(OpenLayers.Control)} List of controls associated with the map. If not provided in the map options at construction, the map will be given the following controls by default: resolution{Float} The resolution of the map. zoom{Integer} The current zoom level of the map panRatio{Float} The ratio of the current extent within which panning will tween. viewRequestID{String} Used to store a unique identifier that changes when the map view changes. viewRequestID should be used when adding data asynchronously to the map: viewRequestID is incremented when you initiate your request (right now during changing of baselayers and changing of zooms). It is stored here in the map and also in the data that will be coming back asynchronously. Before displaying this data on request completion, we check that the viewRequestID of the data is still the same as that of the map. Fix for #480 panTween{OpenLayers.Tween} Animated panning tween object, see panTo() panDuration{Integer} The number of steps to be passed to the OpenLayers.Tween.start() method when the map is panned. Default is 50. paddingForPopups{OpenLayers.Bounds} Outside margin of the popup. Used to prevent the popup from getting too close to the map border. OpenLayers.MapConstructor for a new OpenLayers.Map instance. There are two possible ways to call the map constructor. See the examples below. Parameters| div | {String} Id of an element in your page that will contain the map. May be omitted if the <div> option is provided or if you intend to use <render> later. | | options | {Object} Optional object with properties to tag onto the map. |
Examples (method one)// create a map with default options in an element with the id "map1"
var map = new OpenLayers.Map("map1");
// create a map with non-default options in an element with id "map2"
var options = {
maxExtent: new OpenLayers.Bounds(-200000, -200000, 200000, 200000),
maxResolution: 156543,
units: 'm',
projection: "EPSG:41001"
};
var map = new OpenLayers.Map("map2", options);
| Examples (method two | single argument): |
// create a map with non-default options
var map = new OpenLayers.Map({
div: "map_id",
maxExtent: new OpenLayers.Bounds(-200000, -200000, 200000, 200000),
maxResolution: 156543,
units: 'm',
projection: "EPSG:41001"
});
// create a map without a reference to a container - call render later
var map = new OpenLayers.Map({
maxExtent: new OpenLayers.Bounds(-200000, -200000, 200000, 200000),
maxResolution: 156543,
units: 'm',
projection: "EPSG:41001"
});
unloadDestroyFunction that is called to destroy the map on page unload. stored here so that if map is manually destroyed, we can unregister this. updateSizeDestroyWhen the map is destroyed, we need to stop listening to updateSize events: this method stores the function we need to unregister in non-IE browsers. setLayerZIndex| setLayerZIndex: function ( | layer, | | zIdx | ) |
|
ParametersresetLayersZIndex| resetLayersZIndex: function() |
Reset each layer’s z-index based on layer’s array index addControlToMap| addControlToMap: function ( | control, | | px | ) |
|
ParameterscalculateBounds| calculateBounds: function( | center, | | resolution | ) |
|
Parameters| center | {OpenLayers.LonLat} Default is this.getCenter() | | resolution | {float} Default is this.getResolution() |
Returns{OpenLayers.Bounds} A bounds based on resolution, center, and current mapsize. moveTo| moveTo: function( | lonlat, | | zoom, | | options | ) |
|
ParameterscenterLayerContainer| centerLayerContainer: function ( | lonlat | ) |
|
This function takes care to recenter the layerContainerDiv. ParametersisValidZoomLevel| isValidZoomLevel: function( | zoomLevel | ) |
|
ParametersReturns{Boolean} Whether or not the zoom level passed in is non-null and within the min/max range of zoom levels. isValidLonLat| isValidLonLat: function( | lonlat | ) |
|
ParametersReturns{Boolean} Whether or not the lonlat passed in is non-null and within the maxExtent bounds getLonLatFromViewPortPx| getLonLatFromViewPortPx: function ( | viewPortPx | ) |
|
ParametersReturns{OpenLayers.LonLat} An OpenLayers.LonLat which is the passed-in view port OpenLayers.Pixel, translated into lon/lat by the current base layer. getLonLatFromLayerPx| getLonLatFromLayerPx: function ( | px | ) |
|
ParametersReturns{OpenLayers.LonLat} TILE_WIDTH{Integer} 256 Default tile width (unless otherwise specified) TILE_HEIGHT{Integer} 256 Default tile height (unless otherwise specified) OpenLayers. MarkerInstances of OpenLayers.Marker are a combination of a OpenLayers.LonLat and an OpenLayers.Icon. Markers are generally added to a special layer called OpenLayers.Layer.Markers. Examplevar markers = new OpenLayers.Layer.Markers( "Markers" );
map.addLayer(markers);
var size = new OpenLayers.Size(10,17);
var offset = new OpenLayers.Pixel(-(size.w/2), -size.h);
var icon = new OpenLayers.Icon('http://boston.openguides.org/markers/AQUA.png',size,offset);
markers.addMarker(new OpenLayers.Marker(new OpenLayers.LonLat(0,0),icon));
markers.addMarker(new OpenLayers.Marker(new OpenLayers.LonLat(0,0),icon.clone()));
Note that if you pass an icon into the Marker constructor, it will take that icon and use it. This means that you should not share icons between markers -- you use them once, but you should clone() for any additional markers using that same icon. Summary | | | | | | | | | | | | | | | Calls draw on the icon, and returns that output. | | Erases any drawn elements for this marker. | | Move the marker to the new location. | | {Boolean} Whether or not the marker is currently visible on screen. | | Englarges the markers icon by the specified ratio. | | Change the opacity of the marker by changin the opacity of its icon | | Change URL of the Icon Image. | | | | |
drawCalls draw on the icon, and returns that output. ParametersReturns{DOMElement} A new DOM Image with this marker’s icon set at the location passed-in eraseErases any drawn elements for this marker. moveToMove the marker to the new location. ParametersonScreenReturns{Boolean} Whether or not the marker is currently visible on screen. inflate| inflate: function( | inflate | ) |
|
Englarges the markers icon by the specified ratio. Parameters| inflate | {float} the ratio to enlarge the marker by (passing 2 will double the size). |
setOpacity| setOpacity: function( | opacity | ) |
|
Change the opacity of the marker by changin the opacity of its icon Parameters| opacity | {float} Specified as fraction (0.4, etc) |
setUrlChange URL of the Icon Image. display| display: function( | display | ) |
|
Hide or show the icon defaultIcon| OpenLayers.Marker.defaultIcon = function() |
Creates a default OpenLayers.Icon. Returns{OpenLayers.Icon} A default OpenLayers.Icon to use for a marker OpenLayers. RequestThe OpenLayers.Request namespace contains convenience methods for working with XMLHttpRequests. These methods work with a cross-browser W3C compliant OpenLayers.Request.XMLHttpRequest class. Summary | | | {Object} Default configuration for all requests. |
DEFAULT_CONFIG{Object} Default configuration for all requests. OpenLayers. Tile. ImageInstances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers. Create a new image tile with the OpenLayers.Tile.Image constructor. Inherits fromSummary | | | {String} The URL of the image being requested. | | {DOMElement} The div element which wraps the image. | | {DOMElement} The image element is appended to the frame. | | {Boolean} True if the png alpha hack needs to be applied on the layer’s div. | | {Boolean} Is this tile a back buffer tile? | | {Float} Used in transition code only. | | {Boolean} Is this the first time the tile is being drawn? | | { OpenLayers.Tile} A clone of the tile used to create transition effects when the tile is moved or changes resolution. | | | | | | | | Check that a tile should be drawn, and draw it. | | Triggered by two different events, layer loadend, and tile loadend. | | Internal function to actually initialize the image tile, position it correctly, and set its url. | | Using the properties currenty set on the layer, position the tile correctly. | | Clear the tile of any bounds/position-related data so that it can be reused in a new location. | | Creates the imgDiv property on the tile. | | Make sure that the image that just loaded is the one this tile is meant to display, since panning/zooming might have changed the tile’s URL in the meantime. | | This method is invoked on tiles that are backBuffers for tiles in the grid. | | Show the tile by showing its frame. | | Hide the tile by hiding its frame. |
url{String} The URL of the image being requested. No default. Filled in by layer.getURL() function. imgDiv{DOMElement} The div element which wraps the image. frame{DOMElement} The image element is appended to the frame. Any gutter on the image will be hidden behind the frame. layerAlphaHack{Boolean} True if the png alpha hack needs to be applied on the layer’s div. isBackBuffer{Boolean} Is this tile a back buffer tile? lastRatio{Float} Used in transition code only. This is the previous ratio of the back buffer tile resolution to the map resolution. Compared with the current ratio to determine if zooming occurred. isFirstDraw{Boolean} Is this the first time the tile is being drawn? This is used to force resetBackBuffer to synchronize the backBufferTile with the foreground tile the first time the foreground tile loads so that if the user zooms before the layer has fully loaded, the backBufferTile for tiles that have been loaded can be used. backBufferTile{OpenLayers.Tile} A clone of the tile used to create transition effects when the tile is moved or changes resolution. drawCheck that a tile should be drawn, and draw it. Returns{Boolean} Always returns true. resetBackBuffer| resetBackBuffer: function() |
Triggered by two different events, layer loadend, and tile loadend. In any of these cases, we check to see if we can hide the backBufferTile yet and update its parameters to match the foreground tile. Basic logic- If the backBufferTile hasn’t been drawn yet, reset it
- If layer is still loading, show foreground tile but don’t hide the backBufferTile yet
- If layer is done loading, reset backBuffer tile and show foreground tile
renderTileInternal function to actually initialize the image tile, position it correctly, and set its url. positionImage| positionImage: function() |
Using the properties currenty set on the layer, position the tile correctly. This method is used both by the async and non-async versions of the Tile.Image code. clearClear the tile of any bounds/position-related data so that it can be reused in a new location. initImgDivCreates the imgDiv property on the tile. checkImgURLMake sure that the image that just loaded is the one this tile is meant to display, since panning/zooming might have changed the tile’s URL in the meantime. If the tile URL did change before the image loaded, set the imgDiv display to ‘none’, as either (a) it will be reset to visible when the new URL loads in the image, or (b) we don’t want to display this tile after all because its new bounds are outside our maxExtent. This function should no longer be neccesary with the improvements to Grid.js in OpenLayers 2.3. The lack of a good isEquivilantURL function caused problems in 2.2, but it’s possible that with the improved isEquivilant URL function, this might be neccesary at some point. See discussion in the thread at http://openlayers.org- /pipermail- /dev- /2007-January- /000205.html startTransition| startTransition: function() |
This method is invoked on tiles that are backBuffers for tiles in the grid. The grid tile is about to be cleared and a new tile source loaded. This is where the transition effect needs to be started to provide visual continuity. showShow the tile by showing its frame. hideHide the tile by hiding its frame. OpenLayers. Control. OverviewMapThe OverMap control creates a small overview map, useful to display the extent of a zoomed map and your main map and provide additional navigation options to the User. By default the overview map is drawn in the lower right corner of the main map. Create a new overview map with the OpenLayers.Control.OverviewMap constructor. Inerits fromSummary | | | {DOMElement} The DOM element that contains the overview map | | | | | | | | Create a new overview map | | Render the control in the browser. | | | | Handle extent rectangle drag | | | | | | Hide all the contents of the control, shrink the size, add the maximize icon | | Hide/Show the toggle depending on whether the control is minimized | | Update the overview map after layers move. | | Determines if the overview map is suitable given the extent and resolution of the main map. | | Construct the map that this control contains | | Updates the extent rectangle position and size to match the map extent | | Updates the map extent to match the extent rectangle position and size | | Set extent rectangle pixel bounds. | | Get the rect bounds from the map bounds. | | Get the map bounds from the rect bounds. | | Get a map location from a pixel location | | Get a pixel location from a map location |
element{DOMElement} The DOM element that contains the overview map OpenLayers. Control. OverviewMapCreate a new overview map Parameters| object | {Object} Properties of this object will be set on the overview map object. Note, to set options on the map object contained in this control, set <mapOptions> as one of the options properties. |
drawRender the control in the browser. baseLayerDraw| baseLayerDraw: function() |
| Draw the base layer | called if unable to complete in the initial draw |
rectDragHandle extent rectangle drag ParametersmapDivClick| mapDivClick: function( | evt | ) |
|
Handle browser events ParametersmaximizeControl| maximizeControl: function( | e | ) |
|
Unhide the control. Called when the control is in the map viewport. ParametersminimizeControl| minimizeControl: function( | e | ) |
|
Hide all the contents of the control, shrink the size, add the maximize icon ParametersshowToggle| showToggle: function( | minimize | ) |
|
Hide/Show the toggle depending on whether the control is minimized ParametersupdateUpdate the overview map after layers move. isSuitableOverview| isSuitableOverview: function() |
Determines if the overview map is suitable given the extent and resolution of the main map. createMapConstruct the map that this control contains updateRectToMap| updateRectToMap: function() |
Updates the extent rectangle position and size to match the map extent updateMapToRect| updateMapToRect: function() |
Updates the map extent to match the extent rectangle position and size setRectPxBounds| setRectPxBounds: function( | pxBounds | ) |
|
Set extent rectangle pixel bounds. ParametersgetRectBoundsFromMapBounds| getRectBoundsFromMapBounds: function( | lonLatBounds | ) |
|
Get the rect bounds from the map bounds. ParametersReturns{OpenLayers.Bounds}A bounds which is the passed-in map lon/lat extent translated into pixel bounds for the overview map getMapBoundsFromRectBounds| getMapBoundsFromRectBounds: function( | pxBounds | ) |
|
Get the map bounds from the rect bounds. ParametersReturns{OpenLayers.Bounds} Bounds which is the passed-in overview rect bounds translated into lon/lat bounds for the overview map getLonLatFromOverviewPx| getLonLatFromOverviewPx: function( | overviewMapPx | ) |
|
Get a map location from a pixel location ParametersReturns{OpenLayers.LonLat} Location which is the passed-in overview map OpenLayers.Pixel, translated into lon/lat by the overview map getOverviewPxFromLonLat| getOverviewPxFromLonLat: function( | lonlat | ) |
|
Get a pixel location from a map location ParametersReturns{OpenLayers.Pixel} Location which is the passed-in OpenLayers.LonLat, translated into overview map pixels OpenLayers. FeatureFeatures are combinations of geography and attributes. The OpenLayers.Feature class specifically combines a marker and a lonlat. Summary | | | | | | | | | | | | | | | | | Constructor for features. | | nullify references to prevent circular references and memory leaks | | {Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property) | | Based on the data associated with the Feature, create and return a marker object. | | | | Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data. | | Destroys the popup created via createPopup. |
destroynullify references to prevent circular references and memory leaks onScreenReturns{Boolean} Whether or not the feature is currently visible on screen (based on its ‘lonlat’ property) createMarkerBased on the data associated with the Feature, create and return a marker object. Returns{OpenLayers.Marker} A Marker Object created from the ‘lonlat’ and ‘icon’ properties set in this.data. If no ‘lonlat’ is set, returns null. If no ‘icon’ is set, OpenLayers.Marker() will load the default image. | Note | this.marker is set to return value |
destroyMarker| destroyMarker: function() |
Destroys marker. If user overrides the createMarker() function, s/he should be able to also specify an alternative function for destroying it createPopup| createPopup: function( | closeBox | ) |
|
Creates a popup object created from the ‘lonlat’, ‘popupSize’, and ‘popupContentHTML’ properties set in this.data. It uses this.marker.icon as default anchor. If no ‘lonlat’ is set, returns null. If no this.marker has been created, no anchor is sent. | Note | the returned popup object is ‘owned’ by the feature, so you cannot use the popup’s destroy method to discard the popup. Instead, you must use the feature’s destroyPopup | | Note | this.popup is set to return value |
Parameters| closeBox | {Boolean} create popup with closebox or not |
Returns{OpenLayers.Popup} Returns the created popup, which is also set as ‘popup’ property of this feature. Will be of whatever type specified by this feature’s ‘popupClass’ property, but must be of type OpenLayers.Popup. destroyPopupDestroys the popup created via createPopup. As with the marker, if user overrides the createPopup() function, s/he should also be able to override the destruction OpenLayers. Handler. ClickA handler for mouse clicks. The intention of this handler is to give controls more flexibility with handling clicks. Browsers trigger click events twice for a double-click. In addition, the mousedown, mousemove, mouseup sequence fires a click event. With this handler, controls can decide whether to ignore clicks associated with a double click. By setting a <pixelTolerance>, controls can also ignore clicks that include a drag. Create a new instance with the OpenLayers.Handler.Click constructor. Inherits fromSummary | | | {Number} The id of the timeout waiting to clear the delayedCall. | | | | {Number} The id of the right mouse timeout waiting to clear the <delayedEvent>. | | | | Create a new click handler. | | | | | | | | | | | | | | Determine whether the event is within the optional pixel tolerance. | | Clear the timer and set timerId to null. | | |
timerId{Number} The id of the timeout waiting to clear the delayedCall. rightclickTimerId{Number} The id of the right mouse timeout waiting to clear the <delayedEvent>. OpenLayers. Handler. ClickCreate a new click handler. Parameters| control | {OpenLayers.Control} The control that is making use of this handler. If a handler is being used without a control, the handler’s setMap method must be overridden to deal properly with the map. | | callbacks | {Object} An object with keys corresponding to callbacks that will be called by the handler. The callbacks should expect to recieve a single argument, the click event. Callbacks for ‘click’ and ‘dblclick’ are supported. | | options | {Object} Optional object whose properties will be set on the handler. |
mousedownHandle mousedown. Only registered as a listener if pixelTolerance is a non-zero value at construction. Returns{Boolean} Continue propagating this event. mouseupHandle mouseup. Installed to support collection of right mouse events. Returns{Boolean} Continue propagating this event. rightclick| rightclick: function( | evt | ) |
|
Handle rightclick. For a dblrightclick, we get two clicks so we need to always register for dblrightclick to properly handle single clicks. Returns{Boolean} Continue propagating this event. delayedRightCall| delayedRightCall: function( | evt | ) |
|
Sets rightclickTimerId to null. And optionally triggers the rightclick callback if evt is set. dblclickHandle dblclick. For a dblclick, we get two clicks in some browsers (FF) and one in others (IE). So we need to always register for dblclick to properly handle single clicks. Returns{Boolean} Continue propagating this event. clickHandle click. Returns{Boolean} Continue propagating this event. passesTolerance| passesTolerance: function( | evt | ) |
|
Determine whether the event is within the optional pixel tolerance. Note that the pixel tolerance check only works if mousedown events get to the listeners registered here. If they are stopped by other elements, the <pixelTolerance> will have no effect here (this method will always return true). Returns{Boolean} The click is within the pixel tolerance (if specified). clearTimerClear the timer and set timerId to null. delayedCall| delayedCall: function( | evt | ) |
|
Sets timerId to null. And optionally triggers the click callback if evt is set. OpenLayers. Handler.DragThe drag handler is used to deal with sequences of browser events related to dragging. The handler is used by controls that want to know when a drag sequence begins, when a drag is happening, and when it has finished. Controls that use the drag handler typically construct it with callbacks for ‘down’, ‘move’, and ‘done’. Callbacks for these keys are called when the drag begins, with each move, and when the drag is done. In addition, controls can have callbacks keyed to ‘up’ and ‘out’ if they care to differentiate between the types of events that correspond with the end of a drag sequence. If no drag actually occurs (no mouse move) the ‘down’ and ‘up’ callbacks will be called, but not the ‘done’ callback. Create a new drag handler with the OpenLayers.Handler.Drag constructor. Inherits fromSummary | | | {Boolean} When a mousedown event is received, we want to record it, but not set ‘dragging’ until the mouse moves after starting. | | {Boolean} Stop propagation of mousedown events from getting to listeners on the same element. | | | | | | | | | | {Integer} In order to increase performance, an interval (in milliseconds) can be set to reduce the number of drag events called. | | {String} The id of the timeout used for the mousedown interval. | | | | Returns OpenLayers.Handler.Drag | | This method is called during the handling of the mouse down event. | | This method is called during the handling of the mouse move event. | | This method is called during the handling of the mouse up event. | | This method is called during the handling of the mouse out event. | | | | | | | | | | | | The drag handler captures the click event. | | | | |
started{Boolean} When a mousedown event is received, we want to record it, but not set ‘dragging’ until the mouse moves after starting. stopDown{Boolean} Stop propagation of mousedown events from getting to listeners on the same element. Default is true. interval{Integer} In order to increase performance, an interval (in milliseconds) can be set to reduce the number of drag events called. If set, a new drag event will not be set until the interval has passed. Defaults to 0, meaning no interval. timeoutId{String} The id of the timeout used for the mousedown interval. This is “private”, and should be left alone. OpenLayers. Handler.DragReturns OpenLayers.Handler.Drag Parameters| control | {OpenLayers.Control} The control that is making use of this handler. If a handler is being used without a control, the handlers setMap method must be overridden to deal properly with the map. | | callbacks | {Object} An object containing a single function to be called when the drag operation is finished. The callback should expect to recieve a single argument, the pixel location of the event. Callbacks for ‘move’ and ‘done’ are supported. You can also speficy callbacks for ‘down’, ‘up’, and ‘out’ to respond to those events. | | options | {Object} |
downThis method is called during the handling of the mouse down event. Subclasses can do their own processing here. Parameters| evt | {Event} The mouse down event |
moveThis method is called during the handling of the mouse move event. Subclasses can do their own processing here. Parameters| evt | {Event} The mouse move event |
upThis method is called during the handling of the mouse up event. Subclasses can do their own processing here. Parameters| evt | {Event} The mouse up event |
outThis method is called during the handling of the mouse out event. Subclasses can do their own processing here. Parameters| evt | {Event} The mouse out event |
mousedown| mousedown: function ( | evt | ) |
|
Handle mousedown events ParametersReturns{Boolean} Let the event propagate. mousemove| mousemove: function ( | evt | ) |
|
Handle mousemove events ParametersReturns{Boolean} Let the event propagate. removeTimeout| removeTimeout: function() |
Private. Called by mousemove() to remove the drag timeout. mouseupHandle mouseup events ParametersReturns{Boolean} Let the event propagate. mouseoutHandle mouseout events ParametersReturns{Boolean} Let the event propagate. clickThe drag handler captures the click event. If something else registers for clicks on the same element, its listener will not be called after a drag. ParametersReturns{Boolean} Let the event propagate. activateActivate the handler. Returns{Boolean} The handler was successfully activated. deactivateDeactivate the handler. Returns{Boolean} The handler was successfully deactivated. OpenLayers. Handler. FeatureHandler to respond to mouse events related to a drawn feature. Callbacks with the following keys will be notified of the following events associated with features: click, clickout, over, out, and dblclick. This handler stops event propagation for mousedown and mouseup if those browser events target features that can be selected. Summary | | | {Object} A object mapping the browser events to objects with callback keys for in and out. | | | | | | | | | | {Number} The number of pixels the mouse can move between mousedown and mouseup for the event to still be considered a click. | | To restrict dragging to a limited set of geometry types, send a list of strings corresponding to the geometry class names. | | {Boolean} If stopClick is set to true, handled clicks do not propagate to other click listeners. | | {Boolean} If stopDown is set to true, handled mousedowns do not propagate to other mousedown listeners. | | {Boolean} If stopUp is set to true, handled mouseups do not propagate to other mouseup listeners. | | | | | | | | | | | | | | | | Return true if the geometry type of the passed feature matches one of the geometry types in the geometryTypes array. | | | | Call the callback keyed in the event map with the supplied arguments. | | | | | | Moves the layer for this handler to the top, so mouse events can reach it. | | Moves the layer back to the position determined by the map’s layers array. |
EVENTMAP{Object} A object mapping the browser events to objects with callback keys for in and out. clickTolerance{Number} The number of pixels the mouse can move between mousedown and mouseup for the event to still be considered a click. Dragging the map should not trigger the click and clickout callbacks unless the map is moved by less than this tolerance. Defaults to 4. geometryTypesTo restrict dragging to a limited set of geometry types, send a list of strings corresponding to the geometry class names. @type Array(String) stopClick{Boolean} If stopClick is set to true, handled clicks do not propagate to other click listeners. Otherwise, handled clicks do propagate. Unhandled clicks always propagate, whatever the value of stopClick. Defaults to true. stopDown{Boolean} If stopDown is set to true, handled mousedowns do not propagate to other mousedown listeners. Otherwise, handled mousedowns do propagate. Unhandled mousedowns always propagate, whatever the value of stopDown. Defaults to true. stopUp{Boolean} If stopUp is set to true, handled mouseups do not propagate to other mouseup listeners. Otherwise, handled mouseups do propagate. Unhandled mouseups always propagate, whatever the value of stopUp. Defaults to false. OpenLayers. Handler. FeatureParameters| control | {OpenLayers.Control} | | layer | {OpenLayers.Layer.Vector} | | callbacks | {Object} An object with a ‘over’ property whos value is a function to be called when the mouse is over a feature. The callback should expect to recieve a single argument, the feature. | | options | {Object} |
mousedownHandle mouse down. Stop propagation if a feature is targeted by this event (stops map dragging during feature selection). ParametersmouseupHandle mouse up. Stop propagation if a feature is targeted by this event. ParametersclickHandle click. Call the “click” callback if click on a feature, or the “clickout” callback if click outside any feature. ParametersReturns{Boolean} mousemoveHandle mouse moves. Call the “over” callback if moving in to a feature, or the “out” callback if moving out of a feature. ParametersReturns{Boolean} dblclickHandle dblclick. Call the “dblclick” callback if dblclick on a feature. ParametersReturns{Boolean} geometryTypeMatches| geometryTypeMatches: function( | feature | ) |
|
Return true if the geometry type of the passed feature matches one of the geometry types in the geometryTypes array. Parameters| feature | {<OpenLayers.Vector.Feature>} |
Returns{Boolean} handleParametersReturns{Boolean} The event occurred over a relevant feature. triggerCallback| triggerCallback: function( | type, | | mode, | | args | ) |
|
Call the callback keyed in the event map with the supplied arguments. For click and clickout, the clickTolerance is checked first. ParametersactivateTurn on the handler. Returns false if the handler was already active. Returns{Boolean} deactivateTurn off the handler. Returns false if the handler was already active. Returns{Boolean} moveLayerToTop| moveLayerToTop: function() |
Moves the layer for this handler to the top, so mouse events can reach it. moveLayerBack| moveLayerBack: function() |
Moves the layer back to the position determined by the map’s layers array. OpenLayers. Handler. HoverThe hover handler is to be used to emulate mouseovers on objects on the map that aren’t DOM elements. For example one can use this handler to send WMS/GetFeatureInfo requests as the user moves the mouve over the map. Inherits fromSummary | | | | | | | | | Construct a hover handler. | | Called when the mouse moves on the map. | | Called when the mouse goes out of the map. | | Determine whether the mouse move is within the optional pixel tolerance. | | Clear the timer and set timerId to null. | | |
px| {<OpenLayers.Pixel>} | The location of the last mousemove, expressed in pixels. |
timerId| {Number} | The id of the timer. |
OpenLayers. Handler. HoverConstruct a hover handler. Parameters| control | {OpenLayers.Control} The control that initialized this handler. The control is assumed to have a valid map property; that map is used in the handler’s own setMap method. | | callbacks | {Object} An object with keys corresponding to callbacks that will be called by the handler. The callbacks should expect to receive a single argument, the event. Callbacks for ‘move’, the mouse is moving, and ‘pause’, the mouse is pausing, are supported. | | options | {Object} An optional object whose properties will be set on the handler. |
mousemoveCalled when the mouse moves on the map. ParametersReturns{Boolean} Continue propagating this event. mouseoutCalled when the mouse goes out of the map. ParametersReturns{Boolean} Continue propagating this event. passesTolerance| passesTolerance: function( | px | ) |
|
Determine whether the mouse move is within the optional pixel tolerance. ParametersReturns{Boolean} The mouse move is within the pixel tolerance. clearTimerClear the timer and set timerId to null. delayedCall| delayedCall: function( | evt | ) |
|
Triggers pause callback. ParametersOpenLayers. Handler. MouseWheelHandler for wheel up/down events. Inherits fromSummary | | | | | { OpenLayers.Pixel} mousePosition is necessary because evt.clientX/Y is buggy in Moz on wheel events, so we cache and use the value from the last mousemove. | | | | | | | | Catch the wheel event and handle it xbrowserly | | Given the wheel event, we carry out the appropriate zooming in or out, based on the ‘wheelDelta’ or ‘detail’ property of the event. | | Update the stored mousePosition on every move. | | | | |
mousePosition{OpenLayers.Pixel} mousePosition is necessary because evt.clientX/Y is buggy in Moz on wheel events, so we cache and use the value from the last mousemove. OpenLayers. Handler. MouseWheelParameters| control | {OpenLayers.Control} | | callbacks | {Object} An object containing a single function to be called when the drag operation is finished. The callback should expect to recieve a single argument, the point geometry. | | options | {Object} |
onWheelEvent| onWheelEvent: function( | e | ) |
|
Catch the wheel event and handle it xbrowserly ParameterswheelZoomGiven the wheel event, we carry out the appropriate zooming in or out, based on the ‘wheelDelta’ or ‘detail’ property of the event. Parametersmousemove| mousemove: function ( | evt | ) |
|
Update the stored mousePosition on every move. Parameters| evt | {Event} The browser event |
Returns{Boolean} Allow event propagation deactivate| deactivate: function ( | evt | ) |
|
OpenLayers. LayerSummary | | | {Float} The layer’s opacity. | | | | {Array(String)} Supported application event types. | | | | {Boolean} The layer’s images have an alpha channel. | | {Boolean} The current map resolution is within the layer’s min/max range. | | { OpenLayers.Pixel} For layers with a gutter, the image offset represents displacement due to the gutter. | | {Object} An optional object whose properties will be set on the layer. | | {Array} An immutable (that means don’t change it!) | | | | | | Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own. | | | | | | Set the map property for the layer. | | Called at the end of the map.addLayer sequence. | | This method’s responsibility is to set up the ‘resolutions’ array for the layer -- this array is what the layer will use to interface between the zoom levels of the map and the resolution display of the layer. | | Calculates the max extent which includes all of the data for the layer. | | {Integer} the z-index of this layer | | | | This function will take a bounds, and if wrapDateLine option is set on the layer, it will return a bounds which is wrapped around the world. |
opacity{Float} The layer’s opacity. Float number between 0.0 and 1.0. EVENT_TYPES{Array(String)} Supported application event types. Register a listener for a particular event with the following syntax: layer.events.register(type, obj, listener);
Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened. All event objects have at least the following properties| object | {Object} A reference to layer.events.object. | | element | {DOMElement} A reference to layer.events.element. |
Supported map event types| loadstart | Triggered when layer loading starts. | | loadend | Triggered when layer loading ends. | | loadcancel | Triggered when layer loading is canceled. | | visibilitychanged | Triggered when layer visibility is changed. | | move | Triggered when layer moves (triggered with every mousemove during a drag). | | moveend | Triggered when layer is done moving, object passed as argument has a zoomChanged boolean property which tells that the zoom has changed. |
alpha{Boolean} The layer’s images have an alpha channel. Default is false. inRange{Boolean} The current map resolution is within the layer’s min/max range. This is set in <OpenLayers.Map.setCenter> whenever the zoom changes. imageOffset{OpenLayers.Pixel} For layers with a gutter, the image offset represents displacement due to the gutter. options{Object} An optional object whose properties will be set on the layer. Any of the layer properties can be set as a property of the options object and sent to the constructor when the layer is created. SUPPORTED_TRANSITIONS{Array} An immutable (that means don’t change it!) list of supported transitionEffect values. OpenLayers. LayerParameters| name | {String} The layer name | | options | {Object} Hashtable of extra options to tag onto the layer |
destroy| destroy: function( | setNewBaseLayer | ) |
|
Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own. Parameters| setNewBaseLayer | {Boolean} Set a new base layer when this layer has been destroyed. Default is true. |
moveTo| moveTo:function( | bounds, | | zoomChanged, | | dragging | ) |
|
Parameters| bound | {OpenLayers.Bounds} | | zoomChanged | {Boolean} Tells when zoom has changed, as layers have to do some init work in that case. | | dragging | {Boolean} |
setMapSet the map property for the layer. This is done through an accessor so that subclasses can override this and take special action once they have their map variable set. Here we take care to bring over any of the necessary default properties from the map. ParametersafterAddCalled at the end of the map.addLayer sequence. At this point, the map will have a base layer. To be overridden by subclasses. initResolutions| initResolutions: function() |
This method’s responsibility is to set up the ‘resolutions’ array for the layer -- this array is what the layer will use to interface between the zoom levels of the map and the resolution display of the layer. The user has several options that determine how the array is set up. For a detailed explanation, see the following wiki from the openlayers.org homepage: http://trac.openlayers.org/wiki/SettingZoomLevels getDataExtent| getDataExtent: function () |
Calculates the max extent which includes all of the data for the layer. This function is to be implemented by subclasses. Returns{OpenLayers.Bounds} getZIndexReturns{Integer} the z-index of this layer setZIndex| setZIndex: function ( | zIndex | ) |
|
ParametersadjustBounds| adjustBounds: function ( | bounds | ) |
|
This function will take a bounds, and if wrapDateLine option is set on the layer, it will return a bounds which is wrapped around the world. We do not wrap for bounds which cross the maxExtent.left/right, only bounds which are entirely to the left or entirely to the right. ParametersOpenLayers. Marker.BoxInherits fromSummary | | | | | | | | | | | | | Allow the user to change the box’s color and border width | | | | {Boolean} Whether or not the marker is currently visible on screen. | | |
setBorder| setBorder: function ( | color, | | width | ) |
|
Allow the user to change the box’s color and border width Parameters| color | {String} Default is “red” | | width | {int} Default is 2 |
drawParametersReturns{DOMElement} A new DOM Image with this marker�s icon set at the location passed-in onScreenRreturn{Boolean} Whether or not the marker is currently visible on screen. display| display: function( | display | ) |
|
Hide or show the icon ParametersOpenLayers. Request. XMLHttpRequestStandard-compliant (W3C) cross-browser implementation of the XMLHttpRequest object. From http://code.google.com/p/xmlhttprequest/. Summary | | | | | Parse XML into a doc structure |
OpenLayers. nullHandler| OpenLayers.nullHandler = function( | request | ) |
|
@param {} request parseXMLString| OpenLayers.parseXMLString = function( | text | ) |
|
Parse XML into a doc structure ParametersReturns{?} Parsed AJAX Responsev OpenLayers.AjaxSummary | | | | | {Object} Transport mechanism for whichever browser we’re in, or false if none available. | | | | |
emptyFunction| emptyFunction: function () |
getTransportReturns{Object} Transport mechanism for whichever browser we’re in, or false if none available. OpenLayers. Ajax. Respondersregister| register: function( | responderToAdd | ) |
|
Parametersunregister| unregister: function( | responderToRemove | ) |
|
Parametersdispatch| dispatch: function( | callback, | | request, | | transport | ) |
|
Parameters| callback | {?} | | request | {?} | | transport | {?} |
OpenLayers. Ajax. RequestDeprecated. Use OpenLayers.Request method instead. InheritSummary | | | | | | | | | | | | | | | | | | | | | | | If the optional onException function is set, execute it and then dispatch the call to any other listener registered for onException. | | | | |
OpenLayers. Ajax. RequestParameters| url | {String} | | options | {Object} |
onStateChange| onStateChange: function() |
setRequestHeaders| setRequestHeaders: function() |
respondToReadyState| respondToReadyState: function( | readyState | ) |
|
ParametersgetHeader| getHeader: function( | name | ) |
|
ParametersReturns| {?} | response header for the given name |
dispatchException| dispatchException: function( | exception | ) |
|
If the optional onException function is set, execute it and then dispatch the call to any other listener registered for onException. If no optional onException function is set, we suspect that the user may have also not used OpenLayers.Ajax.Responders.register to register a listener for the onException call. To make sure that something gets done with this exception, only dispatch the call if there are listeners. If you explicitly want to swallow exceptions, set request.options.onException to an empty function (function(){}) or register an empty function with OpenLayers.Ajax.Responders for onException. ParametersOpenLayers. Ajax. ResponseSummary | | | | | | | | | | | | | | | | | | | | | Wrapper function around XMLSerializer, which doesn’t exist/work in IE/Safari. |
OpenLayers. Ajax. ResponsegetResponseHeader| getResponseHeader: function( | name | ) |
|
Returns| {?} | response header for given name |
getElementsByTagNameNS| OpenLayers.Ajax.getElementsByTagNameNS = function( | parentnode, | | nsuri, | | nsprefix, | | tagname | ) |
|
Parameters| parentnode | {?} | | nsuri | {?} | | nsprefix | {?} | | tagname | {?} |
Returns{?} serializeXMLToString| OpenLayers.Ajax.serializeXMLToString = function( | xmldom | ) |
|
Wrapper function around XMLSerializer, which doesn’t exist/work in IE/Safari. We need to come up with a way to serialize in those browser: for now, these browsers will just fail. #535, #536 Parametersxmldom {XMLNode} xml dom to serialize Returns{?} OpenLayers. Control. DragPanThe DragPan control pans the map with a drag of the mouse. Inherits fromSummary | | | {OpenLayers.Control.TYPES} | | | | {Integer} The number of milliseconds that should ellapse before panning the map again. | | | | | | | | Finish the panning operation. |
type{OpenLayers.Control.TYPES} interval{Integer} The number of milliseconds that should ellapse before panning the map again. Set this to increase dragging performance. Defaults to 25 milliseconds. panMapDoneFinish the panning operation. Only call setCenter (through panMap) if the map has actually been moved. ParametersOpenLayers. Feature. VectorVector features use the OpenLayers.Geometry classes as geometry description. They have an ‘attributes’ property, which is the data object, and a ‘style’ property, the default values of which are defined in the OpenLayers.Feature.Vector.style objects. Inherits fromSummary | | | | | { OpenLayers.Bounds} The box bounding that feature’s geometry, that property can be set by an OpenLayers.Format object when deserializing the feature, so in most cases it represents an information set by the server. | | | | {String} rendering intent currently being used | | | | | | nullify references to prevent circular references and memory leaks | | Create a clone of this vector feature. | | Determine whether the feature is within the map viewport. | | | | | | | | Determins whether the feature intersects with the specified location. | | | | Moves the feature and redraws it at its new location | | | | | | OpenLayers features can have a number of style attributes. |
bounds{OpenLayers.Bounds} The box bounding that feature’s geometry, that property can be set by an OpenLayers.Format object when deserializing the feature, so in most cases it represents an information set by the server. renderIntent{String} rendering intent currently being used OpenLayers. Feature. VectorCreate a vector feature. Parameters| geometry | {OpenLayers.Geometry} The geometry that this feature represents. | | attributes | {Object} An optional object that will be mapped to the <attributes> property. | | style | {Object} An optional style object. |
destroynullify references to prevent circular references and memory leaks cloneCreate a clone of this vector feature. Does not set any non-standard properties. Returns{OpenLayers.Feature.Vector} An exact clone of this vector feature. onScreen| onScreen:function( | boundsOnly | ) |
|
Determine whether the feature is within the map viewport. This method tests for an intersection between the geometry and the viewport bounds. If a more effecient but less precise geometry bounds intersection is desired, call the method with the boundsOnly parameter true. Parameters| boundsOnly | {Boolean} Only test whether a feature’s bounds intersects the viewport bounds. Default is false. If false, the feature’s geometry must intersect the viewport for onScreen to return true. |
Returns{Boolean} The feature is currently visible on screen (optionally based on its bounds if boundsOnly is true). createMarker| HACK | we need to decide if all vector features should be able to create markers |
Returns{OpenLayers.Marker} For now just returns null destroyMarker| destroyMarker: function() |
| HACK | we need to decide if all vector features should be able to delete markers |
If user overrides the createMarker() function, s/he should be able to also specify an alternative function for destroying it createPopup| HACK | we need to decide if all vector features should be able to create popups |
Returns{OpenLayers.Popup} For now just returns null atPoint| atPoint: function( | lonlat, | | toleranceLon, | | toleranceLat | ) |
|
Determins whether the feature intersects with the specified location. Parameters| lonlat | {OpenLayers.LonLat} | | toleranceLon | {float} Optional tolerance in Geometric Coords | | toleranceLat | {float} Optional tolerance in Geographic Coords |
Returns{Boolean} Whether or not the feature is at the specified location destroyPopup| HACK | we need to decide if all vector features should be able to delete popups |
moveMoves the feature and redraws it at its new location Parameters| state | {OpenLayers.LonLat or OpenLayers.Pixel} the location to which to move the feature. |
toStateSets the new state ParametersOpenLayers. Feature. Vector. styleOpenLayers features can have a number of style attributes. The ‘default’ style will typically be used if no other style is specified. These styles correspond for the most part, to the styling properties defined by the SVG standard. Information on fill properties: http://www.w3.org- /TR- /SVG- /painting.html#FillProperties Information on stroke properties: http://www.w3.org- /TR- /SVG- /painting.html#StrokeProperties Symbolizer properties| fill | {Boolean} Set to false if no fill is desired. | | fillColor | {String} Hex fill color. Default is “#ee9900”. | | fillOpacity | {Number} Fill opacity (0-1). Default is 0.4 | | stroke | {Boolean} Set to false if no stroke is desired. | | strokeColor | {String} Hex stroke color. Default is “#ee9900”. | | strokeOpacity | {Number} Stroke opacity (0-1). Default is 1. | | strokeWidth | {Number} Pixel stroke width. Default is 1. | | strokeLinecap | {String} Stroke cap type. Default is “round”. [butt | round | square] | | strokeDashstyle | {String} Stroke dash style. Default is “solid”. [dot | dash | dashdot | longdash | longdashdot | solid] | | graphic | {Boolean} Set to false if no graphic is desired. | | pointRadius | {Number} Pixel point radius. Default is 6. | | pointerEvents | {String} Default is “visiblePainted”. | | cursor | {String} Default is “”. | | externalGraphic | {String} Url to an external graphic that will be used for rendering points. | | graphicWidth | {Number} Pixel width for sizing an external graphic. | | graphicHeight | {Number} Pixel height for sizing an external graphic. | | graphicOpacity | {Number} Opacity (0-1) for an external graphic. | | graphicXOffset | {Number} Pixel offset along the positive x axis for displacing an external graphic. | | graphicYOffset | {Number} Pixel offset along the positive y axis for displacing an external graphic. | | graphicZIndex | {Number} The integer z-index value to use in rendering. | | graphicName | {String} Named graphic to use when rendering points. Supported values include “circle” (default), “square”, “star”, “x”, “cross”, “triangle”. | | graphicTitle | {String} Tooltip for an external graphic. Only supported in Firefox and Internet Explorer. | | backgroundGraphic | {String} Url to a graphic to be used as the background under an externalGraphic. | | backgroundGraphicZIndex | {Number} The integer z-index value to use in rendering the background graphic. | | backgroundXOffset | {Number} The x offset (in pixels) for the background graphic. | | backgroundYOffset | {Number} The y offset (in pixels) for the background graphic. | | backgroundHeight | {Number} The height of the background graphic. If not provided, the graphicHeight will be used. | | backgroundWidth | {Number} The width of the background width. If not provided, the graphicWidth will be used. | | label | {String} The text for an optional label. For browsers that use the canvas renderer, this requires either fillText or mozDrawText to be available. | | labelAlign | {String} Label alignment. This specifies the insertion point relative to the text. It is a string composed of two characters. The first character is for the horizontal alignment, the second for the vertical alignment. Valid values for horizontal alignment: “l”=left, “c”=center, “r”=right. Valid values for vertical alignment: “t”=top, “m”=middle, “b”=bottom. Example values: “lt”, “cm”, “rb”. The canvas renderer does not support vertical alignment, it will always use “b”. | | fontColor | {String} The font color for the label, to be provided like CSS. | | fontFamily | {String} The font family for the label, to be provided like in CSS. | | fontSize | {String} The font size for the label, to be provided like in CSS. | | fontWeight | {String} The font weight for the label, to be provided like in CSS. | | display | {String} Symbolizers will have no effect if display is set to “none”. All other values have no effect. |
OpenLayers. Handler.BoxHandler for dragging a rectangle across the map. Box is displayed on mouse down, moves on mouse move, and is finished on mouse up. Inherits fromSummary | | | | | {Object} Caches some box characteristics from css. | | | | | | | | | | | | | | Remove the zoombox from the screen and nullify our reference to it. | | | | | | Determines offset and box model for a box. |
boxCharacteristics{Object} Caches some box characteristics from css. This is used by the getBoxCharacteristics method. OpenLayers. Handler.BoxParameters| control | {OpenLayers.Control} | | callbacks | {Object} An object containing a single function to be called when the drag operation is finished. The callback should expect to recieve a single argument, the point geometry. | | options | {Object} |
removeBoxRemove the zoombox from the screen and nullify our reference to it. getCharacteristicsDetermines offset and box model for a box. Returns{Object} a hash with the following properties: - xOffset - Corner offset in x-direction
- yOffset - Corner offset in y-direction
- newBoxModel - true for all browsers except IE in quirks mode
OpenLayers. Handler. RegularPolygonHandler to draw a regular polygon on the map. Polygon is displayed on mouse down, moves or is modified on mouse move, and is finished on mouse up. The handler triggers callbacks for ‘done’ and ‘cancel’. Create a new instance with the OpenLayers.Handler.RegularPolygon constructor. Inherits fromSummary | | | {Float} The angle from the origin (mouse down) to the current mouse position, in radians. | | {Boolean} The polygon has a fixed radius. | | | | | | | | | | Create a new regular polygon handler. | | Start drawing a new feature | | Respond to drag move events | | Finish drawing the feature | | Finish drawing the feature. | | Create the new polygon geometry. | | Modify the polygon geometry in place. | | Calculate the angle based on settings. | | Finish the geometry and call the “done” callback. | | Trigger the control’s named callback with the given arguments |
angle{Float} The angle from the origin (mouse down) to the current mouse position, in radians. This is measured counterclockwise from the positive x-axis. fixedRadius{Boolean} The polygon has a fixed radius. True if a radius is set before drawing begins. False otherwise. OpenLayers. Handler. RegularPolygonCreate a new regular polygon handler. Parameters| control | {OpenLayers.Control} The control that owns this handler | | callbacks | {Object} An object with a properties whose values are functions. Various callbacks described below. | | options | {Object} An object with properties to be set on the handler. If the options.sides property is not specified, the number of sides will default to 4. |
Named callbacks| create | Called when a sketch is first created. Callback called with the creation point geometry and sketch feature. | | done | Called when the sketch drawing is finished. The callback will recieve a single argument, the sketch geometry. | | cancel | Called when the handler is deactivated while drawing. The cancel callback will receive a geometry. |
downStart drawing a new feature Parameters| evt | {Event} The drag start event |
moveRespond to drag move events ParametersupFinish drawing the feature Parameters| evt | {Event} The mouse up event |
outFinish drawing the feature. Parameters| evt | {Event} The mouse out event |
createGeometry| createGeometry: function() |
Create the new polygon geometry. This is called at the start of the drag and at any point during the drag if the number of sides changes. modifyGeometry| modifyGeometry: function() |
Modify the polygon geometry in place. calculateAngle| calculateAngle: function( | point, | | evt | ) |
|
Calculate the angle based on settings. ParametersfinalizeFinish the geometry and call the “done” callback. callback| callback: function ( | name, | | args | ) |
|
Trigger the control’s named callback with the given arguments Parameters| name | {String} The key for the callback that is one of the properties of the handler’s callbacks object. | | args | {Array} An array of arguments with which to call the callback (defined by the control). |
OpenLayers. Layer. EventPaneBase class for 3rd party layers. Create a new event pane layer with the OpenLayers.Layer.EventPane constructor. Inherits fromSummary | | | {Boolean} EventPaned layers are always base layers, by necessity. | | {DOMElement} A reference to the element that controls the events. | | {Object} This is the object which will be used to load the 3rd party library in the case of the google layer, this will be of type GMap, in the case of the ve layer, this will be of type VEMap | | | | Create a new event pane layer | | Set the map property for the layer. | | If we can’t load the map lib, then display an error message to the user and tell them where to go for help. | | To be implemented by subclasses. | | Set the display on the pane | | Set the z-index order for the pane. | | Handle calls to move the layer. | | Get a map location from a pixel location | | Get a pixel location from a map location | | Get an OL style map location from a 3rd party style map location | | Get a 3rd party map location from an OL map location. | | Get an OL pixel location from a 3rd party pixel location. | | Get a 3rd party pixel location from an OL pixel location |
isBaseLayer{Boolean} EventPaned layers are always base layers, by necessity. pane{DOMElement} A reference to the element that controls the events. mapObject{Object} This is the object which will be used to load the 3rd party library in the case of the google layer, this will be of type GMap, in the case of the ve layer, this will be of type VEMap OpenLayers. Layer. EventPaneCreate a new event pane layer Parameters| name | {String} | | options | {Object} Hashtable of extra options to tag onto the layer |
setMapSet the map property for the layer. This is done through an accessor so that subclasses can override this and take special action once they have their map variable set. ParametersloadWarningMessage| loadWarningMessage:function() |
If we can’t load the map lib, then display an error message to the user and tell them where to go for help. This function sets up the layout for the warning message. Each 3rd party layer must implement its own getWarningHTML() function to provide the actual warning message. getWarningHTML| getWarningHTML:function() |
To be implemented by subclasses. Returns{String} String with information on why layer is broken, how to get it working. display| display: function( | display | ) |
|
Set the display on the pane ParameterssetZIndex| setZIndex: function ( | zIndex | ) |
|
Set the z-index order for the pane. ParametersmoveTo| moveTo:function( | bounds, | | zoomChanged, | | dragging | ) |
|
Handle calls to move the layer. ParametersgetLonLatFromViewPortPx| getLonLatFromViewPortPx: function ( | viewPortPx | ) |
|
Get a map location from a pixel location ParametersReturns{OpenLayers.LonLat} An OpenLayers.LonLat which is the passed-in view port OpenLayers.Pixel, translated into lon/lat by map lib If the map lib is not loaded or not centered, returns null getViewPortPxFromLonLat| getViewPortPxFromLonLat: function ( | lonlat | ) |
|
Get a pixel location from a map location ParametersReturns{OpenLayers.Pixel} An OpenLayers.Pixel which is the passed-in OpenLayers.LonLat, translated into view port pixels by map lib If map lib is not loaded or not centered, returns null getOLLonLatFromMapObjectLonLat| getOLLonLatFromMapObjectLonLat: function( | moLonLat | ) |
|
Get an OL style map location from a 3rd party style map location Parameters moLonLat - {Object} Returns{OpenLayers.LonLat} An OpenLayers.LonLat, translated from the passed in MapObject LonLat Returns null if null value is passed in getMapObjectLonLatFromOLLonLat| getMapObjectLonLatFromOLLonLat: function( | olLonLat | ) |
|
Get a 3rd party map location from an OL map location. ParametersReturns{Object} A MapObject LonLat, translated from the passed in OpenLayers.LonLat Returns null if null value is passed in getOLPixelFromMapObjectPixel| getOLPixelFromMapObjectPixel: function( | moPixel | ) |
|
Get an OL pixel location from a 3rd party pixel location. ParametersReturns{OpenLayers.Pixel} An OpenLayers.Pixel, translated from the passed in MapObject Pixel Returns null if null value is passed in getMapObjectPixelFromOLPixel| getMapObjectPixelFromOLPixel: function( | olPixel | ) |
|
Get a 3rd party pixel location from an OL pixel location ParametersReturns{Object} A MapObject Pixel, translated from the passed in OpenLayers.Pixel Returns null if null value is passed in OpenLayers. Layer. FixedZoomLevelsSome Layers will already have established zoom levels (like google or ve). Instead of trying to determine them and populate a resolutions[] Array with those values, we will hijack the resolution functionality here. When you subclass FixedZoomLevelsThe initResolutions() call gets nullified, meaning no resolutions[] array is set up. Which would be a big problem getResolution() in Layer, since it merely takes map.zoom and indexes into resolutions[]... but.... The getResolution() call is also overridden. Instead of using the resolutions[] array, we simply calculate the current resolution based on the current extent and the current map size. But how will we be able to calculate the current extent without knowing the resolution...? The getExtent() function is also overridden. Instead of calculating extent based on the center point and the current resolution, we instead calculate the extent by getting the lonlats at the top-left and bottom-right by using the getLonLatFromViewPortPx() translation function, taken from the pixel locations (0,0) and the size of the map. But how will we be able to do lonlat-px translation without resolution....? The getZoomForResolution() method is overridden. Instead of indexing into the resolutions[] array, we call OpenLayers.Layer.getExent(), passing in the desired resolution. With this extent, we then call getZoomForExtent() Whenever you implement a layer using OpenLayers.Layer.FixedZoomLevels, it is your responsibility to provide the following three functions: - getLonLatFromViewPortPx
- getViewPortPxFromLonLat
- getZoomForExtent
...those three functions should generally be provided by any reasonable API that you might be working from. Summary | | | Create a new fixed zoom levels layer. | | Populate the resolutions array | | Get the zoom level for a given resolution | | Get the OL zoom index from the map object zoom level | | Get the map object zoom level from the OL zoom level |
OpenLayers. Layer. FixedZoomLevelsCreate a new fixed zoom levels layer. initResolutions| initResolutions: function() |
Populate the resolutions array getZoomForResolution| getZoomForResolution: function( | resolution | ) |
|
Get the zoom level for a given resolution ParametersReturns{Integer} A suitable zoom level for the specified resolution. If no baselayer is set, returns null. getOLZoomFromMapObjectZoom| getOLZoomFromMapObjectZoom: function( | moZoom | ) |
|
Get the OL zoom index from the map object zoom level ParametersReturns{Integer} An OpenLayers Zoom level, translated from the passed in zoom Returns null if null value is passed in getMapObjectZoomFromOLZoom| getMapObjectZoomFromOLZoom: function( | olZoom | ) |
|
Get the map object zoom level from the OL zoom level ParametersReturns{Integer} A MapObject level, translated from the passed in olZoom Returns null if null value is passed in OpenLayers. Layer. HTTPRequestInherits fromSummary | | | {Float} Used to hash URL param strings for multi-WMS server selection. | | | | {Array(String) or String} This is either an array of url strings or a single url string. | | {Object} Hashtable of key/value parameters | | | | | | selectUrl() implements the standard floating-point multiplicative hash function described by Knuth, and hashes the contents of the given param string into a float between 0 and 1. | | Combine url with layer’s params and these newParams. |
URL_HASH_FACTOR{Float} Used to hash URL param strings for multi-WMS server selection. Set to the Golden Ratio per Knuth’s recommendation. url{Array(String) or String} This is either an array of url strings or a single url string. params{Object} Hashtable of key/value parameters OpenLayers. Layer. HTTPRequestParameters| name | {String} | | url | {Array(String) or String} | | params | {Object} | | options | {Object} Hashtable of extra options to tag onto the layer |
selectUrl| selectUrl: function( | paramString, | | urls | ) |
|
selectUrl() implements the standard floating-point multiplicative hash function described by Knuth, and hashes the contents of the given param string into a float between 0 and 1. This float is then scaled to the size of the provided urls array, and used to select a URL. Parameters| paramString | {String} | | urls | {Array(String)} |
Returns{String} An entry from the urls array, deterministically selected based on the paramString. getFullRequestString| getFullRequestString:function( | newParams, | | altUrl | ) |
|
Combine url with layer’s params and these newParams. does checking on the serverPath variable, allowing for cases when it is supplied with trailing ? or &, as well as cases where not. return in formatted string like this”server?key1=value1&key2=value2&key3=value3” WARNING: The altUrl parameter is deprecated and will be removed in 3.0. Parameters| newParams | {Object} | | altUrl | {String} Use this as the url instead of the layer’s url |
Returns{String} OpenLayers. Layer. MarkersInherits fromSummary | | | {Boolean} internal state of drawing. | | | | | | | | This method removes all markers from a layer. | | Calculate the pixel location for the marker, create it, and add it to the layer’s div |
drawn{Boolean} internal state of drawing. This is a workaround for the fact that the map does not call moveTo with a zoomChanged when the map is first starting up. This lets us catch the case where we have never drawn the layer, and draw it even if the zoom hasn’t changed. OpenLayers. Layer. MarkersCreate a Markers layer. Parameters| name | {String} | | options | {Object} Hashtable of extra options to tag onto the layer |
moveTo| moveTo:function( | bounds, | | zoomChanged, | | dragging | ) |
|
ParametersclearMarkersThis method removes all markers from a layer. The markers are not destroyed by this function, but are removed from the list of markers. drawMarker| drawMarker: function( | marker | ) |
|
Calculate the pixel location for the marker, create it, and add it to the layer’s div ParametersOpenLayers. Layer. SphericalMercatorA mixin for layers that wraps up the pieces neccesary to have a coordinate conversion for working with commercial APIs which use a spherical mercator projection. Using this layer as a base layer, additional layers can be used as overlays if they are in the same projection. A layer is given properties of this object by setting the sphericalMercator property to true. More projection informationProj4 Text+proj=merc +a=6378137 +b=6378137 +lat_ts=0.0 +lon_0=0.0 +x_0=0.0 +y_0=0 +k=1.0 +units=m +nadgrids=@null +no_defs WKT900913=PROJCS[“WGS84 / Simple Mercator”, GEOGCS[“WGS 84”, DATUM[“WGS_1984”, SPHEROID[“WGS_1984”, 6378137.0, 298.257223563]], PRIMEM[“Greenwich”, 0.0], UNIT[“degree”, 0.017453292519943295], AXIS[“Longitude”, EAST], AXIS[“Latitude”, NORTH]], PROJECTION[“Mercator_1SP_Google”], PARAMETER[“latitude_of_origin”, 0.0], PARAMETER[“central_meridian”, 0.0], PARAMETER[“scale_factor”, 1.0], PARAMETER[“false_easting”, 0.0], PARAMETER[“false_northing”, 0.0], UNIT[“m”, 1.0], AXIS[“x”, EAST], AXIS[“y”, NORTH], AUTHORITY[“EPSG”,”900913”]] Summary | | | | | Set up the mercator parameters on the layer: resolutions, projection, units. | | Given an object with x and y properties in EPSG:4326, modify the x,y properties on the object to be the Spherical Mercator projected coordinates. | | Given an object with x and y properties in Spherical Mercator, modify the x,y properties on the object to be the unprojected coordinates. | | Transforms from EPSG:4326 to EPSG:900913 and from EPSG:900913 to EPSG:4326 are set by this class. |
initMercatorParameters| initMercatorParameters: function() |
Set up the mercator parameters on the layer: resolutions, projection, units. projectForward| projectForward: function( | point | ) |
|
Given an object with x and y properties in EPSG:4326, modify the x,y properties on the object to be the Spherical Mercator projected coordinates. Parameters| point | {Object} An object with x and y properties. |
Returns{Object} The point, with the x and y properties transformed to spherical mercator. projectInverse| projectInverse: function( | point | ) |
|
Given an object with x and y properties in Spherical Mercator, modify the x,y properties on the object to be the unprojected coordinates. Parameters| point | {Object} An object with x and y properties. |
Returns{Object} The point, with the x and y properties transformed from spherical mercator to unprojected coordinates.. Two transforms declaredTransforms from EPSG:4326 to EPSG:900913 and from EPSG:900913 to EPSG:4326 are set by this class. OpenLayers. Control. DrawFeatureThe DrawFeature control draws point, line or polygon features on a vector layer when active. Inherits fromSummary | | | | | {Object} The functions that are sent to the handler for callback | | | | | | | | | | |
callbacks{Object} The functions that are sent to the handler for callback EVENT_TYPESSupported event types| featureadded | Triggered when a feature is added |
OpenLayers. Control. DrawFeaturedrawFeature| drawFeature: function( | geometry | ) |
|
OpenLayers. Control. MeasureAllows for drawing of features for measurements. Inherits fromSummary | | | {Array(String)} Supported application event types. | | | | {Object} The functions that are sent to the handler for callback | | {String} Display system for output measurements. | | {Boolean} Calculate geodesic metrics instead of planar metrics. | | {Object} Units for various measurement systems. | | {Number} Number of milliseconds between clicks before the event is considered a double-click. | | {Number} Timeout id of trigger for measurepartial. | | | | | | | | Called when the measurement sketch is done. | | Called each time a new point is added to the measurement sketch. | | | | | | | | | | |
EVENT_TYPES{Array(String)} Supported application event types. Register a listener for a particular event with the following syntax: control.events.register(type, obj, listener);
Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened. Supported control event types (in addition to those from OpenLayers.Control)| measure | Triggered when a measurement sketch is complete. Listeners will receive an event with measure, units, order, and geometry properties. | | measurepartial | Triggered when a new point is added to the measurement sketch. Listeners receive an event with measure, units, order, and geometry. |
callbacks{Object} The functions that are sent to the handler for callback displaySystem{String} Display system for output measurements. Supported values are ‘english’, ‘metric’, and ‘geographic’. Default is ‘metric’. geodesic{Boolean} Calculate geodesic metrics instead of planar metrics. This requires that geometries can be transformed into Geographic/WGS84 (if that is not already the map projection). Default is false. displaySystemUnits{Object} Units for various measurement systems. Values are arrays of unit abbreviations (from OpenLayers.INCHES_PER_UNIT) in decreasing order of length. delay{Number} Number of milliseconds between clicks before the event is considered a double-click. The “measurepartial” event will not be triggered if the sketch is completed within this time. This is required for IE where creating a browser reflow (if a listener is modifying the DOM by displaying the measurement values) messes with the dblclick listener in the sketch handler. delayedTrigger{Number} Timeout id of trigger for measurepartial. OpenLayers. Control. MeasureupdateHandler| updateHandler: function( | handler, | | options | ) |
|
Parameters| handler | {Function} One of the sketch handler constructors. | | options | {Object} Options for the handler. |
measureComplete| measureComplete: function( | geometry | ) |
|
Called when the measurement sketch is done. ParametersmeasurePartial| measurePartial: function( | point, | | geometry | ) |
|
Called each time a new point is added to the measurement sketch. Parametersmeasure| measure: function( | geometry, | | eventType | ) |
|
ParametersgetBestArea| getBestArea: function( | geometry | ) |
|
Based on the displaySystem returns the area of a geometry. ParametersReturns{Array([Float, String])} Returns a two item array containing the area and the units abbreviation. getArea| getArea: function( | geometry, | | units | ) |
|
ParametersReturns{Float} The geometry area in the given units. getBestLength| getBestLength: function( | geometry | ) |
|
Based on the displaySystem returns the length of a geometry. ParametersReturns{Array([Float, String])} Returns a two item array containing the length and the units abbreviation. getLength| getLength: function( | geometry, | | units | ) |
|
ParametersReturns{Float} The geometry length in the given units. OpenLayers. Control. ZoomBoxThe ZoomBox control enables zooming directly to a given extent, by drawing a box on the map. The box is drawn by holding down shift, whilst dragging the mouse. Inherits fromSummary | | | {OpenLayers.Control.TYPE} | | {Boolean} Should the control be used for zooming out? | | {Boolean} Always zoom in/out, when box drawed | | | | | | |
type{OpenLayers.Control.TYPE} out{Boolean} Should the control be used for zooming out? alwaysZoom{Boolean} Always zoom in/out, when box drawed zoomBox| zoomBox: function ( | position | ) |
|
ParametersOpenLayers. Format.WKTClass for reading and writing Well-Known Text. Create a new instance with the OpenLayers.Format.WKT constructor. Inherits fromSummary | | | Create a new parser for WKT | | Deserialize a WKT string and return a vector feature or an array of vector features. | | Serialize a feature or array of features into a WKT string. |
OpenLayers. Format.WKTCreate a new parser for WKT Parameters| options | {Object} An optional object whose properties will be set on this instance |
Returns{OpenLayers.Format.WKT} A new WKT parser. readDeserialize a WKT string and return a vector feature or an array of vector features. Supports WKT for POINT, MULTIPOINT, LINESTRING, MULTILINESTRING, POLYGON, MULTIPOLYGON, and GEOMETRYCOLLECTION. ParametersReturns{<OpenLayers.Feature.Vector>|Array} A feature or array of features for GEOMETRYCOLLECTION WKT. write| write: function( | features | ) |
|
Serialize a feature or array of features into a WKT string. Parameters| features | {<OpenLayers.Feature.Vector>|Array} A feature or array of features |
Returns{String} The WKT string representation of the input geometries OpenLayers. Layer. GoogleInherits fromSummary | | | | | | | {Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projection | | | | {GDraggableObject} Since 2.93, Google has exposed the ability to get the maps GDraggableObject. | | {DOMElement} Div for Google’s copyright and terms of use link | | {DOMElement} Div for Google’s powered by logo and link | | | | | | Load the GMap and register appropriate event listeners. | | The map has been centered, and a map type was specified, so we set the map type on the gmap object, then unregister the listener so that we dont keep doing this every time the map moves. | | | | Hack-on function because GMAPS does not give it to us |
RESOLUTIONS{Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projection dragObject{GDraggableObject} Since 2.93, Google has exposed the ability to get the maps GDraggableObject. We can now use this for smooth panning termsOfUse{DOMElement} Div for Google’s copyright and terms of use link poweredBy{DOMElement} Div for Google’s powered by logo and link OpenLayers. Layer. GoogleParameters| name | {String} A name for the layer. | | options | {Object} An optional object whose properties will be set on the layer. |
loadMapObjectLoad the GMap and register appropriate event listeners. If we can’t load GMap2, then display a warning message. setMapTypeThe map has been centered, and a map type was specified, so we set the map type on the gmap object, then unregister the listener so that we dont keep doing this every time the map moves. display| display: function( | display | ) |
|
Hide or show the layer ParametersaddContainerPxFunction| addContainerPxFunction: function() |
Hack-on function because GMAPS does not give it to us ParametersReturns{GPoint} A GPoint specifying gLatLng translated into “Container” coords OpenLayers. Layer.GridBase class for layers that use a lattice of tiles. Create a new grid layer with the OpenLayers.Layer.Grid constructor. Inherits fromSummary | | | {Array(Array( OpenLayers.Tile))} This is an array of rows, each row is an array of tiles. | | | | | | Go through and remove all tiles from the grid, calling destroy() on each of them to kill circular references | | This function is called whenever the map is moved. | | | | | | Generate parameters for the grid layout. | | | | Starts at the top right corner of the grid and proceeds in a spiral towards the center, adding tiles one at a time to the beginning of a queue. | | This function takes a tile as input and adds the appropriate hooks to the tile so that the layer can keep track of the loading tiles. | | This function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks() | | | | | | Shift grid work in the other dimension | | When the size of the map or the buffer changes, we may need to remove some excess rows and columns. | | For singleTile layers, this will set a new tile size according to the dimensions of the map pane. |
grid{Array(Array(OpenLayers.Tile))} This is an array of rows, each row is an array of tiles. OpenLayers. Layer.GridCreate a new grid layer Parameters| name | {String} | | url | {String} | | params | {Object} | | options | {Object} Hashtable of extra options to tag onto the layer |
clearGridGo through and remove all tiles from the grid, calling destroy() on each of them to kill circular references moveTo| moveTo:function( | bounds, | | zoomChanged, | | dragging | ) |
|
This function is called whenever the map is moved. All the moving of actual ‘tiles’ is done by the map, but moveTo’s role is to accept a bounds and make sure the data that that bounds requires is pre-loaded. ParametersgetGridBounds| getGridBounds: function() |
Deprecated. This function will be removed in 3.0. Please use getTilesBounds() instead. Returns{OpenLayers.Bounds} A Bounds object representing the bounds of all the currently loaded tiles (including those partially or not at all seen onscreen) initSingleTile| initSingleTile: function( | bounds | ) |
|
ParameterscalculateGridLayout| calculateGridLayout: function( | bounds, | | extent, | | resolution | ) |
|
Generate parameters for the grid layout. This ParametersReturnsObject containing properties tilelon, tilelat, tileoffsetlat, tileoffsetlat, tileoffsetx, tileoffsety initGriddedTiles| initGriddedTiles:function( | bounds | ) |
|
ParametersspiralTileLoad| spiralTileLoad: function() |
Starts at the top right corner of the grid and proceeds in a spiral towards the center, adding tiles one at a time to the beginning of a queue. Once all the grid’s tiles have been added to the queue, we go back and iterate through the queue (thus reversing the spiral order from outside-in to inside-out), calling draw() on each tile. addTileMonitoringHooks| addTileMonitoringHooks: function( | tile | ) |
|
This function takes a tile as input and adds the appropriate hooks to the tile so that the layer can keep track of the loading tiles. ParametersremoveTileMonitoringHooks| removeTileMonitoringHooks: function( | tile | ) |
|
This function takes a tile as input and removes the tile hooks that were added in addTileMonitoringHooks() ParametersmoveGriddedTiles| moveGriddedTiles: function( | bounds | ) |
|
ParametersshiftRow| shiftRow:function( | prepend | ) |
|
Shifty grid work Parameters| prepend | {Boolean} if true, prepend to beginning. if false, then append to end |
shiftColumn| shiftColumn: function( | prepend | ) |
|
Shift grid work in the other dimension Parameters| prepend | {Boolean} if true, prepend to beginning. if false, then append to end |
removeExcessTiles| removeExcessTiles: function( | rows, | | columns | ) |
|
When the size of the map or the buffer changes, we may need to remove some excess rows and columns. Parameters| rows | {Integer} Maximum number of rows we want our grid to have. | | colums | {Integer} Maximum number of columns we want our grid to have. |
onMapResizeFor singleTile layers, this will set a new tile size according to the dimensions of the map pane. OpenLayers. Layer. VirtualEarthInherits fromSummary | | | | | | | {Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projection | | | | | | | | |
RESOLUTIONS{Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projection OpenLayers. Layer. VirtualEarthParameters| name | {String} | | options | {Object} |
OpenLayers. Layer. YahooInherits fromSummary | | | | | | | {Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projection | | | | | | | | | | The map has been centered, so the mysterious yahoo eventpane has been added. |
RESOLUTIONS{Array(Float)} Hardcode these resolutions so that they are more closely tied with the standard wms projection OpenLayers. Layer. YahooParameters| name | {String} | | options | {Object} |
fixYahooEventPane| fixYahooEventPane: function() |
The map has been centered, so the mysterious yahoo eventpane has been added. we remove it so that it doesnt mess with our event pane. OpenLayers. Protocol.HTTPA basic HTTP protocol for vector layers. Create a new instance with the OpenLayers.Protocol.HTTP constructor. Inherits fromSummary | | | {String} Service URL, read-only, set through the options passed to constructor. | | {Object} HTTP request headers, read-only, set through the options passed to the constructor, Example: {‘Content-Type’: ‘plain/text’} | | {Object} Parameters of GET requests, read-only, set through the options passed to the constructor, Example: {‘bbox’: ‘5,5,5,5’} | | {Object} Function to be called when the <read>, <create>, <update>, <delete> or <commit> operation completes, read-only, set through the options passed to the constructor. | | {Object} Callback execution scope, read-only, set through the options passed to the constructor. | | {Boolean} true if read operations are done with POST requests instead of GET, defaults to false. | | | | A class for giving layers generic HTTP protocol. | | Returns a function that applies the given public method with resp and options arguments. | | Individual callbacks are created for read, create and update, should a subclass need to override each one separately. | | Called the the request issued by <create> is complete. | | Called the the request issued by <update> is complete. | | Called the the request issued by <delete> is complete. | | Called by CRUD specific handlers. | | Read HTTP response body and return features. | | This method is used from within the commit method each time an an HTTP response is received from the server, it is responsible for calling the user-supplied callbacks. |
url{String} Service URL, read-only, set through the options passed to constructor. headers{Object} HTTP request headers, read-only, set through the options passed to the constructor, Example: {‘Content-Type’: ‘plain/text’} params{Object} Parameters of GET requests, read-only, set through the options passed to the constructor, Example: {‘bbox’: ‘5,5,5,5’} callback{Object} Function to be called when the <read>, <create>, <update>, <delete> or <commit> operation completes, read-only, set through the options passed to the constructor. scope{Object} Callback execution scope, read-only, set through the options passed to the constructor. readWithPOST{Boolean} true if read operations are done with POST requests instead of GET, defaults to false. OpenLayers. Protocol.HTTPA class for giving layers generic HTTP protocol. Parameters| options | {Object} Optional object whose properties will be set on the instance. |
Valid options include| url | {String} | | headers | {Object} | | params | {Object} | | format | {OpenLayers.Format} | | callback | {Function} | | scope | {Object} |
createCallback| createCallback: function( | method, | | response, | | options | ) |
|
Returns a function that applies the given public method with resp and options arguments. Parameters| method | {Function} The method to be applied by the callback. | | response | {OpenLayers.Protocol.Response} The protocol response object. | | options | {Object} Options sent to the protocol method (read, create, update, or delete). |
handleRead| handleRead: function( | resp, | | options | ) |
|
Individual callbacks are created for read, create and update, should a subclass need to override each one separately. Parameters| resp | {OpenLayers.Protocol.Response} The response object to pass to the user callback. | | options | {Object} The user options passed to the read call. |
handleCreate| handleCreate: function( | resp, | | options | ) |
|
Called the the request issued by <create> is complete. May be overridden by subclasses. Parameters| resp | {OpenLayers.Protocol.Response} The response object to pass to any user callback. | | options | {Object} The user options passed to the create call. |
handleUpdate| handleUpdate: function( | resp, | | options | ) |
|
Called the the request issued by <update> is complete. May be overridden by subclasses. Parameters| resp | {OpenLayers.Protocol.Response} The response object to pass to any user callback. | | options | {Object} The user options passed to the update call. |
handleDelete| handleDelete: function( | resp, | | options | ) |
|
Called the the request issued by <delete> is complete. May be overridden by subclasses. Parameters| resp | {OpenLayers.Protocol.Response} The response object to pass to any user callback. | | options | {Object} The user options passed to the delete call. |
handleResponse| handleResponse: function( | resp, | | options | ) |
|
Called by CRUD specific handlers. Parameters| resp | {OpenLayers.Protocol.Response} The response object to pass to any user callback. | | options | {Object} The user options passed to the create, read, update, or delete call. |
parseFeatures| parseFeatures: function( | request | ) |
|
Read HTTP response body and return features. Parameters| request | {XMLHttpRequest} The request object |
Returns{Array({OpenLayers.Feature.Vector})} or {OpenLayers.Feature.Vector} Array of features or a single feature. callUserCallback| callUserCallback: function( | resp, | | options | ) |
|
This method is used from within the commit method each time an an HTTP response is received from the server, it is responsible for calling the user-supplied callbacks. ParametersOpenLayers. StyleThis class represents a UserStyle obtained from a SLD, containing styling rules. Summary | | | {String} Title of this style (set if included in SLD) | | {String} Description of this style (set if abstract is included in SLD) | | | | {Object} An optional object with properties that symbolizers’ property values should be evaluated against. | | {Object} hash of style properties to use as default for merging rule-based style symbolizers onto. | | {Boolean} If set to true, the defaultStyle will extend the symbolizer of every rule. | | {Hash of Boolean} cache of style properties that need to be parsed for propertyNames. | | | | | | creates a style by applying all feature-dependent rules to the base style. | | | | creates literals for all style properties that have an entry in <this.propertyStyles>. | | Looks into all rules for this style and the defaultStyle to collect all the style hash property names containing ${...} | | | | Returns the correct symbolizer prefix according to the geometry type of the passed geometry | | converts a style value holding a combination of PropertyName and Literal into a Literal, taking the property values from the passed features. | | | | {Array} prefixes of the sld symbolizers. |
title{String} Title of this style (set if included in SLD) description{String} Description of this style (set if abstract is included in SLD) context{Object} An optional object with properties that symbolizers’ property values should be evaluated against. If no context is specified, feature.attributes will be used defaultStyle{Object} hash of style properties to use as default for merging rule-based style symbolizers onto. If no rules are defined, createSymbolizer will return this style. If defaultsPerSymbolizer is set to true, the defaultStyle will only be taken into account if there are rules defined. defaultsPerSymbolizer{Boolean} If set to true, the defaultStyle will extend the symbolizer of every rule. Properties of the defaultStyle will also be used to set missing symbolizer properties if the symbolizer has stroke, fill or graphic set to true. Default is false. propertyStyles{Hash of Boolean} cache of style properties that need to be parsed for propertyNames. Property names are keys, values won’t be used. OpenLayers. StyleCreates a UserStyle. Parameters| style | {Object} Optional hash of style properties that will be used as default style for this style object. This style applies if no rules are specified. Symbolizers defined in rules will extend this default style. | | options | {Object} An optional object with properties to set on the style. |
Valid optionsReturn{OpenLayers.Style} createSymbolizer| createSymbolizer: function( | feature | ) |
|
creates a style by applying all feature-dependent rules to the base style. ParametersReturns{Object} symbolizer hash applySymbolizer| applySymbolizer: function( | rule, | | style, | | feature | ) |
|
Parameters| rule | {OpenLayers.Rule} | | style | {Object} | | feature | {<OpenLayer.Feature.Vector>} |
Returns{Object} A style with new symbolizer applied. createLiterals| createLiterals: function( | style, | | feature | ) |
|
creates literals for all style properties that have an entry in <this.propertyStyles>. Parameters| style | {Object} style to create literals for. Will be modified inline. | | feature | {Object} |
Returns{Object} the modified style findPropertyStyles| findPropertyStyles: function() |
Looks into all rules for this style and the defaultStyle to collect all the style hash property names containing ${...} strings that have to be replaced using the createLiteral method before returning them. Returns{Object} hash of property names that need createLiteral parsing. The name of the property is the key, and the value is true; addPropertyStyles| addPropertyStyles: function( | propertyStyles, | | symbolizer | ) |
|
Parameters| propertyStyles | {Object} hash to add new property styles to. Will be modified inline | | symbolizer | {Object} search this symbolizer for property styles |
Returns{Object} propertyStyles hash getSymbolizerPrefix| getSymbolizerPrefix: function( | geometry | ) |
|
Returns the correct symbolizer prefix according to the geometry type of the passed geometry Parametersgeometry {OpenLayers.Geometry} Returns{String} key of the according symbolizer createLiteral| OpenLayers.Style.createLiteral = function( | value, | | context, | | feature | ) |
|
converts a style value holding a combination of PropertyName and Literal into a Literal, taking the property values from the passed features. Parameters| value | {String} value to parse. If this string contains a construct like “foo ${bar}”, then “foo “ will be taken as literal, and “${bar}” will be replaced by the value of the “bar” attribute of the passed feature. | | context | {Object} context to take attribute values from | | feature | {OpenLayers.Feature.Vector} The feature that will be passed to <OpenLayers.String.format> for evaluating functions in the context. |
Returns{String} the parsed value. In the example of the value parameter above, the result would be “foo valueOfBar”, assuming that the passed feature has an attribute named “bar” with the value “valueOfBar”. OpenLayers. Style. SYMBOLIZER_PREFIXES{Array} prefixes of the sld symbolizers. These are the same as the main geometry types OpenLayers. Control. NavigationThe navigation control handles map browsing with mouse events (dragging, double-clicking, and scrolling the wheel). Create a new navigation control with the OpenLayers.Control.Navigation control. Note that this control is added to the map by default (if no controls array is sent in the options object to the OpenLayers.Map constructor). InheritsSummary | | | | | | | | | Create a new navigation control | | The destroy method is used to perform any clean up before the control is dereferenced. | | | | | | | | | | | | | | User spun scroll wheel up | | User spun scroll wheel down | | | | |
OpenLayers. Control. NavigationCreate a new navigation control Parameters| options | {Object} An optional object whose properties will be set on the control |
destroyThe destroy method is used to perform any clean up before the control is dereferenced. Typically this is where event listeners are removed to prevent memory leaks. defaultDblClick| defaultDblClick: function ( | evt | ) |
|
ParametersdefaultDblRightClick| defaultDblRightClick: function ( | evt | ) |
|
ParameterswheelChange| wheelChange: function( | evt, | | deltaZ | ) |
|
Parameters| evt | {Event} | | deltaZ | {Integer} |
wheelUpUser spun scroll wheel up ParameterswheelDownUser spun scroll wheel down ParametersdisableZoomWheel| disableZoomWheel : function() |
enableZoomWheel| enableZoomWheel : function() |
OpenLayers. GeometryA Geometry is a description of a geographic object. Create an instance of this class with the OpenLayers.Geometry constructor. This is a base class, typical geometry types are described by subclasses of this class. Summary | | | {String} A unique identifier for this geometry. | | | | | | | | Creates a geometry object. | | | | Nullify this components bounds and that of its parent as well. | | Extend the existing bounds to include the new bounds. | | | | Calculate the length of this geometry. | | Calculate the area of this geometry. | | Returns the Well-Known Text representation of a geometry | | Generate a geometry given a Well-Known Text string. | | Determine whether two line segments intersect. | | |
id{String} A unique identifier for this geometry. parent{OpenLayers.Geometry}This is set when a Geometry is added as component of another geometry OpenLayers. GeometryCreates a geometry object. clearBoundsNullify this components bounds and that of its parent as well. extendBounds| extendBounds: function( | newBounds | ) |
|
Extend the existing bounds to include the new bounds. If geometry’s bounds is not yet set, then set a new Bounds. ParametersatPoint| atPoint: function( | lonlat, | | toleranceLon, | | toleranceLat | ) |
|
| Note | This is only an approximation based on the bounds of the geometry. |
Parameters| lonlat | {OpenLayers.LonLat} | | toleranceLon | {float} Optional tolerance in Geometric Coords | | toleranceLat | {float} Optional tolerance in Geographic Coords |
Returns{Boolean} Whether or not the geometry is at the specified location getLengthCalculate the length of this geometry. This method is defined in subclasses. Returns{Float} The length of the collection by summing its parts getAreaCalculate the area of this geometry. This method is defined in subclasses. Returns{Float} The area of the collection by summing its parts toStringReturns the Well-Known Text representation of a geometry Returns{String} Well-Known Text OpenLayers. Geometry. fromWKT| OpenLayers.Geometry.fromWKT = function( | wkt | ) |
|
Generate a geometry given a Well-Known Text string. Parameters| wkt | {String} A string representing the geometry in Well-Known Text. |
Returns{OpenLayers.Geometry} A geometry of the appropriate class. OpenLayers. Geometry. segmentsIntersect| OpenLayers.Geometry.segmentsIntersect = function( | seg1, | | seg2, | | options | ) |
|
Determine whether two line segments intersect. Optionally calculates and returns the intersection point. This function is optimized for cases where seg1.x2 >= seg2.x1 || seg2.x2 >= seg1.x1. In those obvious cases where there is no intersection, the function should not be called. Parameters| seg1 | {Object} Object representing a segment with properties x1, y1, x2, and y2. The start point is represented by x1 and y1. The end point is represented by x2 and y2. Start and end are ordered so that x1 < x2. | | seg2 | {Object} Object representing a segment with properties x1, y1, x2, and y2. The start point is represented by x1 and y1. The end point is represented by x2 and y2. Start and end are ordered so that x1 < x2. | | options | {Object} Optional properties for calculating the intersection. |
Valid options| point | {Boolean} Return the intersection point. If false, the actual intersection point will not be calculated. If true and the segments intersect, the intersection point will be returned. If true and the segments do not intersect, false will be returned. If true and the segments are coincident, true will be returned. | | tolerance | {Number} If a non-null value is provided, if the segments are within the tolerance distance, this will be considered an intersection. In addition, if the point option is true and the calculated intersection is within the tolerance distance of an end point, the endpoint will be returned instead of the calculated intersection. Further, if the intersection is within the tolerance of endpoints on both segments, or if two segment endpoints are within the tolerance distance of eachother (but no intersection is otherwise calculated), an endpoint on the first segment provided will be returned. |
Returns{Boolean | OpenLayers.Geometry.Point} The two segments intersect. If the point argument is true, the return will be the intersection point or false if none exists. If point is true and the segments are coincident, return will be true (and the instersection is equal to the shorter segment). OpenLayers. Geometry. distanceToSegment| OpenLayers.Geometry.distanceToSegment = function( | point, | | segment | ) |
|
Parameters| point | {Object} An object with x and y properties representing the point coordinates. | | segment | {Object} An object with x1, y1, x2, and y2 properties representing endpoint coordinates. |
Returns{Object} An object with distance, x, and y properties. The distance will be the shortest distance between the input point and segment. The x and y properties represent the coordinates along the segment where the shortest distance meets the segment. OpenLayers. Layer. MapGuideInstances of OpenLayers.Layer.MapGuide are used to display data from a MapGuide OS instance. Inherits fromSummary | | | {Object} Hashtable of default parameter key/value pairs for tiled layer | | {Object} Hashtable of default parameter key/value pairs for untiled layer | | {Object} Hashtable of default parameter key/value pairs for untiled layer | | {Object} Hashtable of parameter key/value pairs which describe the folder structure for tiles as configured in the mapguide serverconfig.ini section [TileServiceProperties] | | | | | | | | Create a new Mapguide layer, either tiled or untiled. | | factor that are different than the defaults used in OpenLayers, so these must be adjusted accordingly in your application. | | Create a clone of this layer | | Creates a tile, initializes it, and adds it to the layer div. | | Return a query string for this layer | | getFullRequestString on MapGuide layers is special, because we do a regular expression replace on ‘,’ in parameters to ‘+’. | | special handler to request mapguide tiles from an http exposed tilecache | | Generate parameters for the grid layout. |
TILE_PARAMS{Object} Hashtable of default parameter key/value pairs for tiled layer SINGLE_TILE_PARAMS{Object} Hashtable of default parameter key/value pairs for untiled layer OVERLAY_PARAMS{Object} Hashtable of default parameter key/value pairs for untiled layer FOLDER_PARAMS{Object} Hashtable of parameter key/value pairs which describe the folder structure for tiles as configured in the mapguide serverconfig.ini section [TileServiceProperties] OpenLayers. Layer. MapGuideCreate a new Mapguide layer, either tiled or untiled. For tiled layers, the ‘groupName’ and ‘mapDefinition’ values must be specified as parameters in the constructor. For untiled base layers, specify either combination of ‘mapName’ and ‘session’, or ‘mapDefinition’ and ‘locale’. For older versions of MapGuide and overlay layers, set useAsyncOverlay to false and in this case mapName and session are required parameters for the constructor. MapGuide OS uses a DPI value and degrees to meters conversionfactor that are different than the defaults used in OpenLayers, so these must be adjusted accordingly in your application. See the MapGuide example for how to set these values for MGOS. Parameters| name | {String} Name of the layer displayed in the interface | | url | {String} Location of the MapGuide mapagent executable (e.g. http://localhost:8008- /mapguide- /mapagent- /mapagent.fcgi) | | params | {Object} hashtable of additional parameters to use. Some parameters may require additional code on the server. The ones that you may want to use are: |
- mapDefinition - {String} The MapGuide resource definition (e.g. Library://Samples/Gmap/Maps/gmapTiled.MapDefinition)
- locale - Locale setting (for untiled overlays layers only)
- mapName - {String} Name of the map as stored in the MapGuide session. (for untiled layers with a session parameter only)
- session - { String} MapGuide session ID (for untiled overlays layers only)
- basemaplayergroupname - {String} GroupName for tiled MapGuide layers only
- format - Image format to be returned (for untiled overlay layers only)
- showLayers - {String} A comma separated list of GUID’s for the layers to display eg: ‘cvc-xcv34,453-345-345sdf’.
- hideLayers - {String} A comma separated list of GUID’s for the layers to hide eg: ‘cvc-xcv34,453-345-345sdf’.
- showGroups - {String} A comma separated list of GUID’s for the groups to display eg: ‘cvc-xcv34,453-345-345sdf’.
- hideGroups - {String} A comma separated list of GUID’s for the groups to hide eg: ‘cvc-xcv34,453-345-345sdf’
- selectionXml - {String} A selection xml string Some server plumbing is required to read such a value.
| options | {Ojbect} Hashtable of extra options to tag onto the layer; will vary depending if tiled or untiled maps are being requested |
addTile| addTile:function( | bounds, | | position | ) |
|
Creates a tile, initializes it, and adds it to the layer div. ParametersReturns{OpenLayers.Tile.Image} The added OpenLayers.Tile.Image getURL| getURL: function ( | bounds | ) |
|
Return a query string for this layer ParametersReturns{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters. getFullRequestString| getFullRequestString:function( | newParams, | | altUrl | ) |
|
getFullRequestString on MapGuide layers is special, because we do a regular expression replace on ‘,’ in parameters to ‘+’. This is why it is subclassed here. Parameters| altUrl | {String} Alternative base URL to use. |
Returns{String} A string with the layer’s url appropriately encoded for MapGuide getImageFilePath| getImageFilePath:function( | newParams, | | altUrl | ) |
|
special handler to request mapguide tiles from an http exposed tilecache Parameters| altUrl | {String} Alternative base URL to use. |
Returns{String} A string with the url for the tile image calculateGridLayout| calculateGridLayout: function( | bounds, | | extent, | | resolution | ) |
|
Generate parameters for the grid layout. This ParametersReturnsObject containing properties tilelon, tilelat, tileoffsetlat, tileoffsetlat, tileoffsetx, tileoffsety OpenLayers. Layer. MapServerInstances of OpenLayers.Layer.MapServer are used to display data from a MapServer CGI instance. Inherits fromSummary | | | {Object} Hashtable of default parameter key/value pairs | | | | Create a new MapServer layer object | | Create a clone of this layer | | Creates a tile, initializes it, and adds it to the layer div. | | Return a query string for this layer | | combine the layer’s url with its params and these newParams. |
DEFAULT_PARAMS{Object} Hashtable of default parameter key/value pairs OpenLayers. Layer. MapServerCreate a new MapServer layer object Parameters| name | {String} A name for the layer | | url | {String} Base url for the MapServer CGI (e.g. http://www2.dmsolutions.ca/cgi-bin/mapserv) | | params | {Object} An object with key/value pairs representing the GetMap query string parameters and parameter values. | | options | {Ojbect} Hashtable of extra options to tag onto the layer |
addTile| addTile:function( | bounds, | | position | ) |
|
Creates a tile, initializes it, and adds it to the layer div. ParametersReturns{OpenLayers.Tile.Image} The added OpenLayers.Tile.Image getURL| getURL: function ( | bounds | ) |
|
Return a query string for this layer ParametersReturns{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters. getFullRequestString| getFullRequestString:function( | newParams, | | altUrl | ) |
|
combine the layer’s url with its params and these newParams. Parameter| newParams | {Object} New parameters that should be added to the request string. | | altUrl | {String} (optional) Replace the URL in the full request string with the provided URL. |
Returns{String} A string with the layer’s url and parameters embedded in it. OpenLayers. Layer.WMSInstances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services. Create a new WMS layer with the OpenLayers.Layer.WMS constructor. Inherits fromSummary | | | {Object} Hashtable of default parameter key/value pairs | | | | | | | | Create a new WMS layer object | | | | Create a clone of this layer | | Return a GetMap query string for this layer | | addTile creates a tile, initializes it, and adds it to the layer div. |
DEFAULT_PARAMS{Object} Hashtable of default parameter key/value pairs reprojectDeprecated. See http://trac.openlayers.org/wiki/SphericalMercator for information on the replacement for this functionality. {Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer. Default is true. Set this in the layer options. Should be set to false in most cases. OpenLayers. Layer.WMSCreate a new WMS layer object Examplevar wms = new OpenLayers.Layer.WMS("NASA Global Mosaic",
"http://wms.jpl.nasa.gov/wms.cgi",
{layers: "modis,global_mosaic"});
Parameters| name | {String} A name for the layer | | url | {String} Base url for the WMS (e.g. http://wms.jpl.nasa.gov/wms.cgi) | | params | {Object} An object with key/value pairs representing the GetMap query string parameters and parameter values. | | options | {Ojbect} Hashtable of extra options to tag onto the layer |
getURL| getURL: function ( | bounds | ) |
|
Return a GetMap query string for this layer ParametersReturns{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters. addTile| addTile:function( | bounds, | | position | ) |
|
addTile creates a tile, initializes it, and adds it to the layer div. ParametersReturns{OpenLayers.Tile.Image} The added OpenLayers.Tile.Image OpenLayers.RuleThis class represents an SLD Rule, as being used for rule-based SLD styling. Summary | | | {String} A unique id for this session. | | {String} Title of this rule (set if included in SLD) | | {String} Description of this rule (set if abstract is included in SLD) | | {Object} An optional object with properties that the rule should be evaluated against. | | {<OpenLayers.Filter>} Optional filter for the rule. | | {Boolean} Determines whether this rule is only to be applied only if no other rules match (ElseFilter according to the SLD specification). | | {Object} Symbolizer or hash of symbolizers for this rule. | | | | | | Gets the context for evaluating this rule |
id{String} A unique id for this session. title{String} Title of this rule (set if included in SLD) description{String} Description of this rule (set if abstract is included in SLD) context{Object} An optional object with properties that the rule should be evaluated against. If no context is specified, feature.attributes will be used. filter{<OpenLayers.Filter>} Optional filter for the rule. elseFilter{Boolean} Determines whether this rule is only to be applied only if no other rules match (ElseFilter according to the SLD specification). Default is false. For instances of OpenLayers.Rule, if elseFilter is false, the rule will always apply. For subclasses, the else property is ignored. symbolizer{Object} Symbolizer or hash of symbolizers for this rule. If hash of symbolizers, keys are one or more of [“Point”, “Line”, “Polygon”]. The latter if useful if it is required to style e.g. vertices of a line with a point symbolizer. Note, however, that this is not implemented yet in OpenLayers, but it is the way how symbolizers are defined in SLD. OpenLayers.RuleCreates a Rule. Parameters| options | {Object} An optional object with properties to set on the rule |
Returns{OpenLayers.Rule} getContext| getContext: function( | feature | ) |
|
Gets the context for evaluating this rule ParamtersOpenLayers. StyleMapSummary | | | Hash of { OpenLayers.Style}, keyed by names of well known rendering intents (e.g. | | {Boolean} if true, every render intent will extend the symbolizers specified for the “default” intent at rendering time. | | | | | | | | Creates the symbolizer for a feature for a render intent. | | Convenience method to create comparison rules for unique values of a property. |
stylesHash of {OpenLayers.Style}, keyed by names of well known rendering intents (e.g. “default”, “temporary”, “select”, “delete”). extendDefault{Boolean} if true, every render intent will extend the symbolizers specified for the “default” intent at rendering time. Otherwise, every rendering intent will be treated as a completely independent style. OpenLayers. StyleMapParameters| style | {Object} Optional. Either a style hash, or a style object, or a hash of style objects (style hashes) keyed by rendering intent. If just one style hash or style object is passed, this will be used for all known render intents (default, select, temporary) | | options | {Object} optional hash of additional options for this instance |
createSymbolizer| createSymbolizer: function( | feature, | | intent | ) |
|
Creates the symbolizer for a feature for a render intent. Parameters| feature | {OpenLayers.Feature} The feature to evaluate the rules of the intended style against. | | intent | {String} The intent determines the symbolizer that will be used to draw the feature. Well known intents are “default” (for just drawing the features), “select” (for selected features) and “temporary” (for drawing features). |
Returns{Object} symbolizer hash addUniqueValueRules| addUniqueValueRules: function( | renderIntent, | | property, | | symbolizers, | | context | ) |
|
Convenience method to create comparison rules for unique values of a property. The rules will be added to the style object for a specified rendering intent. This method is a shortcut for creating something like the “unique value legends” familiar from well known desktop GIS systems Parameters| renderIntent | {String} rendering intent to add the rules to | | property | {String} values of feature attributes to create the rules for | | symbolizers | {Object} Hash of symbolizers, keyed by the desired property values | | context | {Object} An optional object with properties that symbolizers’ property values should be evaluated against. If no context is specified, feature.attributes will be used |
OpenLayers. Geometry. CollectionA Collection is exactly what it sounds like: A collection of different Geometries. These are stored in the local parameter <components> (which can be passed as a parameter to the constructor). As new geometries are added to the collection, they are NOT cloned. When removing geometries, they need to be specified by reference (ie you have to pass in the exact geometry to be removed). The getArea and getLength functions here merely iterate through the components, summing their respective areas and lengths. Create a new instance with the OpenLayers.Geometry.Collection constructor. Inerhits fromSummary | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | Creates a Geometry Collection -- a list of geoms. | | Get a string representing the components for this collection | | Add a new component (geometry) to the collection. | | Remove a component from this geometry. |
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include. A null value means the component types are not restricted. OpenLayers. Geometry. CollectionCreates a Geometry Collection -- a list of geoms. ParametersgetComponentsString| getComponentsString: function() |
Get a string representing the components for this collection Returns{String} A string representation of the components of this geometry addComponent| addComponent: function( | component, | | index | ) |
|
Add a new component (geometry) to the collection. If this.componentTypes is set, then the component class name must be in the componentTypes array. The bounds cache is reset. Parameters| component | {OpenLayers.Geometry} A geometry to add | | index | {int} Optional index into the array to insert the component |
Returns{Boolean} The component geometry was successfully added removeComponent| removeComponent: function( | component | ) |
|
Remove a component from this geometry. ParametersOpenLayers. Geometry. PointPoint geometry class. Inherits fromSummary | | | Construct a point geometry. | | Create a new Bounds based on the lon/lat | | {String} Shortened String representation of Point object. |
OpenLayers. Geometry. PointConstruct a point geometry. ParameterscalculateBounds| calculateBounds: function () |
Create a new Bounds based on the lon/lat toShortString| toShortString: function() |
Returns{String} Shortened String representation of Point object. (ex. <i>”5, 42”</i>) OpenLayers. Layer. VectorInstances of OpenLayers.Layer.Vector are used to render vector data from a variety of sources. Create a new vector layer with the OpenLayers.Layer.Vector constructor. Inherits fromSummary | | | {Array(String)} Supported application event types. | | | | | | {Object} hash of features, keyed by feature.id, that the renderer failed to draw | | | | | | | | {Array(String)} List of supported Renderer classes. | | | | {Boolean} Whether the Vector Layer features have been drawn yet. | | | | Create a new vector layer | | Ask the layer to request features again and redraw them. | | Iterates through the available renderer implementations and selects and assigns the first one whose “supported()” function returns true. | | Let the user know their browser isn’t supported. | | The layer has been added to the map. | | Called at the end of the map.addLayer sequence. | | The layer has been removed from the map. | | Notify the renderer of the change in size. | | Reset the vector layer’s div so that it once again is lined up with the map. | | Erase features from the layer. | | Given an event, return a feature if the event occurred over one. |
EVENT_TYPES{Array(String)} Supported application event types. Register a listener for a particular event with the following syntax: layer.events.register(type, obj, listener);
Listeners will be called with a reference to an event object. The properties of this event depends on exactly what happened. All event objects have at least the following properties| object | {Object} A reference to layer.events.object. | | element | {DOMElement} A reference to layer.events.element. |
Supported map event types (in addition to those from OpenLayers.Layer)| beforefeatureadded | Triggered before a feature is added. Listeners will receive an object with a feature property referencing the feature to be added. To stop the feature from being added, a listener should return false. | | beforefeaturesadded | Triggered before an array of features is added. Listeners will receive an object with a features property referencing the feature to be added. To stop the features from being added, a listener should return false. | | featureadded | Triggered after a feature is added. The event object passed to listeners will have a feature property with a reference to the added feature. | | featuresadded | Triggered after features are added. The event object passed to listeners will have a features property with a reference to an array of added features. | | beforefeatureremoved | Triggered before a feature is removed. Listeners will receive an object with a feature property referencing the feature to be removed. | | featureremoved | Triggerd after a feature is removed. The event object passed to listeners will have a feature property with a reference to the removed feature. | | featuresremoved | Triggered after features are removed. The event object passed to listeners will have a features property with a reference to an array of removed features. | | featureselected | Triggered after a feature is selected. Listeners will receive an object with a feature property referencing the selected feature. | | featureunselected | Triggered after a feature is unselected. Listeners will receive an object with a feature property referencing the unselected feature. | | beforefeaturemodified | Triggered when a feature is selected to be modified. Listeners will receive an object with a feature property referencing the selected feature. | | featuremodified | Triggered when a feature has been modified. Listeners will receive an object with a feature property referencing the modified feature. | | afterfeaturemodified | Triggered when a feature is finished being modified. Listeners will receive an object with a feature property referencing the modified feature. | | vertexmodified | Triggered when a vertex within any feature geometry has been modified. Listeners will receive an object with a feature property referencing the modified feature, a vertex property referencing the vertex modified (always a point geometry), and a pixel property referencing the pixel location of the modification. | | sketchstarted | Triggered when a feature sketch bound for this layer is started. Listeners will receive an object with a feature property referencing the new sketch feature and a vertex property referencing the creation point. | | sketchmodified | Triggered when a feature sketch bound for this layer is modified. Listeners will receive an object with a vertex property referencing the modified vertex and a feature property referencing the sketch feature. | | sketchcomplete | Triggered when a feature sketch bound for this layer is complete. Listeners will receive an object with a feature property referencing the sketch feature. By returning false, a listener can stop the sketch feature from being added to the layer. | | refresh | Triggered when something wants a strategy to ask the protocol for a new set of features. |
unrenderedFeatures{Object} hash of features, keyed by feature.id, that the renderer failed to draw renderers{Array(String)} List of supported Renderer classes. Add to this list to add support for additional renderers. This list is ordered: the first renderer which returns true for the ‘supported()’ method will be used, if not defined in the ‘renderer’ option. drawn{Boolean} Whether the Vector Layer features have been drawn yet. OpenLayers. Layer. VectorCreate a new vector layer Parameters| name | {String} A name for the layer | | options | {Object} Optional object with non-default properties to set on the layer. |
Returns{OpenLayers.Layer.Vector} A new vector layer refreshAsk the layer to request features again and redraw them. Triggers the refresh event if the layer is in range and visible. Parameters| obj | {Object} Optional object with properties for any listener of the refresh event. |
assignRenderer| assignRenderer: function() |
Iterates through the available renderer implementations and selects and assigns the first one whose “supported()” function returns true. displayErrorLet the user know their browser isn’t supported. setMapThe layer has been added to the map. If there is no renderer set, the layer can’t be used. Remove it. Otherwise, give the renderer a reference to the map and set its size. ParametersafterAddCalled at the end of the map.addLayer sequence. At this point, the map will have a base layer. Any autoActivate strategies will be activated here. removeMapThe layer has been removed from the map. ParametersonMapResizeNotify the renderer of the change in size. moveTo| moveTo: function( | bounds, | | zoomChanged, | | dragging | ) |
|
Reset the vector layer’s div so that it once again is lined up with the map. Notify the renderer of the change of extent, and in the case of a change of zoom level (resolution), have the renderer redraw features. If the layer has not yet been drawn, cycle through the layer’s features and draw each one. ParameterseraseFeatures| eraseFeatures: function( | features | ) |
|
Erase features from the layer. ParametersgetFeatureFromEvent| getFeatureFromEvent: function( | evt | ) |
|
Given an event, return a feature if the event occurred over one. Otherwise, return null. ParametersReturns{OpenLayers.Feature.Vector} A feature if one was under the event. OpenLayers. Geometry. MultiPointMultiPoint is a collection of Points. Create a new instance with the OpenLayers.Geometry.MultiPoint constructor. Inherits fromSummary | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | Create a new MultiPoint Geometry |
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include. A null value means the component types are not restricted. OpenLayers. Handler. PointHandler to draw a point on the map. Point is displayed on mouse down, moves on mouse move, and is finished on mouse up. The handler triggers callbacks for ‘done’, ‘cancel’, and ‘modify’. The modify callback is called with each change in the sketch and will receive the latest point drawn. Create a new instance with the OpenLayers.Handler.Point constructor. Inherits fromSummary | | | | | | | {Boolean} Cast features to multi-part geometries before passing to the layer. | | {Boolean} A point is being drawn | | {Boolean} The mouse is down | | | | | | {Object} Any optional properties to be set on the sketch layer. | | | | Create a new point handler. | | | | Destroy the temporary geometries | | Finish the geometry and call the “done” callback. | | | | | | Modify the existing geometry given a pixel location. | | Render features on the temporary layer. | | Return the sketch geometry. | | Return a clone of the relevant geometry. | | | | | | |
multi{Boolean} Cast features to multi-part geometries before passing to the layer. Default is false. drawing{Boolean} A point is being drawn mouseDown{Boolean} The mouse is down layerOptions{Object} Any optional properties to be set on the sketch layer. OpenLayers. Handler. PointCreate a new point handler. Parameters| control | {OpenLayers.Control} The control that owns this handler | | callbacks | {Object} An object with a properties whose values are functions. Various callbacks described below. | | options | {Object} An optional object with properties to be set on the handler |
Named callbacks| create | Called when a sketch is first created. Callback called with the creation point geometry and sketch feature. | | modify | Called with each move of a vertex with the vertex (point) geometry and the sketch feature. | | done | Called when the point drawing is finished. The callback will recieve a single argument, the point geometry. | | cancel | Called when the handler is deactivated while drawing. The cancel callback will receive a geometry. |
createFeature| createFeature: function( | pixel | ) |
|
Add temporary features ParametersdestroyFeature| destroyFeature: function() |
Destroy the temporary geometries finalize| finalize: function( | cancel | ) |
|
Finish the geometry and call the “done” callback. Parameters| cancel | {Boolean} Call cancel instead of done callback. Default is false. |
clickHandle clicks. Clicks are stopped from propagating to other listeners on map.events or other dom elements. Parameters| evt | {Event} The browser event |
Returns{Boolean} Allow event propagation dblclickHandle double-clicks. Double-clicks are stopped from propagating to other listeners on map.events or other dom elements. Parameters| evt | {Event} The browser event |
Returns{Boolean} Allow event propagation modifyFeature| modifyFeature: function( | pixel | ) |
|
Modify the existing geometry given a pixel location. ParametersdrawFeatureRender features on the temporary layer. geometryClone| geometryClone: function() |
Return a clone of the relevant geometry. Returns{OpenLayers.Geometry} mousedownHandle mouse down. Adjust the geometry and redraw. Return determines whether to propagate the event on the map. Parameters| evt | {Event} The browser event |
Returns{Boolean} Allow event propagation mousemove| mousemove: function ( | evt | ) |
|
Handle mouse move. Adjust the geometry and redraw. Return determines whether to propagate the event on the map. Parameters| evt | {Event} The browser event |
Returns{Boolean} Allow event propagation mouseupHandle mouse up. Send the latest point in the geometry to the control. Return determines whether to propagate the event on the map. Parameters| evt | {Event} The browser event |
Returns{Boolean} Allow event propagation OpenLayers. Geometry. CurveA Curve is a MultiPoint, whose points are assumed to be connected. To this end, we provide a “getLength()” function, which iterates through the points, summing the distances between them. InheritsSummary | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | |
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include. A null value means the component types are not restricted. OpenLayers. Geometry. CurveOpenLayers. Geometry. LineStringA LineString is a Curve which, once two points have been added to it, can never be less than two points long. Inherits fromSummary | | | Create a new LineString geometry | | {Array} An array of segment objects. | | Split this geometry with the given segment. | | Use this geometry (the source) to attempt to split a target geometry. | | Split this geometry (the target) with the given geometry (the source). |
OpenLayers. Geometry. LineStringCreate a new LineString geometry ParametersgetSortedSegments| getSortedSegments: function() |
Returns{Array} An array of segment objects. Segment objects have properties x1, y1, x2, and y2. The start point is represented by x1 and y1. The end point is represented by x2 and y2. Start and end are ordered so that x1 < x2. splitWithSegment| splitWithSegment: function( | seg, | | options | ) |
|
Split this geometry with the given segment. Parameters| seg | {Object} An object with x1, y1, x2, and y2 properties referencing segment endpoint coordinates. | | options | {Object} Properties of this object will be used to determine how the split is conducted. |
Valid options| edge | {Boolean} Allow splitting when only edges intersect. Default is true. If false, a vertex on the source segment must be within the tolerance distance of the intersection to be considered a split. | | tolerance | {Number} If a non-null value is provided, intersections within the tolerance distance of one of the source segment’s endpoints will be assumed to occur at the endpoint. |
Returns{Object} An object with lines and points properties. If the given segment intersects this linestring, the lines array will reference geometries that result from the split. The points array will contain all intersection points. Intersection points are sorted along the segment (in order from x1,y1 to x2,y2). split| split: function( | target, | | options | ) |
|
Use this geometry (the source) to attempt to split a target geometry. Parameters| target | {OpenLayers.Geometry} The target geometry. | | options | {Object} Properties of this object will be used to determine how the split is conducted. |
Valid options| mutual | {Boolean} Split the source geometry in addition to the target geometry. Default is false. | | edge | {Boolean} Allow splitting when only edges intersect. Default is true. If false, a vertex on the source must be within the tolerance distance of the intersection to be considered a split. | | tolerance | {Number} If a non-null value is provided, intersections within the tolerance distance of an existing vertex on the source will be assumed to occur at the vertex. |
Returns{Array} A list of geometries (of this same type as the target) that result from splitting the target with the source geometry. The source and target geometry will remain unmodified. If no split results, null will be returned. If mutual is true and a split results, return will be an array of two arrays - the first will be all geometries that result from splitting the source geometry and the second will be all geometries that result from splitting the target geometry. splitWith| splitWith: function( | geometry, | | options | ) |
|
Split this geometry (the target) with the given geometry (the source). Parameters| geometry | {OpenLayers.Geometry} A geometry used to split this geometry (the source). | | options | {Object} Properties of this object will be used to determine how the split is conducted. |
Valid options| mutual | {Boolean} Split the source geometry in addition to the target geometry. Default is false. | | edge | {Boolean} Allow splitting when only edges intersect. Default is true. If false, a vertex on the source must be within the tolerance distance of the intersection to be considered a split. | | tolerance | {Number} If a non-null value is provided, intersections within the tolerance distance of an existing vertex on the source will be assumed to occur at the vertex. |
Returns{Array} A list of geometries (of this same type as the target) that result from splitting the target with the source geometry. The source and target geometry will remain unmodified. If no split results, null will be returned. If mutual is true and a split results, return will be an array of two arrays - the first will be all geometries that result from splitting the source geometry and the second will be all geometries that result from splitting the target geometry. OpenLayers. Geometry. LinearRingA Linear Ring is a special LineString which is closed. It closes itself automatically on every addPoint/removePoint by adding a copy of the first point as the last point. Also, as it is the first in the line family to close itself, a getArea() function is defined to calculate the enclosed area of the linearRing InheritsSummary | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | Linear rings are constructed with an array of points. | | Test if a point is inside a linear ring. |
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include. A null value means the component types are not restricted. OpenLayers. Geometry. LinearRingLinear rings are constructed with an array of points. This array can represent a closed or open ring. If the ring is open (the last point does not equal the first point), the constructor will close the ring. If the ring is already closed (the last point does equal the first point), it will be left closed. ParameterscontainsPoint| containsPoint: function( | point | ) |
|
Test if a point is inside a linear ring. For the case where a point is coincident with a linear ring edge, returns 1. Otherwise, returns boolean. ParametersReturns{Boolean | Number} The point is inside the linear ring. Returns 1 if the point is coincident with an edge. Returns boolean otherwise. OpenLayers. Geometry. MultiLineStringA MultiLineString is a geometry with multiple OpenLayers.Geometry.LineString components. Inherits fromSummary | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | Constructor for a MultiLineString Geometry. | | Use this geometry (the source) to attempt to split a target geometry. | | Split this geometry (the target) with the given geometry (the source). |
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include. A null value means the component types are not restricted. OpenLayers. Geometry. MultiLineStringConstructor for a MultiLineString Geometry. Parameterssplit| split: function( | geometry, | | options | ) |
|
Use this geometry (the source) to attempt to split a target geometry. Parameters| target | {OpenLayers.Geometry} The target geometry. | | options | {Object} Properties of this object will be used to determine how the split is conducted. |
Valid options| mutual | {Boolean} Split the source geometry in addition to the target geometry. Default is false. | | edge | {Boolean} Allow splitting when only edges intersect. Default is true. If false, a vertex on the source must be within the tolerance distance of the intersection to be considered a split. | | tolerance | {Number} If a non-null value is provided, intersections within the tolerance distance of an existing vertex on the source will be assumed to occur at the vertex. |
Returns{Array} A list of geometries (of this same type as the target) that result from splitting the target with the source geometry. The source and target geometry will remain unmodified. If no split results, null will be returned. If mutual is true and a split results, return will be an array of two arrays - the first will be all geometries that result from splitting the source geometry and the second will be all geometries that result from splitting the target geometry. splitWith| splitWith: function( | geometry, | | options | ) |
|
Split this geometry (the target) with the given geometry (the source). Parameters| geometry | {OpenLayers.Geometry} A geometry used to split this geometry (the source). | | options | {Object} Properties of this object will be used to determine how the split is conducted. |
Valid options| mutual | {Boolean} Split the source geometry in addition to the target geometry. Default is false. | | edge | {Boolean} Allow splitting when only edges intersect. Default is true. If false, a vertex on the source must be within the tolerance distance of the intersection to be considered a split. | | tolerance | {Number} If a non-null value is provided, intersections within the tolerance distance of an existing vertex on the source will be assumed to occur at the vertex. |
Returns{Array} A list of geometries (of this same type as the target) that result from splitting the target with the source geometry. The source and target geometry will remain unmodified. If no split results, null will be returned. If mutual is true and a split results, return will be an array of two arrays - the first will be all geometries that result from splitting the source geometry and the second will be all geometries that result from splitting the target geometry. OpenLayers. Handler.PathHandler to draw a path on the map. Path is displayed on mouse down, moves on mouse move, and is finished on mouse up. Inherits fromSummary | | | | | {Boolean} In freehand mode, the handler starts the path on mouse down, adds a point for every mouse move, and finishes the path on mouse up. | | {String} If set, freehandToggle is checked on mouse events and will set the freehand mode to the opposite of this.freehand. | | | | | | | | Destroy temporary geometries | | Destroy the temporary point. | | | | Determine whether to behave in freehand mode or not. | | Modify the existing geometry given the new point | | Render geometries on the temporary layer. | | Return the sketch feature. | | Return the sketch geometry. | | | | | | | | |
freehand{Boolean} In freehand mode, the handler starts the path on mouse down, adds a point for every mouse move, and finishes the path on mouse up. Outside of freehand mode, a point is added to the path on every mouse click and double-click finishes the path. freehandToggle{String} If set, freehandToggle is checked on mouse events and will set the freehand mode to the opposite of this.freehand. To disallow toggling between freehand and non-freehand mode, set freehandToggle to null. Acceptable toggle values are ‘shiftKey’, ‘ctrlKey’, and ‘altKey’. OpenLayers. Handler.PathCreate a new path hander Parameters| control | {OpenLayers.Control} The control that owns this handler | | callbacks | {Object} An object with a properties whose values are functions. Various callbacks described below. | | options | {Object} An optional object with properties to be set on the handler |
Named callbacks| create | Called when a sketch is first created. Callback called with the creation point geometry and sketch feature. | | modify | Called with each move of a vertex with the vertex (point) geometry and the sketch feature. | | point | Called as each point is added. Receives the new point geometry. | | done | Called when the point drawing is finished. The callback will recieve a single argument, the linestring geometry. | | cancel | Called when the handler is deactivated while drawing. The cancel callback will receive a geometry. |
createFeature| createFeature: function( | pixel | ) |
|
Add temporary geometries ParametersdestroyFeature| destroyFeature: function() |
Destroy temporary geometries removePointDestroy the temporary point. addPoint| addPoint: function( | pixel | ) |
|
Add point to geometry. Send the point index to override the behavior of LinearRing that disregards adding duplicate points. ParametersfreehandMode| freehandMode: function( | evt | ) |
|
Determine whether to behave in freehand mode or not. Returns{Boolean} modifyFeature| modifyFeature: function( | pixel | ) |
|
Modify the existing geometry given the new point ParametersdrawFeatureRender geometries on the temporary layer. mousedownHandle mouse down. Add a new point to the geometry and render it. Return determines whether to propagate the event on the map. Parameters| evt | {Event} The browser event |
Returns{Boolean} Allow event propagation mousemove| mousemove: function ( | evt | ) |
|
Handle mouse move. Adjust the geometry and redraw. Return determines whether to propagate the event on the map. Parameters| evt | {Event} The browser event |
Returns{Boolean} Allow event propagation mouseupHandle mouse up. Send the latest point in the geometry to the control. Return determines whether to propagate the event on the map. Parameters| evt | {Event} The browser event |
Returns{Boolean} Allow event propagation dblclickHandle double-clicks. Finish the geometry and send it back to the control. Parameters| evt | {Event} The browser event |
Returns{Boolean} Allow event propagation OpenLayers. Geometry. PolygonPolygon is a collection of Geometry.LinearRings. Inherits fromSummary | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | Constructor for a Polygon geometry. | | Test if a point is inside a polygon. |
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include. A null value means the component types are not restricted. OpenLayers. Geometry. PolygonConstructor for a Polygon geometry. The first ring (this.component[0])is the outer bounds of the polygon and all subsequent rings (this.component[1-n]) are internal holes. ParameterscontainsPoint| containsPoint: function( | point | ) |
|
Test if a point is inside a polygon. Points on a polygon edge are considered inside. ParametersReturns{Boolean | Number} The point is inside the polygon. Returns 1 if the point is on an edge. Returns boolean otherwise. OpenLayers. Geometry. MultiPolygonMultiPolygon is a geometry with multiple OpenLayers.Geometry.Polygon components. Create a new instance with the OpenLayers.Geometry.MultiPolygon constructor. Inherits fromSummary | | | {Array(String)} An array of class names representing the types of components that the collection can include. | | | | Create a new MultiPolygon geometry |
componentTypes{Array(String)} An array of class names representing the types of components that the collection can include. A null value means the component types are not restricted. OpenLayers. Geometry. MultiPolygonCreate a new MultiPolygon geometry ParametersOpenLayers. Handler. PolygonHandler to draw a polygon on the map. Polygon is displayed on mouse down, moves on mouse move, and is finished on mouse up. Inherits fromSummary | | | Create a Polygon Handler. | | | | Destroy temporary geometries | | Render geometries on the temporary layer. | | Return the sketch feature. | | Return the sketch geometry. | | |
OpenLayers. Handler. PolygonCreate a Polygon Handler. Parameters| control | {OpenLayers.Control} The control that owns this handler | | callbacks | {Object} An object with a properties whose values are functions. Various callbacks described below. | | options | {Object} An optional object with properties to be set on the handler |
Named callbacks| create | Called when a sketch is first created. Callback called with the creation point geometry and sketch feature. | | modify | Called with each move of a vertex with the vertex (point) geometry and the sketch feature. | | point | Called as each point is added. Receives the new point geometry. | | done | Called when the point drawing is finished. The callback will recieve a single argument, the polygon geometry. | | cancel | Called when the handler is deactivated while drawing. The cancel callback will receive a geometry. |
createFeature| createFeature: function( | pixel | ) |
|
Add temporary geometries ParametersdestroyFeature| destroyFeature: function() |
Destroy temporary geometries drawFeatureRender geometries on the temporary layer. dblclickHandle double-clicks. Finish the geometry and send it back to the control. ParametersOpenLayers. Format.GMLRead/Wite GML. Create a new instance with the OpenLayers.Format.GML constructor. Supports the GML simple features profile. Inherits fromSummary | | | Create a new parser for GML. | | This function is the core of the GML parsing code in OpenLayers. | | Properties of this object are the functions that parse geometries based on their type. | | Given a GML node representing a point geometry, create an OpenLayers point geometry. | | Given a GML node representing a multipoint geometry, create an OpenLayers multipoint geometry. | | Given a GML node representing a linestring geometry, create an OpenLayers linestring geometry. | | Given a GML node representing a multilinestring geometry, create an OpenLayers multilinestring geometry. | | Given a GML node representing a polygon geometry, create an OpenLayers polygon geometry. | | Given a GML node representing a multipolygon geometry, create an OpenLayers multipolygon geometry. | | | | Accept an OpenLayers.Feature.Vector, and build a GML node for it. | | Object containing methods to do the actual geometry node building based on geometry type. | | Given an OpenLayers point geometry, create a GML point. | | Given an OpenLayers multipoint geometry, create a GML multipoint. | | Given an OpenLayers linestring geometry, create a GML linestring. | | Given an OpenLayers multilinestring geometry, create a GML multilinestring. | | Given an OpenLayers linearring geometry, create a GML linearring. | | Given an OpenLayers polygon geometry, create a GML polygon. | | Given an OpenLayers multipolygon geometry, create a GML multipolygon. | | Given an OpenLayers bounds, create a GML box. | | builds the coordinates XmlNode |
OpenLayers. Format.GMLCreate a new parser for GML. Parameters| options | {Object} An optional object whose properties will be set on this instance. |
parseFeature| parseFeature: function( | node | ) |
|
This function is the core of the GML parsing code in OpenLayers. It creates the geometries that are then attached to the returned feature, and calls parseAttributes() to get attribute data out. Parameters| node | {DOMElement} A GML feature node. |
parseGeometryProperties of this object are the functions that parse geometries based on their type. parseGeometry. pointGiven a GML node representing a point geometry, create an OpenLayers point geometry. Parameters| node | {DOMElement} A GML node. |
Returns{OpenLayers.Geometry.Point} A point geometry. parseGeometry. multipointGiven a GML node representing a multipoint geometry, create an OpenLayers multipoint geometry. Parameters| node | {DOMElement} A GML node. |
Returns{OpenLayers.Geometry.MultiPoint} A multipoint geometry. parseGeometry. linestringGiven a GML node representing a linestring geometry, create an OpenLayers linestring geometry. Parameters| node | {DOMElement} A GML node. |
Returns{OpenLayers.Geometry.LineString} A linestring geometry. parseGeometry. multilinestringGiven a GML node representing a multilinestring geometry, create an OpenLayers multilinestring geometry. Parameters| node | {DOMElement} A GML node. |
Returns{OpenLayers.Geometry.MultiLineString} A multilinestring geometry. parseGeometry. polygonGiven a GML node representing a polygon geometry, create an OpenLayers polygon geometry. Parameters| node | {DOMElement} A GML node. |
Returns{OpenLayers.Geometry.Polygon} A polygon geometry. parseGeometry. multipolygonGiven a GML node representing a multipolygon geometry, create an OpenLayers multipolygon geometry. Parameters| node | {DOMElement} A GML node. |
Returns{OpenLayers.Geometry.MultiPolygon} A multipolygon geometry. parseAttributes| parseAttributes: function( | node | ) |
|
ParametersReturns{Object} An attributes object. createFeatureXML| createFeatureXML: function( | feature | ) |
|
Accept an OpenLayers.Feature.Vector, and build a GML node for it. ParametersReturns{DOMElement} A node reprensting the feature in GML. buildGeometryObject containing methods to do the actual geometry node building based on geometry type. buildGeometry. pointGiven an OpenLayers point geometry, create a GML point. ParametersReturns{DOMElement} A GML point node. buildGeometry. multipointGiven an OpenLayers multipoint geometry, create a GML multipoint. ParametersReturns{DOMElement} A GML multipoint node. buildGeometry. linestringGiven an OpenLayers linestring geometry, create a GML linestring. ParametersReturns{DOMElement} A GML linestring node. buildGeometry. multilinestringGiven an OpenLayers multilinestring geometry, create a GML multilinestring. ParametersReturns{DOMElement} A GML multilinestring node. buildGeometry. linearringGiven an OpenLayers linearring geometry, create a GML linearring. ParametersReturns{DOMElement} A GML linearring node. buildGeometry. polygonGiven an OpenLayers polygon geometry, create a GML polygon. ParametersReturns{DOMElement} A GML polygon node. buildGeometry. multipolygonGiven an OpenLayers multipolygon geometry, create a GML multipolygon. ParametersReturns{DOMElement} A GML multipolygon node. buildGeometry. boundsGiven an OpenLayers bounds, create a GML box. Parameters| bounds | {<OpenLayers.Geometry.Bounds>} A bounds object. |
Returns{DOMElement} A GML box node. buildCoordinates| buildCoordinatesNode: function( | geometry | ) |
|
builds the coordinates XmlNode <gml:coordinates decimal="." cs="," ts=" ">...</gml:coordinates>
Parameters: geometry - {OpenLayers.Geometry} Returns{XmlNode} created xmlNode OpenLayers. Format. GML.BaseSuperclass for GML parsers. Inherits fromSummary | | | {Object} Mapping of namespace aliases to namespace URIs. | | | | {String} Schema location for a particular minor version. | | {Object} Maps OpenLayers geometry class names to GML element names. | | {Boolean} True if there is only 1 featureType, and not an array of featuretypes. | | Compiled regular expressions for manipulating strings. | | Instances of this class are not created directly. | | | | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | | | | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. | | |
namespaces{Object} Mapping of namespace aliases to namespace URIs. schemaLocation{String} Schema location for a particular minor version. geometryTypes{Object} Maps OpenLayers geometry class names to GML element names. Use setGeometryTypes before accessing this property. singleFeatureType{Boolean} True if there is only 1 featureType, and not an array of featuretypes. regExesCompiled regular expressions for manipulating strings. OpenLayers. Format. GML.BaseInstances of this class are not created directly. Use the OpenLayers.Format.GML.v2 or OpenLayers.Format.GML.v3 constructor instead. Parameters| options | {Object} An optional object whose properties will be set on this instance. |
Valid options properties| featureType | {Array(String) or String} Local (without prefix) feature typeName(s) (required). | | featureNS | {String} Feature namespace (required). | | geometryName | {String} Geometry element name. |
readParameters| data | {DOMElement} A gml:featureMember element, a gml:featureMembers element, or an element containing either of the above at any level. |
Returns{Array(OpenLayers.Feature.Vector)} An array of features. readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. The function will be applied in the scope of this parser with two arguments: the node being read and a context object passed from the parent. write| write: function( | features | ) |
|
ParametersReturns{String} Given an array of features, a doc with a gml:featureMembers element will be returned. Given a single feature, a doc with a gml:featureMember element will be returned. writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. setGeometryTypes| setGeometryTypes: function() |
Sets the geometryTypes mapping. OpenLayers. Format. GML.v2Parses GML version 2. Inherits fromSummary | | | {String} Schema location for a particular minor version. | | Create a parser for GML v2. | | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | | | | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. |
schemaLocation{String} Schema location for a particular minor version. OpenLayers. Format. GML.v2Create a parser for GML v2. Parameters| options | {Object} An optional object whose properties will be set on this instance. |
Valid options properties| featureType | {String} Local (without prefix) feature typeName (required). | | featureNS | {String} Feature namespace (required). | | geometryName | {String} Geometry element name. |
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. The function will be applied in the scope of this parser with two arguments: the node being read and a context object passed from the parent. write| write: function( | features | ) |
|
ParametersReturns{String} Given an array of features, a doc with a gml:featureMembers element will be returned. Given a single feature, a doc with a gml:featureMember element will be returned. writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. OpenLayers. Format. GML.v3Parses GML version 3. Inherits fromSummary | | | {String} Schema location for a particular minor version. | | {Boolean} Write gml:Curve instead of gml:LineString elements. | | {Boolean} Write gml:MultiCurve instead of gml:MultiLineString. | | {Boolean} Write gml:Surface instead of gml:Polygon elements. | | {Boolean} Write gml:multiSurface instead of gml:MultiPolygon. | | Create a parser for GML v3. | | Contains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. | | | | As a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. | | Sets the <geometryTypes> mapping. | | | | | | | | Contains Array Prototypes like each, contains, and erase. | | Contains Function Prototypes like create, bind, pass, and delay. | | Contains Number Prototypes like limit, round, times, and ceil. | | Contains String Prototypes like camelCase, capitalize, test, and toInt. | | Contains Hash Prototypes. | | Contains the Event Native, to make the event object completely crossbrowser. | | Contains the Class Function for easily creating, extending, and implementing reusable Classes. | | Contains Utility Classes that can be implemented into your own Classes to ease the execution of many common tasks. | | One of the most important items in MooTools. | | Contains Element methods for dealing with events, and custom Events. | | Contains methods for interacting with the styles of Elements in a fashionable way. | | Contains methods to work with size, scroll, or positioning of Elements and the window object. | | Adds advanced CSS Querying capabilities for targeting elements. | | Contains the domready custom event. | | JSON encoder and decoder. | | Class for creating, loading, and saving browser Cookies. | | Wrapper for embedding SWF movies. | | Contains the basic animation logic to be extended by all other Fx Classes. | | Contains the CSS animation logic. | | Formerly Fx.Style, effect to transition any CSS property for an element. | | Formerly Fx.Styles, effect to transition any number of CSS properties for an element using an object of rules, or CSS based selector rules. | | Contains a set of advanced transitions to be used with any of the Fx Classes. | | Powerful all purpose Request Class. | | Extends the basic Request Class with additional methods for sending and receiving JSON data. | | A css-class based form validation system. | | Additional validators for the FormValidator class. | | Defines Fx.Reveal, a class that shows and hides elements with a transition. | | Effect to slide an element in and out of view. | | Class for creating a smooth scrolling effect to all internal links on the page. | | A Drag extension that provides support for the constraining of draggables to containers and droppables. | | Class for creating horizontal and vertical slider controls. | | Defines Request.JSONP, a class for cross domain javascript via script injection. | | Requests the same url at a time interval that increases when no data is returned from the requested server | | Class for monitoring collections of events | | Class for creating, reading, and deleting Cookies in JSON format. |
schemaLocation{String} Schema location for a particular minor version. The writers conform with the Simple Features Profile for GML. curve{Boolean} Write gml:Curve instead of gml:LineString elements. This also affects the elements in multi-part geometries. Default is false. To write gml:Curve elements instead of gml:LineString, set curve to true in the options to the contstructor (cannot be changed after instantiation). multiCurve{Boolean} Write gml:MultiCurve instead of gml:MultiLineString. Since the latter is deprecated in GML 3, the default is true. To write gml:MultiLineString instead of gml:MultiCurve, set multiCurve to false in the options to the constructor (cannot be changed after instantiation). surface{Boolean} Write gml:Surface instead of gml:Polygon elements. This also affects the elements in multi-part geometries. Default is false. To write gml:Surface elements instead of gml:Polygon, set surface to true in the options to the contstructor (cannot be changed after instantiation). multiSurface{Boolean} Write gml:multiSurface instead of gml:MultiPolygon. Since the latter is deprecated in GML 3, the default is true. To write gml:MultiPolygon instead of gml:multiSurface, set multiSurface to false in the options to the constructor (cannot be changed after instantiation). OpenLayers. Format. GML.v3Create a parser for GML v3. Parameters| options | {Object} An optional object whose properties will be set on this instance. |
Valid options properties| featureType | {String} Local (without prefix) feature typeName (required). | | featureNS | {String} Feature namespace (required). | | geometryName | {String} Geometry element name. |
readersContains public functions, grouped by namespace prefix, that will be applied when a namespaced node is found matching the function name. The function will be applied in the scope of this parser with two arguments: the node being read and a context object passed from the parent. write| write: function( | features | ) |
|
ParametersReturns{String} Given an array of features, a doc with a gml:featureMembers element will be returned. Given a single feature, a doc with a gml:featureMember element will be returned. writersAs a compliment to the readers property, this structure contains public writing functions grouped by namespace alias and named like the node names they produce. setGeometryTypes| setGeometryTypes: function() |
Sets the <geometryTypes> mapping. Browser.jsThe Browser Core. Contains Browser initialization, Window and Document, and the Browser Hash. LicenseMIT-style license. Array.jsContains Array Prototypes like each, contains, and erase. LicenseMIT-style license. Function.jsContains Function Prototypes like create, bind, pass, and delay. LicenseMIT-style license. Number.jsContains Number Prototypes like limit, round, times, and ceil. LicenseMIT-style license. String.jsContains String Prototypes like camelCase, capitalize, test, and toInt. LicenseMIT-style license. Hash.jsContains Hash Prototypes. Provides a means for overcoming the JavaScript practical impossibility of extending native Objects. LicenseMIT-style license. Event.jsContains the Event Native, to make the event object completely crossbrowser. LicenseMIT-style license. Class.jsContains the Class Function for easily creating, extending, and implementing reusable Classes. LicenseMIT-style license. Class. Extras.jsContains Utility Classes that can be implemented into your own Classes to ease the execution of many common tasks. LicenseMIT-style license. Element.jsOne of the most important items in MooTools. Contains the dollar function, the dollars function, and an handful of cross-browser, time-saver methods to let you easily work with HTML Elements. LicenseMIT-style license. Element. Event.jsContains Element methods for dealing with events, and custom Events. LicenseMIT-style license. Element. Style.jsContains methods for interacting with the styles of Elements in a fashionable way. LicenseMIT-style license. Element. Dimensions.jsContains methods to work with size, scroll, or positioning of Elements and the window object. LicenseMIT-style license. CreditsSelectors.jsAdds advanced CSS Querying capabilities for targeting elements. Also includes pseudoselectors support. LicenseMIT-style license. Domready.jsContains the domready custom event. LicenseMIT-style license. Cookie.jsClass for creating, loading, and saving browser Cookies. LicenseMIT-style license. CreditsBased on the functions by Peter-Paul Koch (http://quirksmode.org). Swiff.jsWrapper for embedding SWF movies. Supports (and fixes) External Interface Communication. LicenseMIT-style license. CreditsFlash detection & Internet Explorer + Flash Player 9 fix inspired by SWFObject. Fx.jsContains the basic animation logic to be extended by all other Fx Classes. LicenseMIT-style license. Fx. CSS.jsContains the CSS animation logic. Used by Fx.Tween, Fx.Morph, Fx.Elements. LicenseMIT-style license. Fx. Tween.jsFormerly Fx.Style, effect to transition any CSS property for an element. LicenseMIT-style license. Fx. Morph.jsFormerly Fx.Styles, effect to transition any number of CSS properties for an element using an object of rules, or CSS based selector rules. LicenseMIT-style license. Fx. Transitions.jsContains a set of advanced transitions to be used with any of the Fx Classes. LicenseMIT-style license. CreditsEasing Equations by Robert Penner, http://www.robertpenner.com/easing/, modified and optimized to be used with MooTools. Request.jsPowerful all purpose Request Class. Uses XMLHTTPRequest. LicenseMIT-style license. Request. JSON.jsExtends the basic Request Class with additional methods for sending and receiving JSON data. LicenseMIT-style license. FormValidator.jsA css-class based form validation system. LicenseMIT-style license. AuthorsAaron Newton FormValidator. Extras.jsAdditional validators for the FormValidator class. LicenseMIT-style license. AuthorsAaron Newton Fx. Reveal.jsDefines Fx.Reveal, a class that shows and hides elements with a transition. LicenseMIT-style license. AuthorsAaron Newton Fx. Slide.jsEffect to slide an element in and out of view. LicenseMIT-style license. AuthorsValerio Proietti Fx. SmoothScroll.jsClass for creating a smooth scrolling effect to all internal links on the page. LicenseMIT-style license. AuthorsValerio Proietti Drag. Move.jsA Drag extension that provides support for the constraining of draggables to containers and droppables. LicenseMIT-style license. AuthorsValerio Proietti Tom Occhinno Jan Kassens Slider.jsClass for creating horizontal and vertical slider controls. LicenseMIT-style license. AuthorsValerio Proietti Request. JSONP.jsDefines Request.JSONP, a class for cross domain javascript via script injection. LicenseMIT-style license. AuthorsAaron Newton Guillermo Rauch Request. Periodical.jsRequests the same url at a time interval that increases when no data is returned from the requested server LicenseMIT-style license. AuthorsChristoph Pojer Group.jsClass for monitoring collections of events LicenseMIT-style license. AuthorsValerio Proietti Hash. Cookie.jsClass for creating, reading, and deleting Cookies in JSON format. LicenseMIT-style license. AuthorsValerio Proietti Aaron Newton JxJx is a global singleton object that contains the entire Jx library within it. All Jx functions, attributes and classes are accessed through the global Jx object. Jx should not create any other global variables, if you discover that it does then please report it as a bug LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | This is the URL that Jx was loaded from, it is automatically calculated from the script tag src property that included Jx. | | | | Static method that applies the PNG Filter Hack for IE browsers when showing 24bit PNG’s. | | Request that an image be set to a DOM IMG element src attribute. | | An internal method that ensures no more than 2 images are loading at a time. | | An internal method actually populate the DOM element with the image source. | | Creates a new iframe element that is intended to fill a container to mask out other operating system controls (scrollbars, inputs, buttons, etc) when HTML elements are supposed to be above them. | | safely parse a number and return its integer value. | | return the dimensions of the browser client area. |
{String} baseURLThis is the URL that Jx was loaded from, it is automatically calculated from the script tag src property that included Jx. Note that this assumes that you are loading Jx from a js/ or lib/ folder in parallel to the images/ folder that contains the various images needed by Jx components. If you have a different folder structure, you can define Jx’s base by including the following before including the jxlib javascript file: Jx = {
baseURL: 'some/path'
}
applyPNGFilter| Jx.applyPNGFilter = function( | o | ) |
|
Static method that applies the PNG Filter Hack for IE browsers when showing 24bit PNG’s. Used automatically for img tags with a class of png24. The filter is applied using a nifty feature of IE that allows javascript to be executed as part of a CSS style rule - this ensures that the hack only gets applied on IE browsers. The CSS that triggers this hack is only in the ie6.css files of the various themes. Parametersobject {Object} the object (img) to which the filter needs to be applied. addToImgQueue| Jx.addToImgQueue = function( | obj | ) |
|
Request that an image be set to a DOM IMG element src attribute. This puts the image into a queue and there are private methods to manage that queue and limit image loading to 2 at a time. Parameters| obj | {Object} an object containing an element and src property, where element is the element to update and src is the url to the image. |
checkImgQueue| Jx.checkImgQueue = function() |
An internal method that ensures no more than 2 images are loading at a time. loadNextImg| Jx.loadNextImg = function() |
An internal method actually populate the DOM element with the image source. createIframeShim| Jx.createIframeShim = function() |
Creates a new iframe element that is intended to fill a container to mask out other operating system controls (scrollbars, inputs, buttons, etc) when HTML elements are supposed to be above them. Returnsan HTML iframe element that can be inserted into the DOM. getNumber| Jx.getNumber = function( | n, | | def | ) |
|
safely parse a number and return its integer value. A NaN value returns 0. CSS size values are also parsed correctly. Parameters| n | {Mixed} the string or object to parse. |
Returns{Integer} the integer value that the parameter represents getPageDimensions| Jx.getPageDimensions = function() |
return the dimensions of the browser client area. Returns{Object} an object containing a width and height property that represent the width and height of the browser client area. ElementElement is a global object provided by the mootools library. The functions documented here are extensions to the Element object provided by Jx to make cross-browser compatibility easier to achieve. Most of the methods are measurement related. While the code in these methods has been converted to use MooTools methods, there may be better MooTools methods to use to accomplish these things. Ultimately, it would be nice to eliminate most or all of these and find the MooTools equivalent or convince MooTools to add them. Summary | | | return the size of the content area of an element. | | return the size of the border area of an element. | | return the size of the margin area of an element. | | set either or both of the width and height of an element to the provided size. | | set either or both of the width and height of an element to the provided size. | | returns the padding for each edge of an element | | returns the border size for each edge of an element | | determines if the element is a descendent of the reference node. | | search the parentage of the element to find an element of the given tag name. |
getContentBoxSize| getContentBoxSize : function() |
return the size of the content area of an element. This is the size of the element less margins, padding, and borders. Parameters| elem | {Object} the element to get the content size of. |
Returns{Object} an object with two properties, width and height, that are the size of the content area of the measured element. getBorderBoxSize| getBorderBoxSize: function() |
return the size of the border area of an element. This is the size of the element less margins. Parameters| elem | {Object} the element to get the border sizing of. |
Returns{Object} an object with two properties, width and height, that are the size of the border area of the measured element. getMarginBoxSize| getMarginBoxSize: function() |
return the size of the margin area of an element. This is the size of the element plus margins. Parameters| elem | {Object} the element to get the margin sizing of. |
Returns{Object} an object with two properties, width and height, that are the size of the margin area of the measured element. setContentBoxSize| setContentBoxSize : function( | size | ) |
|
set either or both of the width and height of an element to the provided size. This function ensures that the content area of the element is the requested size and the resulting size of the element may be larger depending on padding and borders. Parameters| elem | {Object} the element to set the content area of. | | size | {Object} an object with a width and/or height property that is the size to set the content area of the element to. |
setBorderBoxSize| setBorderBoxSize : function( | size | ) |
|
set either or both of the width and height of an element to the provided size. This function ensures that the border size of the element is the requested size and the resulting content areaof the element may be larger depending on padding and borders. Parameters| elem | {Object} the element to set the border size of. | | size | {Object} an object with a width and/or height property that is the size to set the content area of the element to. |
getPaddingSize| getPaddingSize : function () |
returns the padding for each edge of an element Parameters| elem | {Object} The element to get the padding for. |
Returns{Object} an object with properties left, top, right and bottom that contain the associated padding values. getBorderSize| getBorderSize : function() |
returns the border size for each edge of an element Parameters| elem | {Object} The element to get the borders for. |
Returns{Object} an object with properties left, top, right and bottom that contain the associated border values. descendantOf| descendantOf: function( | node | ) |
|
determines if the element is a descendent of the reference node. Parameters| node | {HTMLElement} the reference node |
Returns{Boolean} true if the element is a descendent, false otherwise. findElement| findElement: function( | type | ) |
|
search the parentage of the element to find an element of the given tag name. Parameters| type | {String} the tag name of the element type to search for |
Returns{HTMLElement} the first node (this one or first parent) with the requested tag name or false if none are found. Jx. ContentLoaderContentLoader is a mix-in class that provides a consistent mechanism for other Jx controls to load content in one of four different ways: - using an existing element, by id
- using an existing element, by object reference
- using an HTML string
- using a URL to get the content remotely
Use the Implements syntax in your Class to add Jx.ContentLoader to your class. Option: content content may be an HTML element reference, the id of an HTML element already in the DOM, or an HTML string that becomes the inner HTML of the element. Option: contentURL the URL to load content from Summary | | | tracks the load state of the content, specifically useful in the case of remote content. | | | | triggers loading of content based on options set for the current object. | | Is fired after a delay to check the request to make sure it’s not failing in AIR. |
contentIsLoadedtracks the load state of the content, specifically useful in the case of remote content. loadContent| loadContent: function( | element | ) |
|
triggers loading of content based on options set for the current object. Parameters| element | {Object} the element to insert the content into |
EventsContentLoader adds the following events to an object. You can register for these events using the addEvent method or by providing callback functions via the on{EventName} properties in the options object | contentLoaded | called when the content has been loaded. If the content is not asynchronous then this is called before loadContent returns. | | contentLoadFailed | called if the content fails to load, primarily useful when using the contentURL method of loading content. |
checkRequest()Is fired after a delay to check the request to make sure it’s not failing in AIR. Jx. AutoPositionMix-in class that provides a method for positioning elements relative to other elements. Summary | | | positions an element relative to another element based on the provided options. |
position| position: function( | element, | | relative, | | options | ) |
|
positions an element relative to another element based on the provided options. Positioning rules are a string with two space-separated values. The first value references the parent element and the second value references the thing being positioned. In general, multiple rules can be considered by passing an array of rules to the horizontal and vertical options. The position method will attempt to position the element in relation to the relative element using the rules specified in the options. If the element does not fit in the viewport using the rule, then the next rule is attempted. If all rules fail, the last rule is used and element may extend outside the viewport. Horizontal and vertical rules are processed independently. Horizontal PositioningHorizontal values are ‘left’, ‘center’, ‘right’, and numeric values. Some common rules are: - ’left left’ is interpreted as aligning the left edge of the element to be positioned with the left edge of the reference element.
- ’right right’ aligns the two right edges.
- ’right left’ aligns the left edge of the element to the right of the reference element.
- ’left right’ aligns the right edge of the element to the left edge of the reference element.
Vertical PositioningVertical values are ‘top’, ‘center’, ‘bottom’, and numeric values. Some common rules are: - ’top top’ is interpreted as aligning the top edge of the element to be positioned with the top edge of the reference element.
- ’bottom bottom’ aligns the two bottom edges.
- ’bottom top’ aligns the top edge of the element to the bottom of the reference element.
- ’top bottom’ aligns the bottom edge of the element to the top edge of the reference element.
Parameters| element | the element to position | | relative | the element to position relative to | | options | the positioning options, see list below. |
Options| horizontal | the horizontal positioning rule to use to position the element. Valid values are ‘left’, ‘center’, ‘right’, and a numeric value. The default value is ‘center center’. | | vertical | the vertical positioning rule to use to position the element. Valid values are ‘top’, ‘center’, ‘bottom’, and a numeric value. The default value is ‘center center’. | | offsets | an object containing numeric pixel offset values for the object being positioned as top, right, bottom and left properties. |
Jx. ChromeA mix-in class that provides chrome helper functions. Chrome is the extraneous visual element that provides the look and feel to some elements i.e. dialogs. Chrome is added inside the element specified but may bleed outside the element to provide drop shadows etc. This is done by absolutely positioning the chrome objects in the container based on calculations using the margins, borders, and padding of the jxChrome class and the element it is added to. Chrome can consist of either pure CSS border and background colors, or a background-image on the jxChrome class. Using a background-image on the jxChrome class creates four images inside the chrome container that are positioned in the top-left, top-right, bottom-left and bottom-right corners of the chrome container and are sized to fill 50% of the width and height. The images are positioned and clipped such that the appropriate corners of the chrome image are displayed in those locations. Summary | | | the DOM element that contains the chrome | | | | create chrome on an element. | | show the chrome on an element. | | removes the chrome from the DOM. |
chromethe DOM element that contains the chrome makeChrome| makeChrome: function( | element | ) |
|
create chrome on an element. Parameters| element | {HTMLElement} the element to put the chrome on. |
showChrome| showChrome: function( | element | ) |
|
show the chrome on an element. This creates the chrome if necessary. If the chrome has been previously created and not removed, you can call this without an element and it will just resize the chrome within its existing element. You can also pass in a different element from which the chrome was previously attached to and it will move the chrome to the new element. Parameters| element | {HTMLElement} the element to show the chrome on. |
hideChromeremoves the chrome from the DOM. If you do this, you can’t call showChrome with no arguments. Jx. AddableA mix-in class that provides a helper function that allows an object to be added to an existing element on the page. Summary | | | adds the object to the DOM relative to another element. |
addTo| addTo: function( | reference, | | where | ) |
|
adds the object to the DOM relative to another element. If you use ‘top’ or ‘bottom’ then the element is added to the relative element (becomes a child node). If you use ‘before’ or ‘after’ then the element is inserted adjacent to the reference node. Parameters| reference | {Object} the DOM element or id of a DOM element to append the object relative to | | where | {String} where to append the element in relation to the reference node. Can be ‘top’, ‘bottom’, ‘before’ or ‘after’. The default is ‘bottom’. |
Returnsthe object itself, which is useful for chaining calls together Jx. ButtonExtends: Object Implements: Options, Events, Jx.Addable Jx.Button creates a clickable element that can be added to a web page. When the button is clicked, it fires a ‘click’ event. The CSS styling for a button is controlled by several classes related to the various objects in the button’s HTML structure: <div class="jxButtonContainer">
<a class="jxButton">
<span class="jxButtonContent">
<img class="jxButtonIcon" src="image_url">
<span class="jxButtonLabel">button label</span>
</span>
</a>
</div>
The CSS classes will change depending on the type option passed to the constructor of the button. The default type is Button. Passing another value such as Tab will cause all the CSS classes to change from jxButton to jxTab. For example: <div class="jxTabContainer">
<a class="jxTab">
<span class="jxTabContent">
<img class="jxTabIcon" src="image_url">
<span class="jxTabLabel">tab label</span>
</span>
</a>
</div>
When you construct a new instance of Jx.Button, the button does not automatically get inserted into the web page. Typically a button is used as part of building another capability such as a Jx.Toolbar. However, if you want to manually insert the button into your application, you may use the addTo method to append or insert the button into the page. There are two modes for a button, normal and toggle. A toggle button has an active state analogous to a checkbox. A toggle button generates different events (down and up) from a normal button (click). To create a toggle button, pass toggle: true to the Jx.Button constructor. To use a Jx.Button in an application, you should to register for the ‘click’ event. You can pass a function in the ‘onClick’ option when constructing a button or you can call the addEvent(‘click’, myFunction) method. The addEvent method can be called several times, allowing more than one function to be called when a button is clicked. You can use the removeEvent(‘click’, myFunction) method to stop receiving click events. Examplevar button = new Jx.Button(options);
button.addTo('myListItem'); // the id of an LI in the page.
Example:
var options = {
imgPath: 'images/mybutton.png',
tooltip: 'click me!',
label: 'click me',
onClick: function() {
alert('you clicked me');
}
};
var button = new Jx.Button(options);
button.addEvent('click', anotherFunction);
function anotherFunction() {
alert('a second alert for a single click');
}
Events| click | the button was pressed and released (only if type is not ‘toggle’). | | down | the button is down (only if type is ‘toggle’) | | up | the button is up (only if the type is ‘toggle’). |
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | | | triggered when the user clicks the button, processes the actionPerformed event | | This returns true if the button is enabled, false otherwise | | enable or disable the button. | | For toggle buttons, this returns true if the toggle button is currently active and false otherwise. | | Set the active state of the button | | set the image of this button to a new image URL | | sets the text of the button. | | returns the text of the button. | | sets the tooltip displayed by the button | | capture the keyboard focus on this button | | remove the keyboard focus from this button |
Jx. Buttoncreate a new button. Parameters| options | {Object} an object containing optional properties for this button as below. |
clickedtriggered when the user clicks the button, processes the actionPerformed event Parameters| evt | {Event} the user click event |
isEnabledThis returns true if the button is enabled, false otherwise Returns{Boolean} whether the button is enabled or not setEnabled| setEnabled: function( | enabled | ) |
|
enable or disable the button. Parameters| enabled | {Boolean} the new enabled state of the button |
isActiveFor toggle buttons, this returns true if the toggle button is currently active and false otherwise. Returns{Boolean} the active state of a toggle button setActive| setActive: function( | active | ) |
|
Set the active state of the button Parameters| active | {Boolean} the new active state of the button |
setImageset the image of this button to a new image URL Parameters| path | {String} the new url to use as the image for this button |
setLabel| setLabel: function( | label | ) |
|
sets the text of the button. Only works if a label was supplied when the button was constructed Parameters| label | {String} the new label for the button |
getLabelreturns the text of the button. setTooltip| setTooltip: function( | tooltip | ) |
|
sets the tooltip displayed by the button Parameters| tooltip | {String} the new tooltip |
focuscapture the keyboard focus on this button blurremove the keyboard focus from this button Jx. Button. FlyoutExtends: Jx.Button Implements: Jx.ContentLoader, Jx.AutoPosition, Jx.Chrome Flyout buttons expose a panel when the user clicks the button. The panel can have arbitrary content. You must provide any necessary code to hook up elements in the panel to your application. When the panel is opened, the ‘open’ event is fired. When the panel is closed, the ‘close’ event is fired. You can register functions to handle these events in the options passed to the constructor (onOpen, onClose). The user can close the flyout panel by clicking the button again, by clicking anywhere outside the panel and other buttons, or by pressing the ‘esc’ key. Flyout buttons implement Jx.ContentLoader which provides the hooks to insert content into the Flyout element. Note that the Flyout element is not appended to the DOM until the first time it is opened, and it is removed from the DOM when closed. It is generally best to specify a width and height for your flyout content area through CSS to ensure that it works correctly across all browsers. You can do this for all flyouts using the .jxFlyout CSS selector, or you can apply specific styles to your content elements. A flyout closes other flyouts when it is opened. It is possible to embed flyout buttons inside the content area of another flyout button. In this case, opening the inner flyout will not close the outer flyout but it will close any other flyouts that are siblings. Examplevar flyout = new Jx.Button.Flyout({
label: 'flyout',
content: 'flyoutContent',
onOpen: function(flyout) {
console.log('flyout opened');
},
onClose: function(flyout) {
console.log('flyout closed');
}
});
Events| open | this event is triggered when the flyout is opened. | | close | this event is triggered when the flyout is closed. |
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | the HTML element that contains the flyout content | | | | construct a new instance of a flyout button. | | | | Closes the flyout if open |
contentthe HTML element that contains the flyout content initialize| initialize: function( | options | ) |
|
construct a new instance of a flyout button. The single options argument takes a combination of options that apply to Jx.Button, Jx.ContentLoader, and Jx.AutoPosition. Parameters| options | an options object used to initialize the button, see <Jx.Button.Options>, <Jx.ContentLoader.Options>, and <Jx.AutoPosition.Options> for details. |
hideCloses the flyout if open Jx. LayoutExtends: Object Implements: Options, Events Jx.Layout is used to provide more flexible layout options for applications Jx.Layout wraps an existing DOM element (typically a div) and provides extra functionality for sizing that element within its parent and sizing elements contained within it that have a ‘resize’ function attached to them. To create a Jx.Layout, pass the element or id plus an options object to the constructor. Examplevar myContainer = new Jx.Layout('myDiv', options);
Events| sizeChange | fired when the size of the container changes |
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | Create a new instance of Jx.Layout. | | when the window is resized, any Jx.Layout controlled elements that are direct children of the BODY element are resized | | resize the element controlled by this Jx.Layout object. |
Jx. LayoutCreate a new instance of Jx.Layout. Parameters| domObj | {HTMLElement} element or id to apply the layout to | | options | <Jx.Layout.Options> |
windowResizewhen the window is resized, any Jx.Layout controlled elements that are direct children of the BODY element are resized resize| resize: function( | options | ) |
|
resize the element controlled by this Jx.Layout object. Parameters| options | new options to apply, see <Jx.Layout.Options> |
Jx. Button.TabExtends: Jx.Button Implements: Jx.ContentLoader A single tab in a tab set. A tab has a label (displayed in the tab) and a content area that is displayed when the tab is active. A tab has to be added to both a Jx.TabSet (for the content) and Jx.Toolbar (for the actual tab itself) in order to be useful. Alternately, you can use a Jx.TabBox which combines both into a single control at the cost of some flexibility in layout options. A tab is a Jx.ContentLoader and you can specify the initial content of the tab using any of the methods supported by Jx.ContentLoader::loadContent. You can acccess the actual DOM element that contains the content (if you want to dynamically insert content for instance) via the <Jx.Tab::content> property. A tab is a button of type toggle which means that it emits the up and down events. Examplevar tab1 = new Jx.Button.Tab({
label: 'tab 1',
content: 'content1',
onDown: function(tab) {
console.log('tab became active');
},
onUp: function(tab) {
console.log('tab became inactive');
}
});
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {HTMLElement} The content area that is displayed when the tab is active. | | | | Create a new instance of Jx.Button.Tab. | | triggered when the user clicks the button, processes the actionPerformed event |
content{HTMLElement} The content area that is displayed when the tab is active. Jx. Button.TabCreate a new instance of Jx.Button.Tab. Any layout options passed are used to create a Jx.Layout for the tab content area. Parametersclickedtriggered when the user clicks the button, processes the actionPerformed event Jx. ColorPaletteExtends: Object Implements: Options, Events, Jx.Addable A Jx.ColorPalette presents a user interface for selecting colors. Currently, the user can either enter a HEX colour value or select from a palette of web-safe colours. The user can also enter an opacity value. A Jx.ColorPalette can be embedded anywhere in a web page using its addTo method. However, a Jx.Button subclass is provided (Jx.Button.Color) that embeds a colour panel inside a button for easy use in toolbars. Colour changes are propogated via a change event. To be notified of changes in a Jx.ColorPalette, use the addEvent method. Example
Events| change | triggered when the color changes. | | click | the user clicked on a color swatch (emitted after a change event) |
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | the HTML element representing the color panel | | | | initialize a new instance of Jx.ColorPalette | | handle the mouse moving over a colour swatch by updating the preview | | handle mouse click on a swatch by updating the color and hiding the panel. | | handle the user entering a new colour value manually by updating the selected colour if the entered value is valid HEX. | | handle the user entering a new alpha value manually by updating the selected alpha if the entered value is valid alpha (0-100). | | set the colour represented by this colour panel | | set the alpha represented by this colour panel | | update the colour panel user interface based on the current colour and alpha values |
{HTMLElement} domObjthe HTML element representing the color panel Jx. ColorPaletteinitialize a new instance of Jx.ColorPalette Parameters| options | <Jx.ColorPalette.Options> |
swatchOverhandle the mouse moving over a colour swatch by updating the preview Parameters| e | {Event} the mousemove event object |
swatchClickhandle mouse click on a swatch by updating the color and hiding the panel. Parameters| e | {Event} the mouseclick event object |
changedhandle the user entering a new colour value manually by updating the selected colour if the entered value is valid HEX. alphaChangedhandle the user entering a new alpha value manually by updating the selected alpha if the entered value is valid alpha (0-100). setColor| setColor: function( | color | ) |
|
set the colour represented by this colour panel Parameters| color | {String} the new hex color value |
setAlpha| setAlpha: function( | alpha | ) |
|
set the alpha represented by this colour panel Parameters| alpha | {Integer} the new alpha value (between 0 and 100) |
updateSelected| updateSelected: function() |
update the colour panel user interface based on the current colour and alpha values Jx. Button. ColorExtends: Jx.Button.Flyout A Jx.ColorPalette wrapped up in a Jx.Button. The button includes a preview of the currently selected color. Clicking the button opens the color panel. A color button is essentially a Jx.Button.Flyout where the content of the flyout is a Jx.ColorPalette. For performance, all color buttons share an instance of Jx.ColorPalette which means only one button can be open at a time. This isn’t a huge restriction as flyouts already close each other when opened. Examplevar colorButton = new Jx.Button.Color({
onChange: function(button) {
console.log('color:' + button.options.color + ' alpha: ' +
button.options.alpha);
}
});
Events| change | fired when the color is changed. |
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | initialize a new color button. | | | | | | set the color represented by this color panel | | set the alpha represented by this color panel | | handle the color changing in the palette by updating the preview swatch in the button and firing the change event. | | Update the swatch color for the current color |
Jx. Button. Colorinitialize a new color button. Parameters| options | <Jx.Button.Color.Options> initialize instance options. |
setColor| setColor: function( | color | ) |
|
set the color represented by this color panel Parameters| color | {String} the new hex color value |
setAlpha| setAlpha: function( | alpha | ) |
|
set the alpha represented by this color panel Parameters| alpha | {Integer} the new alpha value (between 0 and 100) |
changedhandle the color changing in the palette by updating the preview swatch in the button and firing the change event. ParametersupdateSwatchUpdate the swatch color for the current color Jx.MenuExtends: Object Implements: Options, Events, Jx.AutoPosition, Jx.Chrome, Jx.Addable A main menu as opposed to a sub menu that lives inside the menu. TODO: Jx.Menu revisit this to see if Jx.Menu and Jx.SubMenu can be merged into a single implementation. Example
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {HTMLElement} The HTML element containing the menu. | | { Jx.Button} The button that represents this menu in a toolbar and opens the menu. | | {HTMLElement} the HTML element that contains the menu items within the menu. | | {Array} the items in this menu | | | | Create a new instance of Jx.Menu. | | Add menu items to the sub menu. | | Deactivate the menu by hiding it. | | Handle the user moving the mouse over the button for this menu by showing this menu and hiding the other menu. | | determine if an event happened inside this menu or a sub menu of this menu. | | | | | | Set the sub menu that is currently open |
domObj{HTMLElement} The HTML element containing the menu. button{Jx.Button} The button that represents this menu in a toolbar and opens the menu. subDomObj{HTMLElement} the HTML element that contains the menu items within the menu. items{Array} the items in this menu Jx.MenuCreate a new instance of Jx.Menu. Parameters| options | see <Jx.Button.Options>. If no options are provided then no button is created. |
addAdd menu items to the sub menu. Parameters| item | {<Jx.MenuItem>} the menu item to add. Multiple menu items can be added by passing multiple arguments to this function. |
deactivateDeactivate the menu by hiding it. onMouseOverHandle the user moving the mouse over the button for this menu by showing this menu and hiding the other menu. ParameterseventInMenudetermine if an event happened inside this menu or a sub menu of this menu. ParametersReturns{Boolean} true if the event happened in the menu or a sub menu of this menu, false otherwise setVisibleItem| setVisibleItem: function( | obj | ) |
|
Set the sub menu that is currently open Parametersobj- {<Jx.SubMenu>} the sub menu that just became visible Jx. ButtonSetExtends: Object Implements: Options, Events A ButtonSet manages a set of Jx.Button instances by ensuring that only one of the buttons is active. All the buttons need to have been created with the toggle option set to true for this to work. Examplevar toolbar = new Jx.Toolbar('bar');
var buttonSet = new Jx.ButtonSet();
var tab1 = new Jx.Button({label: 'b1', toggle:true, contentID: 'content1'});
var tab2 = new Jx.Button({label: 'b2', toggle:true, contentID: 'content2'});
var tab3 = new Jx.Button({label: 'b3', toggle:true, contentID: 'content3'});
var tab4 = new Jx.Button({label: 'b4', toggle:true, contentURL: 'test_content.html'});
buttonSet.add(b1,b2,b3,b4);
Events| change | the current button has changed |
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {Array} array of buttons that are managed by this button set | | | | | | | | Remove a button from this Button. | | Set the active button to the one passed to this method | | Handle selection changing on the buttons themselves and activate the appropriate button in response. |
buttons{Array} array of buttons that are managed by this button set Jx. ButtonSetCreate a new instance of Jx.ButtonSet Parameters| options | an options object, only event handlers are supported as options at this time. |
addAdd one or more Jx.Buttons to the ButtonSet. Parameters| button | {Jx.Button} an instance of Jx.Button to add to the button set. More than one button can be added by passing extra parameters to this method. |
remove| remove : function( | button | ) |
|
Remove a button from this Button. ParameterssetActiveButton| setActiveButton: function( | button | ) |
|
Set the active button to the one passed to this method ParametersselectionChangedHandle selection changing on the buttons themselves and activate the appropriate button in response. ParametersJx. Button. MultiExtends: Jx.Button ImplementsMulti buttons are used to contain multiple buttons in a drop down list where only one button is actually visible and clickable in the interface. When the user clicks the active button, it performs its normal action. The user may also click a drop-down arrow to the right of the button and access the full list of buttons. Clicking a button in the list causes that button to replace the active button in the toolbar and performs the button’s regular action. Other buttons can be added to the Multi button using the add method. This is not really a button, but rather a container for buttons. The button structure is a div containing two buttons, a normal button and a flyout button. The flyout contains a toolbar into which all the added buttons are placed. The main button content is cloned from the last button clicked (or first button added). The Multi button does not trigger any events itself, only the contained buttons trigger events. Examplevar b1 = new Jx.Button({
label: 'b1',
onClick: function(button) {
console.log('b1 clicked');
}
});
var b2 = new Jx.Button({
label: 'b2',
onClick: function(button) {
console.log('b2 clicked');
}
});
var b3 = new Jx.Button({
label: 'b3',
onClick: function(button) {
console.log('b3 clicked');
}
});
var multiButton = new Jx.Button.Multi();
multiButton.add(b1, b2, b3);
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | the currently selected button | | {Array} the buttons added to this multi button | | | | construct a new instance of Jx.Button.Multi. | | adds one or more buttons to the Multi button. | | remove a button from a multi button | | update the menu item to be the requested button. | | update the active button in the menu item, trigger the button’s action and hide the flyout that contains the buttons. |
{<Jx. Button>} activeButtonthe currently selected button buttons{Array} the buttons added to this multi button Jx. Button. Multiconstruct a new instance of Jx.Button.Multi. addadds one or more buttons to the Multi button. The first button added becomes the active button initialize. This function takes a variable number of arguments, each of which is expected to be an instance of Jx.Button. Parametersremoveremove a button from a multi button ParameterssetActiveButton| setActiveButton: function( | button | ) |
|
update the menu item to be the requested button. ParameterssetButton| setButton: function( | button | ) |
|
update the active button in the menu item, trigger the button’s action and hide the flyout that contains the buttons. Parameters| button | {Jx.Button} The button to set as the active button |
Jx. Menu.ItemExtends: Jx.Button A menu item is a single entry in a menu. It is typically composed of a label and an optional icon. Selecting the menu item emits an event. Jx.Menu.Item is represented by a Jx.Button with type MenuItem and the associated CSS changes noted in Jx.Button. The container of a MenuItem is an ‘li’ element. Example
Events| click | fired when the menu item is clicked. |
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {<Jx.SubMenu> or Jx.Menu} the menu that contains the menu item. | | | | Create a new instance of Jx.Menu.Item | | Set the owner of this menu item | | | | | | Handle the user clicking on the menu item, overriding the Jx.Button::clicked method to facilitate menu tracking | | handle the mouse moving over the menu item |
owner{<Jx.SubMenu> or Jx.Menu} the menu that contains the menu item. Jx. Menu.ItemCreate a new instance of Jx.Menu.Item Parameters| options | See <Jx.Button.Options> |
setOwnerSet the owner of this menu item Parameters| obj | {Object} the new owner |
clickedHandle the user clicking on the menu item, overriding the Jx.Button::clicked method to facilitate menu tracking Parameters| obj | {Object} an object containing an event property that was the user event. |
onmouseoverhandle the mouse moving over the menu item Parameters| e | {Event} the mousemove event |
Jx. Button. ComboExtends: Jx.Button.Multi A drop down list of selectable items. Items can be either a string, an image or both. Examplenew Jx.Button.Combo({
label: 'Choose a symbol',
items: [
{label: 'Star', image: 'images/swatches.png', imageClass: 'comboStar'},
{label: 'Square', image: 'images/swatches.png', imageClass: 'comboSquare'},
{label: 'Triangle', image: 'images/swatches.png', imageClass: 'comboTriangle'},
{label: 'Circle', image: 'images/swatches.png', imageClass: 'comboCircle'},
{label: 'Plus', image: 'images/swatches.png', imageClass: 'comboPlus'},
{label: 'Cross', image: 'images/swatches.png', imageClass: 'comboCross'}
],
onChange: function(combo) { alert('you selected ' + combo.getValue()) }
})
Events| change | triggered when the user selects a new item from the list |
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {Object} current selection in the list | | | | create a new instance of Jx.Combo | | enable or disable the combo button. | | invoked when the current value is changed | | Handle the user pressing a key by looking for an ENTER key to set the value. | | add a new item to the pick list | | Remove the item at the given index. | | set the value of the Combo | | |
currentSelection{Object} current selection in the list Jx. Combocreate a new instance of Jx.Combo Parameters| options | <Jx.button.Combo.Options> |
setEnabled| setEnabled: function( | enabled | ) |
|
enable or disable the combo button. Parameters| enabled | {Boolean} the new enabled state of the button |
valueChangedinvoked when the current value is changed onKeyPressHandle the user pressing a key by looking for an ENTER key to set the value. Parameters| e | {Event} the keypress event |
addadd a new item to the pick list Parameters| options | {Object} object with properties suitable to be passed to a <Jx.Menu.Item.Options> object. More than one options object can be passed, comma separated or in an array. |
removeRemove the item at the given index. Not implemented. Parameters| idx | {Integer} the item to remove. |
setValue| setValue: function( | value | ) |
|
set the value of the Combo Parameters| value | {Object} the new value. May be a string, a text node, or another DOM element. |
getValueReturn the current value Returns{Object} returns the currently selected item Jx. PanelExtends: Object Implements: Options, Events, Jx.ContentLoader A panel is a fundamental container object that has a content area and optional toolbars around the content area. It also has a title bar area that contains an optional label and some user controls as determined by the options passed to the constructor. Example
Events| close | fired when the panel is closed | | collapse | fired when the panel is collapsed | | expand | fired when the panel is opened |
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | Initialize a new Jx.Panel instance | | the sizeChange event of the Jx.Layout that manages the outer container is intercepted and passed through this method to handle resizing of the panel contents because we need to do some calculations if the panel is collapsed and if there are toolbars to put around the content area. | | Set the label in the title bar of this panel | | Get the label of the title bar of this panel | | | | | | set the content of this panel to some HTML | | Set the content of this panel to come from some URL. | | When the content of the panel is loaded from a remote URL, this method is called when the ajax request returns. | | Set the panel as busy or not busy, which displays a loading image in the title bar. | | sets or toggles the collapsed state of the panel. | | Closes the panel (completely hiding it). |
Jx. PanelInitialize a new Jx.Panel instance Options: <Jx.Panel.Options>, <Jx.ContentLoader.Options> layoutContent| layoutContent: function() |
the sizeChange event of the Jx.Layout that manages the outer container is intercepted and passed through this method to handle resizing of the panel contents because we need to do some calculations if the panel is collapsed and if there are toolbars to put around the content area. setLabelSet the label in the title bar of this panel ParametersgetLabelGet the label of the title bar of this panel Returns{String} the label setContent| setContent : function ( | html | ) |
|
set the content of this panel to some HTML Parameters| html | {String} the new HTML to go in the panel |
setContentURL| setContentURL : function ( | url | ) |
|
Set the content of this panel to come from some URL. Parameters| url | {String} URL to some HTML content for this panel |
panelContentLoaded| panelContentLoaded: function( | html | ) |
|
When the content of the panel is loaded from a remote URL, this method is called when the ajax request returns. Parameters| html | {String} the html return from xhr.onSuccess |
setBusy| setBusy : function( | isBusy | ) |
|
Set the panel as busy or not busy, which displays a loading image in the title bar. Parameters| isBusy | {Boolean} the busy state |
toggleCollapse| toggleCollapse: function( | state | ) |
|
sets or toggles the collapsed state of the panel. If a new state is passed, it is used, otherwise the current state is toggled. Parameters| state | optional, if passed then the state is used, otherwise the state is toggled. |
closeCloses the panel (completely hiding it). Jx. DialogExtends: Jx.Panel Implements: Jx.AutoPosition, Jx.Chrome A Jx.Dialog implements a floating dialog. Dialogs represent a useful way to present users with certain information or application controls. Jx.Dialog is designed to provide the same types of features as traditional operating system dialog boxes, including: - dialogs may be modal (user must dismiss the dialog to continue) or non-modal
- dialogs are movable (user can drag the title bar to move the dialog around)
- dialogs may be a fixed size or allow user resizing.
Jx.Dialog uses Jx.ContentLoader to load content into the content area of the dialog. Refer to the Jx.ContentLoader documentation for details on content options. Examplevar dialog = new Jx.Dialog();
Events| open | triggered when the dialog is opened | | close | triggered when the dialog is closed | | change | triggered when the value of an input in the dialog is changed | | resize | triggered when the dialog is resized |
ExtendsJx.Dialog extends Jx.Panel, please go there for more details. LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | modal dialogs prevent interaction with the rest of the application while they are open, this element is displayed just under the dialog to prevent the user from clicking anything. | | | | Construct a new instance of Jx.Dialog | | | | overload panel’s sizeChanged method | | sets or toggles the collapsed state of the panel. | | show the dialog, external code should use the Jx.Dialog::open method to make the dialog visible. | | hide the dialog, external code should use the Jx.Dialog::close method to hide the dialog. | | open the dialog and load content from the provided url. | | | | close the dialog and trigger the onClose callback function if necessary |
{HTMLElement} blanketmodal dialogs prevent interaction with the rest of the application while they are open, this element is displayed just under the dialog to prevent the user from clicking anything. Jx. DialogConstruct a new instance of Jx.Dialog Parameters| options | {Object} an object containing options for the dialog. |
Options: <Jx.Dialog.Options>, <Jx.Panel.Options>, <Jx.ContentLoader.Options> resize| resize: function( | width, | | height, | | autoPosition | ) |
|
resize the dialog. This can be called when the dialog is closed or open. Parameters| width | the new width | | height | the new height | | autoPosition | boolean, false by default, if resizing an open dialog setting this to true will reposition it according to its position rules. |
sizeChangedoverload panel’s sizeChanged method toggleCollapse| toggleCollapse: function( | state | ) |
|
sets or toggles the collapsed state of the panel. If a new state is passed, it is used, otherwise the current state is toggled. Parameters| state | optional, if passed then the state is used, otherwise the state is toggled. |
showshow the dialog, external code should use the Jx.Dialog::open method to make the dialog visible. hidehide the dialog, external code should use the Jx.Dialog::close method to hide the dialog. openURLopen the dialog and load content from the provided url. If you don’t provide a URL then the dialog opens normally. Parameters| url | <String> the url to load when opening. |
openopen the dialog. This may be delayed depending on the asynchronous loading of dialog content. The onOpen callback function is called when the dialog actually opens closeclose the dialog and trigger the onClose callback function if necessary Jx. SplitterExtends: Object Implements: Options a Jx.Splitter creates two or more containers within a parent container and provides user control over the size of the containers. The split can be made horizontally or vertically. A horizontal split creates containers that divide the space horizontally with vertical bars between the containers. A vertical split divides the space vertically and creates horizontal bars between the containers. Example
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {HTMLElement} the element being split | | {Array} an array of elements that are displayed in each of the split areas | | {Array} an array of the bars between each of the elements used to resize the split areas. | | {Boolean} track the first resize event so that unexposed Jx things can be forced to calculate their size the first time they are exposed. | | | | Create a new instance of Jx.Splitter | | Prepare a new, empty element to go into a split area. | | Prepare a new, empty bar to go into between split areas. | | Setup the initial set of constraints that set the behaviour of the bars between the elements in the split area. | | In a horizontally split container, handle a bar being dragged left or right by resizing the elements on either side of the bar. | | In a vertically split container, handle a bar being dragged up or down by resizing the elements on either side of the bar. | | handle the size of the container being changed. | | Resize a horizontally layed-out container | | Resize a vertically layed out container. |
domObj{HTMLElement} the element being split elements{Array} an array of elements that are displayed in each of the split areas bars{Array} an array of the bars between each of the elements used to resize the split areas. firstUpdate{Boolean} track the first resize event so that unexposed Jx things can be forced to calculate their size the first time they are exposed. Jx. SplitterCreate a new instance of Jx.Splitter Parameters| domObj | {HTMLElement} the element or id of the element to split | | options | <Jx.Splitter.Options> |
prepareElement| prepareElement: function() |
Prepare a new, empty element to go into a split area. Returns{HTMLElement} an HTMLElement that goes into a split area. prepareBarPrepare a new, empty bar to go into between split areas. Returns{HTMLElement} an HTMLElement that becomes a bar. establishConstraints| establishConstraints: function() |
Setup the initial set of constraints that set the behaviour of the bars between the elements in the split area. dragHorizontal| dragHorizontal: function( | obj | ) |
|
In a horizontally split container, handle a bar being dragged left or right by resizing the elements on either side of the bar. Parameters| obj | {HTMLElement} the bar that was dragged |
dragVertical| dragVertical: function( | obj | ) |
|
In a vertically split container, handle a bar being dragged up or down by resizing the elements on either side of the bar. Parameters| obj | {HTMLElement} the bar that was dragged |
sizeChangedhandle the size of the container being changed. horizontalResize| horizontalResize: function() |
Resize a horizontally layed-out container verticalResize| verticalResize: function() |
Resize a vertically layed out container. Jx. PanelSetExtends: Object Implements: Options, Events, Jx.Addable A panel set manages a set of panels within a DOM element. The PanelSet fills its container by resizing the panels in the set to fill the width and then distributing the height of the container across all the panels. Panels can be resized by dragging their respective title bars to make them taller or shorter. The maximize button on the panel title will cause all other panels to be closed and the target panel to be expanded to fill the remaining space. In this respect, PanelSet works like a traditional Accordion control. When creating panels for use within a panel set, it is important to use the proper options. You must override the collapse option and set it to false and add a maximize option set to true. You must also not include options for menu and close. Examplevar p1 = new Jx.Panel({collapse: false, maximize: true, content: 'content1'});
var p2 = new Jx.Panel({collapse: false, maximize: true, content: 'content2'});
var p3 = new Jx.Panel({collapse: false, maximize: true, content: 'content3'});
var panelSet = new Jx.PanelSet('panels', [p1,p2,p3]);
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {Array} the panels being managed by the set | | {Integer} the height of the container, cached for speed | | {Boolean} true until the panel set has first been resized | | | | Create a new instance of Jx.PanelSet. | | Maximize a panel, taking up all available space (taking into consideration any minimum or maximum values) |
panels{Array} the panels being managed by the set height{Integer} the height of the container, cached for speed firstLayout{Boolean} true until the panel set has first been resized Jx. PanelSetCreate a new instance of Jx.PanelSet. Parameters| options | <Jx.PanelSet.Options> |
TODO: Jx.PanelSet.initialize Remove the panels parameter in favour of an add method. maximizePanel| maximizePanel: function( | panel | ) |
|
Maximize a panel, taking up all available space (taking into consideration any minimum or maximum values) Jx.GridExtends: Object Implements: Options, Events, Jx.Addable A tabular control that has fixed scrolling headers on the rows and columns like a spreadsheet. Jx.Grid is a tabular control with convenient controls for resizing columns, sorting, and inline editing. It is created inside another element, typically a div. If the div is resizable (for instance it fills the page or there is a user control allowing it to be resized), you must call the resize() method of the grid to let it know that its container has been resized. When creating a new Jx.Grid, you can specify a number of options for the grid that control its appearance and functionality. Jx.Grid renders data that comes from an external source. This external source, called the model, must implement the following interface. Example
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | construct a new instance of Jx.Grid within the domObj | | handle the grid scrolling by updating the position of the headers | | resize the grid to fit inside its container. | | set the model for the grid to display. | | destroy the contents of the grid safely | | create the grid for the current model | | | | called through the grid listener interface when data has changed in the underlying model | | apply the jxGridRowHeaderPrelight style to the header cell of a row. | | apply the jxGridColumnHeaderPrelight style to the header cell of a column. | | apply the jxGridRowPrelight style to row. | | apply the jxGridColumnPrelight style to a column. | | apply the jxGridCellPrelight style to a cell. | | Select a cell and apply the jxGridCellSelected style to it. | | Apply the jxGridRowHeaderSelected style to the row header cell of a selected row. | | Select a row and apply the jxGridRowSelected style to it. | | Apply the jxGridColumnHeaderSelected style to the column header cell of a selected column. | | | | handle the mouse moving over the main grid. | | handle the mouse moving over the row header cells. | | handle the mouse moving over the column header cells. | | handle the user clicking on the grid. | | handle the user clicking on the row header. | | handle the user clicking on the column header. | | retrieve the row and column indexes from an event click. | | | | This function returns the number of columns of data in the model as an integer value. | | This function returns an HTML string to be placed in the column header for the given column index. | | This function returns an integer which is the height of the column header row in pixels. | | This function returns an integer which is the width of the given column in pixels. | | This function returns an HTML string to be placed in the row header for the given row index | | This function returns an integer which is the width of the row header column in pixels. | | This function returns an integer which is the height of the given row in pixels. | | This function returns the number of rows of data in the model as an integer value. | | This function returns an HTML string which is the text to place in the cell at the given row and column. | | This function is called with a column index and width in pixels when a column is resized. | | This function returns a boolean value to indicate if a given cell is editable by the user. | | This function is called with the row and column of a cell and a new value for the cell. | | This function is called by the grid to indicate that the user has selected a row by clicking on the row header. | | This function is called by the grid to indicate that the user has selected a column by clicking on the column header. | | This function is called by the grid to indicate that the user has selected a cell by clicking on the cell in the grid. |
Jx.Gridconstruct a new instance of Jx.Grid within the domObj ParametersonScrollhandle the grid scrolling by updating the position of the headers resizeresize the grid to fit inside its container. This involves knowing something about the model it is displaying (the height of the column header and the width of the row header) so nothing happens if no model is set setModel| setModel: function( | model | ) |
|
set the model for the grid to display. If a model is attached to the grid it is removed and the new model is displayed. Parameters| model | {Object} the model to use for this grid |
destroyGriddestroy the contents of the grid safely createGridcreate the grid for the current model setRowHeaderHeight| setRowHeaderHeight: function( | row, | | height | ) |
|
set the height of a row. This is used internally to adjust the height of the row header when cell contents wrap. A limitation of the table structure is that overflow: hidden on a td will work horizontally but not vertically Parameters| row | {Integer} the row to set the height for | | height | {Integer} the height to set the row (in pixels) |
gridChanged| gridChanged: function( | model, | | row, | | col, | | value | ) |
|
called through the grid listener interface when data has changed in the underlying model Parameters| model | {Object} the model that changed | | row | {Integer} the row that changed | | col | {Integer} the column that changed | | value | {Mixed} the new value |
prelightRowHeader| prelightRowHeader: function( | row | ) |
|
apply the jxGridRowHeaderPrelight style to the header cell of a row. This removes the style from the previously pre-lit row header. Parameters| row | {Integer} the row to pre-light the header cell of |
prelightColumnHeader| prelightColumnHeader: function( | col | ) |
|
apply the jxGridColumnHeaderPrelight style to the header cell of a column. This removes the style from the previously pre-lit column header. Parameters| col | {Integer} the column to pre-light the header cell of |
prelightRow| prelightRow: function( | row | ) |
|
apply the jxGridRowPrelight style to row. This removes the style from the previously pre-lit row. Parameters| row | {Integer} the row to pre-light |
prelightColumn| prelightColumn: function( | col | ) |
|
apply the jxGridColumnPrelight style to a column. This removes the style from the previously pre-lit column. Parameters| col | {Integer} the column to pre-light |
TODO: Jx.Grid.prelightColumn Not Yet Implemented. prelightCell| prelightCell: function( | row, | | col | ) |
|
apply the jxGridCellPrelight style to a cell. This removes the style from the previously pre-lit cell. Parameters| row | {Integer} the row of the cell to pre-light | | col | {Integer} the column of the cell to pre-light |
selectCell| selectCell: function( | row, | | col | ) |
|
Select a cell and apply the jxGridCellSelected style to it. This deselects a previously selected cell. If the model supports cell selection, it should implement a cellSelected function to receive notification of the selection. Parameters| row | {Integer} the row of the cell to select | | col | {Integer} the column of the cell to select |
selectRowHeader| selectRowHeader: function( | row, | | selected | ) |
|
Apply the jxGridRowHeaderSelected style to the row header cell of a selected row. Parameters| row | {Integer} the row header to select | | selected | {Boolean} the new state of the row header |
selectRow| selectRow: function( | row, | | selected | ) |
|
Select a row and apply the jxGridRowSelected style to it. If the model supports row selection, it should implement a rowSelected function to receive notification of the selection. Parameters| row | {Integer} the row to select | | selected | {Boolean} the new state of the row |
selectColumnHeader| selectColumnHeader: function( | col, | | selected | ) |
|
Apply the jxGridColumnHeaderSelected style to the column header cell of a selected column. Parameters| col | {Integer} the column header to select | | selected | {Boolean} the new state of the column header |
selectColumn| selectColumn: function( | col, | | selected | ) |
|
Select a column. This deselects a previously selected column. Parameters| col | {Integer} the column to select | | selected | {Boolean} the new state of the column |
onMouseMoveGrid| onMouseMoveGrid: function( | e | ) |
|
handle the mouse moving over the main grid. This pre-lights the cell, and subsquently the row and column (and headers). Parameters| e | {Event} the browser event object |
onMouseMoveRowHeader| onMouseMoveRowHeader: function( | e | ) |
|
handle the mouse moving over the row header cells. This pre-lights the row and subsequently the row header. Parameters| e | {Event} the browser event object |
onMouseMoveColumnHeader| onMouseMoveColumnHeader: function( | e | ) |
|
handle the mouse moving over the column header cells. This pre-lights the column and subsequently the column header. Parameters| e | {Event} the browser event object |
onClickGridhandle the user clicking on the grid. This triggers an event to the model (if a cellSelected function is provided). The following is an example of a function in the model that selects a row when the cellSelected function is called and deselects any rows that are currently selected. cellSelected: function(grid, row,col) {
if (this.selectedRow != null) {
grid.selectRow(this.selectedRow, false);
}
this.selectedRow = row;
grid.selectRow(row, true);
}
Parameters:
e - {Event} the browser event object
onClickRowHeader| onClickRowHeader: function( | e | ) |
|
handle the user clicking on the row header. This triggers an event to the model (if a rowSelected function is provided) which can then select the row if desired. The following is an example of a function in the model that selects a row when the rowSelected function is called and deselects any rows that are currently selected. More complex code could be written to allow the user to select multiple rows. rowSelected: function(grid, row) {
if (this.selectedRow != null) {
grid.selectRow(this.selectedRow, false);
}
this.selectedRow = row;
grid.selectRow(row, true);
}
Parameters| e | {Event} the browser event object |
onClickColumnHeader| onClickColumnHeader: function( | e | ) |
|
handle the user clicking on the column header. This triggers column selection and column (and header) styling changes and an event to the model (if a columnSelected function is provided) The following is an example of a function in the model that selects a column when the columnSelected function is called and deselects any columns that are currently selected. More complex code could be written to allow the user to select multiple columns. colSelected: function(grid, col) {
if (this.selectedColumn != null) {
grid.selectColumn(this.selectedColumn, false);
}
this.selectedColumn = col;
grid.selectColumn(col, true);
}
Parameters| e | {Event} the browser event object |
getRowColumnFromEvent| getRowColumnFromEvent: function( | e | ) |
|
retrieve the row and column indexes from an event click. This function is used by the grid, row header and column header to safely get these numbers. If the event isn’t valid (i.e. it wasn’t on a TD or TH) then the returned values will be -1, -1 Parameters| e | {Event} the browser event object |
@return Object an object with two properties, row and column, that contain the row and column that was clicked Jx. Grid. Modelcreate a new grid model Parameters| data | array of data to display in the grid | | options | <Jx.Grid.Model.Options> |
getColumnCount| getColumnCount: function() |
This function returns the number of columns of data in the model as an integer value. getColumnHeaderHTML| getColumnHeaderHTML: function( | col | ) |
|
This function returns an HTML string to be placed in the column header for the given column index. getColumnHeaderHeight| getColumnHeaderHeight: function() |
This function returns an integer which is the height of the column header row in pixels. getColumnWidth| getColumnWidth: function( | col | ) |
|
This function returns an integer which is the width of the given column in pixels. getRowHeaderHTML| getRowHeaderHTML: function( | row | ) |
|
This function returns an HTML string to be placed in the row header for the given row index getRowHeaderWidth| getRowHeaderWidth: function() |
This function returns an integer which is the width of the row header column in pixels. getRowHeight| getRowHeight: function( | row | ) |
|
This function returns an integer which is the height of the given row in pixels. getRowCountThis function returns the number of rows of data in the model as an integer value. getValueAt| getValueAt: function( | row, | | col | ) |
|
This function returns an HTML string which is the text to place in the cell at the given row and column. setColumnWidth| setColumnWidth: function() |
This function is called with a column index and width in pixels when a column is resized. This function is only required if the grid allows resizeable columns. isCellEditable| isCellEditable: function() |
This function returns a boolean value to indicate if a given cell is editable by the user. setValueAt| setValueAt: function( | row, | | col, | | value | ) |
|
This function is called with the row and column of a cell and a new value for the cell. It is mandatory to provide this function if any of the cells in the model are editable. rowSelected| rowSelected: function( | grid, | | row | ) |
|
This function is called by the grid to indicate that the user has selected a row by clicking on the row header. columnSelected| columnSelected: function( | grid, | | col | ) |
|
This function is called by the grid to indicate that the user has selected a column by clicking on the column header. cellSelected| cellSelected: function( | grid, | | row, | | col | ) |
|
This function is called by the grid to indicate that the user has selected a cell by clicking on the cell in the grid. Jx. Menu. ContextExtends: Jx.Menu A Jx.Menu that has no button but can be opened at a specific browser location to implement context menus (for instance). Example
Events| TODO | add open/close events? |
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | create a new context menu | | Show the context menu at the location of the mouse click |
Jx. ContextMenucreate a new context menu Parameters| id | {HTMLElement} element or id to make this the context menu for. The menu hooks the oncontextmenu event of the element and shows itself at the mouse position where the right-click happened. |
showShow the context menu at the location of the mouse click ParametersJx. Menu. SeparatorExtends: Object A convenience class to create a visual separator in a menu. Example
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {HTMLElement} the HTML element that the separator is contained within | | | | | | Create a new instance of a menu separator | | Set the ownder of this menu item | | | | |
domObj{HTMLElement} the HTML element that the separator is contained within Jx. Menu. SeparatorCreate a new instance of a menu separator setOwnerSet the ownder of this menu item Parameters| obj | {Object} the new owner |
Jx. Menu. SubMenuExtends: Jx.Menu.Item Implements: Jx.AutoPosition, Jx.Chrome A sub menu contains menu items within a main menu or another sub menu. The structure of a SubMenu is the same as a Jx.Menu.Item with an additional unordered list element appended to the container. Example
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {HTMLElement} the HTML container for the sub menu. | | | | {<Jx.MenuItem>} the visible item within the menu | | {Array} the menu items that are in this sub menu. | | | | Create a new instance of Jx.SubMenu | | Set the owner of this sub menu | | | | | | Add menu items to the sub menu. | | Insert a menu item before another menu item. | | Remove a single menu item from the menu. | | | | Indicate if this sub menu is active | | Set the active state of the Jx.Menu that contains this sub menu | | Set a sub menu of this menu to be visible and hide the previously visible one. |
subDomObj{HTMLElement} the HTML container for the sub menu. visibleItem{<Jx.MenuItem>} the visible item within the menu items{Array} the menu items that are in this sub menu. Jx. SubMenuCreate a new instance of Jx.SubMenu Parameters| options | see <Jx.Button.Options> |
setOwnerSet the owner of this sub menu ParametersaddAdd menu items to the sub menu. Parameters| item | {<Jx.MenuItem>} the menu item to add. Multiple menu items can be added by passing multiple arguments to this function. |
insertBefore| insertBefore: function( | newItem, | | targetItem | ) |
|
Insert a menu item before another menu item. Parameters| newItem | {<Jx.MenuItem>} the menu item to insert | | targetItem | {<Jx.MenuItem>} the menu item to insert before |
removeRemove a single menu item from the menu. Parameters| item | {<Jx.MenuItem} the menu item to remove. |
deactivateDeactivate the sub menu Parameters| e | {Event} the event that triggered the menu being deactivated. |
isActiveIndicate if this sub menu is active Returns{Boolean} true if the Jx.Menu that ultimately contains this sub menu is active, false otherwise. setActive| setActive: function( | isActive | ) |
|
Set the active state of the Jx.Menu that contains this sub menu Parameters| isActive | {Boolean} the new active state |
setVisibleItem| setVisibleItem: function( | obj | ) |
|
Set a sub menu of this menu to be visible and hide the previously visible one. Parameters| obj | {Jx.SubMenu} the sub menu that should be visible |
Jx. Splitter.SnapExtends: Object A helper class to create an element that can snap a split panel open or closed. Example
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {HTMLElement} the DOM element of the snap (the thing that gets clicked). | | {HTMLElement} An element of the Jx.Splitter that gets controlled by this snap | | { Jx.Splitter} the splitter that this snap is associated with. | | {String} track the layout of the splitter for convenience. | | | | Create a new Jx.Splitter.Snap | | Snap the element open or closed. | | Handle the size of the element changing to see if the toggle state has changed. |
snap{HTMLElement} the DOM element of the snap (the thing that gets clicked). element{HTMLElement} An element of the Jx.Splitter that gets controlled by this snap splitter{Jx.Splitter} the splitter that this snap is associated with. layout{String} track the layout of the splitter for convenience. Jx. Splitter.SnapCreate a new Jx.Splitter.Snap Parameters| snap | {HTMLElement} the clickable thing that snaps the element open and closed | | element | {HTMLElement} the element that gets controlled by the snap | | splitter | {Jx.Splitter} the splitter that this all happens inside of. |
toggleElement| toggleElement: function() |
Snap the element open or closed. sizeChangedHandle the size of the element changing to see if the toggle state has changed. Jx. ToolbarExtends: Object Implements: Options, Events A toolbar is a container object that contains other objects such as buttons. The toolbar organizes the objects it contains automatically, wrapping them as necessary. Multiple toolbars may be placed within the same containing object. Jx.Toolbar includes CSS classes for styling the appearance of a toolbar to be similar to traditional desktop application toolbars. There is one special object, Jx.ToolbarSeparator, that provides a visual separation between objects in a toolbar. While a toolbar is generally a dumb container, it serves a special purpose for menus by providing some infrastructure so that menus can behave properly. In general, almost anything can be placed in a Toolbar, and mixed with anything else. ExampleThe following example shows how to create a Jx.Toolbar instance and place two objects in it. //myToolbarContainer is the id of a <div> in the HTML page.
function myFunction() {}
var myToolbar = new Jx.Toolbar('myToolbarContainer');
var myButton = new Jx.Button(buttonOptions);
var myElement = document.createElement('select');
myToolbar.add(myButton, new Jx.ToolbarSeparator(), myElement);
Events| add | fired when one or more buttons are added to a toolbar | | remove | fired when on eor more buttons are removed from a toolbar |
ImplementsOptions LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {Array} an array of the things in the toolbar. | | {HTMLElement} the HTML element that the toolbar lives in | | When a toolbar contains Jx.Menu instances, they want to know if any menu in the toolbar is active and this is how they find out. | | | | Create a new instance of Jx.Toolbar. | | add this toolbar to a DOM element automatically creating a toolbar container if necessary | | Add an item to the toolbar. | | remove an item from a toolbar. | | Deactivate the Toolbar (when it is acting as a menu bar). | | Indicate if the toolbar is currently active (as a menu bar) | | Set the active state of the toolbar (for menus) | | For menus, they want to know which menu is currently open. |
items{Array} an array of the things in the toolbar. domObj{HTMLElement} the HTML element that the toolbar lives in isActiveWhen a toolbar contains Jx.Menu instances, they want to know if any menu in the toolbar is active and this is how they find out. Jx. ToolbarCreate a new instance of Jx.Toolbar. Parameters| options | <Jx.Toolbar.Options> |
addToadd this toolbar to a DOM element automatically creating a toolbar container if necessary Parameters| parent | the DOM element or toolbar container to add this toolbar to. |
addAdd an item to the toolbar. If the item being added is a Jx component with a domObj property, the domObj is added. If the item being added is an LI element, then it is given a CSS class of jxToolItem. Otherwise, the thing is wrapped in a <Jx.ToolbarItem>. Parameters| thing | {Object} the thing to add. More than one thing can be added by passing multiple arguments. |
removeremove an item from a toolbar. If the item is not in this toolbar nothing happens Parameters| item | {Object} the object to remove |
Returns{Object} the item that was removed, or null if the item was not removed. deactivateDeactivate the Toolbar (when it is acting as a menu bar). isActiveIndicate if the toolbar is currently active (as a menu bar) Returns{Boolean} setActiveSet the active state of the toolbar (for menus) ParameterssetVisibleItem| setVisibleItem: function( | obj | ) |
|
For menus, they want to know which menu is currently open. Parameters| obj | {Jx.Menu} the menu that just opened. |
Jx. TabSetExtends: Object Implements: Options, Events A TabSet manages a set of Jx.Button.Tab content areas by ensuring that only one of the content areas is visible (i.e. the active tab). TabSet does not manage the actual tabs. The instances of Jx.Button.Tab that are to be managed as a set have to be added to both a TabSet and a Jx.Toolbar. The content areas of the Jx.Button.Tabs are sized to fit the content area that the TabSet is managing. Examplevar tabBar = new Jx.Toolbar('tabBar');
var tabSet = new Jx.TabSet('tabArea');
var tab1 = new Jx.Button.Tab('tab 1', {contentID: 'content1'});
var tab2 = new Jx.Button.Tab('tab 2', {contentID: 'content2'});
var tab3 = new Jx.Button.Tab('tab 3', {contentID: 'content3'});
var tab4 = new Jx.Button.Tab('tab 4', {contentURL: 'test_content.html'});
tabSet.add(t1, t2, t3, t4);
tabBar.add(t1, t2, t3, t4);
Events| tabChange | the current tab has changed |
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {Array} array of tabs that are managed by this tab set | | {HTMLElement} The HTML element that represents this tab set in the DOM. | | | | Create a new instance of Jx.TabSet within a specific element of the DOM. | | Resize the tab set content area and propogate the changes to each of the tabs managed by the tab set. | | | | Remove a tab from this TabSet. | | Set the active tab to the one passed to this method |
tabs{Array} array of tabs that are managed by this tab set domObj{HTMLElement} The HTML element that represents this tab set in the DOM. The content areas of each tab are sized to fill the domObj. Jx. TabSetCreate a new instance of Jx.TabSet within a specific element of the DOM. Parameters| domObj | {HTMLElement} an element or id of an element to put the content of the tabs into. | | options | an options object, only event handlers are supported as options at this time. |
resizeTabBoxResize the tab set content area and propogate the changes to each of the tabs managed by the tab set. addAdd one or more Jx.Button.Tabs to the TabSet. Parameters| tab | {<Jx.Tab>} an instance of <Jx.Tab> to add to the tab set. More than one tab can be added by passing extra parameters to this method. |
removeRemove a tab from this TabSet. Note that it is the caller’s responsibility to remove the tab from the Jx.Toolbar. Parameters| tab | {<Jx.Tab>} the tab to remove. |
setActiveTab| setActiveTab: function( | tab | ) |
|
Set the active tab to the one passed to this method ParametersJx. TabBoxExtends: Object Implements: Options, Events, Jx.Addable A convenience class to handle the common case of a single toolbar directly attached to the content area of the tabs. It manages both a Jx.Toolbar and a Jx.TabSet so that you don’t have to. If you are using a TabBox, then tabs only have to be added to the TabBox rather than to both a Jx.TabSet and a Jx.Toolbar. Examplevar tabBox = new Jx.TabBox('subTabArea', 'top');
var tab1 = new Jx.Button.Tab('Tab 1', {contentID: 'content4'});
var tab2 = new Jx.Button.Tab('Tab 2', {contentID: 'content5'});
tabBox.add(tab1, tab2);
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | | | | | | | Create a new instance of a TabBox. | | Add one or more <Jx.Tab>s to the TabBox. | | Remove a tab from the TabSet. |
tabSet{Jx.TabSet} the tab set for this tab box. Jx. TabBoxCreate a new instance of a TabBox. Parameters| options | <Jx.TabBox.Options> |
addAdd one or more <Jx.Tab>s to the TabBox. Parameters| tab | {<Jx.Tab>} an instance of <Jx.Tab> to add to the tab box. More than one tab can be added by passing extra parameters to this method. Unlike Jx.TabSet, tabs do not have to be added to a separate Jx.Toolbar. |
removeRemove a tab from the TabSet. Parameters| tab | {<Jx.Tab>} the tab to remove. |
Jx. Toolbar. ContainerExtends: Object Implements: Options, Events, Jx.Addable A toolbar container contains toolbars. A single toolbar container fills the available space horizontally. Toolbars placed in a toolbar container do not wrap when they exceed the available space. Events| add | fired when one or more toolbars are added to a container | | remove | fired when one or more toolbars are removed from a container |
ImplementsOptions Events {Jx.Addable} LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {HTMLElement} the HTML element that the container lives in | | | | Create a new instance of Jx.Toolbar.Container | | Add a toolbar to the container. | | remove an item from a toolbar. | | scrolls an item in one of the toolbars into the currently visible area of the container if it is not already fully visible |
domObj{HTMLElement} the HTML element that the container lives in Jx. Toolbar. ContainerCreate a new instance of Jx.Toolbar.Container Parameters| options | <Jx.Toolbar.Options> |
addAdd a toolbar to the container. Parameters| toolbar | {Object} the toolbar to add. More than one toolbar can be added by passing multiple arguments. |
removeremove an item from a toolbar. If the item is not in this toolbar nothing happens Parameters| item | {Object} the object to remove |
Returns{Object} the item that was removed, or null if the item was not removed. scrollIntoView| scrollIntoView: function( | item | ) |
|
scrolls an item in one of the toolbars into the currently visible area of the container if it is not already fully visible ParametersJx. Toolbar.ItemExtends: Object Implements: Options A helper class to provide a container for something to go into a Jx.Toolbar. LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {HTMLElement} an element to contain the thing to be placed in the toolbar. | | | | Create a new instance of Jx.Toolbar.Item. |
domObj{HTMLElement} an element to contain the thing to be placed in the toolbar. Jx. Toolbar.ItemCreate a new instance of Jx.Toolbar.Item. Parameters| jxThing | {Object} the thing to be contained. |
Jx. Toolbar. SeparatorExtends: Object A helper class that represents a visual separator in a Jx.Toolbar Example
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {HTMLElement} The DOM element that goes in the Jx.Toolbar | | | | Create a new Jx.Toolbar.Separator |
domObj{HTMLElement} The DOM element that goes in the Jx.Toolbar Jx. Toolbar. SeparatorCreate a new Jx.Toolbar.Separator Jx. TreeItemExtends: Object Implements: Options, Events An item in a tree. An item is a leaf node that has no children. Jx.TreeItem supports selection via the click event. The application is responsible for changing the style of the selected item in the tree and for tracking selection if that is important. Example
Events| click | triggered when the tree item is clicked |
Implements| Events | MooTools Class.Extras | | Options | MooTools Class.Extras |
LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {HTMLElement} a reference to the HTML element that is the TreeItem in the DOM | | {Object} the folder or tree that this item belongs to | | | | Create a new instance of Jx.TreeItem with the associated options | | Clean up the TreeItem and remove all DOM references | | Clean up the TreeItem and remove all DOM references | | Create a clone of the TreeItem | | Update the CSS of the TreeItem’s DOM element in case it has changed position | | Called when the DOM element for the TreeItem is clicked, the node is selected. | | Get the label associated with a TreeItem | | A property of an object has changed, synchronize the state of the TreeItem with the state of the object |
domObj{HTMLElement} a reference to the HTML element that is the TreeItem in the DOM owner{Object} the folder or tree that this item belongs to Jx. TreeItemCreate a new instance of Jx.TreeItem with the associated options Parameters| options | <Jx.TreeItem.Options> |
finalizeClean up the TreeItem and remove all DOM references finalizeItemClean up the TreeItem and remove all DOM references cloneCreate a clone of the TreeItem Returns{Jx.TreeItem} a copy of the TreeItem update| update : function( | shouldDescend | ) |
|
Update the CSS of the TreeItem’s DOM element in case it has changed position Parameters| shouldDescend | {Boolean} propagate changes to child nodes? |
selectedCalled when the DOM element for the TreeItem is clicked, the node is selected. ParametersgetNameGet the label associated with a TreeItem Returns{String} the name propertyChanged| propertyChanged : function( | obj | ) |
|
A property of an object has changed, synchronize the state of the TreeItem with the state of the object Parameters| obj | {Object} the object whose state has changed |
Jx. TreeFolderExtends: Jx.TreeItem A Jx.TreeFolder is an item in a tree that can contain other items. It is expandable and collapsible. Example
ExtendsJx.TreeItem LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | {HTMLElement} an HTML container for the things inside the folder | | {Array} an array of references to the javascript objects that are children of this folder | | | | Create a new instance of Jx.TreeFolder | | | | Internal method to clean up folder-related stuff. | | Create a clone of the TreeFolder | | Indicates if a node is the last thing in the folder. | | Update the CSS of the TreeFolder’s DOM element in case it has changed position. | | append a node at the end of the sub-tree | | insert a node after refNode. | | remove the specified node from the tree | | Replace a node with another node | | handle the user clicking on this folder by expanding or collapsing it. | | | | | | Get a reference to a child node by recursively searching the tree |
subDomObj{HTMLElement} an HTML container for the things inside the folder nodes{Array} an array of references to the javascript objects that are children of this folder Jx. TreeFolderCreate a new instance of Jx.TreeFolder Parameters| options | <Jx.TreeFolder.Options> and <Jx.TreeItem.Options> |
finalizeFolder| finalizeFolder: function() |
Internal method to clean up folder-related stuff. cloneCreate a clone of the TreeFolder Returns{Jx.TreeFolder} a copy of the TreeFolder isLastNode| isLastNode : function( | node | ) |
|
Indicates if a node is the last thing in the folder. Parameters| node | {Jx.TreeItem} the node to check |
Returns{Boolean} update| update : function( | shouldDescend | ) |
|
Update the CSS of the TreeFolder’s DOM element in case it has changed position. Parameters| shouldDescend | {Boolean} propagate changes to child nodes? |
appendappend a node at the end of the sub-tree Parameters| node | {Object} the node to append. |
insert| insert : function( | node, | | refNode | ) |
|
insert a node after refNode. If refNode is null, insert at beginning Parameters| node | {Object} the node to insert | | refNode | {Object} the node to insert before |
removeremove the specified node from the tree Parameters| node | {Object} the node to remove |
replace| replace: function( | newNode, | | refNode | ) |
|
Replace a node with another node Parameters| newNode | {Object} the node to put into the tree | | refNode | {Object} the node to replace |
Returns{Boolean} true if the replacement was successful. clickedhandle the user clicking on this folder by expanding or collapsing it. Parameters| e | {Event} the event object |
findChild| findChild : function( | path | ) |
|
Get a reference to a child node by recursively searching the tree Parameters| path | {Array} an array of labels of nodes to search for |
Returns{Object} the node or null if the path was not found Jx.TreeExtends: Jx.TreeFolder Implements: Jx.Addable Jx.Tree displays hierarchical data in a tree structure of folders and nodes. Example
Extends: Jx.TreeFolder LicenseCopyright © 2008, DM Solutions Group Inc. This file is licensed under an MIT style license Summary | | | Create a new instance of Jx.Tree | | Clean up a Jx.Tree instance | | Clear the tree of all child nodes | | Update the CSS of the Tree’s DOM element in case it has changed position | | Append a node at the end of the sub-tree |
Jx.TreeCreate a new instance of Jx.Tree Parametersoptions: options for Jx.Addable finalizeClean up a Jx.Tree instance clearClear the tree of all child nodes update| update: function( | shouldDescend | ) |
|
Update the CSS of the Tree’s DOM element in case it has changed position Parameters| shouldDescend | {Boolean} propagate changes to child nodes? |
appendAppend a node at the end of the sub-tree Parameters| node | {Object} the node to append. |
Fusion. ErrorGeneral purpose Error object Fusion. Lib. EventMgran internal class for managing generic events. Classes that wish to publish and trigger events that other objects can listen for need to inherit from Fusion.Lib.EventMgr. To publish an event, call registerEventID with some unique numeric or string value. Other objects can then call registerForEvent with the eventID and a function to call when the event is triggered. To trigger an event, call triggerEvent with the eventID and any additional arguments that should be passed to listeners. Fusion. Lib. ApplicationDefinitionUtility class to parse an application definition Summary | | | array of map groups, parsed from ApplicationDefinition. | | array of widget sets (each one corresponding to a map) parsed from the ApplicationDefinition. | | A Broker object that can communicate with a MapGuide instance in the case we are running against a MapGuide server | | An array of search definitions | | An array of search categories | | | | construct a new instance of the ApplicationDefinition object. | | start parsing the ApplicationDefinition file. | | parse the ApplicationDefinition file into the appropriate Fusion objects | | Create the application definition. | | return a map widget with the given name | | return a map widget with the given id | | return the map widget at the given index | | return the specified map group from the application definition |
mapGroupsarray of map groups, parsed from ApplicationDefinition. A MapGroup consists of one or more Maps that can be combined into the same OpenLayers Map object widgetSetsarray of widget sets (each one corresponding to a map) parsed from the ApplicationDefinition. {Object} oBrokerA Broker object that can communicate with a MapGuide instance in the case we are running against a MapGuide server {Array} searchDefinitionsAn array of search definitions {Array} searchCategoriesAn array of search categories ApplicationDefinitionconstruct a new instance of the ApplicationDefinition object. While not enforced, this is intended to be a singleton. Parameter: sessionId an optional session id to initialize the application with, passed to the map widgets when they are created. parsestart parsing the ApplicationDefinition file. This happens asynchronously since the ApplicationDefinition has to be retrieved from the server or the MapGuide repository. When parsing is complete, an APPLICATIONDEFINITION_PARSED event will be emitted. This function returns true if parsing will start, false if it will not (due to a missing application definition for instance). parseAppDef| parseAppDef: function( | json | ) |
|
parse the ApplicationDefinition file into the appropriate Fusion objects Parameter: {XmlHttpRequest} xhr the XmlHttpRequest object createCreate the application definition. This actually triggers initializing every widget and container. getMapByName| getMapByName : function( | name | ) |
|
return a map widget with the given name Parameter: {String} name The map name to return Returns: {Object} a map object or null if not found. getMapById| getMapById : function( | id | ) |
|
return a map widget with the given id Parameter: {String} id The map id to return. ID is distinct from map.name in that id is the id of the HTML tag where the map widget is inserted. Returns: {Object} a map object or null if not found. getMapByIndice| getMapByIndice : function( | indice | ) |
|
return the map widget at the given index Parameter: {String} indice The map indice to return Returns: {Object} a map object or null if not found. getMapGroup| getMapGroup : function( | mapGroupId | ) |
|
return the specified map group from the application definition Parameter: {String} mapgroup The id of the MapGroup to return Returns: {Object} a MapGroup appdef or null if not found. Fusion. Lib. ApplicationDefinition. MapGroupHolds an internal representation of MapGroup objects as defined in the AppDef Fusion. Lib. ApplicationDefinition.MapHolds an internal representation of Map objects as defined in the AppDef Fusion. Lib. ApplicationDefinition. WidgetSetHolds an internal representation of WidgetSet objects as defined in the AppDef Summary | | | keep track of live widgets created in this widgetSet | | return the map widget for this widget set | | create all the things required by this widgetSet, including containers and widgets. | | return the map widget from this widget set if the map’s name matches the requested name, or null. |
addWidgetInstance| addWidgetInstance: function( | widget | ) |
|
keep track of live widgets created in this widgetSet Parameter: {Fusion.Widget} widget the widget to add getMapWidgetreturn the map widget for this widget set Returns: {<Fusion.Lib.Map>} a map widget or null createcreate all the things required by this widgetSet, including containers and widgets. Parameter: {Fusion.Lib.ApplicationDefinition} the application definition that this widgetSet is part of getMapByName| getMapByName : function( | name | ) |
|
return the map widget from this widget set if the map’s name matches the requested name, or null. Parameter: {String} name The map name to check Returns: {Object} a map object or null. Fusion. Lib. ApplicationDefinition. ContainerHolds an internal representation of Container objects as defined in the AppDef Fusion. Lib. ApplicationDefinition. WidgetHolds an internal representation of Widget objects as defined in the AppDef Summary | | | creates a new instance of the widget, optionally using a different name during instantiation to accomodate containers |
create| create: function( | widgetSet, | | widgetName | ) |
|
creates a new instance of the widget, optionally using a different name during instantiation to accomodate containers Parameter: name An optional name to use for the widget, overrides the original name temporarily if passed. Returns: an instance of the widget represented by this object. Fusion. Lib. ApplicationDefinition.ItemHolds an internal representation of Menu Item objects as defined in the AppDef Fusion. Lib. ApplicationDefinition. FlyoutHolds an internal representation of Flyout objects as defined in the AppDef Fusion. Lib. ApplicationDefinition. MultiHolds an internal representation of Multi objects as defined in the AppDef Fusion. Lib. ApplicationDefinition. SearchDefinitionHolds an internal representation of SearchDefinition objects as defined in the AppDef Fusion. Lib. ApplicationDefinition. SearchJoinHolds an internal representation of SearchJoin objects as defined in the AppDef Fusion. Lib. ApplicationDefinition. SearchRuleHolds an internal representation of SearchRule objects as defined in the AppDef Fusion. Lib. ApplicationDefinition. SearchConditionHolds an internal representation of SearchCondition objects as defined in the AppDef Fusion. Lib. MGBrokerMGBroker is used to broker requests to the MapGuide Open Source mapagent interface. It is a very simple class that is configured with a URL and credentials via the setSiteURL method and can send requests to the server via the dispatchRequest method. Fusion. Lib. MGRequestMGRequest is the base class for all broker-compatible requests. A request is a wrapper around an operation that is supported by the mapagent. Fusion. Lib. MGRequest. MGEnumerateResourcesencapsulate a request to the server to enumerate resources in the library. Fusion. Lib. MGRequest. MGGetResourceContentencapsulate a request to the server to get resource contents from the library. Fusion. Lib. MGRequest. MGGetResourceHeaderencapsulate a request to the server to get resource header from the library. Fusion. Lib. MGRequest. MGCreateSessionencapsulate a request to the server to create a new session on the server. Fusion. Lib. MGRequest. MGCopyResourceencapsulate a request to the server to copy a resource. Fusion. Lib. MGRequest. MGDeleteResourceencapsulate a request to the server to delete a resource. Fusion. Lib. MGRequest. MGMoveResourceencapsulate a request to the server to move a resource in the repository. Fusion. Lib. MGRequest. MGMoveResourceencapsulate a request to the server to set the content XML of a resource. Fusion. Lib. MGRequest. MGDescribeSchemaencapsulate a request to the server to describe the schema of a FeatureSource. Fusion. Lib. MGRequest. MGGetSpatialContextsencapsulate a request to the server to retrieve the spatial context of a resource. Fusion. Lib. MGRequest. MGEnumerateResourceReferencesencapsulate a request to the server to enumerate the references to a resource id. Fusion. Lib. MGRequest. MGEnumerateResourceDataencapsulate a request to the server to enumerate the data associated with a FeatureSource N.B. This does not enumerate resource data for ‘unmanaged’ FeatureSources (those referencing files or directories outside the respository) Fusion.Lib.MGRequest.MGDescribeSchema should be used for those sources. Fusion. Lib. MGRequest. MGGetVisibleMapExtentencapsulate a request to the server to enumerate the data associated with a FeatureSource N.B. This does not enumerate resource data for ‘unmanaged’ FeatureSources (those referencing files or directories outside the respository) Fusion.Lib.MGRequest.MGDescribeSchema should be used for those sources. Fusion. Lib. MGRequest. MGQueryMapFeaturesencapsulate a request to the server to query map features on selectable layers Fusion. Lib. MGRequest. MGGetFeatureSetEnvelopeencapsulate a request to the server to query map features on selectable layers Fusion. WidgetThis is the base class for all widgets. It provides some basic functionality that all widgets should need. Summary | | | returns the location of this widget relative to the installation of fusion. |
getLocationreturns the location of this widget relative to the installation of fusion. Can be used to construct URLs to resources that the widget needs. Returns: {String} the location of this widget Fusion. Tool. SearchThe Fusion search mechanism defines a common capability for searches that link individual searches to a common search set maintained for all search-based widgets. The common search set can be statically and/or dynamically created. Static definition is done in the WebLayout. Dynamic creation is done by individual widgets and creating instances of Fusion.Tool.SearchDefinition(s) - or rather a MGSearchDefinition. Widgets that want to take advantage of this behaviour can sub-class this widget. Just make sure to initialize properly! Fusion. Widget.Mapgeneric class for map widgets. Provides common utility classes. This class provides a wrapper around the OpenLayers Map object. Summary | | | Callback for when all maps have been loaded | | Attaches a context menu as defined in the AppDef to the map | | Controls the creation of Layers based on the MapGroup object passed in | | Called after each layer is loaded in the OL viewport. | | handles mouse wheel events by accummulating the events and setting a timer to do the actual zoom in/out | | Carries out the actual map zoom based on the wheel movement | | User spun scroll wheel up | | User spun scroll wheel down | | returns the dom element for this widget | | returns the name of the baselayer map | | returns the Title of the baselayer map. | | returns the server session ID | | returns the ID of dom element for this widget | | sets options on the OpenLayers map object, a wrapper for the OL function | | adds a map/Layer to the map and registers some event handlers on the map | | returns the array of map objects | | Called to reload all the map objects. | | Loads the ScaleRange objects separate from the LoadMap sequence since this also generates sprites and is a relatively expensive operation. | | dispatch query requests to the maps | | handle selection events from maps and republish for widgets as appropriate | | cehck to see if any of the maps have an active selection | | clear the selection on all maps | | initiates a call to get the current selection asynchronously in case we need to retrieve the details from the server | | sets a Selection XML back to the server for each of the maps | | accumulate the selection results from each map and when all have reported in, pass the results to the callback function | | sets the active layer for selection/manipulation | | returns the active layer for selection/manipulation | | indicate that a new asynchronous process has started and make sure the visual indicator is visible for the user. | | indicate that an asynchronous process has completed and hide the visual indicator if no remaining processes are active. | | OpenLayers event handler for whenever the map changes either zoom level of the center has changed. | | check to see if there are any outstanding requests to the server | | callback for when the browser window size changes, simply calls resize on the map viewport layout object | | handles the resizing of the maps and triggers a Fusion event | | redraws the map using current extents and zoom level. | | sets the background color for the map | | handle selection events from maps and republish for widgets as appropriate | | | | gets the intitial extents from all maps with or without including the extent of any Generic/commercial layers | | sets the extent of the map to the max as returned by loadMap | | returns if the map has finished loading (based on setting the _oCurrentExtent value) | | sets the map zoom and extent. | | sets the map zoom and extent. | | sets the map zoom and extent. | | sets the map zoom and extent. | | returns the current center of the map view | | returns the Extent of the map given a center point and a scale (optional) |
mapLoadedCallback for when all maps have been loaded Parameter: none. Return: none setMenuAttaches a context menu as defined in the AppDef to the map Parameter: none. Return: none loadMapGroup| loadMapGroup: function( | mapGroup | ) |
|
Controls the creation of Layers based on the MapGroup object passed in | Parameter: {Object} mapGroup | a representation of the MapGroup object |
Return: none layerLoadedCalled after each layer is loaded in the OL viewport. Nothing happens here until the last layer is laoded, then it sets the OL baselayer and zooms to the initial extent. Parameter: none Return: none wheelChange| wheelChange: function( | evt, | | deltaZ | ) |
|
handles mouse wheel events by accummulating the events and setting a timer to do the actual zoom in/out Parameters| evt | {Event} the mouse wheel event object | | deltaZ | {Integer} the number of ticks wheeled |
doWheelChange| doWheelChange: function( | evt, | | deltaZ | ) |
|
Carries out the actual map zoom based on the wheel movement Parameters| evt | {Event} the mouse wheel event object | | deltaZ | {Integer} the number of ticks wheeled |
Return: none wheelUpUser spun scroll wheel up ParameterswheelDownUser spun scroll wheel down ParametersgetDomObjreturns the dom element for this widget Parameters: none Return: none getMapNamereturns the name of the baselayer map Parameters: none Return: {String} the name of the baselayer map getMapTitlereturns the Title of the baselayer map. This is a human-readable title Parameters: none Return: {String} the Title of the baselayer map getSessionIDreturns the server session ID Parameters: none Return: {String} the session ID getDomIdreturns the ID of dom element for this widget Parameters: none Return: {String} the id of the DOM element setMapOptions| setMapOptions: function( | options | ) |
|
sets options on the OpenLayers map object, a wrapper for the OL function | Parameters: {Object} options | has of option key/value pairs |
Return: none addMapadds a map/Layer to the map and registers some event handlers on the map | Parameters: {Object} map | the map object to tbe added (really a layer object) |
Return: none getAllMapsreturns the array of map objects Parameters: none Return: {Array} the array of map Objects reloadMapCalled to reload all the map objects. this uses setTimeout so this method can be called from an IFRAME Parameters: none Return: none loadScaleRanges| loadScaleRanges: function( | userFunc | ) |
|
Loads the ScaleRange objects separate from the LoadMap sequence since this also generates sprites and is a relatively expensive operation. | Parameters: {Function} userFunc | a user defined function to be called as a callback |
Return: none querydispatch query requests to the maps | Parameters: {object} options | query options to be passed to each map |
selectionHandler| selectionHandler: function() |
handle selection events from maps and republish for widgets as appropriate Parameters: none Return: none hasSelectioncehck to see if any of the maps have an active selection | Returns: {Boolean} | true if any map has a selection |
clearSelection| clearSelection: function() |
clear the selection on all maps getSelection| getSelection: function( | callback, | | layers, | | startcount | ) |
|
initiates a call to get the current selection asynchronously in case we need to retrieve the details from the server setSelection| setSelection: function( | selText, | | zoomTo | ) |
|
sets a Selection XML back to the server for each of the maps Parameters| {String} selText | the selection string | | {Boolean} zoomTo | if set, will zoom to the selection on completion |
accumulateSelection| accumulateSelection: function( | map, | | oSelection | ) |
|
accumulate the selection results from each map and when all have reported in, pass the results to the callback function Parameters| {Object} map | the map object that has the selection | | {Object} oSelection | the Fusion selection object |
setActiveLayer| setActiveLayer: function( | oLayer | ) |
|
sets the active layer for selection/manipulation Parameters| {Object} oLayer | the layer to be set as active |
getActiveLayer| getActiveLayer: function() |
returns the active layer for selection/manipulation Returns{Object} the active layer _addWorkerindicate that a new asynchronous process has started and make sure the visual indicator is visible for the user. This is intended to be used internally by gMap but could be used by external tools if appropriate. _removeWorker| _removeWorker: function() |
indicate that an asynchronous process has completed and hide the visual indicator if no remaining processes are active. This is intended to be used internally by gMap but could be used by external tools if appropriate. Only call this function if addWorker was previously called mapExtentsChanged| mapExtentsChanged: function() |
OpenLayers event handler for whenever the map changes either zoom level of the center has changed. This in turn triggers the Fusion event. Parameters: none Return: none isBusycheck to see if there are any outstanding requests to the server Parameters: none Return: {Boolean} true if there are active requests sizeChangedcallback for when the browser window size changes, simply calls resize on the map viewport layout object Parameters: none Return: none resizehandles the resizing of the maps and triggers a Fusion event Parameters: none Return: none redrawredraws the map using current extents and zoom level. A dummy parameter is added to the map request to ensure the map request is not cached. Parameters: none Return: none setBackgroundColor| setBackgroundColor: function( | color | ) |
|
sets the background color for the map | Parameters: {String} color | the CSS color value to set as background |
Return: none setExtents| setExtents: function( | oExtents | ) |
|
handle selection events from maps and republish for widgets as appropriate | Parameters: {Object} oExtents | an OpenLayers.Bounds object or an array of 4 values that will be converted to Bounds |
Return: none setInitialExtents| setInitialExtents: function() |
determine the initialExtents of the map from (in order of precedence)1. a URL query parameter called ‘extent’ 2. an <InitialView> specified in the MapGroup in AppDef 3. the maxExtent as specified by the LoadMap call (default) Returns: {Object} an OpenLayers.Bounds object which is the initial extent getMapGroupExtent| getMapGroupExtent: function( | includeGenericLayers | ) |
|
gets the intitial extents from all maps with or without including the extent of any Generic/commercial layers Return: {Object} an OpenLayers.Bounds object which is the initial extent fullExtentssets the extent of the map to the max as returned by loadMap isMapLoadedreturns if the map has finished loading (based on setting the _oCurrentExtent value) Returns {Boolean} true if the map is loaded and extent has been set zoom| zoom: function( | fX, | | fY, | | nFactor | ) |
|
sets the map zoom and extent. Parameters| fX {Float} | new x coordinate value in map units | | fY {Float} | new y coordinate value in map units | | nFactor {Float} | zoom factor; positive values zoom in, negative out |
- if set to 0 or 1, the map is just recentered
- if the map has fractional zoom enabled, the map resolution will be modified by this factor
- with fixed scales, zoom up or down one level, depending on the sign
Returns: none zoom| zoomToScale: function( | fScale | ) |
|
sets the map zoom and extent. Parameters| fX {Float} | new x coordinate value in map units | | fY {Float} | new y coordinate value in map units | | nFactor {Float} | zoom factor; positive values zoom in, negative out |
- if set to 0 or 1, the map is just recentered
- if the map has fractional zoom enabled, the map resolution will be modified by this factor
- with fixed scales, zoom up or down one level, depending on the sign
Returns: none zoomsets the map zoom and extent. Parameters| fX {Float} | new x coordinate value in map units | | fY {Float} | new y coordinate value in map units | | nFactor {Float} | zoom factor; positive values zoom in, negative out |
- if set to 0 or 1, the map is just recentered
- if the map has fractional zoom enabled, the map resolution will be modified by this factor
- with fixed scales, zoom up or down one level, depending on the sign
Returns: none zoomsets the map zoom and extent. Parameters| fX {Float} | new x coordinate value in map units | | fY {Float} | new y coordinate value in map units | | nFactor {Float} | zoom factor; positive values zoom in, negative out |
- if set to 0 or 1, the map is just recentered
- if the map has fractional zoom enabled, the map resolution will be modified by this factor
- with fixed scales, zoom up or down one level, depending on the sign
Returns: none getCurrentCenter| getCurrentCenter: function() |
returns the current center of the map view Return: {Object} an object with the following attributes x - the x coordinate of the center y - the y coordinate of the center getExtentFromPoint| getExtentFromPoint: function( | fX, | | fY, | | fScale | ) |
|
returns the Extent of the map given a center point and a scale (optional) Return: {OpenLayers.Bounds} the bounds for the map centered on a point Fusion. LayersImplements Layers for Fusion. Summary | | | This function should be called after the map has loaded. | | Returns true if the Map has been laoded succesfully form the server |
loadScaleRanges| loadScaleRanges: function( | userFunc | ) |
|
This function should be called after the map has loaded. It loads the scsle ranges for each layer. I tis for now only used by the legend widget. isMapLoadedReturns true if the Map has been laoded succesfully form the server Fusion. Layers. GroupImplements the map layer groups Fusion. Layers. LayerImplements individual map legend layers Fusion. Layers. ScaleRangeImplements a scale range object Fusion. Layers. StyleItemImplements the legend style items to get a legend icon from the server OpenLayers. Lang[“ca”]Dictionary for Catalan, UTF8 encoding. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“cs-CZ”]Dictionary for Czech. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“da-DK”]Dictionary for Danish. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“de”]Dictionary for German. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“en-CA”]Dictionary for English-CA. This dictionary inherits from the standard English dictionary. Override only those entries with language specific to the CA region. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“en”]Dictionary for English. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“es”]Dictionary for Spanish, UTF8 encoding. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“fr”]Dictionary for French. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“hu”]Dictionary for Hungarian. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“it”]Dictionary for Italian. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“ja”]Dictionary for Japanese. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“nb”]Dictionary for norwegian bokm�l (Norway). Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“nl”]Dictionary for Dutch. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“pt-BR”]Dictionary for Brazilian Portuguese. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“sv-SE”]Dictionary for swedish (Sweden). Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“zh-CN”]Dictionary for Simplified Chinese. Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. OpenLayers. Lang[“zh-TW”]Dictionary for Traditional Chinese. (Used Mainly in Taiwan) Keys for entries are used in calls to <OpenLayers.Lang.translate>. Entry bodies are normal strings or strings formatted for use with <OpenLayers.String.format> calls. Fusion. Widget. AboutAbout widget to display a pop-up window about the application. The contents of the page are come from an HTML page set as the AboutUrl extension property. Summary | | | | | opens a pop-up window with the about information when invoked |
AboutParameters| widgetTag | JSON node for this widget from the Application definition |
executeopens a pop-up window with the about information when invoked Fusion. Widget. ActivityIndicatorAcitivityIndicator is a widget that shows or hides its DOM element based on whether the map widget is busy or not. The map widget becomes busy when loading maps, reloading maps or redrawing layers. Fusion. Widget. BasemapSwitcherA widget to allow selection of the basemaps display under the overlay MapGuide layer Currently, Google Street, Google Satellite, Google Hybrid, Yahoo Street, Yahoo Satellite, Yahoo Hybrid, Bing Street, Bing Satellite and Bing Hybrid is supported. Fusion. Widget. BufferThe Buffer widget prompts the user for some inputs and then creates a buffer around the current selection based on those inputs. This version of the widget is not currently being used.Use BufferPanel instead. The 2 widgets will be merged eventually. Fusion. Widget. BufferPanelThe BufferPanel widget prompts the user for some inputs and then creates a buffer around the current selection based on those inputs. If the Target property points to TaskPane widget, the task will be listed in the menu list of the TaskPane and loaded there. Otherwise if the target is an existing IFrame in the page it will be loaded there, otherwise it will open a new window with that name. Fusion. Widget. CenterSelectionCenter the current selection, if any, but maintain the current scale if possible. Zoom out if not. Fusion. Widget. ClearSelectionClears the current selection, if any. Fusion. Widget. ColorPickerThe user can pick from a palette of web-safe colours or enter a hex value. The colour selected will be entered into the configured input element. Fusion. Widget. CursorPositionDisplays the geographic position of the cursor when it is over the map. Precision (integer, optional) The number of digits to round the output to. The geographic location is calculated with arbitrary precision and is often not necessary. A value of less than 0 means no rounding (the default if parameter is missing). Template (string, optional) The format of the output string. Use {x} and {y} as placeholders for the x and y location. The default template is: x: {x}, y: {y} You can embed HTML in the template, but you must escape any characters that result in illegal HTML. This would include: < is < is >
& is & So a two-line display would bex: {x}<br/>y: {y} Fusion. Widget. EditableScaleThe user can manually type in a new scale Fusion. Widget. ExtentHistoryMaintain and navigate through a history of extents Fusion. Widget. FeatureInfoThe FeatureInfo widget displays information about selected polygons. If the Target property points to TaskPane widget, the task will be listed in the menu list of the TaskPane and loaded there. Otherwise if the target is an existing IFrame in the page it will be loaded there, otherwise it will open a new window with that name. Fusion. Widget.HelpDisplay a user help page. Fusion. Widget. InitialMapViewRestore the map to it’s full extents determined when it was initially loaded. Fusion. Widget. InvokeScriptExecutes an arbitrary piece of JavaScript code Fusion. Widget. InvokeURLA widget that will open the configured URL in the target element. If the Target property points to TaskPane widget, the task will be listed in the menu list of the TaskPane and loaded there. Otherwise if the target is an existing HTML elementt in the page it will be loaded there, otherwise it will open a new window with that name. Fusion. Widget. LayerManagerDisplays a LayerManager of all the layers in the map as a collapsable tree. ShowRootFolder (boolean, optional) This controls whether the tree will have a single root node that contains the name of the map as its label. By default, the root node does not appear. Set to “true” or “1” to make the root node appear. RootFolderIcon: (string, optional) The url to an image to use for the root folder. This only has an affect if ShowRootFolder is set to show the root folder. LayerThemeIcon: (string, optional) The url to an image toTopography use for layers that are currently themed. DisabledLayerIcon: (string, optional) The url to an image to use for layers that are out of scale. Fusion. Widget. LegendA widget to display a legend of all layers. Summary | | | {String} The default image for DWF layer | | {String} The default image for Raster layer | | {String} The default image for layers that are currently themed. | | {String} The default image for layers that are out of scale. | | {String} The default image for the root folder | | {String} The default image for layer info | | {String} The default image for groupd info |
defaultLayerDWFIcon{String} The default image for DWF layer defaultLayerRasterIcon{String} The default image for Raster layer defaultLayerThemeIcon{String} The default image for layers that are currently themed. defaultDisabledLayerIcon{String} The default image for layers that are out of scale. defaultRootFolderIcon{String} The default image for the root folder defaultLayerInfoIcon{String} The default image for layer info defaultGroupInfoIcon{String} The default image for groupd info Fusion. Widget. Legend. LegendRendererThis is a class designed to help users to create their own renderer for customize the legend. Summary | | | | | {Groups} The groups of all layers. | | | | Abstract method that have the main purpose to draw the legend. | | Abstract method that handle the event: Fusion.Event.MAP_LOADED. | | Abstract method that handle the event: Fusion.Event.MAP_RELOADED. | | Helper method to obtains the map. |
layerRoot{Groups} The groups of all layers. renderLegendAbstract method that have the main purpose to draw the legend. This method should be implemented by all concrete class. mapLoadedAbstract method that handle the event: Fusion.Event.MAP_LOADED. This method occur only at the first load of the map and should be implemented by all concrete class. mapReloadedAbstract method that handle the event: Fusion.Event.MAP_RELOADED. This method should be implemented by all concrete class. getMapHelper method to obtains the map. Returns{<Fusion.Maps>} The map that uses the SelectionPanel Widget. Fusion. Widget. Legend. LegendRendererDefaultThis class provide a default legend as a collapsable tree. Summary | | | {Boolean} This controls whether the tree will have a single root node that contains the name of the map as its label. | | {Jx.TreeNode} The current selected node. | | {Boolean} Determine if the map is drawn. | | {Jx.TreeFolder} The current TreeFolder that the mouse will interact with. | | {Boolean} Determine if non-visible layer must be draw in the legend. |
showRootFolder{Boolean} This controls whether the tree will have a single root node that contains the name of the map as its label. By default, the root node does not appear. Set to “true” or “1” to make the root node appear. currentNode{Jx.TreeNode} The current selected node. bIsDrawn{Boolean} Determine if the map is drawn. targetFolder{Jx.TreeFolder} The current TreeFolder that the mouse will interact with. bIncludeVisToggle{Boolean} Determine if non-visible layer must be draw in the legend. Fusion. Widget. LinkToViewA widget that displays a link to the currently displayedd map view. Fusion. Widget. MapMenuA widget that displays a selection of maps that can be loaded into the application. The list of maps is configured in the ApplicationDefinition. Fusion. Widget. MaptipDisplays tooltips over the map when the mouse is hovered for some time. You must configure tooltips for each layer using Studio or Web Studio by editing the LayerDefinition Settings and specifying an expression for the tooltip. Delay (optional) This is the delay, in milliseconds, that the user must keep the mouse in the same position in order for the maptip to appear. The default, if not specified, is 350 milliseconds. Layer (optional, multiple) This is the name of a layer from the MapDefinition to get the tooltip from. If no Layer elements are specified, then all layers will be queried and the top-most one will be displayed. Multiple Layer tags can be added, allowing tooltips to come from different layers. Fusion. Widget. MeasureThe Measure widget allows the user to measure distances or areas on the map in one or more segments. Area is positive if measured clockwise. Fusion. Widget. NavigatorA widget that immplements an in-map navigation control with zoom and pan. Fusion. Widget. OverviewMapA widget that displays an overview map showing the current view of the primary map. Fusion. Widget.PanA widget that allows for naviagtion by panning Fusion. Widget. PanOnClickPans the map a fixed amount in a particular direction Fusion. Widget. PanQueryA widget that combines pan and query functionality. If the mouse is moved before being released, a pan is performedd, otherwise a query is executed. Fusion. Widget. QueryThe Query widget prompts the user for some inputs and then executes a query on the map. If the Target property points to TaskPane widget, the task will be listed in the menu list of the TaskPane and loaded there. Otherwise if the target is an existing IFrame in the page it will be loaded there, otherwise it will open a new window with that name. Fusion. Widget. RedlineAllows the user to create a temporary OpenLayers Vector layer and draw POINT, LINE and POLYGON features on that layer. Fusion. Widget. RefreshMapRefreshes the current map view without changing zoom or center. Fusion. Widget. SaveMapSave the current map image on the client’s computer usageDWF format support requires a structure like this in the application definition’s widget tag extension: <Extension> <Format></Format> <ResourceId></ResourceId> <Scale></Scale> </Extension> Fusion. Widget. ScalebarDualA dynamically generated cartographic scalebar that looks like the Google scalebar Fusion. Widget. SearchA widget that displays a pre-configured search form to the user and then runs the search. Searches are done on the attributes of specifiedd layers. uses JavaScript Scale Bar for MapServer (http://mapserver.commenspace.org/tools/scalebar/ Fusion. Widget. Selectperform a selection on map features Fusion. Widget. SelectPolygonperform a selection using a polygon Fusion. Widget. SelectRadiusperform a selection by radius from a point Fusion. Widget. SelectRadiusValueA widget to allow the user to specify the radius to use for a SelectRadius widget. Fusion. Widget. SelectWithinA widget to perform a selection within a currently selected set of features. Fusion. Widget. SelectionInfoDisplays the number of features and number of layers in the current selection. Template (string, optional) The format of the output string. Use {layers} and {features} as placeholders for the number of layers and features in the current selection. You can embed HTML in the template, but you must escape any characters that result in illegal HTML. This would include: < is < is >
& is & Fusion. Widget. SelectionPanelA widget to display information about the currently selected set of features. Summary | | | {String} The default image for Previous page button. | | {String} The default image for Previous page button. |
previousIcon{String} The default image for Previous page button. nextIcon{String} The default image for Previous page button. Fusion. Widget. SelectionPanel. SelectionRendererThis is a class designed to help users to create their own renderer for customize display results. Summary | | | | | {Array(int)} The index of the current position for pagination. | | {int} The number of results per page for pagination. | | | | | | Helper method to update the aiCurrentIndex array for pagination. | | Get the next batches of features. | | Get the previous batches of features. | | Helper method to obtains the map. | | Get a batches of features in a selection. | | Abstract method that handle the event: Fusion.Event.MAP_SELECTION_ON. | | Abstract method that handle the event: Fusion.Event.MAP_SELECTION_OFF. |
aiCurrentIndex{Array(int)} The index of the current position for pagination. iResultsPerPage{int} The number of results per page for pagination. Fusion. Widget. SelectionPanel. SelectionRendererupdateSelectionObjectHelper method to update the aiCurrentIndex array for pagination. getNextPage| getNextPage: function( | selectionLayer | ) |
|
Get the next batches of features. Wrapper of the getPage() method. This method calcul the startIndex/endIndex of the next batch. Parameters| selectionLayer | {<Fusion.SelectionObject.Layer>} The layer that contains the set of features. |
Returns{Array(Array)} An array of all features with their properties. getPreviousPage| getPreviousPage: function( | selectionLayer | ) |
|
Get the previous batches of features. Wrapper of the getPage() method. This method calcul the startIndex/endIndex of the previous batch. Parameters| selectionLayer | {<Fusion.SelectionObject.Layer>} The layer that contains the set of features. |
Returns{Array(Array)} An array of all features with their properties. getMapHelper method to obtains the map. Returns{<Fusion.Maps>} The map that uses the SelectionPanel Widget. getPage| getPage: function( | selectionLayer, | | startIndex, | | endIndex | ) |
|
Get a batches of features in a selection. Parameters| selectionLayer | {<Fusion.SelectionObject.Layer>} The layer that contains the set of features. | | startIndex | {int} The index of the first element. | | endIndex | {int} The index of the last element. |
Returns{Array(Array)} An array of all features with their properties. updateSelection| updateSelection: function() |
Abstract method that handle the event: Fusion.Event.MAP_SELECTION_ON. This method should be implemented by all concrete class. clearSelection| clearSelection: function() |
Abstract method that handle the event: Fusion.Event.MAP_SELECTION_OFF. This method should be implemented by all concrete class. Fusion. Widget. SelectionPanel. SelectionRendererDefaultThis class provide a default behavior for the selection panel. Fusion. Widget. SelectionPanel. SelectionRendererHorizontalThis class provide a alternate behavior for the selection panel. Generate a table which have one feature per row. Fusion. Widget. TaskPaneA utility widget that holds output from other widgets. Fusion. Widget. ThemeThe Theme widget prompts the user for some inputs and then creates a new themed layer based on one of the existing map layers. If the Target property points to TaskPane widget, the task will be listed in the menu list of the TaskPane and loaded there. Otherwise if the target is an existing IFrame in the page it will be loaded there, otherwise it will open a new window with that name. Fusion. Widget. ViewOptionsA widget to allow selection of the display units for various widgets Fusion. Widget. ViewSizeDisplay the size of the current view in user-definable units Fusion. Widget.ZoomA widget that will zoom the map in or out. Fusion. Widget. ZoomOnClickZoom the map by a fixed amount when a button is clicked Fusion. Widget. ZoomToSelectionZoom to the current selection, if any Fusion. Layers. GenericImplements the map layer for Generic mapping services. Fusion. Layers. MapGuideImplements the map widget for MapGuide Open Source services. Summary | | | This function should be called after the map has loaded. | | Returns an OpenLayers MapGuide layer object | | Returns the MapGuide layer object as identified by the layer name | | Returns the MapGuide layer object as identified by the layer unique id |
loadScaleRanges| loadScaleRanges: function( | userFunc | ) |
|
This function should be called after the map has loaded. It loads the scsle ranges for each layer. I tis for now only used by the legend widget. createOLLayer| createOLLayer: function( | layerName, | | bSingleTile, | | behavior, | | forceAsOverlay | ) |
|
Returns an OpenLayers MapGuide layer object getLayerByName| getLayerByName : function( | name | ) |
|
Returns the MapGuide layer object as identified by the layer name getLayerById| getLayerById : function( | id | ) |
|
Returns the MapGuide layer object as identified by the layer unique id Fusion. Layers. MapServerImplementation of the map widget for MapServer CGI interface services Summary | | | This function should be called after the map has loaded. |
loadScaleRanges| loadScaleRanges: function( | userFunc | ) |
|
This function should be called after the map has loaded. It loads the scsle ranges for each layer. I tis for now only used by the legend widget. |
