Interface IPin<TEvent, TMobile>

Type Parameters

TEvent extends string = PinEvents
TMobile extends MobileOSProps<IPinIOS, {}> = MobileOSProps<IPinIOS, {}>

Hierarchy

INativeComponent
IEventEmitter<TEvent | PinEvents>
- IPin

Index

Properties

nativeObject

nativeObject: { [key: string]: any }

Type declaration

[key: string]: any

location

location: { latitude: number; longitude: number }

Type declaration

latitude: number
longitude: number

android

android: TMobile["android"]

ios

ios: TMobile["ios"]

title

title: string

subtitle

subtitle: string

color

color: IColor

id

id: number

image

image: null | IImage<any, MobileOSProps<ImageIOSProps, ImageAndroidProps>>

visible

visible: boolean

isClusterEnabled

isClusterEnabled: boolean

onInfoWindowPress

onInfoWindowPress: (() => void)

Type declaration

(): void

Deprecated

Example

import Pin from '@smartface/native/ui/mapview/pin';

const pin = new Pin();
pin.on(Pin.Events.InfoWindowPress, () => {
 console.info('onInfoWindowPress');
});

Returns void

Events

onPress

onPress: (() => void)

Type declaration

(): void

This event will be fired when the pin is touched.

onPress

Deprecated

Android

Ios

Since

1.1.2

Example

import Pin from '@smartface/native/ui/mapview/pin';

const pin = new Pin();
pin.on(Pin.Events.Press, () => {
 console.info('onPress');
});

Returns void

Methods

on

on(eventName: "infoWindowPress", callback: (() => void)): (() => void)
Creates an event emitter instance to listen for the actions

Returns
Call the function to remove the event
Parameters
- eventName: "infoWindowPress"
- callback: (() => void)
  
  Gets as any arguments as it needs
  - - (): void
    - Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides IEventEmitter.on
- Defined in ui/mapview/pin/pin.ts:60
on(eventName: "press", callback: ((state: object) => void)): (() => void)
Parameters
- eventName: "press"
- callback: ((state: object) => void)
  - - (state: object): void
    - Parameters
      
      state: object
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides IEventEmitter.on
- Defined in ui/mapview/pin/pin.ts:61
on(eventName: "press" | "infoWindowPress", callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: "press" | "infoWindowPress"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides IEventEmitter.on
- Defined in ui/mapview/pin/pin.ts:62

off

off(eventName: "infoWindowPress", callback: (() => void)): void
Removes the specified event and invokes the callback after it is removed
Parameters
- eventName: "infoWindowPress"
- callback: (() => void)
  - - (): void
    - Returns void
Returns void
Overrides IEventEmitter.off
- Defined in ui/mapview/pin/pin.ts:64
off(eventName: "press", callback: ((state: object) => void)): void
Parameters
- eventName: "press"
- callback: ((state: object) => void)
  - - (state: object): void
    - Parameters
      
      state: object
      
      Returns void
Returns void
Overrides IEventEmitter.off
- Defined in ui/mapview/pin/pin.ts:65
off(eventName: "press" | "infoWindowPress", callback: ((...args: any[]) => void)): void
Parameters
- eventName: "press" | "infoWindowPress"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides IEventEmitter.off
- Defined in ui/mapview/pin/pin.ts:66

emit

emit(eventName: "infoWindowPress"): void
Triggers the event manually.
Parameters
- eventName: "infoWindowPress"
Returns void
Overrides IEventEmitter.emit
- Defined in ui/mapview/pin/pin.ts:68
emit(eventName: "press"): void
Parameters
- eventName: "press"
Returns void
Overrides IEventEmitter.emit
- Defined in ui/mapview/pin/pin.ts:69
emit(eventName: "press" | "infoWindowPress", ...args: any[]): void
Parameters
- eventName: "press" | "infoWindowPress"
- Rest ...args: any[]
Returns void
Overrides IEventEmitter.emit
- Defined in ui/mapview/pin/pin.ts:70

once

once(eventName: "infoWindowPress", callback: (() => void)): (() => void)
Creates an event emitter instance to listen for the actions

Returns
Call the function to remove the event
Parameters
- eventName: "infoWindowPress"
- callback: (() => void)
  
  Gets as any arguments as it needs
  - - (): void
    - Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides IEventEmitter.once
- Defined in ui/mapview/pin/pin.ts:72
once(eventName: "press", callback: ((state: object) => void)): (() => void)
Parameters
- eventName: "press"
- callback: ((state: object) => void)
  - - (state: object): void
    - Parameters
      
      state: object
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides IEventEmitter.once
- Defined in ui/mapview/pin/pin.ts:73
once(eventName: "press" | "infoWindowPress", callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: "press" | "infoWindowPress"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides IEventEmitter.once
- Defined in ui/mapview/pin/pin.ts:74

prependListener

prependListener(eventName: "infoWindowPress", callback: (() => void)): void
Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
Parameters
- eventName: "infoWindowPress"
- callback: (() => void)
  - - (): void
    - Returns void
Returns void
Overrides IEventEmitter.prependListener
- Defined in ui/mapview/pin/pin.ts:76
prependListener(eventName: "press", callback: ((state: object) => void)): void
Parameters
- eventName: "press"
- callback: ((state: object) => void)
  - - (state: object): void
    - Parameters
      
      state: object
      
      Returns void
Returns void
Overrides IEventEmitter.prependListener
- Defined in ui/mapview/pin/pin.ts:77
prependListener(eventName: "press" | "infoWindowPress", callback: ((...args: any[]) => void)): void
Parameters
- eventName: "press" | "infoWindowPress"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides IEventEmitter.prependListener
- Defined in ui/mapview/pin/pin.ts:78

prependOnceListener

prependOnceListener(eventName: "infoWindowPress", callback: (() => void)): void
Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.
Parameters
- eventName: "infoWindowPress"
- callback: (() => void)
  - - (): void
    - Returns void
Returns void
Overrides IEventEmitter.prependOnceListener
- Defined in ui/mapview/pin/pin.ts:80
prependOnceListener(eventName: "press", callback: ((state: object) => void)): void
Parameters
- eventName: "press"
- callback: ((state: object) => void)
  - - (state: object): void
    - Parameters
      
      state: object
      
      Returns void
Returns void
Overrides IEventEmitter.prependOnceListener
- Defined in ui/mapview/pin/pin.ts:81
prependOnceListener(eventName: "press" | "infoWindowPress", callback: ((...args: any[]) => void)): void
Parameters
- eventName: "press" | "infoWindowPress"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides IEventEmitter.prependOnceListener
- Defined in ui/mapview/pin/pin.ts:82

Interface IPin<TEvent, TMobile>

Type Parameters

TEvent extends string = PinEvents

TMobile extends MobileOSProps<IPinIOS, {}> = MobileOSProps<IPinIOS, {}>

Hierarchy

Index

Properties

Events

Methods

Properties

nativeObject

Type declaration

[key: string]: any

location

Type declaration

latitude: number

longitude: number

android

ios

title

subtitle

color

id

image

visible

isClusterEnabled

onInfoWindowPress

Type declaration

Deprecated

Example

Returns void

Events

onPress

Type declaration

Deprecated

Android

Ios

Since

Example

Returns void

Methods

on

Returns

Parameters

eventName: "infoWindowPress"

callback: (() => void)

Returns void

Returns (() => void)

Returns void

Parameters

eventName: "press"

callback: ((state: object) => void)

Parameters

state: object

Returns void

Returns (() => void)

Returns void

Parameters

eventName: "press" | "infoWindowPress"

callback: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns (() => void)

Returns void

off

Parameters

eventName: "infoWindowPress"

callback: (() => void)

Returns void

Returns void

Parameters

eventName: "press"

callback: ((state: object) => void)

Parameters

state: object

Returns void

Returns void

Parameters

eventName: "press" | "infoWindowPress"

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]