edu.ucdavis.cstars.client.dijits

Class Scalebar

java.lang.Object

edu.ucdavis.cstars.client.dijits.Scalebar

public class Scalebar
extends java.lang.Object

The scalebar widget displays a scalebar on the map or in a specified HTML node. The widget respects various coordinate systems and displays units in english or metric values. When working with Web Mercator or geographic coordinate systems the scalebar takes into account projection distortion and dynamically adjusts the scalebar. The Scalebar sample,which uses a map using the Web Mercator projection, shows this behavior. Open the sample and note that as you pan the map south towards the equator the scalebar gets shorter and as you pan north it gets longer. The location of the scalebar is used to calculate the scale, when the scalebar is positioned outside the map div the following values are used: - If the scalebar is above the map,the upper border of the map is used. - If the scalebar is below the map,the lower border of the map is used. - If the scalebar is positioned next to the map its vertical location is used.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scalebar.AttachTo
static class	Scalebar.Parameters
static class	Scalebar.ScalebarUnit

Constructor Summary

Constructors

Constructor and Description
Scalebar(Scalebar.Parameters params) Creates a new Scalebar dijit.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	assertLoaded() Check that the esri.dijit.Scalebar package has been loaded
void	hide() Hide the scalebar dijit.
void	show() Set the scalebar's visibility to true.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Scalebar

public Scalebar(Scalebar.Parameters params)

Creates a new Scalebar dijit. The Scalebar constructor should be called after the map is loaded, e.g., in the map's onLoad event.

Parameters:

params - - Parameters used to configure the widgit.

Method Detail

assertLoaded

public static boolean assertLoaded()

Check that the esri.dijit.Scalebar package has been loaded

Returns:

boolean

hide

public void hide()

Hide the scalebar dijit.

show

public void show()

Set the scalebar's visibility to true. This method only applies if the scalebar has been hidden using scalebar.hide.