Class: Ellipse

Ellipse

Represents a Ellipse Geometry.

new Ellipse(center, width, height, optionsopt) [source]

var ellipse = new Ellipse([100, 0], 1000, 500, {
    id : 'ellipse0'
});
Parameter Type Default Description
center Coordinate center of the ellipse
width Number width of the ellipse, in meter
height Number height of the ellipse, in meter
options opt Object null construct options defined in Ellipse
Extends:
Mixes From:

Members

  • (constant) options

  • Properties:
    Name Type Default Description
    options opt Object null
    Properties
    Name Type Default Description
    numberOfShellPoints opt Number 60 number of shell points when exporting the ellipse's shell coordinates as a polygon.
    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.
    shadowBlur opt Number 0 level of the shadow around the geometry, see MDN's explanation
    shadowColor opt String black color of the shadow around the geometry, a CSS style color
    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

  • getWidth() [source]

  • Get ellipse's width
    Returns:
    Number:
  • setWidth(width) [source]

  • Set new width to ellipse
    Parameter Type Description
    width Number new width
    Fires:
    Returns:
    Ellipse: this
  • getHeight() [source]

  • Get ellipse's height
    Returns:
    Number:
  • setHeight(height) [source]

  • Set new height to ellipse
    Parameter Type Description
    height Number new height
    Fires:
    Returns:
    Ellipse: this
  • getShell() [source]

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

  • Ellipse 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: