Class: SearchOverlayUI

SearchOverlayUI

new SearchOverlayUI(config)

Controls the DOM of an individual search by area overlay.
Parameters:
Name Type Description
config Object Configuration for this object. The config supplied directly extends the control

Members

(static) content

Properties:
Name Type Description
content object The root DOM element of the UI.

(static) events

Properties:
Name Type Description
events Cadcorp.Util.Events The Event handler.

(static) overlay

Properties:
Name Type Description
overlay Cadcorp.GeognoSIS.Overlay The overlay used to populate the UI.

(static) overlayOffImageUrl

Properties:
Name Type Description
overlayOnImageUrl string The url of the OverlayOn image file on the web server.

(static) overlayOnImageUrl

Properties:
Name Type Description
overlayOnImageUrl string The url of the OverlayOn image file on the web server.

(static) selected

Properties:
Name Type Description
selected boolean Is the overlay currently selected.

Methods

(static) buildUI() → {object}

Builds the UI DOM elements.
Returns:
The root DOM element of the created UI.
Type
object

(static) clickHandler()

Handles the DOM click element.
Fires:

(static) destroy()

Safely destroy this object.

(static) getUI()

Get the root DOM element of the UI.

(static) registerClickHandler()

Register a {Cadcorp.UI.SearchByArea.SearchUI.OverlayClickedCallback} to execute on {Cadcorp.UI.SearchByArea.SearchOverlayUI~searchoverlayclicked} from this object.

(static) setLayerVisibility(visibility)

Set the layer visibility.
Parameters:
Name Type Description
visibility boolean The desired visibility status.

(static) unregisterClickHandler()

Unregister a {Cadcorp.UI.SearchByArea.SearchUI.OverlayClickedCallback} from {Cadcorp.UI.SearchByArea.SearchOverlayUI~searchoverlayclicked} on this object.

Events

searchoverlayclicked

searchoverlayclicked event.
Type:
  • object
Properties:
Name Type Description
overlay Cadcorp.GeognoSIS.Overlay The overlay clicked.
status boolean The current state of the overlay selection.