Class: Circle

Circle

Represents a Circle Geometry.

new Circle(center, radius, optionsopt) [source]

var circle = new Circle([100, 0], 1000, {
    id : 'circle0',
    properties : {
        foo : 'bar'
    }
});
Parameter Type Default Description
center Coordinate center of the circle
radius Number radius of the circle, in meter
options opt Object null construct options defined in Circle
Extends:
Mixes From:

Members

  • (constant) options

  • Properties:
    Name Type Description
    options Object
    Properties
    Name Type Default Description
    numberOfShellPoints opt Number 60 number of shell points when converting the circle to a polygon.
    smoothness opt String 0 line smoothing by quad bezier interporating, 0 by default
    symbol Object Path's default symbol
    id opt Boolean null id of the geometry
    visible opt Boolean true whether the geometry is visible.
    editable opt Boolean true whether the geometry can be edited.
    cursor opt String null cursor style when mouseover the geometry, same as the definition in CSS.
    measure opt String EPSG:4326 the measure code for the geometry, defines measureGeometry how it can be measured.
    draggable opt Boolean false whether the geometry can be dragged.
    dragShadow opt Boolean false if true, during geometry dragging, a shadow will be dragged before geometry was moved.
    dragOnAxis opt Boolean null if set, geometry can only be dragged along the specified axis, possible values: x, y
    Source:

    Methods

  • getRadius() [source]

  • Get radius of the circle
    Returns:
    Number:
  • setRadius(radius) [source]

  • Set a new radius to the circle
    Parameter Type Description
    radius Number new radius
    Fires:
    Returns:
    Circle: this
  • getShell() [source]

  • Gets the shell of the circle as a polygon, number of the shell points is decided by options.numberOfShellPoints
    Returns:
    Array.<Coordinate>: - shell coordinates
  • getHoles() [source]

  • Circle won't have any holes, always returns null
    Returns:
    Array.<Object>: an empty array
  • (mixin) getCoordinates() [source]

  • Get geometry's center
    Mixes From:
    Returns:
    Coordinate: - center of the geometry
  • (mixin) setCoordinates(coordinates) [source]

  • Set a new center to the geometry
    Parameter Type Description
    coordinates Coordinate | Array.<Number> new center
    Mixes From:
    Fires:
    Returns:
    Geometry: this
  • (inherited) getCenterInExtent(extent) [source]

  • Get center of linestring's intersection with give extent
    const extent = map.getExtent();
     const center = line.getCenterInExtent(extent);
    Parameter Type Description
    extent Extent
    Inherited From:
    Returns:
    Coordinate: center, null if line doesn't intersect with extent
  • (inherited) hasHoles() [source]

  • Whether the polygon has any holes inside.
    Inherited From:
    Returns:
    Boolean: