logo
Documentation
Tutorials
Getting Started Initialization Layers Third party Controls Geometries Vector styles Measures InfoBox Utils
Releases

Documentation

Modules

  • Constants

Events

  • FEATURE_CLICK
  • FEATURE_HOVER
  • CENTER_DATE_IMAGE
  • CHANGE_MEASURE
  • CLICK
  • COMPLETE_LAYERS_AOIS
  • FEATURES_CLICK
  • FIND_IMAGES_LOADED
  • FINISH_MEASURE
  • LAYER_AOIS
  • MAP_INITIALIZE
  • MOVE_END
  • NO_3D_IMAGES
  • POINTER_MOVE
  • START_MEASURE
  • TILES_END_LOAD
  • TILES_START_LOAD
  • FEATURE_CLICK
  • FEATURE_HOVER

General

Classes / Controls

  • Bar
  • Button
  • Swipe
  • Toggle

Classes / Managers

  • LayerManager
  • MeasurementManager

Classes

  • Map

Geometry

Classes

  • Extent
  • Feature
  • Line
  • Location
  • MultiPolygon
  • Point
  • Polygon

Classes / Readers

  • GeoJSON
  • WKT

InfoBox

Classes

  • InfoBox

Layers

Classes / Internal

  • AOILayer
  • CollectionLayer

Classes

  • ArcGISLayer
  • BingLayer
  • GroupLayer
  • OSMLayer
  • VectorLayer
  • VectorTileLayer
  • VexcelLayer
  • WFSLayer
  • WMSLayer
  • WMTSLayer
  • XYZLayer

Classes / Base Layers

  • BaseGroupLayer
  • BaseTileLayer
  • BaseVectorLayer

Measurements

Classes / Tools

  • CircleTool
  • HeightTool
  • LineTool
  • PointTool
  • PolygonTool
  • RectangleTool
  • RelativeHeightTool

Classes

  • Measure

Services

Classes

  • UserService

Styles

Classes

  • Circle
  • Fill
  • Icon
  • RegularShape
  • Stroke
  • Style
  • Text

Utils

Classes

  • Transform

Class

Toggle

Toggle(opts)

A simple toggle control. The control can be created with an interaction to control its activation.

Constructor

# new Toggle(opts)

Initialization object

Parameters:
Name Type Attributes Default Description
opts object

Button options.

className string <optional>

class of the control

title number <optional>

title of the control

html number <optional>

html to insert in the control

active boolean <optional>
false

the control is created active, default false

disable boolean <optional>
false

the control is created disabled, default false

bar Bar <optional>

a subbar associated with the control (drawn when active if control is nested in a Bar)

onToggle function <optional>

callback when control is clicked (or use change:active event)

Tutorials:
  • Map Toggle

Classes

Toggle

Methods

# getActive() → {boolean}

Gets the control's active state. Returns true if the control is active.

boolean

# getDisable() → {boolean}

Gets the control's disable state. Returns true if the control is disabled.

boolean

# setActive(active)

Sets control state to active

Parameters:
Name Type Description
active boolean

# setDisable(disable)

Disables the control. If disabled, the control will be deactivated too.

Parameters:
Name Type Description
disable boolean

# toggle()

Toggles control's active state

Documentation generated by Vexcel Imaging