Global - Documentation

Members

(private, constant) featureTypeToRenderer

Source:

layer.js, line 22

Properties:

Name	Type	Description
`featureTypeToRenderer`	Object

Maps GeoJSON geometry types to a set of default renders defined in GlobalStorage.DefaultRenders

(constant) serviceType

Source:

layer.js, line 35

Properties:

Name	Type	Description
`serviceType`	Object

Different types of services that a URL could point to

Methods

(private) _addLine(path, spatialReference, id, opts)

Source:

layer/layerRec/graphicsRecord.js, line 373

Add a line where specified using the path of longitutes and latitutes.

Parameters:

Name	Type	Description
`path`	Array	an array of long and lat to use as the path for the line
`spatialReference`	Object	the projection the graphics should be in
`id`	String	id of api geometry being added to map
`opts`	Object	options to apply to line

(private) _addMultiLine(paths, spatialReference, id, opts)

Source:

layer/layerRec/graphicsRecord.js, line 408

Add multiple lines where specified using the path of longitutes and latitutes.

Parameters:

Name	Type	Description
`paths`	Array	a 3D array of long and lat to use as the paths for the lines
`spatialReference`	Object	the projection the graphics should be in
`id`	String	id of api geometry being added to map
`opts`	Object	options to apply to lines

(private) _addMultiPoint(coords, spatialReference, icon, id, opts)

Source:

layer/layerRec/graphicsRecord.js, line 321

Add multiple points where specified using the longitutes and latitutes.

Parameters:

Name	Type	Description
`coords`	Array	a 3D array of long and lat to use as the graphic location for each point
`spatialReference`	Object	the projection the graphics should be in
`icon`	String	data / image url or svg path for layer icon. defaults to a green point
`id`	String	id of api geometry being added to map
`opts`	Object	options to apply to points

(private) _addPoint(coords, spatialReference, icon, id, opts)

Source:

layer/layerRec/graphicsRecord.js, line 265

Add a point where specified using longitute and latitute.

Parameters:

Name	Type	Description
`coords`	Object	the long and lat to use as the graphic location
`spatialReference`	Object	the projection the graphics should be in
`icon`	String	data / image url or svg path for layer icon. defaults to a red point
`id`	String	id of api geometry being added to map
`opts`	Object	options to apply to point

(private) _addPolygon(rings, spatialReference, id, opts)

Source:

layer/layerRec/graphicsRecord.js, line 443

Add a polygon where specified using the rings provided.

Parameters:

Name	Type	Description
`rings`	Array	an array of rings containing an array of coordinates
`spatialReference`	Object	the projection the graphics should be in
`id`	String	id of api geometry being added to map
`opts`	Object	settings such as color and opacity for the polygon

(private) _attribsAdded(idx, attribs)

Source:

layer/layerRec/layerRecord.js, line 149

Reacts to a layer downloading attributes.

Parameters:

Name	Type	Description
`idx`	String	the index of the layer whose attributes were downloaded
`attribs`	Object	the layer attributes downloaded

(private) _fireEvent(handlerArray, …eventParams)

Source:

layer/layerRec/root.js, line 27

Utility for triggering an event and giving it to the listeners

Parameters:

Name	Type	Attributes	Description
`handlerArray`	Array		array of event handler functions
`eventParams`	Object	<repeatable>	arbitrary set of parameters to pass to the event handler functions

(private) _isUrl(text) → {Boolean}

Source:

layer/layerRec/graphicsRecord.js, line 489

Check to see if text provided is a valid image / data URL based on extension type or format.

Parameters:

Name	Type	Description
`text`	String	string to be matched against valid image types / data url format

Returns:

true if valid image extension

Type: Boolean

(private) _listToSymbology(conversionFunction, list) → {Array}

Source:

symbology.js, line 386

Converts a config-supplied list of symbology to the format used by layer records.

Parameters:

Name	Type	Description
`conversionFunction`	function	a conversion function to wrap the supplied image into an image or an icon style symbology container
`list`	Array	a list of config-supplied symbology items in the form of [ { text: , image: }, ... ] wher `image` can be dataURL or an actual url

Returns:

an array of converted symbology symbols in the form of [ { name: , image: , svgcode: }, ... ]; items will be populated async as conversions are done

Type: Array

(private) _stateChange(newState)

Source:

layer/layerRec/layerRecord.js, line 108

Reacts to a layer-level state change.

Parameters:

Name	Type	Description
`newState`	String	the state the layer has now become

(private) _zoomToScaleSet(map, lods, zoomIn, scaleSet, positionOverLayer) → {Promise}

Source:

layer/layerRec/layerRecord.js, line 380

Figure out visibility scale and zoom to it. Will use layer minScale/maxScale and map levels of detail to determine scale boundaries.

Parameters:

Name	Type	Description
`map`	Object	the map object
`lods`	Array	level of details array for basemap
`zoomIn`	Boolean	the zoom to scale direction; true need to zoom in; false need to zoom out
`scaleSet`	Object	contains min and max scales for the layer
`positionOverLayer`	Boolean	ensures the map is over the layer's extent after zooming. only applied if zoomIn is true. defaults to true

Returns:

promise that resolves after map finishes moving about

Type: Promise

abortAttribLoad()

Source:

layer/layerRec/attribFC.js, line 92

Attempts to abort an attribute load in progress. Harmless to call before or after an attribute load.

abortAttribLoad()

Source:

layer/layerRec/featureRecord.js, line 192

Attempts to abort an attribute load in progress. Harmless to call before or after an attribute load.

addAttribListener(listenerCallback)

Source:

layer/layerRec/layerRecord.js, line 163

Wire up attrib added listener.

Parameters:

Name	Type	Description
`listenerCallback`	function	function to call when attributes download event happens

addGeometry(geo, spatialReference)

Source:

layer/layerRec/graphicsRecord.js, line 203

Identify the type of geometry being added and add it to the map.

Parameters:

Name	Type	Description
`geo`	Object \| Array	api geometry class to be added
`spatialReference`	Object	the projection the graphics should be in

addHilight(graphic, clearLayer)

Source:

hilight.js, line 98

Add a graphic or array of graphics to the highlight layer. Remove any previous graphics.

Parameters:

Name	Type	Description
`graphic`	Graphic \| Array	an ESRI graphic, or array of ESRI graphics. Should be in map spatialReference, and not bound to a layer
`clearLayer`	Boolean	indicates any previous graphics in the hilight layer should be removed. defaults to false

addHoverListener(listenerCallback)

Source:

layer/layerRec/layerRecord.js, line 188

Wire up mouse hover listener.

Parameters:

Name	Type	Description
`listenerCallback`	function	function to call when a hover event happens

addHoverListener(listenerCallback)

Source:

layer/layerRec/graphicsRecord.js, line 128

Wire up mouse hover listener.

Parameters:

Name	Type	Description
`listenerCallback`	function	function to call when a hover event happens

addPin(point, clearLayer)

Source:

hilight.js, line 82

Add a graphic to indicate where user clicked.

Parameters:

Name	Type	Description
`point`	Point	an ESRI point object to use as the graphic location
`clearLayer`	Boolean	indicates any previous graphics in the hilight layer should be removed. defaults to false

addStateListener(listenerCallback)

Source:

layer/layerRec/layerRecord.js, line 124

Wire up state change listener.

Parameters:

Name	Type	Description
`listenerCallback`	function	function to call when a state change event happens

aliasedFieldName(attribName, childIndex) → {Promise}

Source:

layer/layerRec/dynamicRecord.js, line 511

Get the best user-friendly name of a field. Uses alias if alias is defined, else uses the system attribute name.

Parameters:

Name	Type	Description
`attribName`	String	the attribute name we want a nice name for
`childIndex`	String	index of the child layer whos attributes we are looking at

Returns:

resolves to the best available user friendly attribute name

Type: Promise

allComb(M, N)

Source:

legend.js, line 14

Generate all permutations of length M, with exactly N true values.

Parameters:

Name	Type	Description
`M`	int	the size of the array (must be greater than 0)
`N`	int	the number of entries which should be true (must not be greater than M)

Returns:

an array containing all possible size M arrays of boolean values with N true entries

(private) allocateLayersToSections(layers, sectionsAvailable, mapHeight)

Source:

legend.js, line 213

Parameters:

Name	Type	Description
`layers`	Array	a list of layers to be updated (modified in place)
`sectionsAvailable`	int	the maximum number of sections to use
`mapHeight`	int	the rendered height of the map image

Returns:

the same layers array as passed in

(private) arrayBufferToString(buffer) → {String}

Source:

layer.js, line 462

Converts an array buffer to a string

Parameters:

Name	Type	Description
`buffer`	Arraybuffer	an array buffer containing stuff (ideally string-friendly)

Returns:

array buffer in string form

Type: String

assignIds()

Source:

layer.js, line 801

Performs in place assignment of integer ids for a GeoJSON FeatureCollection. If at least one feature has an existing id outside the geoJson properties section, the original id value is copied in a newly created property ID_FILE of the properties object and the existing id value is replaced by an autogenerated number. Features without existing id from that same dataset will get a new properties ID_FILE with an empty string as value.

If at least one feature has an existing OBJECTID inside the geoJson properties section, the original OBJECTID value is copied in a newly created property OBJECTID_FILE of the properties object and the existing OBJECTID value is replaced by an autogenerated number. Features without existing OBJECTID from that same dataset will get a new properties OBJECTID_FILE with an empty string as value.

(private) assignLayerSplits(layers, splitPoints)

Source:

legend.js, line 42

Convenience function for assigning the splitBefore property on layers at specified points. NOTE: this function modifies data in place

Parameters:

Name	Type	Description
`layers`	Array	a list of layers to be updated (modified in place)
`splitPoints`	Array	an array of boolean values indicating if the layer list should be split at that point (must be layers.length-1 in size)

Returns:

layers the same array as passed in

attribsLoaded() → {Boolean}

Source:

layer/layerRec/attribFC.js, line 72

Indicates if attributes have been downloaded for this FC.

Returns:

true if attributes are downloaded.

Type: Boolean

bindEvents(layer)

Source:

layer/layerRec/graphicsRecord.js, line 108

Attach record event handlers to common layer events

Parameters:

Name	Type	Description
`layer`	Object	the api layer object

bindEvents(layer)

Source:

layer/layerRec/layerRecord.js, line 72

Attach record event handlers to common layer events

Parameters:

Name	Type	Description
`layer`	Object	the api layer object

checkDateType(attribName, childIndex) → {Promise}

Source:

layer/layerRec/dynamicRecord.js, line 565

Check to see if the attribute in question is an esriFieldTypeDate type.

Parameters:

Name	Type	Description
`attribName`	String	the attribute name we want to check if it's a date or not
`childIndex`	String	index of the child layer whos attributes we are looking at

Returns:

resolves to true or false based on the attribName type being esriFieldTypeDate

Type: Promise

checkProj(spatialReference, epsgLookup) → {Object}

Source:

proj.js, line 166

Check whether or not a spatialReference is supported by proj4 library.

Parameters:

Name	Type	Description
`spatialReference`	Object	to be checked to see if it's supported by proj4. Can be ESRI SR object or a EPSG string.
`epsgLookup`	function	an optional lookup function for EPSG codes which are not loaded in the proj4 definitions, the function should take a numeric EPSG code and return a Promise resolving with a proj4 style definition string

Returns:

with the structure { foundProj: (bool) indicates if the projection was found without a web lookup, message: (string) provides a reason why the projection was not found, lookupPromise: (Promise) an promise resolving after any web lookups. Resolves with true or false overall success. }

Type: Object

(private) cleanRenderer(renderer, fields) → {Object}

Source:

symbology.js, line 186

Will inspect the field names in a renderer and adjust any mis-matched casing to align with the layer field definitions

Parameters:

Name	Type	Description
`renderer`	Object	a layer renderer in json format
`fields`	Array	list of field objects for the layer

Returns:

the renderer with any fields adjusted with proper case

Type: Object

cleanUpAttribs()

Source:

layer/layerRec/layerRecord.js, line 564

Deletes any pre-loaded attributes when the layer automatically refreshes to ensure up-to-date attributes are loaded next time

cleanUpFields(geoJson, layerDefinition)

Source:

layer.js, line 863

Rename any fields with invalid names. Both parameters are modified in place.

Parameters:

Name	Type	Description
`geoJson`	Object	layer data in geoJson format
`layerDefinition`	Object	layer definition of feature layer not yet created

clearHilight()

Source:

hilight.js, line 115

Remove hilight from map

(private) clipExtentCoords(mid, max, min, mapMax, mapMin, len) → {Array}

Source:

map/esriMap.js, line 327

Compares to sets of co-ordinates for extents (valid for both x and y). If center of input co-ordinates falls outside map co-ordiantes, function will adjust them so the center is inside the map co-ordinates.

Parameters:

Name	Type	Description
`mid`	Numeric	middle of the the range to test
`max`	Numeric	maximum value of the range to test
`min`	Numeric	minimum value of the range to test
`mapMax`	Numeric	maximum value of the map range
`mapMin`	Numeric	minimum value of the map range
`len`	Numeric	length of the adjusted range, if adjusted

Returns:

two element array of Numeric, containing result max and min values

Type: Array

constructLayer() → {Object}

Source:

layer/layerRec/layerRecord.js, line 96

Generates a new api layer object.

Returns:

the new api layer object.

Type: Object

convertImageToCanvas(url, canvas, crossOrigin) → {Promise}

Source:

shared.js, line 55

Convert an image to a canvas element

Parameters:

Name	Type	Default	Description
`url`	String		image url to convert (result from the esri print task)
`canvas`	Object	`null`	[optional = null] canvas to draw the image upon; if not supplied, a new canvas will be made
`crossOrigin`	Boolean	`true`	[optional = true] when set, tries to fetch an image with crossOrigin = anonymous

Returns:

conversion promise resolving into a canvas of the image

Type: Promise

convertImagetoDataURL(imageUri, imageType) → {Promise}

Source:

shared.js, line 84

Loads an image (as crossing) and converts it to dataURL. If a supplied imageUri is already a dataURL, just return it. If an image fails to load with the crossing attribute, return the original imageUri

Parameters:

Name	Type	Description
`imageUri`	String	url of the image to load and convert
`imageType`	String	[optional = 'image/png'] format of the image representation

Returns:

promise resolving with the dataURL of the image

Type: Promise

(private) crawlLayerInfos(layerInfos, urlMap)

Source:

layer/ogc.js, line 182

Recursively crawl a wms layer info structure. Store any legends in the provided map object.

Parameters:

Name	Type	Description
`layerInfos`	Array	array of ESRI WMSLayerInfo objects
`urlMap`	Map	a Map of sublayer names to legend urls

(private) createAttribSet(oidField, featureData) → {Object}

Source:

attribute.js, line 160

Will generate attribute package with object id indexes

Parameters:

Name	Type	Description
`oidField`	String	field containing object id
`featureData`	Array	feature objects to index and return

Returns:

object containing features and an index by object id

Type: Object

createBasemap(esriBundle, basemapConfig) → {Object}

Source:

map/basemap.js, line 46

Create a basemap object using the config settings provided.

Parameters:

Name	Type	Description
`esriBundle`	Object	ESRI modules from the initial startup
`basemapConfig`	Object	basemap settings in the form { id: string, layers: [string], title: string, thumbnailUrl: string, wkid: integer }

Returns:

a basemap object:

Type: Object

csvPeek(csvData, delimiter) → {Array}

Source:

layer.js, line 1119

Peek at the CSV output (useful for checking headers)

Parameters:

Name	Type	Description
`csvData`	string	the CSV data to be processed
`delimiter`	string	the delimiter used by the data

Returns:

an array of arrays containing the parsed CSV

Type: Array

dataSource() → {String}

Source:

layer/layerRec/featureRecord.js, line 175

Indicates if the layer is file based, WFS, or esri based.

Returns:

'file' if file layer, 'wfs' if WFS, else 'esri'

Type: String

dataSource() → {String}

Source:

layer/layerRec/wmsRecord.js, line 132

Indicates the layer is WMS based.

Returns:

'wms' since WMS based layer

Type: String

dataSource()

Source:

layer/layerRec/layerRecord.js, line 292

Indicates if layer is file based, WMS, WFS, or esri based.

enforceBoundary(extent, maxExtent) → {Object}

Source:

map/esriMap.js, line 351

Checks if the center of the given extent is outside of the maximum extent. If it is, will determine an adjusted extent with a center inside the maximum extent. Returns both an indicator flag if an adjustment happened, and the adjusted extent.

Parameters:

Name	Type	Description
`extent`	Object	an ESRI extent to test
`maxExtent`	Object	an ESRI extent indicating the boundary of the map

Returns:

an object with two properties. adjusted - boolean, true if extent was adjusted. newExtent - object, adjusted ESRI extent

Type: Object

enhanceRenderer(renderer, legend) → {Promise}

Source:

symbology.js, line 123

Will add extra properties to a renderer to support images. New properties .svgcode and .defaultsvgcode contains image source for app on each renderer item.

Parameters:

Name	Type	Description
`renderer`	Object	an ESRI renderer object in server JSON form. Param is modified in place
`legend`	Object	object for the layer that maps legend label to data url of legend image

Returns:

resolving when the renderer has been enhanced

Type: Promise

extractFields()

Source:

layer.js, line 849

Extracts fields from the first feature in the feature collection, does no guesswork on property types and calls everything a string.

fetchGraphic(childIndex, objId, opts) → {Promise}

Source:

layer/layerRec/dynamicRecord.js, line 534

Fetches a graphic from the given child layer. Will attempt local copy (unless overridden), will hit the server if not available.

Parameters:

Name Type Description

childIndex

String

index of the child layer to target

objId

Integer

ID of object being searched for

opts

Object

object containing option parametrs

            - map           map wrapper object of current map. only required if requesting geometry
            - geom          boolean. indicates if return value should have geometry included. default to false
            - attribs       boolean. indicates if return value should have attributes included. default to false

Returns:

resolves with a bundle of information. .graphic is the graphic; .layerFC for convenience

Type: Promise

fetchGraphic(objId, opts) → {Promise}

Source:

layer/layerRec/attribRecord.js, line 92

Fetches a graphic for the given object id. Will attempt local copy (unless overridden), will hit the server if not available.

Parameters:

Name Type Description

Name	Type	Description
`objId`	Integer	ID of object being searched for
`opts`	Object	object containing option parametrs `- map map wrapper object of current map. only required if requesting geometry - geom boolean. indicates if return value should have geometry included. default to false - attribs boolean. indicates if return value should have attributes included. default to false`

objId

Integer

ID of object being searched for

opts

Object

object containing option parametrs

            - map           map wrapper object of current map. only required if requesting geometry
            - geom          boolean. indicates if return value should have geometry included. default to false
            - attribs       boolean. indicates if return value should have attributes included. default to false

Returns:

resolves with a bundle of information. .graphic is the graphic; .layerFC for convenience

Type: Promise

fetchGraphic(objectId, opts) → {Promise}

Source:

layer/layerRec/attribFC.js, line 295

Fetches a graphic from the given layer. Will attempt local copy (unless overridden), will hit the server if not available.

Parameters:

Name Type Description

Name	Type	Description
`objectId`	Integer	ID of object being searched for
`opts`	Object	object containing option parametrs `- map map wrapper object of current map. only required if requesting geometry - geom boolean. indicates if return value should have geometry included. default to false - attribs boolean. indicates if return value should have attributes included. default to false`

objectId

Integer

ID of object being searched for

opts

Object

object containing option parametrs

            - map           map wrapper object of current map. only required if requesting geometry
            - geom          boolean. indicates if return value should have geometry included. default to false
            - attribs       boolean. indicates if return value should have attributes included. default to false

Returns:

resolves with a bundle of information. .graphic is the graphic; .layerFC for convenience

Type: Promise

filterifyRenderer(renderer, fields)

Source:

symbology.js, line 30

Will add extra properties to a renderer to support filtering by symbol. New property .definitionClause contains sql where fragment valid for symbol for app on each renderer item.

Parameters:

Name	Type	Description
`renderer`	Object	an ESRI renderer object in server JSON form. Param is modified in place
`fields`	Array	Optional. Array of field definitions for the layer the renderer belongs to. If missing, all fields are assumed as String

(private) findCandidates(rows, regular, range) → {Array}

Source:

layer.js, line 690

Find the suitable candidate fields that passes the regular expressions specified

Parameters:

Name	Type	Description
`rows`	Array	csv data
`regular`	RegExp	expression for the value of the field
`range`	Array	the range of the candidate cell values should be within. range[0] is the lower limit and range[1] is the upper limit.

Returns:

a list of suitable candidate fields

Type: Array

findClosestLOD(lods, scale) → {Object}

Source:

map/esriMap.js, line 237

Finds the level of detail closest to the provided scale.

Parameters:

Name	Type	Description
`lods`	Array	list of levels of detail objects
`scale`	Number	scale value to search for in the levels of detail

Returns:

the level of detail object closest to the scale

Type: Object

(private) findOptimalSplit(layer, splitCount)

Source:

legend.js, line 174

Find the optimal split points for the given layer.

Parameters:

Name	Type	Description
`layer`	Object	a layer object to be split into `splitCount` parts
`splitCount`	int	the number of pieces which the layer should be broken into

Returns:

a reference to the layer passed in

findZoomScale(lods, scaleSet, zoomIn) → {Object}

Source:

layer/layerRec/layerRecord.js, line 317

Figure out visibility scale. Will use layer minScale/maxScale and map levels of detail to determine scale boundaries.

Parameters:

Name	Type	Description
`lods`	Array	array of valid levels of detail for the map
`scaleSet`	Object	contains .minScale and .maxScale for valid viewing scales
`zoomIn`	Boolean	the zoom to scale direction; true need to zoom in; false need to zoom out

Returns:

a level of detail (lod) object for the appropriate scale to zoom to

Type: Object

fitInto(element, CONTAINER_SIZE)

Source:

symbology.js, line 855

Fits svg element in the size specified

Parameters:

Name	Type	Description
`element`	Ojbect	svg element to fit
`CONTAINER_SIZE`	Number	width/height of a container to fit the element into

generateLocalCanvas(map, options, canvas) → {Promise}

Source:

map/print.js, line 132

Create a canvas from the user added layers (svg tag)

Parameters:

Name	Type	Default	Description
`map`	Object		esri map object
`options`	Object	`null`	[optional = null] { width, height } values; needed to get canvas of a size different from default width {Number} height {Number}
`canvas`	Object	`null`	[optional = null] canvas to draw the image upon; if not supplied, a new canvas will be made

Returns:

resolving when the canvas have been created resolve with a canvas element with user added layer on it

Type: Promise

(private) generatePlaceholderSymbology(name, colour) → {Object}

Source:

symbology.js, line 477

Generates a placeholder symbology graphic. Returns a promise for consistency

Parameters:

Name	Type	Description
`name`	String	label symbology label
`colour`	String	colour to use in the graphic

Returns:

symbology svg code and its label

Type: Object

generateServerImage(esriBundle, map, options) → {Promise}

Source:

map/print.js, line 37

Generate the image from the esri print task

Parameters:

Name	Type	Description
`esriBundle`	Object	bundle of API classes
`map`	Object	esri map object
`options`	Object	options for the print task url - for the esri geometry server format - output format width - target image height if different from default height - target image width if different from default

Returns:

resolving when the print task created the image resolve with a "response: { url: value }" where url is the path for the print task export image

Type: Promise

generateUUID() → {String}

Source:

shared.js, line 28

Get a 'good enough' uuid. For backup purposes if client does not supply its own unique layer id

Returns:

a uuid

Type: String

generateWMSSymbology(name, imageUri) → {Promise}

Source:

symbology.js, line 354

Generates svg symbology for WMS layers.

Parameters:

Name	Type	Description
`name`	String	label for the symbology item (it's not used right now, but is required to be consistent with other symbology generating functions)
`imageUri`	String	url or dataUrl of the legend image

Returns:

a promise resolving with symbology svg code and its label

Type: Promise

geomToGraphic(geometry, symbol) → {Object}

Source:

hilight.js, line 10

Generating a graphic from server geometry.

Parameters:

Name	Type	Description
`geometry`	Object	feature geometry conforming to ESRI Geometry standard
`symbol`	Object	esri symbol in server format

Returns:

an ESRI GraphicsLayer

Type: Object

getAttribs() → {Promise}

Source:

layer/layerRec/attribFC.js, line 43

Returns attribute data for this FC.

Returns:

resolves with a layer attribute data object

Type: Promise

getAttribs() → {Promise}

Source:

layer/layerRec/attribRecord.js, line 60

Returns attribute data for this layer.

Returns:

resolves with a layer attribute data object

Type: Promise

getAttribs(childIndex) → {Promise}

Source:

layer/layerRec/dynamicRecord.js, line 577

Returns attribute data for a child layer.

Parameters:

Name	Type	Description
`childIndex`	String	the index of the child layer

Returns:

resolves with a layer attribute data object

Type: Promise

getChildName(childIndex) → {String}

Source:

layer/layerRec/dynamicRecord.js, line 742

Retrieves a child layer name from the server.

Parameters:

Name	Type	Description
`childIndex`	String	index of the child layer to get attributes for

Returns:

server name of the child layer

Type: String

getChildTree() → {Object}

Source:

layer/layerRec/dynamicRecord.js, line 495

Get a structured representation of the heirarchy of child layers in this Record. We omit parts of the tree that were not specified to load / be used in the config.

Returns:

structured representation of child layers

Type: Object

getExtentFromJson(extentJson) → {Object}

Source:

map/esriMap.js, line 170

Create an ESRI Extent object from extent setting JSON object.

Parameters:

Name	Type	Description
`extentJson`	Object	that follows config spec

Returns:

an ESRI Extent object

Type: Object

getFeatureCount(url) → {Promise}

Source:

layer/layerRec/attribRecord.js, line 121

Get feature count of a feature layer.

Parameters:

Name	Type	Description
`url`	String	server url of the feature layer. empty string for file based layers

Returns:

resolves with an integer indicating the feature count. -1 if error occured.

Type: Promise

getFeatureCount(featureIdx) → {Promise}

Source:

layer/layerRec/dynamicRecord.js, line 124

Get feature count of a child layer.

Parameters:

Name	Type	Description
`featureIdx`	String	index of the child

Returns:

resolves with an integer indicating the feature count.

Type: Promise

getFeatureCount() → {Promise}

Source:

layer/layerRec/layerRecord.js, line 457

Returns the feature count

Returns:

resolves feature count

Type: Promise

getFeatureCount() → {Promise}

Source:

layer/layerRec/featureRecord.js, line 164

Get feature count of this layer.

Returns:

resolves with an integer indicating the feature count.

Type: Promise

getFeatureName(objId, attribs) → {String}

Source:

layer/layerRec/attribRecord.js, line 80

Extract the feature name from a feature as best we can.

Parameters:

Name	Type	Description
`objId`	String	the object id of the attribute
`attribs`	Object	the dictionary of attributes for the feature.

Returns:

the name of the feature

Type: String

getFeatureName(objId, attribs) → {String}

Source:

layer/layerRec/attribFC.js, line 120

Extract the feature name from a feature as best we can.

Parameters:

Name	Type	Description
`objId`	String	the object id of the attribute
`attribs`	Object	the dictionary of attributes for the feature.

Returns:

the name of the feature

Type: String

getFeatureName(childIndex, objId, attribs) → {String}

Source:

layer/layerRec/dynamicRecord.js, line 599

Extract the feature name from a feature as best we can.

Parameters:

Name	Type	Description
`childIndex`	String	the index of the child layer
`objId`	String	the object id of the attribute
`attribs`	Object	the dictionary of attributes for the feature.

Returns:

the name of the feature

Type: String

getFormattedAttributes(childIndex) → {Promise}

Source:

layer/layerRec/dynamicRecord.js, line 523

Retrieves attributes from a layer for a specified feature index

Parameters:

Name	Type	Description
`childIndex`	String	index of the child layer to get attributes for

Returns:

promise resolving with formatted attributes to be consumed by the datagrid and esri feature identify

Type: Promise

getGeomType() → {String}

Source:

layer/layerRec/layerRecord.js, line 512

Indicates the geometry type of the layer.

Returns:

the geometry type of the layer

Type: String

getGeomType() → {String}

Source:

layer/layerRec/featureRecord.js, line 64

Indicates the geometry type of the layer.

Returns:

the geometry type of the layer

Type: String

getGraphicIcon(attributes, renderer) → {String}

Source:

symbology.js, line 328

Given feature attributes, return the image URL for that feature/graphic object.

Parameters:

Name	Type	Description
`attributes`	Object	object of feature attribute key value pairs
`renderer`	Object	an enhanced renderer (see function enhanceRenderer)

Returns:

svgcode Url to the features symbology image

Type: String

getGraphicsBoundingBox(graphics) → {Object}

Source:

layer/layerRec/graphicsRecord.js, line 502

Return the extent of an array of graphics.

Parameters:

Name	Type	Description
`graphics`	Array.<Graphic>	the graphics whose bounding box we want to calculate

Returns:

the extent of an array of graphics

Type: Object

getGraphicSymbol(attributes, renderer) → {Object}

Source:

symbology.js, line 341

Given feature attributes, return the symbol for that feature/graphic object.

Parameters:

Name	Type	Description
`attributes`	Object	object of feature attribute key value pairs
`renderer`	Object	an enhanced renderer (see function enhanceRenderer)

Returns:

an ESRI Symbol object in server format

Type: Object

getLayerData() → {Promise}

Source:

layer/layerRec/attribRecord.js, line 70

Returns layer-specific data for this Record

Returns:

resolves with a layer data object

Type: Promise

getLayerData() → {Promise}

Source:

layer/layerRec/attribFC.js, line 82

Returns layer-specific data for this FC.

Returns:

resolves with a layer data object

Type: Promise

getLayerData(childIndex) → {Promise}

Source:

layer/layerRec/dynamicRecord.js, line 588

Returns layer-specific data for a child layer

Parameters:

Name	Type	Description
`childIndex`	String	the index of the child layer

Returns:

resolves with a layer data object

Type: Promise

getLayerType(layer) → {String}

Source:

shared.js, line 5

Will return a string indicating the type of layer a layer object is.

Parameters:

Name	Type	Description
`layer`	Object	an ESRI API layer object

Returns:

layer type

Type: String

getLegendUrls(wmsLayer, layerList) → {Array}

Source:

layer/ogc.js, line 200

Finds the appropriate legend URLs for WMS layers.

Parameters:

Name	Type	Description
`wmsLayer`	WMSLayer	an ESRI WMSLayer object to be queried
`layerList`	Array	a list of objects identifying the WMS layers to be queried

Returns:

a list of strings containing URLs for specified layers (order is preserved)

Type: Array

(private) getMapServerLegend(layerUrl, esriBundle) → {Promise}

Source:

symbology.js, line 993

Returns the legend information of an ESRI map service.

Parameters:

Name	Type	Description
`layerUrl`	String	service url (root service, not indexed endpoint)
`esriBundle`	Object	collection of ESRI API objects

Returns:

resolves in an array of legend data

Type: Promise

getNorthArrowAngle(opts) → {Number}

Source:

map/esriMap.js, line 251

Calculate north arrow bearing. Angle returned is to to rotate north arrow image. http://www.movable-type.co.uk/scripts/latlong.html

Parameters:

Name	Type	Description
`opts`	Object	options to apply to north arrow calculation

Returns:

map rotation angle (in degree)

Type: Number

getOidField() → {String}

Source:

layer/layerRec/layerRecord.js, line 523

Indicates the oid field of the layer.

Returns:

the oid field of the layer

Type: String

getOidField() → {String}

Source:

layer/layerRec/featureRecord.js, line 74

Indicates the oid field of the layer.

Returns:

the oid field of the layer

Type: String

getProxy() → {Object}

Source:

layer/layerRec/featureRecord.js, line 84

Provides the proxy interface object to the layer.

Returns:

the proxy interface for the layer

Type: Object

getProxy() → {Object}

Source:

layer/layerRec/layerRecord.js, line 534

Provides the proxy interface object to the layer.

Returns:

the proxy interface for the layer

Type: Object

getProxy() → {Object}

Source:

layer/layerRec/graphicsRecord.js, line 153

Provides the proxy interface object to the layer.

Returns:

the proxy interface for the layer

Type: Object

getScaleRatio(mapWidth) → {Object}

Source:

map/esriMap.js, line 282

Calculate distance between min and max extent to know the pixel ratio between screen size and earth distance. http://www.movable-type.co.uk/scripts/latlong.html

Parameters:

Name	Type	Description
`mapWidth`	Number	optional the map width to use to calculate ratio

Returns:

contain information about the scale

                          - distance: distance between min and max extentId
                          - ratio: measure for 1 pixel in earth distance
                          - units: array of units [metric, imperial]

Type: Object

getScaleSet() → {Object}

Source:

layer/layerRec/dynamicFC.js, line 64

Returns an object with minScale and maxScale values for the feature class.

Returns:

scale set for the feature class

Type: Object

getScaleSet() → {Object}

Source:

layer/layerRec/basicFC.js, line 34

Returns an object with minScale and maxScale values for the feature class.

Returns:

scale set for the feature class

Type: Object

getSymbology(childIndex) → {Object}

Source:

layer/layerRec/dynamicRecord.js, line 612

Return symbology for a child layer.

Parameters:

Name	Type	Description
`childIndex`	String	the index of the child layer

Returns:

the symbology object

Type: Object

getUnboundGraphics(graphicBundles, spatialReference) → {Array}

Source:

hilight.js, line 28

Generating a graphic from server geometry.

Parameters:

Name	Type	Description
`graphicBundles`	Array	set of graphic bundles with properties .graphic, .layerFC
`spatialReference`	Object	the projection the unbound graphics should be in

Returns:

a set of promises that resolve with an unbound graphic, one for each graphic bundle provided

Type: Array

getVisibility() → {Boolean}

Source:

layer/layerRec/basicFC.js, line 83

Returns the visibility of the feature class.

Returns:

visibility of the feature class

Type: Boolean

getVisibility() → {Boolean}

Source:

layer/layerRec/dynamicFC.js, line 143

Returns the visibility of the feature class.

Returns:

visibility of the feature class

Type: Boolean

getVisibility() → {Boolean}

Source:

layer/layerRec/placeholderFC.js, line 27

Indicates visibility of the FC.

Returns:

the visibility of the FC

Type: Boolean

getVisibleScales() → {Object}

Source:

layer/layerRec/layerRecord.js, line 441

Returns the visible scale values of the layer

Returns:

has properties .minScale and .maxScale

Type: Object

(private) getWMSLayerTitle(wmsLayer, wmsLayerId) → {String}

Source:

layer/layerRec/wmsFC.js, line 5

Searches for a layer title defined by a wms.

Parameters:

Name	Type	Description
`wmsLayer`	Object	esri layer object for the wms
`wmsLayerId`	String	layers id as defined in the wms (i.e. not wmsLayer.id)

Returns:

layer title as defined on the service, '' if no title defined

Type: String

(private) guessCSVfields(rows, latCandidates, longCandidates) → {Object}

Source:

layer.js, line 647

From provided CSV data, guesses which columns are long and lat with in the canadidates. If guessing is no successful, returns null for one or both fields.

Parameters:

Name	Type	Description
`rows`	Array	csv data
`latCandidates`	Array	list of all the valid latitude fields
`longCandidates`	Array	list of all the valid longitude fields

Returns:

an object with lat and long string properties indicating corresponding field names

Type: Object

hideLayers(map) → {Array}

Source:

map/print.js, line 102

Set svg-based layer visibility to false to avoid CORS error

Parameters:

Name	Type	Description
`map`	Object	esri map object

Returns:

layer array of layers where visibility is true

Type: Array

identify(opts) → {Object}

Source:

layer/layerRec/featureRecord.js, line 276

Run a query on a feature layer, return the result as a promise. Options:

clickEvent {Object} an event object from the mouse click event, where the user wants to identify.
map {Object} map object. A geoApi wrapper, such as esriMap, not an actual esri api map
geometry {Object} geometry (in map coordinates) to identify against
tolerance {Integer} an optional click tolerance for the identify

Parameters:

Name	Type	Description
`opts`	Object	additional arguemets, see above.

Returns:

an object with identify results array and identify promise resolving when identify is complete; if an empty object is returned, it will be skipped

Type: Object

identify(opts) → {Object}

Source:

layer/layerRec/dynamicRecord.js, line 623

Run a query on a dynamic layer, return the result as a promise. Options:

map {Object} map object. A geoApi wrapper, such as esriMap, not an actual esri api map
geometry {Object} geometry (in map coordinates) to identify against
mapExtent {Object} extent object of the current map view
height {Integer} height of the map view in pixels
width {Integer} width of the map view in pixels
tolerance {Integer} an optional click tolerance for the identify. Defaults to 5
returnGeometry {Boolean} if result geometery should be returned with results. Defaults to false

Parameters:

Name	Type	Description
`opts`	Object	additional arguemets, see above.

Returns:

an object with identify results array and identify promise resolving when identify is complete; if an empty object is returned, it will be skipped

Type: Object

initBasemaps(esriBundle, basemapsConfig, map) → {Object}

Source:

map/basemap.js, line 16

Make basemap gallery based on the settings of basemap metadata.

Parameters:

Name	Type	Description
`esriBundle`	Object	ESRI modules from the initial startup
`basemapsConfig`	Array	array of basemap settings in the form { id: string, layers: [string], title: string, thumbnailUrl: string, wkid: integer }
`map`	esriMap	ESRI map object

Returns:

an object with the following properties:

setBasemap {function} set current basemap with a basemap uid
basemapGallery {object} basemapGallery object

Type: Object

isOffScale(mapScale) → {Object}

Source:

layer/layerRec/basicFC.js, line 50

Indicates if the feature class is not visible at the given scale, and if so, if we need to zoom in to see it or zoom out

Parameters:

Name	Type	Description
`mapScale`	Integer	the scale to test against

Returns:

has boolean properties offScale and zoomIn

Type: Object

isOffScale(mapScale) → {Object}

Source:

layer/layerRec/layerRecord.js, line 418

Indicates if the feature class is not visible at the given scale, and if so, if we need to zoom in to see it or zoom out

Parameters:

Name	Type	Description
`mapScale`	Integer	the scale to test against

Returns:

has boolean properties offScale and zoomIn

Type: Object

isOffScale(childIndex, mapScale) → {Object}

Source:

layer/layerRec/dynamicRecord.js, line 459

Indicates if the feature class is not visible at the given scale, and if so, if we need to zoom in to see it or zoom out

Parameters:

Name	Type	Description
`childIndex`	String	index of the child layer to target
`mapScale`	Integer	the scale to test against

Returns:

has boolean properties offScale and zoomIn

Type: Object

isOffScale(mapScale) → {Object}

Source:

layer/layerRec/placeholderFC.js, line 51

Indicates if the feature class is not visible at the given scale, and if so, if we need to zoom in to see it or zoom out. Placeholder is always in scale

Parameters:

Name	Type	Description
`mapScale`	Integer	the scale to test against

Returns:

has boolean properties offScale and zoomIn

Type: Object

isQueryable() → {Boolean}

Source:

layer/layerRec/layerRecord.js, line 492

Indicates the layer is queryable.

Returns:

the queryability of the layer

Type: Boolean

isQueryable(childIndex) → {Boolean}

Source:

layer/layerRec/dynamicRecord.js, line 472

Indicates the layer is queryable.

Parameters:

Name	Type	Description
`childIndex`	String	index of the child layer to target

Returns:

the queryability of the layer

Type: Boolean

(static) isSpatialRefEqual(sr1, sr2) → {Boolean}

Source:

proj.js, line 308

Checks if two spatial reference objects are equivalent. Handles both wkid and wkt definitions.

Parameters:

Name	Type	Description
`sr1`	type	Esri Spatial Reference First to compare
`sr2`	type	Esri Spatial Reference Second to compare

Returns:

true if the two spatial references are equivalent. False otherwise.

Type: Boolean

layerLoaded(state) → {Boolean}

Source:

layer/layerRec/shared.js, line 88

Takes a specific layer state and determines if the layer can be considered loaded or not.

Parameters:

Name	Type	Description
`state`	String	a layer state

Returns:

if the layer is loaded or not

Type: Boolean

(private) loadDataBatch(opts, callerDef)

Source:

attribute.js, line 205

Recursive function to load a full set of attributes, regardless of the maximum output size of the service. Passes result back on the provided Deferred object.

Parameters:

Name Type Description

opts

Object

options object that consists of these properties

    - maxId: integer, largest object id that has already been downloaded.
    - supportsLimit: boolean, indicates if server result will notify us if our request surpassed the record limit.
    - batchSize: integer, maximum number of results the service will return. if -1, means currently unknown. only required if supportsLimit is false.
    - layerUrl: string, URL to feature layer endpoint.
    - oidField: string, name of attribute containing the object id for the layer.
    - attribs: string, a comma separated list of attributes to download. '*' will download all.
    - esriBundle: object, standard set of ESRI API objects.
    - layerPackage: reference to the object that manages the loaded attributes

callerDef

Object

deferred object that resolves when current data has been downloaded

loadSymbology() → {Promise}

Source:

layer/layerRec/wmsFC.js, line 56

Download or refresh the internal symbology for the FC.

Returns:

resolves when symbology has been downloaded

Type: Promise

loadSymbology(mergeAllLayers) → {Promise}

Source:

layer/layerRec/basicFC.js, line 104

Download or refresh the internal symbology for the FC. mergeAllLayers indicates we should collate entire parent legend into one block. E.g. for basemap tile. the FC index would be 0, but we want all indexes

Parameters:

Name	Type	Description
`mergeAllLayers`	Boolean	take entire service legend, no just legend for this FC. Defaults to false.

Returns:

resolves when symbology has been downloaded

Type: Promise

loadSymbology() → {Promise}

Source:

layer/layerRec/attribFC.js, line 102

Download or refresh the internal symbology for the FC.

Returns:

resolves when symbology has been downloaded

Type: Promise

localProjectExtent(extent, sr) → {Object}

Source:

proj.js, line 94

Reproject an EsriExtent object on the client. Does not require network traffic, but may not handle conversion between projection types as well. Internally it tests 8 points along each edge and takes the max extent of the result.

Parameters:

Name	Type	Description
`extent`	EsriExtent	to reproject
`sr`	Object	is the target spatial reference (if a number it will be treated as a WKID)

Returns:

an extent as an unstructured object

Type: Object

localProjectGeometry(destProj, geometry) → {Object}

Source:

proj.js, line 59

Project a single point.

Parameters:

Name	Type	Description
`destProj`	Object \| Integer \| String	the spatial reference of the result (as ESRI SpatialReference, integer WKID or an EPSG string)
`geometry`	Object	an object conforming to ESRI Geometry object standards containing the coordinates to Reproject

Returns:

an object conforming to ESRI Geomtery object standards containing the input geometry in the destination projection

Type: Object

localProjectPoint(srcProj, destProj, point) → {Array|Object}

Source:

proj.js, line 49

Project a single point.

Parameters:

Name	Type	Description
`srcProj`	Object \| Integer \| String	the spatial reference of the point (as ESRI SpatialReference, integer WKID or an EPSG string)
`destProj`	Object \| Integer \| String	the spatial reference of the result (as ESRI SpatialReference, integer WKID or an EPSG string)
`point`	Array \| Object	a 2d array or object with {x,y} props containing the coordinates to Reproject

Returns:

a 2d array or object containing the projected point

Type: Array | Object

makeBoundingBox(id, extent, targetSr) → {GraphicsLayer}

Source:

layer/bbox.js, line 9

Makes a bounding box layer (a graphics layer with one rectangle graphic matching the supplied extent).

Parameters:

Name	Type	Description
`id`	String	the id of the bounding box to be created
`extent`	EsriExtent	an ESRI extent object to be used for the graphics boundaries
`targetSr`	SpatialReference	an ESRI spatial reference which is used for projecting the result

Returns:

an ESRI GraphicsLayer

Type: GraphicsLayer

makeClickBuffer(point, map, tolerance) → {Object}

Source:

layer/layerRec/layerRecord.js, line 470

Create an extent centered around a point, that is appropriate for the current map scale.

Parameters:

Name	Type	Description
`point`	Object	point on the map for extent center
`map`	Object	map object the extent is relevant for
`tolerance`	Integer	optional. distance in pixels from mouse point that qualifies as a hit. default is 5

Returns:

an extent of desired size and location

Type: Object

makeGeoJsonLayer(geoJson, opts) → {Promise}

Source:

layer.js, line 908

Converts a GeoJSON object into a FeatureLayer. Expects GeoJSON to be formed as a FeatureCollection containing a uniform feature type (FeatureLayer type will be set according to the type of the first feature entry). Accepts the following options:

targetWkid: Required. an integer for an ESRI wkid to project geometries to
renderer: a string identifying one of the properties in defaultRenders
sourceProjection: a string matching a proj4.defs projection to be used for the source data (overrides geoJson.crs)
epsgLookup: a function that takes an EPSG code (string or number) and returns a promise of a proj4 style definition or null if not found
layerId: a string to use as the layerId
colour: a hex string to define the symbol colour. e.g. '#33DD6A'

Parameters:

Name	Type	Description
`geoJson`	Object	An object following the GeoJSON specification, should be a FeatureCollection with Features of only one type
`opts`	Object	An object for supplying additional parameters

Returns:

a promise resolving with a {FeatureLayer}

Type: Promise

makeHilightLayer(options) → {Object}

Source:

hilight.js, line 57

Generate a graphic layer to handle feature hilighting.

Parameters:

Name	Type	Description
`options`	Object	optional settings for the hilight layer layerId - id to use for the hilight layer. defaults to rv_hilight markerSymbol - esri symbol in server json format to symbolize the click marker. defaults to a red pin

Returns:

an ESRI GraphicsLayer

Type: Object

makeLayerConfig() → {Object}

Source:

layer/layerRec/wmsRecord.js, line 34

Creates an options object for the map API object

Returns:

an object with api options

Type: Object

makeLayerConfig() → {Object}

Source:

layer/layerRec/dynamicRecord.js, line 78

Creates an options object for the map API object

Returns:

an object with api options

Type: Object

makeLayerConfig() → {Object}

Source:

layer/layerRec/layerRecord.js, line 302

Creates an options object for the map API object

Returns:

an object with api options

Type: Object

makeLayerConfig() → {Object}

Source:

layer/layerRec/featureRecord.js, line 40

Creates an options object for the map API object

Returns:

an object with api options

Type: Object

(private) makeLayerInfo(type, name, url, json) → {Object}

Source:

layer.js, line 63

Returns a standard information object with info common for most ESRI endpoints .serviceName .serviceType .tileSupport .rootUrl

Parameters:

Name	Type	Description
`type`	String	serviceType enum value for layer
`name`	String	property in json parameter containing a service name
`url`	String	url we are investigating
`json`	Object	data result from service we interrogated

Returns:

Type: Object

makeLegend(layerList, sectionsAvailable, mapHeight)

Source:

legend.js, line 252

Generate the structure for a legend given a set of layers.

Parameters:

Name	Type	Description
`layerList`	Array	a list of layers to be updated (modified in place)
`sectionsAvailable`	int	the maximum number of sections to use
`mapHeight`	int	the rendered height of the map image

Returns:

an object with properties layers, sectionsUsed. (layerList is modified in place)

makeSafeExtent(extent) → {Object}

Source:

layer/layerRec/shared.js, line 107

Takes an extent. If extent has problematic boundaries, adjust the extent inwards.

Parameters:

Name	Type	Description
`extent`	Object	an extent. Param may be modified in place

Returns:

an extent that has been adjusted if it's too big

Type: Object

makeSymbologyArray(legendData) → {Array}

Source:

layer/layerRec/shared.js, line 28

Takes an array of (possibly pending) legend data and constructs an array of default symbology objects. As each legend item loads, the symbology objects are updated.

Parameters:

Name	Type	Description
`legendData`	Array	list of promises that resolve with legend data (svg and labels)

Returns:

a list of symbology objects.

Type: Array

mapDefault(key, valueopt)

Source:

map/esriMap.js, line 452

Sets or gets map default config values.

Parameters:

Name	Type	Attributes	Description
`key`	String		name of the default property
`value`	Any	<optional>	optional value to set for the specified default property

(private) mapServerLegendToRenderer(serverLegend, layerIndex) → {Object}

Source:

symbology.js, line 1029

Our symbology engine works off of renderers. When dealing with layers with no renderers, we need to take server-side legend and convert it to a fake renderer, which lets us leverage all the existing symbology code.

Parameters:

Name	Type	Description
`serverLegend`	Object	legend json from an esri map server
`layerIndex`	Integer	the index of the layer in the legend we are interested in

Returns:

a fake unique value renderer based off the legend

Type: Object

(private) mapServerLegendToRendererAll(serverLegend) → {Object}

Source:

symbology.js, line 1063

Same as mapServerLegendToRenderer function but combines all layer renderers.

Parameters:

Name	Type	Description
`serverLegend`	Object	legend json from an esri map server

Returns:

a fake unique value renderer based off the legend

Type: Object

mapServerToLocalLegend(mapServerUrl, layerIndexopt) → {Promise}

Source:

symbology.js, line 1097

Orchestrator function that will:

Fetch a legend from an esri map server
Extract legend for a specific sub layer
Convert server legend to a temporary renderer
Convert temporary renderer to a viewer-formatted legend (return value)

Parameters:

Name	Type	Attributes	Description
`mapServerUrl`	String		service url (root service, not indexed endpoint)
`layerIndex`	Integer	<optional>	the index of the layer in the legend we are interested in. If not provided, all layers will be collapsed into a single legend

Returns:

resolves in a viewer-compatible legend for the given server and layer index

Type: Promise

moveToOffsetExtent(targetExtent, offsetFraction) → {Promise}

Source:

map/esriMap.js, line 467

Will position the map so that the target extent is in view. Offsetting is available to allow the view to take into account UI elements that cover the map (e.g. legend and grid are open, so want extent visible in remaining map area)

Parameters:

Name	Type	Description
`targetExtent`	Object	an ESRI extent to position the map to
`offsetFraction`	Object	an object with decimal properties `x` and `y` indicating percentage of offsetting on each axis

Returns:

resolves after the map is done moving

Type: Promise

(private) newLayerPackage(featureIdx, esriBundle) → {Object}

Source:

attribute.js, line 73

Will generate an empty object structure to store attributes for a single layer of features

Parameters:

Name	Type	Description
`featureIdx`	String	server index of the layer
`esriBundle`	Object	bundle of API classes

Returns:

empty layer package object

Type: Object

(private) newProp(target, propName, getter)

Source:

layer/layerRec/layerInterface.js, line 230

Worker function to add or override a get property on an object

Parameters:

Name	Type	Description
`target`	Object	the object that will receive the new property
`propName`	String	name of the get property
`getter`	function	the function defining the guts of the get property.

(private) normalizeProj(proj) → {String}

Source:

proj.js, line 27

Convert a projection to an string that is compatible with proj4. If it is an ESRI SpatialReference or an integer it will be converted.

Parameters:

Name	Type	Description
`proj`	Object \| Integer \| String	an ESRI SpatialReference, integer or string. Strings will be unchanged and unchecked, ints and SpatialReference objects will be converted.

Returns:

A string in the form EPSG:####

Type: String

onError(e)

Source:

layer/layerRec/layerRecord.js, line 248

Triggers when the layer has an error.

Parameters:

Name	Type	Description
`e`	Object	error event object