API / geotoolkit / scene / shapes / painters / AimPainter / AimPainter
painters.AimPainter.AimPainter
Draws an aim symbol that consists of a multiple circles with the same center and different radiuses
↳
AimPainter
Constructors
Methods
Constructors
• new AimPainter(radiuses?)
Create AimPainter
| Name | Type | Description |
|---|---|---|
Optional radiuses | number[] | { radiuses?: number[] } | array of the circles radiuses (from 0 to 1) or properties object |
EventDispatcher.constructor
Methods
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getProperties(): Object
Gets all the properties pertaining to the aim painter
Object
aim painter properties
| Name | Type |
|---|---|
radiuses | number[] |
▸ getRadiuses(): number[]
Returns current aim circle radiuses
number[]
radiuses
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
EventDispatcher.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify(type, source, args?): AimPainter
Notify listeners
| Name | Type | Description |
|---|---|---|
type | string | event types |
source | any | of the event |
Optional args | any | arguments of the event |
this
▸ off(type?, callback?): AimPainter
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type | Description |
|---|---|---|
Optional type | string | type of the event |
Optional callback | EventListener | function to be called |
this
▸ off<E>(type, callback): AimPainter
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: AimPainter, args: EventMap[E]) => void |
▸ on(type, callback, options?): AimPainter
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
callback | EventListener | to be called |
Optional options | Options | options of subscription |
this
▸ on<E>(type, callback, options?): AimPainter
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: AimPainter, args: EventMap[E]) => void |
Optional options | Options |
▸ render(context, symbol, bbox): void
Draw text on context
| Name | Type | Description |
|---|---|---|
context | RenderingContext | rendering context |
symbol | SymbolShape | symbol, which uses this painter |
bbox | Rect | bounding box |
void
▸ setProperties(props?): AimPainter
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional props | Object | aim painter properties |
Optional props.radiuses | number[] |
this
▸ setRadiuses(radiuses): AimPainter
Sets aim circle radiuses (from 0 to 1)
| Name | Type | Description |
|---|---|---|
radiuses | number[] | array of the circles radiuses (from 0 to 1) |
this
▸ setSilent(bool): AimPainter
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ Static getClassName(): string
string