CircleStyleLayer
A style layer that defines a circle
Extends
Methods
listens()
listens(
type
:string
):boolean
Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.
Parameters
Parameter | Type | Description |
---|---|---|
type |
string |
The event type |
Returns
boolean
true
if there is at least one registered listener for specified event type, false
otherwise
Inherited from
Defined in
off()
off(
type
:string
,listener
:Listener
):CircleStyleLayer
Removes a previously registered event listener.
Parameters
Parameter | Type | Description |
---|---|---|
type |
string |
The event type to remove listeners for. |
listener |
Listener |
The listener function to remove. |
Returns
Inherited from
Defined in
on()
on(
type
:string
,listener
:Listener
):this
Adds a listener to a specified event type.
Parameters
Parameter | Type | Description |
---|---|---|
type |
string |
The event type to add a listen for. |
listener |
Listener |
The function to be called when the event is fired. The listener function is called with the data object passed to fire , extended with target and type properties. |
Returns
this
Inherited from
Defined in
once()
once(
type
:string
,listener
?:Listener
):Promise
<any
> |CircleStyleLayer
Adds a listener that will be called only once to a specified event type.
The listener will be called first time the event fires after the listener is registered.
Parameters
Parameter | Type | Description |
---|---|---|
type |
string |
The event type to listen for. |
listener ? |
Listener |
The function to be called when the event is fired the first time. |
Returns
Promise
<any
> | CircleStyleLayer
this
or a promise if a listener is not provided
Inherited from
Defined in
setEventedParent()
setEventedParent(
parent
?:Evented
,data
?:any
):CircleStyleLayer
Bubble all events fired by this instance of Evented to this parent instance of Evented.
Parameters
Parameter | Type |
---|---|
parent ? |
Evented |
data ? |
any |