Interface PointMarker

Visual that is displayed at the Cursors position. Has customizable fill and border.

Hierarchy

Marginable
Interactable
- PointMarker

Implemented by

UIPoint

Properties

getFillStyle

getFillStyle: (() => FillStyle)

Type declaration

- (): FillStyle
- Get fillStyle of PointMarker
  
  Returns
  FillStyle object
  
  Returns FillStyle

getOrigin

getOrigin: (() => Point)

Type declaration

- (): Point
- Get origin position of PointMarker
  
  Returns
  (-1 to 1 which specifies position of origin, 0 is center of the object)
  
  Returns Point

getSize

getSize: (() => Point)

Type declaration

- (): Point
- Get size of PointMarker
  
  Returns
  Size of PointMarker in pixels
  
  Returns Point

setFillStyle

setFillStyle: ((fillStyle: FillStyle | ImmutableMutator<FillStyle, FillStyle>) => PointMarker)

Type declaration

- (fillStyle: FillStyle | ImmutableMutator<FillStyle, FillStyle>): PointMarker
- Set fillStyle of PointMarker
  
  Returns
  Object itself
  Parameters
  - fillStyle: FillStyle | ImmutableMutator<FillStyle, FillStyle>
    
    FillStyle object or mutator to modify existing one
  Returns PointMarker

setOrigin

setOrigin: ((origin: Point) => PointMarker)

Type declaration

- (origin: Point): PointMarker
- Set origin position of PointMarker
  
  Returns
  Object itself for fluent interface
  Parameters
  - origin: Point
    
    (-1 to 1 which specifies position of origin, 0 is center of the object)
  Returns PointMarker

setSize

setSize: ((size: Point) => PointMarker)

Type declaration

- (size: Point): PointMarker
- Set size of PointMarker
  
  Returns
  Object itself
  Parameters
  - size: Point
    
    Size of PointMarker in pixels
  Returns PointMarker

Methods

getMargin

getMargin(): Margin
Get margin around object in pixels.

Returns
Margin datastructure

Returns Margin

Inherited from Marginable.getMargin

getMouseInteractions

getMouseInteractions(): boolean
Returns
Mouse interactions state

Returns boolean

Inherited from Interactable.getMouseInteractions

getRotation

getRotation(): number
Get rotation of point shape in degrees.

Returns
Rotation as degrees

Returns number

getShape

getShape(): Icon | PointShape
Get displayed shape.

Returns Icon | PointShape

offMouseClick

offMouseClick(token: Token): boolean
Remove event listener from Mouse Click Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offMouseClick

offMouseDoubleClick

offMouseDoubleClick(token: Token): boolean
Remove event listener from Mouse Double Click Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offMouseDoubleClick

offMouseDown

offMouseDown(token: Token): boolean
Remove event listener from Mouse Down Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offMouseDown

offMouseDrag

offMouseDrag(token: Token): boolean
Remove event listener from Mouse Drag Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offMouseDrag

offMouseDragStart

offMouseDragStart(token: Token): boolean
Remove event listener from Mouse Drag start Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offMouseDragStart

offMouseDragStop

offMouseDragStop(token: Token): boolean
Remove event listener from Mouse Drag stop Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offMouseDragStop

offMouseEnter

offMouseEnter(token: Token): boolean
Remove event listener from Mouse Enter Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offMouseEnter

offMouseLeave

offMouseLeave(token: Token): boolean
Remove event listener from Mouse Leave Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offMouseLeave

offMouseMove

offMouseMove(token: Token): boolean
Remove event listener from Mouse Move Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offMouseMove

offMouseUp

offMouseUp(token: Token): boolean
Remove event listener from Mouse Up Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offMouseUp

offMouseWheel

offMouseWheel(token: Token): boolean
Remove event listener from Mouse Wheel Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offMouseWheel

offTouchEnd

offTouchEnd(token: Token): boolean
Remove event listener from Touch End Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offTouchEnd

offTouchMove

offTouchMove(token: Token): boolean
Remove event listener from Touch Move Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offTouchMove

offTouchStart

offTouchStart(token: Token): boolean
Remove event listener from Touch Start Event

Returns
True if the listener is successfully removed and false if it is not found
Parameters
- token: Token
  
  Token of event listener which has to be removed
Returns boolean

Inherited from Interactable.offTouchStart

onMouseClick

onMouseClick(listener: MouseEventHandler<PointMarker, {}>): Token
Subscribe on Mouse Enter click

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onMouseClick

onMouseDoubleClick

onMouseDoubleClick(listener: MouseEventHandler<PointMarker, {}>): Token
Subscribe to Mouse Double Click event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onMouseDoubleClick

onMouseDown

onMouseDown(listener: MouseEventHandler<PointMarker, {}>): Token
Subscribe to Mouse Down event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onMouseDown

onMouseDrag

onMouseDrag(listener: MouseDragEventHandler<PointMarker, {}>): Token
Subscribe to Mouse Drag event

Returns
Token of subscription
Parameters
- listener: MouseDragEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onMouseDrag

onMouseDragStart

onMouseDragStart(listener: MouseDragStartEventHandler<PointMarker, {}>): Token
Subscribe to Mouse Drag Start event

Returns
Token of subscription
Parameters
- listener: MouseDragStartEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onMouseDragStart

onMouseDragStop

onMouseDragStop(listener: MouseDragStopEventHandler<PointMarker, {}>): Token
Subscribe to Mouse Drag Stop event

Returns
Token of subscription
Parameters
- listener: MouseDragStopEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onMouseDragStop

onMouseEnter

onMouseEnter(listener: MouseEventHandler<PointMarker, {}>): Token
Subscribe on Mouse Enter event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onMouseEnter

onMouseLeave

onMouseLeave(listener: AbruptMouseEventHandler<PointMarker>): Token
Subscribe on Mouse Enter leave

Returns
Token of subscription
Parameters
- listener: AbruptMouseEventHandler<PointMarker>
  
  Event handler function
Returns Token

Inherited from Interactable.onMouseLeave

onMouseMove

onMouseMove(listener: MouseEventHandler<PointMarker, {}>): Token
Subscribe to Mouse Move event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onMouseMove

onMouseUp

onMouseUp(listener: MouseEventHandler<PointMarker, {}>): Token
Subscribe to Mouse Up event

Returns
Token of subscription
Parameters
- listener: MouseEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onMouseUp

onMouseWheel

onMouseWheel(listener: MouseWheelEventHandler<PointMarker, {}>): Token
Subscribe to Mouse Wheel event

Returns
Token of subscription
Parameters
- listener: MouseWheelEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onMouseWheel

onTouchEnd

onTouchEnd(listener: TouchEventHandler<PointMarker, {}>): Token
Subscribe to Touch End event

Returns
Token of subscription
Parameters
- listener: TouchEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onTouchEnd

onTouchMove

onTouchMove(listener: TouchEventHandler<PointMarker, {}>): Token
Subscribe to Touch Move event

Returns
Token of subscription
Parameters
- listener: TouchEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onTouchMove

onTouchStart

onTouchStart(listener: TouchEventHandler<PointMarker, {}>): Token
Subscribe to Touch Start event

Returns
Token of subscription
Parameters
- listener: TouchEventHandler<PointMarker, {}>
  
  Event handler function
Returns Token

Inherited from Interactable.onTouchStart

setMargin

setMargin(margin: number | Partial<MMargin>): PointMarker
Set margin around object in pixels.

Returns
Object itself
Parameters
- margin: number | Partial<MMargin>
  
  Number with pixel margins for all sides or datastructure with individual pixel margins for each side. Any side can be omitted, only passed values will be overridden.
Returns PointMarker

Inherited from Marginable.setMargin

setMouseInteractions

setMouseInteractions(state: boolean): PointMarker
Set mouse interactions enabled or disabled

Returns
Object itself for fluent interface
Parameters
- state: boolean
  
  Specifies state of mouse interactions
Returns PointMarker

Inherited from Interactable.setMouseInteractions

setRotation

setRotation(rotationDeg: number): PointMarker
Set rotation of point shape in degrees.

Returns
Object itself.
Parameters
- rotationDeg: number
  
  Rotation in degrees.
Returns PointMarker

setShape

setShape(shape: Icon | PointShape): PointMarker
Set displayed shape.
```
 // Example
 setShape(PointShape.Star)
```
See PointShape for all available options.
Parameters
- shape: Icon | PointShape
Returns PointMarker