packages/core/src/lib/directives/circle.ts
| Selector | agm-circle |
Properties |
|
Methods |
Inputs |
Outputs |
constructor(_manager: CircleManager)
|
||||||
|
Parameters :
|
| circleDraggable | |
Default value : false
|
|
|
If set to true, the user can drag this circle over the map. Defaults to false. |
|
| clickable | |
Default value : true
|
|
|
Indicates whether this Circle handles mouse events. Defaults to true. |
|
| editable | |
Default value : false
|
|
|
If set to true, the user can edit this circle by dragging the control points shown at the center and around the circumference of the circle. Defaults to false. |
|
| fillColor | |
Type : string
|
|
|
The fill color. All CSS3 colors are supported except for extended named colors. |
|
| fillOpacity | |
Type : number
|
|
|
The fill opacity between 0.0 and 1.0. |
|
| latitude | |
Type : number
|
|
|
The latitude position of the circle (required). |
|
| longitude | |
Type : number
|
|
|
The clickable position of the circle (required). |
|
| radius | |
Default value : 0
|
|
|
The radius in meters on the Earth's surface. |
|
| strokeColor | |
Type : string
|
|
|
The stroke color. All CSS3 colors are supported except for extended named colors. |
|
| strokeOpacity | |
Type : number
|
|
|
The stroke opacity between 0.0 and 1.0 |
|
| strokePosition | |
Default value : 'CENTER'
|
|
|
The stroke position. Defaults to CENTER. This property is not supported on Internet Explorer 8 and earlier. |
|
| strokeWeight | |
Default value : 0
|
|
|
The stroke width in pixels. |
|
| visible | |
Default value : true
|
|
|
Whether this circle is visible on the map. Defaults to true. |
|
| zIndex | |
Type : number
|
|
|
The zIndex compared to other polys. |
|
| centerChange | |
Type : EventEmitter<google.maps.LatLngLiteral>
|
|
|
This event is fired when the circle's center is changed. |
|
| circleClick | |
Type : EventEmitter<google.maps.MouseEvent>
|
|
|
This event emitter gets emitted when the user clicks on the circle. |
|
| circleDblClick | |
Type : EventEmitter<google.maps.MouseEvent>
|
|
|
This event emitter gets emitted when the user clicks on the circle. |
|
| drag | |
Type : EventEmitter<google.maps.MouseEvent>
|
|
|
This event is repeatedly fired while the user drags the circle. |
|
| dragEnd | |
Type : EventEmitter<google.maps.MouseEvent>
|
|
|
This event is fired when the user stops dragging the circle. |
|
| dragStart | |
Type : EventEmitter<google.maps.MouseEvent>
|
|
|
This event is fired when the user starts dragging the circle. |
|
| mouseDown | |
Type : EventEmitter<google.maps.MouseEvent>
|
|
|
This event is fired when the DOM mousedown event is fired on the circle. |
|
| mouseMove | |
Type : EventEmitter<google.maps.MouseEvent>
|
|
|
This event is fired when the DOM mousemove event is fired on the circle. |
|
| mouseOut | |
Type : EventEmitter<google.maps.MouseEvent>
|
|
|
This event is fired on circle mouseout. |
|
| mouseOver | |
Type : EventEmitter<google.maps.MouseEvent>
|
|
|
This event is fired on circle mouseover. |
|
| mouseUp | |
Type : EventEmitter<google.maps.MouseEvent>
|
|
|
This event is fired when the DOM mouseup event is fired on the circle. |
|
| radiusChange | |
Type : EventEmitter<number>
|
|
|
This event is fired when the circle's radius is changed. |
|
| rightClick | |
Type : EventEmitter<google.maps.MouseEvent>
|
|
|
This event is fired when the circle is right-clicked on. |
|
| Private _registerEventListeners |
_registerEventListeners()
|
|
Returns :
void
|
| Private _updateCircleOptionsChanges | ||||||
_updateCircleOptionsChanges(changes: literal type)
|
||||||
|
Parameters :
Returns :
void
|
| getBounds |
getBounds()
|
|
Gets the LatLngBounds of this Circle.
Returns :
Promise<google.maps.LatLngBounds>
|
| getCenter |
getCenter()
|
|
Returns :
Promise<google.maps.LatLng>
|
| ngOnChanges | ||||||
ngOnChanges(changes: literal type)
|
||||||
|
Parameters :
Returns :
void
|
| ngOnDestroy |
ngOnDestroy()
|
|
Returns :
void
|
| ngOnInit |
ngOnInit()
|
|
Returns :
void
|
| Private _circleAddedToManager |
Default value : false
|
| Private _eventSubscriptions |
Type : Subscription[]
|
Default value : []
|
| Private Static _mapOptions |
Type : string[]
|
Default value : [
'fillColor', 'fillOpacity', 'strokeColor', 'strokeOpacity', 'strokePosition', 'strokeWeight',
'visible', 'zIndex', 'clickable',
]
|