logo
API 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_COLLECTIONS
  • FEATURES_CLICK
  • FIND_IMAGES_LOADED
  • FINISH_MEASURE
  • MAP_INITIALIZE
  • MAP_STATUS_EVENT
  • 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

  • CollectionManager
  • OverlayManager

Classes

  • Map

Classes / View

  • MapStatusView

Geometry

Classes

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

Classes / Readers

  • GeoJSON
  • WKT

InfoBox

Classes

  • InfoBox

Layers

Classes

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

Classes / Base Layers

  • BaseLayer
  • BaseVectorLayer

Measurements

Classes / Tools

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

Classes

  • Measure

Objects

Classes

  • Collection
  • CollectionStatus
  • Image
  • LayerCollections
  • LayerCollectionsStatus
  • MapStatus

Services

Classes

  • UserService

Styles

Classes

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

Utils

Classes

  • Transform

Class

Circle

Circle(opts)

Set circle style for vector features.

Learn how to implement a Circle in our Point styles tutorial.

Constructor

# new Circle(opts)

Initialization object

Parameters:
Name Type Attributes Description
opts object

Options

fill Fill <optional>

Fill style.

stroke Stroke <optional>

Stroke style

radius number <optional>

Circle radius.

opacity number <optional>

Opacity.

rotateWithView boolean <optional>

Whether to rotate the shape with the view (meaningful only when used in conjunction with a two dimensional scale).

rotation number <optional>

Rotation in radians (positive rotation clockwise, meaningful only when used in conjunction with a two dimensional scale).

scale number <optional>

Scale. A two dimensional scale will produce an ellipse. Unless two dimensional scaling is required a better result may be obtained with an appropriate setting for radius

displacement number <optional>

Displacement.

Tutorials:
  • Point styles

Classes

Circle

Methods

# getAnchor() → {Array.<number>}

Get the anchor point in pixels. The anchor determines the center point for the symbolizer.

Anchor.

Array.<number>

# getDisplacement() → {Array.<number>}

Get the displacement of the shape

Shape's center displacement

Array.<number>

# getFill() → {Fill}

Get the fill style.

Fill

# getOpacity() → {number}

Get the symbolizer opacity.

Opacity.

number

# getRadius() → {number}

Get the (primary) radius for the shape.

Radius.

number

# getRotateWithView() → {boolean}

Determine whether the symbolizer rotates with the map.

Rotate with map.

boolean

# getRotation() → {number}

Get the symoblizer rotation.

Rotation.

number

# getScale() → {number}

Get the symbolizer scale.

Scale.

number

# getStroke() → {Stroke}

Get the stroke style

Stroke

# setFill(fill)

Set the fill style.

Parameters:
Name Type Description
fill Fill

# setOpacity(opacity)

Set the opacity.

Parameters:
Name Type Description
opacity number

Opacity.

# setRotateWithView(rotateWithView)

Set whether to rotate the style with the view.

Parameters:
Name Type Description
rotateWithView boolean

Rotate with map.

# setRotation(rotation)

Set the rotation.

Parameters:
Name Type Description
rotation number

Rotation.

# setScale(scale)

Set the scale.

Parameters:
Name Type Description
scale number

Scale.

# setStroke(stroke)

Set the stroke style

Parameters:
Name Type Description
stroke Stroke

Documentation generated by Vexcel Imaging