FilterManager Class

Uses

Defined in: src\js\RAMP\Modules\filterManager.js:11

Module: FilterManager
Parent Module: RAMP

FilterManager class. Represents the legend next to the map and the controls to toggle each map layer's visibility and boundary box. The FilterManager also includes a attribute filter that allows the user to hide map features based on a attribute values

For a doc with diagrams on how this class works, please see http://ecollab.ncr.int.ec.gc.ca/projects/science-apps/priv/RAMP/RAMP%20AMD%20Filter%20Module.docx

Index
Methods
Properties
Events

Item Index

Methods

`_checkMaster`

() private

Inherited from CheckboxGroup: src\js\RAMP\Utils\checkboxGroup.js:260

Synchronizes the state of the master Checkbox with the state of the group. All group members checked -> master checked Any of the group members unchecked -> master unchecked

`_emit`

(

agency

)

private

Inherited from Checkbox: src\js\RAMP\Utils\checkbox.js:202

Emits a TOGGLE event when the checkbox's state is changed.

Parameters:

agency String

Specified the agency that toggled the Checkbox.

`_getFeatures`

(

fl

)

Object

Defined in src\js\RAMP\Modules\filterManager.js:980

Queries all map points on a given feature layer and returns their attributes

Parameters:

fl Object

A feature layer to query

Returns:

Object:

An array of attributes from the designated feature layer

`_getField`

(

fl
field

)

Object

Defined in src\js\RAMP\Modules\filterManager.js:996

Grabs all distinct values of the given field from a featureLayer.

Parameters:

fl Object

A feature layer to query
field String

The field (or column) to query in the feature layer

Returns:

Object:

deferred A deferred object which will resolve to an array of unique values

`_hideLoadingImg`

() private

Inherited from Map: src\js\RAMP\Modules\map.js:127

Hides the loading image.

`_initEventHandlers`

(

map

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:368

Creates event handlers for the map control: click, mouse-over, load, extent change, and update events.

Parameters:

map Object

A ESRI map object

`_initListeners`

(

map

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:215

Subscribe to external events (published using topic.publish) and react accordingly

Parameters:

map Object

map object

`_initRepublishers`

(

map

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:184

Republishes map events to the outside using topic.publish

Parameters:

map Object

object

`_initScale`

(

event

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:154

Initialize Map Scale

Parameters:

event Object

`_showLoadingImg`

() private

Inherited from Map: src\js\RAMP\Modules\map.js:117

Shows the loading image.

`_updateScale`

(

event

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:137

Update Map Scale when zoom level changes

Parameters:

event Object

`_wrapFileCallInPromise`

(

readMethod

)

Function private

Inherited from Util: src\js\RAMP\Utils\util.js:33

Helper function for wrapping File API calls in Promise objects. Used for building a series of helpers which call different file read methods.

Parameters:

readMethod String

a string indicating the FileReader method to call

Returns:

Function:

a function which accepts a {File} object and returns a Promise

`addLayer`

(

layerType
layerConfig
initState

)

Defined in src\js\RAMP\Modules\filterManager.js:898

Add a provided layer to the layer selector.

Parameters:

layerType String

layer type - name of the layer group
layerConfig Object

a layer config
initState String

optional. the state to initialize in. Default value is LOADING

`AddStaticLayer`

(

layer_type
layer_url
layer_op

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:566

Add a static, non-interactive Layer to the map

Parameters:

layer_type String

A value which controls how the layer is going to be added to the map
layer_url String

A URL pointing to a valid map service endpoint
layer_op Number

A value between 0.0 and 1.0 which determines the transparency of the layer

`adjustPaneWidth`

() private

Defined in src\js\RAMP\Modules\filterManager.js:429

Changes the width of the layers pane to accommodate for the scrollbar if it's needed.

`applyExtentDefaulting`

() private

Inherited from Map: src\js\RAMP\Modules\map.js:826

Apply extent defaulting prior to URL overrides.

`checkBoundary`

(

e
maxExtent

)

Esri/geometry/Extent

Inherited from Map: src\js\RAMP\Modules\map.js:858

Given an ESRI Extent Object, returns a new ESRI Extent Object that contains the extent adjusted according to this map's maximum extent

NOTE: this method is currently unused!

Parameters:

e Esri/geometry/Extent

the extent Object
maxExtent Esri/geometry/Extent

the maximum extent

Returns:

Esri/geometry/Extent:

An adjusted extent, if the target extent is outside the boundary

`createGroups`

() private

Defined in src\js\RAMP\Modules\filterManager.js:184

Sets UI status of a layer presentation (checkbox and eye) according to the user action: select / de-select a layer. publishes event "filterManager/box-visibility-toggled" every time a layer status changed. There should only be one eye and one global checkbox, but we say checkbox"es" because jquery returns a list and it's easier to write a function that takes a list of checkboxes than to write two functions, one to take a list and one to take an individual checkbox

`enhanceLayer`

(

layer
config
userLayer

)

Inherited from Map: src\js\RAMP\Modules\map.js:1025

Adds custom ramp properties to layer. Adds handlers to loading events.

Parameters:

layer Object

layer to be prepped
config Object

config object for the layer
userLayer Boolean

optional. indicates if layer was added by a user. default value is false

`finishExtentProjection`

(

projectedMaxExtent

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:550

process the projected maximum extent, then alert app to continue loading the map. used as an asynchronous gate for the projection.

Parameters:

projectedMaxExtent Array

an array containing the maximum extent object in the map's projection

`getBoundingBoxMapping`

() Object

Inherited from Map: src\js\RAMP\Modules\map.js:804

Returns the mapping of feature layer ids to assocciated bounding box layers.

Returns:

Object:

A dictionary of String, Esri/layers/GraphicsLayer pairs.

`getFeatureLayer`

(

featureId

)

Esri/layers/FeatureLayer private

Inherited from Map: src\js\RAMP\Modules\map.js:814

Return the feature layer corresponding to the given id.

Parameters:

featureId String

the id of the feature layer

Returns:

Esri/layers/FeatureLayer:

feature layer

`getLayerConfigWithId`

(

id

)

Inherited from RAMP: src\js\RAMP\Modules\ramp.js:64

Returns the feature layer config for the given id

Parameters:

id String

layer id string

`getLayerItem`

(

layerId

)

private

Defined in src\js\RAMP\Modules\filterManager.js:735

Returns a LayerItem object with specified layerId.

Parameters:

layerId String

a layer id

`getLayerState`

(

layerId

)

private

Defined in src\js\RAMP\Modules\filterManager.js:953

Returns the state of the layer with the specified layer id.

Parameters:

layerId String

a layer id

`getServiceURL`

(

rampService
mapID
language

)

Inherited from RAMP: src\js\RAMP\Modules\ramp.js:93

This method builds a complete service URL callout for a map configuration. The URL is built using a base URL and map ID, and a language culture code.

Parameters:

rampService String

The base URL for a web service that provide's valid map JSON configuration data
mapID Number

a unique identifier for a group of map configuration
language String

culture code either 'en' or 'fr'

`getSymbolForFeature`

(

feature

)

Icon

Inherited from RAMP: src\js\RAMP\Modules\ramp.js:77

Given a feature object or a graphic object (or any object that has a getLayer method and an attributes field) return the object containing the image URL and legend text for that feature/graphic object.

Parameters:

feature Object

Returns:

Icon:

The default icon used to represent the feature layer

`getVisibleFeatureLayers`

() Array

Inherited from Map: src\js\RAMP\Modules\map.js:764

Returns a list of feature layers that are currently visible on the map.

(

extent
sr

)

Esri/Extent private

Inherited from Map but overwritten in src\js\RAMP\Modules\map.js:420

Will project an extent to a desired spatial reference, using client side projection library. Avoids the need for Esri Geometry Service

Parameters:

extent Esri/Extent

extent to be projected
sr Esri/SpatialReference

Esri/SpatialReference to project to

Returns:

Esri/Extent:

extent in the desired projection

`makeFeatureLayer`

(

layerConfig
userLayer

)

Esri/layers/FeatureLayer

Inherited from Map: src\js\RAMP\Modules\map.js:915

Create a new FeatureLayer object based on the config input

Parameters:

layerConfig Object

config object for the layer to create
userLayer Boolean

optional specifies if layer was added by a user

Returns:

Esri/layers/FeatureLayer:

feature layer object (unloaded)

`makeStaticLayer`

(

layerConfig
userLayer

)

Object private

Inherited from Map: src\js\RAMP\Modules\map.js:969

Return the static layer corresponding to the given url.

Parameters:

layerConfig Object

config object for the layer to create
userLayer Boolean

optional specifies if layer was added by a user

Returns:

Object:

layer object of the appropriate type

`makeWmsLayer`

(

layerConfig
userLayer

)

Esri/layers/WMSLayer

Inherited from Map: src\js\RAMP\Modules\map.js:939

Return the feature layer corresponding to the given url.

Parameters:

layerConfig Object

config object for the layer to create
userLayer Boolean

optional specifies if layer was added by a user

Returns:

Esri/layers/WMSLayer:

WMS layer

`newPopup`

(

popupAttr

)

private

Inherited from PopupManager: src\js\RAMP\Utils\popupManager.js:515

Create a new PopupBase object from the settings provided.

Parameters:

popupAttr PopupBaseSettings

Popup settings

Returns:

popup

`prepLayer`

(

layer
config
userLayer

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:657

Sets up loading event handlers and initializes the .ramp object of a layer Circular reference errors prevent us from calling LayerLoader directly from this module

Parameters:

layer Object

layer to be prepped
config Object

config object for the layer
userLayer Boolean

optional. indicates if layer was added by a user. default value is false

`projectConfigExtents`

()

Inherited from Map: src\js\RAMP\Modules\map.js:845

initiate the projection of the config extents to basemap extents

`projectExtent`

(

extent
sr
callWhenDone

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:476

project an extent to a new spatial reference, if required when projection is finished, call another function and pass the result to it.

Parameters:

extent Object

an extent object from the configuration
sr Esri/SpatialReference

Esri/SpatialReference to project to
callWhenDone Function

function to call when extent is projected. expects geometry parameter

`projectFullExtent`

(

projectedDefaultExtent

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:518

process the projected default extent, begin projection of full extent. used as an asynchronous gate for the projection.

Parameters:

projectedDefaultExtent Array

an array containing the default extent object in the map's projection

`projectMaxExtent`

(

projectedFullExtent

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:534

process the projected full extent, begin projection of maximum extent. used as an asynchronous gate for the projection.

Parameters:

projectedFullExtent Array

an array containing the full extent object in the map's projection

`removeLayer`

(

layerType
layerId

)

Defined in src\js\RAMP\Modules\filterManager.js:933

Remove a layer from the layer selector.

Parameters:

layerType String

layer type - name of the layer group
layerId String

layer id of layer to remove

`republish`

(

name

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:194

Republish map events using topic.publish

Parameters:

name String

`setBoundingBoxVisibility`

(

layerId

)

private

Inherited from Map: src\js\RAMP\Modules\map.js:609

Sets the visibility of the bounding box that belongs to the layer with the given layerId. Note: the layerId needs to be the ID of the featurelayer, not the ID of the actual bounding box layer.

Parameters:

layerId String

the id of the layer whose bounding box visibility should be set

`setButtonEvents`

() private

Defined in src\js\RAMP\Modules\filterManager.js:439

Sets event handlers for various controls that may be present in the layer items. All event handlers are set on the main list container and are independed of the individual layer items.

`setEachState`

(

fcn

)

chainable

Inherited from CheckboxGroup: src\js\RAMP\Utils\checkboxGroup.js:320

Toggle all the checkboxes based on the return value of the given function.

Parameters:

fcn Function

a function that takes a checkbox as an argument and returns true if the given checkbox should be toggled on, false if it should be toggled off

`setLayerOffScaleState`

(

layerId

)

private

Defined in src\js\RAMP\Modules\filterManager.js:819

Checks if a specific layer has data that is not visible and sets the appropriate layer state.

Parameters:

layerId String

a layer id

`setLayerOffScaleStates`

() private

Defined in src\js\RAMP\Modules\filterManager.js:784

Checks if any of the layers have data that is not visible and sets the appropriate layer state.

`setLayerReorderingEvents`

() private

Defined in src\js\RAMP\Modules\filterManager.js:365

Sets all the events to handle layer reordering with both mouse and keyboard.

`setLayerState`

(

layerId
layerState
[options]

)

private

Defined in src\js\RAMP\Modules\filterManager.js:753

Set the state of the specified layer to the provided value.

Parameters:

layerId String

a layer id
layerState String

a state to set the specified layer to
[options] Object optional

additional options to be passed to the layerItem upon setting state

`setLayerState`

(

layerId
layerState
[options]

)

Defined in src\js\RAMP\Modules\filterManager.js:969

Set the state of the specified layer to the provided value. Public hook to call internal setLayerState function.

Parameters:

layerId String

a layer id
layerState String

a state to set the specified layer to
[options] Object optional

additional options to be passed to the layerItem upon setting state

`setState`

(

state

)

Checkbox chainable

Inherited from CheckboxGroup but overwritten in src\js\RAMP\Utils\checkbox.js:219

Toggle the state of Checkbox.

Parameters:

state Boolean

Specifies the state of the checkbox: true, false

Returns:

Checkbox:

Control object for chaining

`ui.addLayerGroup`

() private

Defined in src\js\RAMP\Modules\filterManager.js:724

Add the provided layer group node to the layer selector ui.

`ui.update`

() private

Defined in src\js\RAMP\Modules\filterManager.js:711

Updates certain UI aspects like layer settings panel (visibility sliders for now only), layer visibility and bounding box toggles, and layer sorting.

`zoomToLayerScale`

(

layerId

)

Inherited from Map: src\js\RAMP\Modules\map.js:707

For a specified layer, zooms to the closest level that has some visible data.

Parameters:

layerId String

a layer id to zoom to.

Properties

`agency`

Object private

Inherited from Checkbox: src\js\RAMP\Utils\checkbox.js:267

An object specifying possible agencies that can affect the Checkbox.

Example:

 agency: {
      USER: "USER",
      CODE: "CODE"
  }

`baseLayer`

Esri/layers/ArcGISTiledMapServiceLayer private

Inherited from Map: src\js\RAMP\Modules\map.js:1078

The basemap layer

`boundingBoxMapping`

Object private

Inherited from Map: src\js\RAMP\Modules\map.js:92

Maps the id of a graphic layer to the GraphicsLayer Object that represents its extent bounding box. A dictionary of String, Esri/layers/GraphicsLayer pairs.

`config`

Object

Inherited from RAMP: src\js\RAMP\RAMP-starter.js:40

The RAMP application config, it should be treated as read only by all modules other than globalStorage and bootstrapper

`configServiceURL`

String

Inherited from RAMP: src\js\RAMP\RAMP-starter.js:32

Contains a URL that points to the application configuration (JSON format) if it's hosted on a web service. This is not required if the application has a JSON config file in the website's folder

`cssClass`

Object

Inherited from CheckboxGroup but overwritten in src\js\RAMP\Utils\checkbox.js:74

active, focus, and check CSS class to be applied to the Checkbox correspondingly.

Example:

 cssClass: {
     active: "active",
     focus: "focused",
     check: "checked"
 }

`event`

Object private

Inherited from CheckboxGroup but overwritten in src\js\RAMP\Utils\checkbox.js:285

Event names published by the Checkbox

Default: null

Example:

 {
     TOGGLE: "checkbox/toggle"
 }

`featureLayers`

Array private

Inherited from Map: src\js\RAMP\Modules\map.js:76

An Array of Esri/layers/FeatureLayer objects.

`featureLayerStartIndex`

Integer private

Inherited from Map: src\js\RAMP\Modules\map.js:101

The map not only contains feature layers, but also other layers such as the basemap layer, highlight layer, bounding box layer, etc. This variable is used to store the starting index of the feature layers in the map.

`fullExtent`

Esri/geometry/Extent private

Inherited from Map: src\js\RAMP\Modules\map.js:1113

Used for full extent in nav widget

`getMap`

Object

Inherited from Map: src\js\RAMP\Modules\map.js:751

Return the map control object

`getMaxExtent`

Object

Inherited from Map: src\js\RAMP\Modules\map.js:742

The maximum extent of the map control is allowed to go to

`id`

String

Inherited from Checkbox: src\js\RAMP\Utils\checkbox.js:129

Id of the Checkbox as specified by nodeIdAttr.

Default: null

`InitExtent`

Esri/geometry/Extent private

Inherited from Map: src\js\RAMP\Modules\map.js:1104

The initial extent of the map

`label`

Object

Inherited from CheckboxGroup but overwritten in src\js\RAMP\Utils\checkbox.js:93

check and uncheck label texts to be applied to the Checkbox labels.

Example:

 label: {
     check: "check",
     uncheck: "unchecked"
 }

`labelNode`

JObject private

Inherited from Checkbox: src\js\RAMP\Utils\checkbox.js:55

Node of the input checkbox label.

Default: null

`master`

Object

Inherited from CheckboxGroup: src\js\RAMP\Utils\checkboxGroup.js:136

Options for the master Checkbox.

Example:

 master: {
     node: null,
     checkbox: null,
     nodeIdAttr: null,

     cssClass: {
         active: "active",
         focus: "focused",
         check: "checked"
     },

     label: {
         check: "checked",
         uncheck: "unchecked"
     },

     onChange: function () { }
 }

`maxExtent`

Esri/geometry/Extent private

Inherited from Map: src\js\RAMP\Modules\map.js:1122

The maximum extent of the map

`node`

JObject

Inherited from Checkbox: src\js\RAMP\Utils\checkbox.js:46

Node of the input checkbox originally supplied to the Checkbox.

Default: null

`nodeIdAttr`

String

Inherited from CheckboxGroup but overwritten in src\js\RAMP\Utils\checkbox.js:65

Name of the "data-*" attribute set on the checkbox node to be treated as the checkbox id.

Default: "id"

`nodes`

JArray

Inherited from CheckboxGroup but overwritten in src\js\RAMP\Utils\checkboxGroup.js:63

Nodes of the checkbox nodes originally supplied to the CheckboxGroup.

Default: []

`onChnage`

Function

Inherited from CheckboxGroup but overwritten in src\js\RAMP\Utils\checkbox.js:110

A function to be called when the state of the Checkbox changes.

Example:

 function () { }

`plugins`

Object

Inherited from RAMP: src\js\RAMP\RAMP-starter.js:48

A registry of plugins for RAMP code to reference, these should be loaded and registered by bootstrapper.js

`state`

Boolean | String

Inherited from RAMP but overwritten in src\js\RAMP\Utils\checkbox.js:120

State of the Checkbox: true | false or INVALID

Default: null

`url`

String private

Inherited from Map: src\js\RAMP\Modules\map.js:1069

The URL of the first layer of the basemap that is on by default.

`wmsLayers`

Array private

Inherited from Map: src\js\RAMP\Modules\map.js:84

An Array of Esri/layer/WMSLayer objects.

Inherited from CheckboxGroup: src\js\RAMP\Utils\checkboxGroup.js:382

Published whenever the master Checkbox get toggled.

Event Payload:

event Object
- checkbox Checkbox
  
  master Checkbox object that has been toggled
- agency String
  
  Agency that toggled the Checkbox

`MEMBER_TOGGLE`

Inherited from CheckboxGroup: src\js\RAMP\Utils\checkboxGroup.js:372

Published whenever a Checkbox get toggled.

Event Payload:

event Object
- checkbox Checkbox
  
  Checkbox object that has been toggled
- agency String
  
  Agency that toggled the Checkbox

`TOGGLE`

Inherited from CheckboxGroup but overwritten in src\js\RAMP\Utils\checkbox.js:298

Published whenever a Checkbox get toggled.

Event Payload:

event Object
- checkbox Checkbox
  
  Checkbox object that has been toggled
- agency String
  
  Agency that toggled the Checkbox

Reusable Accessible Mapping Platform

APIs

FilterManager Class

Item Index

Methods

Properties

Events

Methods

_checkMaster

_emit

Parameters:

_getFeatures

Parameters:

Returns:

_getField

Parameters:

Returns:

_hideLoadingImg

_initEventHandlers

Parameters:

_initListeners

Parameters:

_initRepublishers

Parameters:

_initScale

Parameters:

_showLoadingImg

_updateScale

Parameters:

_wrapFileCallInPromise

Parameters:

Returns:

addLayer

Parameters:

AddStaticLayer

Parameters:

adjustPaneWidth

applyExtentDefaulting

checkBoundary

Parameters:

Returns:

createGroups

enhanceLayer

Parameters:

finishExtentProjection

Parameters:

getBoundingBoxMapping

Returns:

getFeatureLayer

Parameters:

Returns:

getLayerConfigWithId

Parameters:

getLayerItem

Parameters:

getLayerState

Parameters:

getServiceURL

Parameters:

getSymbolForFeature

Parameters:

Returns:

getVisibleFeatureLayers

Returns:

init

initListeners

initScrollListeners

initTooltips

loadStrings

localProjectExtent

Parameters:

Returns:

makeFeatureLayer

Parameters:

Returns:

makeStaticLayer

Parameters:

Returns:

makeWmsLayer

Parameters:

`_checkMaster`

`_emit`

`_getFeatures`

`_getField`

`_hideLoadingImg`

`_initEventHandlers`

`_initListeners`

`_initRepublishers`

`_initScale`

`_showLoadingImg`

`_updateScale`

`_wrapFileCallInPromise`

`addLayer`

`AddStaticLayer`

`adjustPaneWidth`

`applyExtentDefaulting`

`checkBoundary`

`createGroups`

`enhanceLayer`

`finishExtentProjection`

`getBoundingBoxMapping`

`getFeatureLayer`

`getLayerConfigWithId`

`getLayerItem`

`getLayerState`

`getServiceURL`

`getSymbolForFeature`

`getVisibleFeatureLayers`

`init`

`initListeners`

`initScrollListeners`

`initTooltips`

`loadStrings`

`localProjectExtent`

`makeFeatureLayer`

`makeStaticLayer`

`makeWmsLayer`

`newPopup`

`prepLayer`

`projectConfigExtents`

`projectExtent`

`projectFullExtent`

`projectMaxExtent`

`removeLayer`

`republish`

`setBoundingBoxVisibility`

`setButtonEvents`

`setEachState`

`setLayerOffScaleState`

`setLayerOffScaleStates`

`setLayerReorderingEvents`

`setLayerState`

`setLayerState`

`setState`

`ui.addLayerGroup`

`ui.update`

`zoomToLayerScale`

`agency`

`baseLayer`

`boundingBoxMapping`

`config`

`configServiceURL`

`cssClass`

`event`

`featureLayers`

`featureLayerStartIndex`

`fullExtent`

`getMap`

`getMaxExtent`

`id`

`InitExtent`

`label`

`labelNode`

`master`

`maxExtent`

`node`

`nodeIdAttr`

`nodes`

`onChnage`

`plugins`