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:
Fires:

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 Number 0 line smoothing by quad bezier interporating, 0 by default
    enableSimplify opt Boolean true whether to simplify path before rendering
    simplifyTolerance opt Number 2 tolerance to simplify path, the higher the simplify is more intense
    enableClip opt Boolean true whether to clip path with map's current extent
    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.
    interactive opt Boolean true whether the geometry can be interactived.
    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 true 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
    zIndex opt Number geometry's initial zIndex
    antiMeridian opt Boolean false geometry's antiMeridian
    Overrides:
    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

  • (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
    Returns:
    Coordinate: center, null if line doesn't intersect with extent

  • (inherited) hasHoles() [source]

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

  • (inherited) animateShow(optionsopt, cbopt) [source]

    • Show the linestring with animation 
    line.animateShow({
   duration : 2000,
   easing : 'linear'
 }, function (frame, currentCoord) {
   //frame is the animation frame
   //currentCoord is current coordinate of animation
 });
    Parameter Type Default Description
    options opt Object null animation options
    Properties
    Parameter Type Default Description
    duration opt Number 1000 duration
    easing opt String out animation easing
    cb opt function null callback function in animation, function parameters: frame, currentCoord
    Returns:
    LineString: this

  • (inherited) getFirstCoordinate() [source]

    • Returns the first coordinate of the geometry.
    Returns:
    Coordinate: First Coordinate

  • (inherited) getLastCoordinate() [source]

    • Returns the last coordinate of the geometry.
    Returns:
    Coordinate: Last Coordinate

  • (inherited) addTo(layer, fitviewopt) [source]

    • Adds the geometry to a layer
    Parameter Type Default Description
    layer Layer layer add to
    fitview opt Boolean false automatically set the map to a fit center and zoom for the geometry
    Fires:
    Returns:
    Geometry: this

  • (inherited) getLayer() [source]

    • Get the layer which this geometry added to.
    Returns:
    Layer: - layer added to

  • (inherited) getMap() [source]

    • Get the map which this geometry added to
    Returns:
    Map: - map added to

  • (inherited) getId() [source]

    • Gets geometry's id. Id is set by setId or constructor options.
    Returns:
    String|Number: geometry的id

  • (inherited) setId(id) [source]

    • Set geometry's id.
    Parameter Type Description
    id String new id
    Fires:
    Returns:
    Geometry: this

  • (inherited) getProperties() [source]

    • Get geometry's properties. Defined by GeoJSON as feature's properties.
    Returns:
    Object: properties

  • (inherited) setProperties(properties) [source]

    • Set a new properties to geometry.
    Parameter Type Description
    properties Object new properties
    Fires:
    Returns:
    Geometry: this

  • (inherited) getType() [source]

    • Get type of the geometry, e.g. "Point", "LineString"
    Returns:
    String: type of the geometry

  • (inherited) getSymbol() [source]

    • Get symbol of the geometry
    Returns:
    Object: geometry's symbol

  • (inherited) setSymbol(symbol) [source]

    • Set a new symbol to style the geometry.
    Parameter Type Description
    symbol Object new symbol
    Fires:
    Returns:
    Geometry: this

  • (inherited) getSymbolHash() [source]

    • Get symbol's hash code
    Returns:
    String:

  • (inherited) updateSymbol(props) [source]

    • Update geometry's current symbol. 
    var marker = new Marker([0, 0], {
 // if has markerFile , the priority of the picture is greater than the vector and the path of svg
 // svg image type:'path';vector type:'cross','x','diamond','bar','square','rectangle','triangle','ellipse','pin','pie'
   symbol : {
      markerType : 'ellipse',
      markerWidth : 20,
      markerHeight : 30
   }
});
// update symbol's markerWidth to 40
marker.updateSymbol({
    markerWidth : 40
});
    Parameter Type Description
    props Object | Array symbol properties to update
    Fires:
    Returns:
    Geometry: this

  • (inherited) getTextContent() [source]

    • Get geometry's text content if it has
    Returns:
    String:

  • (inherited) getCenter() [source]

    • Get the geographical center of the geometry.
    Returns:
    Coordinate:

  • (inherited) getExtent() [source]

    • Get the geometry's geographical extent
    Returns:
    Extent: geometry's extent

  • (inherited) getContainerExtent() [source]

    • Get geometry's screen extent in pixel
    Returns:
    PointExtent:

  • (inherited) getSize() [source]

    • Get pixel size of the geometry, which may vary in different zoom levels.
    Returns:
    Size:

  • (inherited) containsPoint(point, topt) [source]

    • Whehter the geometry contains the input container point. 
    var circle = new Circle([0, 0], 1000)
    .addTo(layer);
var contains = circle.containsPoint(new maptalks.Point(400, 300));
    Parameter Type Description
    point Point | Coordinate input container point or coordinate
    t opt Number tolerance in pixel
    Returns:
    Boolean:

  • (inherited) show() [source]

    • Show the geometry.
    Fires:
    Returns:
    Geometry: this

  • (inherited) hide() [source]

    • Hide the geometry
    Fires:
    Returns:
    Geometry: this

  • (inherited) isVisible() [source]

    • Whether the geometry is visible
    Returns:
    Boolean:

  • (inherited) getZIndex() [source]

    • Get zIndex of the geometry, default is 0
    Returns:
    Number: zIndex

  • (inherited) setZIndex(zIndex) [source]

    • Set a new zIndex to Geometry and fire zindexchange event (will cause layer to sort geometries and render)
    Parameter Type Description
    zIndex Number new zIndex
    Fires:
    Returns:
    Geometry: this

  • (inherited) setZIndexSilently(zIndex) [source]

    • Only set a new zIndex to Geometry without firing zindexchange event.
    Can be useful to improve perf when a lot of geometries' zIndex need to be updated.
    When updated N geometries, You can use setZIndexSilently with (N-1) geometries and use setZIndex with the last geometry for layer to sort and render.
    Parameter Type Description
    zIndex Number new zIndex
    Returns:
    Geometry: this

  • (inherited) bringToFront() [source]

    • Bring the geometry on the top
    Fires:
    Returns:
    Geometry: this

  • (inherited) bringToBack() [source]

    • Bring the geometry to the back
    Fires:
    Returns:
    Geometry: this

  • (inherited) translate(x, y) [source]

    • Translate or move the geometry by the given offset.
    Parameter Type Description
    x Number x offset
    y Number y offset
    Fires:
    Returns:
    Geometry: this

  • (inherited) flash(intervalopt, countopt, cbopt, contextopt) [source]

    • Flash the geometry, show and hide by certain internal for times of count.
    Parameter Type Default Description
    interval opt Number 100 interval of flash, in millisecond (ms)
    count opt Number 4 flash times
    cb opt function null callback function when flash ended
    context opt * null callback context
    Returns:
    Geometry: this

  • (inherited) copy() [source]

    • Returns a copy of the geometry without the event listeners.
    Returns:
    Geometry: copy

  • (inherited) remove() [source]

    • remove itself from the layer if any.
    Fires:
    Returns:
    Geometry: this

  • (inherited) toGeoJSONGeometry() [source]

    • Exports geometry out of a GeoJSON feature.
    Returns:
    Object: GeoJSON Geometry

  • (inherited) toGeoJSON(optsopt) [source]

    • Exports a GeoJSON feature.
    Parameter Type Default Description
    opts opt Object null export options
    Properties
    Parameter Type Default Description
    geometry opt Boolean true whether export geometry
    properties opt Boolean true whether export properties
    Returns:
    Object: GeoJSON Feature

  • (inherited) toJSON(optionsopt) [source]

    • Export a profile json out of the geometry.
    Besides exporting the feature object, a profile json also contains symbol, construct options and infowindow info.
    The profile json can be stored somewhere else and be used to reproduce the geometry later.
    Due to the problem of serialization for functions, event listeners and contextmenu are not included in profile json. 
    // an example of a profile json.
var profile = {
            "feature": {
                  "type": "Feature",
                  "id" : "point1",
                  "geometry": {"type": "Point", "coordinates": [102.0, 0.5]},
                  "properties": {"prop0": "value0"}
            },
            //construct options.
            "options":{
                "draggable" : true
            },
            //symbol
            "symbol":{
                "markerFile"  : "http://foo.com/icon.png",
                "markerWidth" : 20,
                "markerHeight": 20
            },
            //infowindow info
            "infowindow" : {
                "options" : {
                    "style" : "black"
                },
                "title" : "this is a infowindow title",
                "content" : "this is a infowindow content"
            }
        };
    Parameter Type Default Description
    options opt Object null export options
    opts.geometry opt Boolean true whether export feature's geometry
    opts.properties opt Boolean true whether export feature's properties
    opts.options opt Boolean true whether export construct options
    opts.symbol opt Boolean true whether export symbol
    opts.infoWindow opt Boolean true whether export infowindow
    Returns:
    Object: profile json object

  • (inherited) getLength() [source]

    • Get the geographic length of the geometry.
    Returns:
    Number: geographic length, unit is meter

  • (inherited) getArea() [source]

    • Get the geographic area of the geometry.
    Returns:
    Number: geographic area, unit is sq.meter

  • (inherited) rotate(angle, pivotopt) [source]

    • Rotate the geometry of given angle around a pivot point
    Parameter Type Default Description
    angle Number angle to rotate in degree
    pivot opt Coordinate null optional, will be the geometry's center by default
    Returns:
    Geometry: this

  • (inherited) startEdit(optionsopt) [source]

    • Start to edit
    Parameter Type Default Description
    options opt Object null edit options
    Properties
    Parameter Type Default Description
    symbol opt Object null symbol for the geometry during editing
    fixAspectRatio opt Object false fix outline's aspect ratio when resizing
    centerHandleSymbol opt Object null symbol of center handle
    vertexHandleSymbol opt Object null symbol of vertex handle
    newVertexHandleSymbol opt Object null symbol of new vertex handle
    removeVertexOn opt Object contextmenu event to remove a vertex from line or polygon, contextmenu by default
    Returns:
    Geometry: this

  • (inherited) endEdit() [source]

    • End editing.
    Returns:
    Geometry: this

  • (inherited) redoEdit() [source]

    • Redo the edit
    Returns:
    Geometry: this

  • (inherited) undoEdit() [source]

    • Undo the edit
    Returns:
    Geometry: this

  • (inherited) cancelEdit() [source]

    • cancel the edit
    Returns:
    Geometry: this

  • (inherited) isEditing() [source]

    • Whether the geometry is being edited.
    Returns:
    Boolean:

  • (inherited) isDragging() [source]

    • Whether the geometry is being dragged.

  • (inherited) animate(styles, optionsopt, stepopt) [source]

    • Animate the geometry 
    var player = marker.animate({
    'symbol': {
        'markerHeight': 82
     }
}, {
    'duration': 2000
}, function (frame) {
    if (frame.state.playState === 'finished') {
        console.log('animation finished');
    }
});
player.pause();
    Parameter Type Default Description
    styles Object styles to animate
    options opt Object null animation options
    Properties
    Parameter Type Default Description
    duration opt NUmber 1000 duration
    startTime opt Number null time to start animation in ms
    easing opt String linear animation easing: in, out, inAndOut, linear, upAndDown
    repeat opt Boolean false repeat animation
    step opt function null step function during animation, animation frame as the parameter
    Returns:
    animation.Player: animation player

  • (inherited) setInfoWindow(options) [source]

    • Set an InfoWindow to the geometry 
    geometry.setInfoWindow({
    title    : 'This is a title',
    content  : '<div style="color:#f00">This is content of the InfoWindow</div>'
});
    Parameter Type Description
    options Object construct options for the InfoWindow
    Returns:
    Geometry: this

  • (inherited) getInfoWindow() [source]

    • Get the InfoWindow instance.
    Returns:
    ui.InfoWindow:

  • (inherited) openInfoWindow(coordinateopt) [source]

    • Open the InfoWindow, default on the center of the geometry.
    Parameter Type Default Description
    coordinate opt Coordinate null coordinate to open the InfoWindow
    Returns:
    Geometry: this

  • (inherited) closeInfoWindow() [source]

    • Close the InfoWindow
    Returns:
    Geometry: this

  • (inherited) removeInfoWindow() [source]

    • Remove the InfoWindow
    Returns:
    Geometry: this

  • (inherited) on(eventsOn, handler, contextopt) [source]

    • Register a handler function to be called whenever this event is fired. 
    foo.on('mousedown mousemove mouseup', onMouseEvent, foo);
    Parameter Type Default Description
    eventsOn String event types to register, seperated by space if more than one.
    handler function handler function to be called
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    Any: this

  • (inherited) addEventListener(eventTypes, handler, contextopt) [source]

    • Alias for on
    Parameter Type Default Description
    eventTypes String event types to register, seperated by space if more than one.
    handler function handler function to be called
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    : this

  • (inherited) once(eventTypes, handler, contextopt) [source]

    • Same as on, except the listener will only get fired once and then removed. 
    foo.once('mousedown mousemove mouseup', onMouseEvent, foo);
    Parameter Type Default Description
    eventTypes String event types to register, seperated by space if more than one.
    handler function listener handler
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    : this

  • (inherited) off(eventsOff, handler, contextopt) [source]

    • Unregister the event handler for the specified event types. 
    foo.off('mousedown mousemove mouseup', onMouseEvent, foo);
    Parameter Type Default Description
    eventsOff String event types to unregister, seperated by space if more than one.
    handler function listener handler
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    : this

  • (inherited) removeEventListener(eventTypes, handler, contextopt) [source]

    • Alias for off
    Parameter Type Default Description
    eventTypes String event types to unregister, seperated by space if more than one.
    handler function listener handler
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    : this

  • (inherited) listens(eventType, hanlderopt, contextopt) [source]

    • Returns listener's count registered for the event type.
    Parameter Type Default Description
    eventType String an event type
    hanlder opt function null listener function
    context opt Object null the context of the handler
    Mixes From:
    Returns:
    Number:

  • (inherited) getListeningEvents() [source]

    • Get all the listening event types
    Mixes From:
    Returns:
    Array.<String>: events

  • (inherited) copyEventListeners(target) [source]

    • Copy all the event listener to the target object
    Parameter Type Description
    target Object target object to copy to.
    Mixes From:
    Returns:
    : this

  • (inherited) fire(eventType, param) [source]

    • Fire an event, causing all handlers for that event name to run.
    Parameter Type Description
    eventType String an event type to fire
    param Object parameters for the listener function.
    Mixes From:
    Returns:
    : this

  • (inherited) registerJSONType(type) [source]

    • It is a static method.
    Register layer for JSON serialization and assign a JSON type.
    Parameter Type Description
    type String JSON type
    Mixes From:

  • (inherited) getJSONClass(type) [source]

    • It is a static method.
    Get class of input JSON type
    Parameter Type Description
    type String JSON type
    Mixes From:
    Returns:
    Class: Class

  • (inherited) getJSONType() [source]

    • Get object's JSON Type
    Mixes From:
    Returns:
    String:

  • (inherited) setMenu(options) [source]

    • Set a context menu 
    foo.setMenu({
 'width'  : 160,
 'custom' : false,
 'items' : [
     //return false to prevent event propagation
    {'item': 'Query', 'click': function() {alert('Query Clicked!'); return false;}},
    '-',
    {'item': 'Edit', 'click': function() {alert('Edit Clicked!')}},
    {'item': 'About', 'click': function() {alert('About Clicked!')}}
   ]
});
    Parameter Type Description
    options Object menu options
    Mixes From:
    Returns:
    *: this

  • (inherited) getMenu() [source]

    • get a context menu
    Mixes From:
    Returns:
    *: ui.Menu

  • (inherited) openMenu(coordinateopt) [source]

    • Open the context menu, default on the center of the geometry or map.
    Parameter Type Default Description
    coordinate opt Coordinate null coordinate to open the context menu
    Mixes From:
    Returns:
    *: this

  • (inherited) setMenuItems(items) [source]

    • Set menu items to the context menu
    Parameter Type Description
    items Array.<Object> menu items
    Mixes From:
    Returns:
    *: this

  • (inherited) getMenuItems() [source]

    • Get the context menu items
    Mixes From:
    Returns:
    Array.<Object>:

  • (inherited) closeMenu() [source]

    • Close the contexnt menu
    Mixes From:
    Returns:
    *: this

  • (inherited) removeMenu() [source]

    • Remove the context menu
    Mixes From:
    Returns:
    *: this

  • (inherited) callInitHooks() [source]

    • Visit and call all the init hooks defined on Class and its parents.
    Returns:
    Class: this

  • (inherited) setOptions(options) [source]

    • Merges options with the default options of the object.
    Parameter Type Description
    options Object options to set
    Returns:
    Class: this

  • (inherited) config(conf) [source]

    • 1. Return object's options if no parameter is provided.
    2. update an option and enable/disable the handler if a handler with the same name existed. 
    // Get marker's options;
var options = marker.config();
// Set map's option "draggable" to false and disable map's draggable handler.
map.config('draggable', false);
// You can update more than one options like this:
map.config({
    'scrollWheelZoom' : false,
    'doubleClickZoom' : false
});
    Parameter Type Description
    conf Object config to update
    Returns:
    Class: this

  • (inherited) onConfig() [source]

    • Default callback when config is called

    Events

  • (inherited) mousedown [source]

    • mousedown event
    Properties:
    Name Type Description
    type String mousedown
    target Geometry the Geometry fires event
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) mouseup [source]

    • mouseup event
    Properties:
    Name Type Description
    type String mouseup
    target Geometry the Geometry fires event
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) mousemove [source]

    • mousemove event
    Properties:
    Name Type Description
    type String mousemove
    target Geometry the Geometry fires event
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) click [source]

    • click event
    Properties:
    Name Type Description
    type String click
    target Geometry the Geometry fires event
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) dblclick [source]

    • dblclick event
    Properties:
    Name Type Description
    type String dblclick
    target Geometry the Geometry fires event
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) contextmenu [source]

    • contextmenu event
    Properties:
    Name Type Description
    type String contextmenu
    target Geometry the Geometry fires event
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) touchstart [source]

    • touchstart event
    Properties:
    Name Type Description
    type String touchstart
    target Geometry the Geometry fires event
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) touchmove [source]

    • touchmove event
    Properties:
    Name Type Description
    type String touchmove
    target Geometry the Geometry fires event
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) touchend [source]

    • touchend event
    Properties:
    Name Type Description
    type String touchend
    target Geometry the Geometry fires event
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) mouseenter [source]

    • mouseenter event for geometry
    Properties:
    Name Type Description
    type String mouseenter
    target Geometry the geometry fires mouseenter
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) mouseover [source]

    • mouseover event for geometry
    Properties:
    Name Type Description
    type String mouseover
    target Geometry the geometry fires mouseover
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) mouseout [source]

    • mouseout event for geometry
    Properties:
    Name Type Description
    type String mouseout
    target Geometry the geometry fires mouseout
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) idchange [source]

    • idchange event.
    Properties:
    Name Type Description
    type String idchange
    target Geometry the geometry fires the event
    old String | Number value of the old id
    new String | Number value of the new id
    Overrides:
    Source:

  • (inherited) propertieschange [source]

    • propertieschange event, thrown when geometry's properties is changed.
    Properties:
    Name Type Description
    type String propertieschange
    target Geometry the geometry fires the event
    old String | Number value of the old properties
    new String | Number value of the new properties
    Overrides:
    Source:

  • (inherited) show [source]

    • show event
    Properties:
    Name Type Description
    type String show
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) hide [source]

    • hide event
    Properties:
    Name Type Description
    type String hide
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) zindexchange [source]

    • zindexchange event, fired when geometry's zIndex is changed.
    Properties:
    Name Type Description
    type String zindexchange
    target Geometry the geometry fires the event
    old Number old zIndex
    new Number new zIndex
    Overrides:
    Source:

  • (inherited) removestart [source]

    • removestart event.
    Properties:
    Name Type Description
    type String removestart
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) removeend [source]

    • removeend event.
    Properties:
    Name Type Description
    type String removeend
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) remove [source]

    • remove event.
    Properties:
    Name Type Description
    type String remove
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) shapechange [source]

    • shapechange event.
    Properties:
    Name Type Description
    type String shapechange
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) positionchange [source]

    • positionchange event.
    Properties:
    Name Type Description
    type String positionchange
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) symbolchange [source]

    • symbolchange event.
    Properties:
    Name Type Description
    type String symbolchange
    target Geometry the geometry fires the event
    properties Object symbol properties to update if has
    Overrides:
    Source:

  • (inherited) editstart [source]

    • start edit event
    Properties:
    Name Type Description
    type String editstart
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) editend [source]

    • end edit event
    Properties:
    Name Type Description
    type String editend
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) redoedit [source]

    • redo edit event
    Properties:
    Name Type Description
    type String redoedit
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) undoedit [source]

    • undo edit event
    Properties:
    Name Type Description
    type String undoedit
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) canceledit [source]

    • cancel edit event
    Properties:
    Name Type Description
    type String canceledit
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) dragstart [source]

    • drag start event
    Properties:
    Name Type Description
    type String dragstart
    target Geometry the geometry fires event
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) dragging [source]

    • dragging event
    Properties:
    Name Type Description
    type String dragging
    target Geometry the geometry fires event
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) dragend [source]

    • dragend event
    Properties:
    Name Type Description
    type String dragend
    target Geometry the geometry fires event
    coordinate Coordinate coordinate of the event
    containerPoint Point container point of the event
    viewPoint Point view point of the event
    domEvent Event dom event
    Overrides:
    Source:

  • (inherited) animateend [source]

    • fired when geometry's animation ended.
    Properties:
    Name Type Description
    type String animateend
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) animating [source]

    • fired when geometry is animating.
    Properties:
    Name Type Description
    type String animating
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) animatestart [source]

    • fired when geometry's animation start.
    Properties:
    Name Type Description
    type String animatestart
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) handledragstart [source]

    • change geometry shape start event, fired when drag to change geometry shape.
    Properties:
    Name Type Description
    type String handledragstart
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) handledragging [source]

    • changing geometry shape event, fired when dragging to change geometry shape.
    Properties:
    Name Type Description
    type String handledragging
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) handledragend [source]

    • changed geometry shape event, fired when drag end to change geometry shape.
    Properties:
    Name Type Description
    type String handledragend
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) editrecord [source]

    • edit record event, fired when an edit happend and being recorded
    Properties:
    Name Type Description
    type String editrecord
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) add [source]

    • add event.
    Properties:
    Name Type Description
    type String add
    target Geometry geometry
    layer Layer the layer added to.
    Overrides:
    Source:

  • (inherited) openmenu [source]

    • openmenu event
    Properties:
    Name Type Description
    type String openmenu
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) closemenu [source]

    • closemenu event
    Properties:
    Name Type Description
    type String closemenu
    target Geometry the geometry fires the event
    Overrides:
    Source:

  • (inherited) removemenu [source]

    • removemenu event
    Properties:
    Name Type Description
    type String removemenu
    target Geometry the geometry fires the event
    Overrides:
    Source: