Class: ConnectorLine

ConnectorLine

A straight connector line geometry can connect geometries or ui components with each other.

new ConnectorLine(src, target, optionsopt) [source] 

var src = new Marker([0,0]).addTo(layer),
    dst = new Marker([1,0]).addTo(layer),
    line = new ConnectorLine(src, dst, {
        showOn : 'always', //'moving', 'click', 'mouseover', 'always'
        arrowStyle : 'classic',
        arrowPlacement : 'vertex-last', //vertex-first, vertex-last, vertex-firstlast, point
        symbol: {
          lineColor: '#34495e',
          lineWidth: 2
       }
    }).addTo(layer);
Parameter Type Default Description
src Geometry | control.Control | UIComponent source to connect
target Geometry | control.Control | UIComponent target to connect
options opt Object null construct options defined in ConnectorLine
Extends:
Mixes From:
  • connectorLineMixin
Fires:

Members

  • (constant) options

    • Inherited From:
    Properties:
    Name Type Default Description
    options opt Object null
    Properties
    Name Type Default Description
    arrowStyle opt String | Array.<Number> null style of arrow, can be a pre-defined value or an array [arrow-width, arrow-height] (value in the array is times of linewidth), possible predefined values: classic ([3, 4])
    arrowPlacement opt String vertex-last arrow's placement: vertex-first, vertex-last, vertex-firstlast, point
    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
    Inherited From:
    Source:

    Methods

  • (inherited) setCoordinates(coordinates) [source]

    • Set new coordinates to the line string
    Parameter Type Description
    coordinates Array.<Coordinate> | Array.<Array.<Number>> new coordinates
    Inherited From:
    Fires:
    Returns:
    LineString: this

  • (inherited) getCoordinates() [source]

    • Get coordinates of the line string
    Inherited From:
    Returns:
    Array.<Coordinate>|Array.<Array.<Number>>: coordinates

  • (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) 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
    Inherited From:
    Returns:
    LineString: this

  • (inherited) getFirstCoordinate() [source]

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

  • (inherited) getLastCoordinate() [source]

    • Returns the last coordinate of the geometry.
    Inherited From:
    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
    Inherited From:
    Fires:
    Returns:
    Geometry: this

  • (inherited) getLayer() [source]

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

  • (inherited) getMap() [source]

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

  • (inherited) getId() [source]

    • Gets geometry's id. Id is set by setId or constructor options.
    Inherited From:
    Returns:
    String|Number: geometryçš„id

  • (inherited) setId(id) [source]

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

  • (inherited) getProperties() [source]

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

  • (inherited) setProperties(properties) [source]

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

  • (inherited) getType() [source]

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

  • (inherited) getSymbol() [source]

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

  • (inherited) setSymbol(symbol) [source]

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

  • (inherited) updateSymbol(props) [source]

    • Update geometry's current symbol. 
    var marker = new Marker([0, 0], {
   symbol : {
      markerType : 'ellipse',
      markerWidth : 20,
      markerHeight : 30
   }
});
// update symbol's markerWidth to 40
marker.updateSymbol({
    markerWidth : 40
});
    Parameter Type Description
    props Object symbol properties to update
    Inherited From:
    Fires:
    Returns:
    Geometry: this

  • (inherited) getCenter() [source]

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

  • (inherited) getExtent() [source]

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

  • (inherited) getContainerExtent() [source]

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

  • (inherited) getSize() [source]

    • Get pixel size of the geometry, which may vary in different zoom levels.
    Inherited From:
    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
    Inherited From:
    Returns:
    Boolean:

  • (inherited) show() [source]

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

  • (inherited) hide() [source]

    • Hide the geometry
    Inherited From:
    Fires:
    Returns:
    Geometry: this

  • (inherited) isVisible() [source]

    • Whether the geometry is visible
    Inherited From:
    Returns:
    Boolean:

  • (inherited) getZIndex() [source]

    • Get zIndex of the geometry, default is 0
    Inherited From:
    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
    Inherited From:
    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
    Inherited From:
    Returns:
    Geometry: this

  • (inherited) bringToFront() [source]

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

  • (inherited) bringToBack() [source]

    • Bring the geometry to the back
    Inherited From:
    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
    Inherited From:
    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
    Inherited From:
    Returns:
    Geometry: this

  • (inherited) copy() [source]

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

  • (inherited) remove() [source]

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

  • (inherited) toGeoJSONGeometry() [source]

    • Exports geometry out of a GeoJSON feature.
    Inherited From:
    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
    Inherited From:
    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
    Inherited From:
    Returns:
    Object: profile json object

  • (inherited) getLength() [source]

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

  • (inherited) getArea() [source]

    • Get the geographic area of the geometry.
    Inherited From:
    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
    Inherited From:
    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
    Inherited From:
    Returns:
    Geometry: this

  • (inherited) endEdit() [source]

    • End editing.
    Inherited From:
    Returns:
    Geometry: this

  • (inherited) redoEdit() [source]

    • Redo the edit
    Inherited From:
    Returns:
    Geometry: this

  • (inherited) undoEdit() [source]

    • Undo the edit
    Inherited From:
    Returns:
    Geometry: this

  • (inherited) cancelEdit() [source]

    • cancel the edit
    Inherited From:
    Returns:
    Geometry: this

  • (inherited) isEditing() [source]

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

  • (inherited) isDragging() [source]

    • Whether the geometry is being dragged.
    Inherited From:

  • (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
    Inherited From:
    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
    Inherited From:
    Returns:
    Geometry: this

  • (inherited) getInfoWindow() [source]

    • Get the InfoWindow instance.
    Inherited From:
    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
    Inherited From:
    Returns:
    Geometry: this

  • (inherited) closeInfoWindow() [source]

    • Close the InfoWindow
    Inherited From:
    Returns:
    Geometry: this

  • (inherited) removeInfoWindow() [source]

    • Remove the InfoWindow
    Inherited From:
    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:
    Inherited 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:
    Inherited 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:
    Inherited 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:
    Inherited 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:
    Inherited 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:
    Inherited From:
    Returns:
    Number:

  • (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:
    Inherited 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:
    Inherited 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 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:
    Inherited From:
    Returns:
    Class: Class

  • (inherited) getJSONType() [source]

    • Get object's JSON Type
    Mixes From:
    Inherited 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:
    Inherited From:
    Returns:
    *: this

  • (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:
    Inherited From:
    Returns:
    *: this

  • (inherited) setMenuItems(items) [source]

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

  • (inherited) getMenuItems() [source]

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

  • (inherited) closeMenu() [source]

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

  • (inherited) removeMenu() [source]

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

  • (inherited) callInitHooks() [source]

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

  • (inherited) setOptions(options) [source]

    • Merges options with the default options of the object.
    Parameter Type Description
    options Object options to set
    Inherited From:
    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
    Inherited From:
    Returns:
    Class: this

  • (inherited) onConfig() [source]

    • Default callback when config is called
    Inherited From:

    Events

  • (inherited) mousedown [source]

    • mousedown event
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) mouseup [source]

    • mouseup event
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) mousemove [source]

    • mousemove event
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) click [source]

    • click event
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) dblclick [source]

    • dblclick event
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) contextmenu [source]

    • contextmenu event
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) touchstart [source]

    • touchstart event
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) touchmove [source]

    • touchmove event
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) touchend [source]

    • touchend event
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) mouseenter [source]

    • mouseenter event for geometry
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) mouseover [source]

    • mouseover event for geometry
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) mouseout [source]

    • mouseout event for geometry
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) idchange [source]

    • idchange event.
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) propertieschange [source]

    • propertieschange event, thrown when geometry's properties is changed.
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) show [source]

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

  • (inherited) hide [source]

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

  • (inherited) zindexchange [source]

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

  • (inherited) removestart [source]

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

  • (inherited) removeend [source]

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

  • (inherited) remove [source]

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

  • (inherited) shapechange [source]

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

  • (inherited) positionchange [source]

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

  • (inherited) symbolchange [source]

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

  • (inherited) editstart [source]

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

  • (inherited) editend [source]

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

  • (inherited) redoedit [source]

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

  • (inherited) undoedit [source]

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

  • (inherited) canceledit [source]

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

  • (inherited) dragstart [source]

    • drag start event
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) dragging [source]

    • dragging event
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) dragend [source]

    • dragend event
    Inherited From:
    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
    Inherited From:
    Source:

  • (inherited) animateend [source]

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

  • (inherited) animating [source]

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

  • (inherited) animatestart [source]

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

  • (inherited) handledragstart [source]

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

  • (inherited) handledragging [source]

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

  • (inherited) handledragend [source]

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

  • (inherited) editrecord [source]

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

  • (inherited) add [source]

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