• AFFHT Web App

    • Return to HUD EGIS Docs

    Classes and Modules

    Affht.AffhtScalePickerController Class

    Defined in: ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtScalePickerController.js:5

    A class that is responsible for controlling the button for Local vs State scale.

    Methods

    adjustDotDensityRenderer

    ()

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Sidebar\AffhtSidebar.js:43

    Calls the AffhtMap to update the dot density renderer based on the HTML input.

    authenticateUserToken

    (
    • url
    • token
    )
    Deferred

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtAjax.js:64

    Validate the application input token against the specified authentication service.

    Parameters:

    • url String
    • token String

    Returns:

    Deferred:

    d

    createDotDensityRenderer

    (
    • dotValue
    • fields
    • dotSize
    • dotShape
    • valueUnit
    )
    DotDensityRenderer

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:324

    A utility method that builds and returns an Esri JS API DotDensityRenderer object.

    Parameters:

    • dotValue Number
    • fields Array
    • dotSize Number
    • dotShape String
    • valueUnit String

      (optional)

    Returns:

    DotDensityRenderer:

    drawJurisdiction

    ()

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:254

    Draws the currently selected AFFHT grantee boundary on the live map.

    drawRegion

    ()

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:276

    Draws the currently selected AFFHT CBSA boundary on the live map.

    getAllStates

    (
    • url
    )
    Deferred

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtAjax.js:13

    Query all the states from the ArcGIS Server rest endpoint.

    Parameters:

    • url String

    Returns:

    Deferred:

    r

    getGraphicsLayer

    () GraphicsLayer

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:99

    Returns the graphics layer used by the custom affht components.

    Returns:

    GraphicsLayer:

    getMapCollection

    (
    • url
    )
    Deferred

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtAjax.js:40

    Query all the web map json records from the ArcGIS Server rest endpoint.

    Parameters:

    • url String

    Returns:

    Deferred:

    r

    getSelectedAffhtMap

    () Object

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:81

    Returns the object that represents the currently selected AFFHT map.

    Returns:

    Object:

    getSelectedAffhtMap

    () Object

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:90

    Sets the local property to an object that represents the currently selected AFFHT map.

    Returns:

    Object:

    getSelectedJurisdiction

    () Object

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:108

    Returns an Esri JS API feature object representing the selected AFFHT grantee.

    Returns:

    Object:

    getSelectedRegion

    () Object

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:125

    Returns an Esri JS API feature object representing the selected AFFHT CBSA.

    Returns:

    Object:

    hideDotDensitySelect

    ()

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Sidebar\AffhtSidebar.js:61

    Hides the HTML input controls for adjusting the dot density dot value.

    initialize

    (
    • options
    )

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Sidebar\AffhtSidebar.js:27

    Initializes the AFFHT sidebar by injecting the DOM elements and assiging the event handlers.

    Parameters:

    • options Object

    loadMap

    (
    • dotValue
    • fields
    )
    Deferred

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:48

    Loads an Esri JS API map from a JSON definiton object. Returns a deferred that resolves when the map is loaded.

    Parameters:

    • dotValue String
    • fields Array

    Returns:

    Deferred:

    def

    queryJurisdictionById

    (
    • jurisdictionId
    )
    Deferred

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:169

    Queries the ArcGIS Server rest endpoint for a grantee feature with the matching ID.

    Parameters:

    • jurisdictionId String

    Returns:

    Deferred:

    d

    queryJurisdictionsByState

    (
    • stateAbbr
    )
    Deferred

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:142

    Queries the ArcGIS Server rest endpoint for a list of AFFHT grantees within the specified state.

    Parameters:

    • stateAbbr String

    Returns:

    Deferred:

    d

    queryRegionById

    (
    • regionId
    )
    Deferred

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:198

    Queries the ArcGIS Server rest endpoint for a CBSA feature with the matching ID.

    Parameters:

    • regionId String

    Returns:

    Deferred:

    d

    refreshDotDensityTools

    (
    • dotValue
    )

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Sidebar\AffhtSidebar.js:52

    Sets the HTML input to the current dot value of the dot density renderer.

    Parameters:

    • dotValue String

    renderLegend

    () Deferred

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:351

    Creates an AFFHT map legend and injects the HTML into the DOM. An AFFHT map legend has enhanced features to show custom dot density renderer fields based on configuration.

    Returns:

    Deferred:

    d

    saveMap

    (
    • url
    • input
    )
    Deferred

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtAjax.js:90

    Posts a web map json defintion to the specified service endpoint.

    Parameters:

    • url String
    • input Object

    Returns:

    Deferred:

    d

    setConfig

    ()

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:40

    Sets the module config to the input.

    setSelectedJurisdiction

    ()

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:117

    Sets the local property to an Esri JS API feature object representing the selected AFFHT grantee.

    setSelectedRegion

    ()

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:134

    Sets the local property to an Esri JS API feature object representing the selected AFFHT CBSA.

    showDotDensitySelect

    ()

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Sidebar\AffhtSidebar.js:69

    Shows the HTML input controls for adjusting the dot density dot value.

    toggleVisibility

    (
    • map
    )

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Sidebar\AffhtSidebar.js:77

    Toggle the visibility of the side bar.

    Parameters:

    • map Esri/Map

    updateDotDensity

    (
    • dotDensity
    )

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:302

    A utitility method to update all dot density layers in the map with the input dot density ratio value.

    Parameters:

    • dotDensity String

    zoomToJurisdiction

    () Deferred

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:226

    Zooms the live map to the extent of the currently selected AFFHT grantee.

    Returns:

    Deferred:

    zoomToRegion

    () Deferred

    Defined in ..\..\..\..\src\Hud.Affht\Hud.Affht.Web\app\Tools\AffhtMap.js:237

    Zooms the live map to the extent of the currently selected AFFHT CBSA.

    Returns:

    Deferred: