Class Mapserv

Object
   |
   +--Mapserv

class Mapserv

This is the basic Mapserv class.
Defined in mapserv.js

Field Detail

cellsize

Double cellsize

calculated length of a pixel side in map units.

defaultextent

Array defaultextent

the extent that was passed to this Mapserv instance at construction.

drawHandler

Object drawHandler

extent

Array extent

a four-member array of Doubles defining the rectangular extent of the map (in map coordinates).
• extent[0] - minimum x map coordinate
• extent[1] - minimum y map coordinate
• extent[2] - maximum x map coordinate
• extent[3] - maximum y map coordinate

height

Integer height

the height of the map image (in pixels).

inchesPerMapUnit

Float inchesPerMapUnit

number of inches in the current map unit.

default: 39.3701 (inches in a meter)

layers

Array layers

an associative array of layer status, keyed by layer name; values are booleans.

mapfile

String mapfile

the MapServer configuration file for map draws.

mapserver

String mapserver

the url for the MapServer executable that will create maps.

maxscale

Integer maxscale

maximum scale to allow for map draws.

value used is denominator of the representative fraction (1:x)

value of -1 indicates no maximum

minscale

Integer minscale

minimum scale to allow for map draws.

value used is denominator of the representative fraction (1:x)

value of -1 indicates no minimum

mode

String mode

mode in which the MapServer executable will be called.

Valid values are map, query and nquery although it is certainly possible to create more complex queries outside of the Mapserv object.

options

String options

a url query string ("&this=that&some=other") used to pass any application-specific options for a map draw operation that are not covered in the draw() method.

pansize

Float pansize

amount by which to move the map in automatic pan operations.

0 < pansize < 1

pixelsPerInch

Integer pixelsPerInch

a value used in scale calculations.

default: 72 (typical monitor resolution)

point

Array point

a two-member array of Doubles defining a point of interest (in map coordinates) to the current operation (typically from a user's mouse click).
• point[0] is x
• point[1] is y

queryextent

Array queryextent

a four-member array of Doubles defining a rectangular extent (in map coordinates) for a query operation.
• queryextent[0] is minimum x
• queryextent[1] is minimum y
• queryextent[2] is maximum x
• queryextent[3] is maximum y

queryfile

String queryfile

the MapServer configuration file for query operations.

queryHandler

Object queryHandler

queryoptions

String queryoptions

a url query string ("&this=that&some=other") used to store any application-specific options for a query operation that are not covered in the query() method.

querypoint

Array querypoint

a two-member array of Doubles defining a point of interest (in image coordinates) to the current query operation (typically from a user's mouse click).
• querypoint[0] is x
• querypoint[1] is y

queryserver

String queryserver

the url for the MapServer executable that will handle queries.

referencemap

Mapserv referencemap

a reference map object.

url

String url

a complete url for a map draw or query operation.

width

Integer width

the width of the map image (in pixels).

zoomdir

Integer zoomdir

direction of zoom.
• -1 = out
• 0 = none (pan)
• 1 = in

zoomsize

Object zoomsize

the zoom factor to be applied on zoom-in operations (the inverse is taken for zoom-out operations).

Mapserv

Mapserv(<String> mapserver, <String> mapfile, <Double> minx, <Double> miny, <Double> maxx, <Double> maxy, <Integer> width, <Integer> height)

Construct a new Mapserv object.

Parameters:
mapserver - The url for the MapServer instance that will create maps.
mapfile - The mapfile to be used.
minx - The minimum x coordinate for the initial (default) map extent.
miny - The minimum y coordinate for the initial (default) map extent.
maxx - The maximum x coordinate for the initial (default) map extent.
maxy - The maximum y coordinate for the initial (default) map extent.
width - The width (in pixels) of the maps to be created.
height - The height (in pixels) of the maps to be created.

Returns:
A new mapserv object

applyBox

void applyBox(<Integer> minx, <Integer> miny, <Integer> maxx, <Integer> maxy)

convert a box defined in image coordinates to an extent defined in map coordinates and store in the extent field.

Parameters:
minx - minimum x image coordinate
miny - minimum y image coordinate
maxx - maximum x image coordinate
maxy - maximum y image coordinate

applyBoxQuery

void applyBoxQuery(<Integer> minx, <Integer> miny, <Integer> maxx, <Integer> maxy)

construct a four-member query extent array in image coordinates and store in the queryextent field.

Parameters:
minx - minimum x image coordinate
miny - minimum y image coordinate
maxx - maximum x image coordinate
maxy - maximum y image coordinate

applyPointQuery

void applyPointQuery(<Integer> x,<Integer> y)

construct a two-member query point array in image coordinates and store in the querypoint field.

Parameters:
x - image coordinate x value
y - image coordinate y value

applyReference

void applyReference(<Integer> x,<Integer> y)

calculate a new map extent to be centered on an image coordinate from the reference map image, and store in the extent field.

Parameters:
x - reference map image coordinate x value
y - reference map image coordinate y value

applyZoom

void applyZoom(<Integer> x, <Integer> y)

calculate a new map extent based on zoomdir, zoomsize, and the passed point (in image coordinates), and store in the extent field.

Parameters:
x - image coordinate x
y - image coordinate y

draw

void draw()

construct a pair of urls (one for the main map and one for the reference map, if applicable) using the current settings of various fields, store them in the url and referencemap.url fields, respectively, and call the drawHandler.

Fields/methods used in assembling the url for the main map are:

• mapserver
• (map=) mapfile
• (mapext=) extent
• (mapsize=) width+height
• (layers=) getLayers()
• options

Fields/methods used in assembling the url for the reference map are:

• mapserver
• (map=) referencemap.mapfile
• (mapext=) extent
• (mapsize=) width+height

getLayers

String getLayers(delimeter)

Get the list of currently active layers.

Parameters:
delimiter - the character(s) to use to delimit the returned list

Returns:
A delimited string of active layers

getScale

Double getScale()

get the nominal scale based on current settings.

Returns:
scale the nominal scale

imageToMap

void imageToMap(<Integer> x, <Integer> y)

convert an image coordinate pair to a map coordinate pair, and store in the point field.

Parameters:
x - the x image coordinate
y - the y image coordinate

layersOff

void layersOff()

Set draw/query status for all layers to off.

pan

void pan(<Enumerated> direction)

pan map in the given direction, using the current pansize setting.

Parameters:
direction - direction to pan. Specified as a lowercase abbreviation of one of the eight cardinal/primary intercardinal directions:
• n
• ne
• e
• se
• s
• sw
• w
• nw

query

void query()

construct a query url using the current settings of various fields, store in the url field, and call the queryHandler.

Fields/methods used in assembling the url are:

• queryserver
• (mode=) mode
• (map=) queryfile
• (imgext=) extent
• (imgxy=) querypoint
• (imgbox=) queryextent
• (imgsize=) width height
• (layers=) getLayers()
• queryoptions

recenter

void recenter(<Double> x, <Double> y)

recenter the map at the given point, using the current scale.

Parameters:
x - map coordinate x value
y - map coordinate y value

setExtent

void setExtent(<Double> minx, <Double> miny, <Double> maxx, <Double> maxy)

set extent using the given values.

Parameters:
minx - minimum x coordinate
miny - minimum y coordinate
maxx - maximum x coordinate
maxy - maximum y coordinate

setExtentFromScale

void setExtentFromScale(<Double> x, <Double> y, <Integer> scale)

set extent centered on the given point using the given scale.

Parameters:
x - map coordinate x value
y - map coordinate y value
scale - desired scale, given as denominator of the representative fraction (1:x)

setHandler

void setHandler(<Enumerated> type, <Function> handler)

set a handler function for draw/query operations.

Parameters:
type - constant for handler type to be set. Valid type values are:
• MAPSERV_DRAW (0)
• MAPSERV_QUERY (1)
handler - function to be called

See:
- drawhandler
- queryhandler

setLayer

void setLayer(<String> name, <Boolean> status)

set the draw/query status of a layer.

Parameters:
name - The name of the layer to set status for
status - 0/false - off; 1/true - on

setUnits

void setUnits(<Enumerated> type)

set the map units.

Parameters:
type - constant for desired units type. Valid type values are:
• MAPSERV_UNITS_METERS (0)
• MAPSERV_UNITS_FEET (1)
• MAPSERV_UNITS_MILES (2)
• MAPSERV_UNITS_KILOMETERS (3)
• MAPSERV_UNITS_DD (4)

zoomDefault

void zoomDefault()

redraw the map at the default extent.

See:
- defaultextent

zoomIn

void zoomIn(<Double> x,<Double> y)

zoom in centered on the given point, using the current zoomsize setting.

Parameters:
x - map coordinate x value
y - map coordinate y value

zoomOut

void zoomOut(<Double> x,<Double> y)

zoom out centered on the given point, using the inverse of the current zoomsize setting.

Parameters:
x - map coordinate x value
y - map coordinate y value

zoomRadius

void zoomRadius(<Double> x, <Double> y, <Double> radius)

draw a new map centered on the given point, with an extent that minimally fits the circle defined by the point and supplied radius.

Parameters:
x - map coordinate x value
y - map coordinate y value
radius - desired distance from given point to edge of map

zoomScale

void zoomScale(<Double> x, <Double> y, <Integer> scale)

recenter the map at the given point, using the given scale.

Parameters:
x - map coordinate x value
y - map coordinate y value
scale - desired scale, given as denominator of the representative fraction (1:x)