EasyGuideMapsEngine |

Hierarchy

EasyGuideMapsEngine

Index

Constructors

constructor

Methods

Constructors

constructor

new EasyGuideMapsEngine(oEasyGuideMapsEngineOptions: IEasyGuideMapsEngineOptions): EasyGuideMapsEngine

- Defined in EasyGuideMapsEngine_V2.0.0.ts:313
Parameters
- oEasyGuideMapsEngineOptions: IEasyGuideMapsEngineOptions
Returns EasyGuideMapsEngine

Properties

_bDebug

_bDebug: boolean

_nProject

_nProject: number

oEasyGuideMapsEngineOptions

oEasyGuideMapsEngineOptions: IEasyGuideMapsEngineOptions

Static ENABLE_CORS_PROXY

ENABLE_CORS_PROXY: boolean = false

Static EVENT_FLOOD_COMPLETED

EVENT_FLOOD_COMPLETED: string = "EVENT_FLOOD_COMPLETED"

Static EVENT_FUNCTION_RETURN

EVENT_FUNCTION_RETURN: string = "EVENT_FUNCTION_RETURN"

Static EVENT_LAYER_CHANGED

EVENT_LAYER_CHANGED: string = "EVENT_LAYER_CHANGED"

Static EVENT_LOADED

EVENT_LOADED: string = "EVENT_LOADED"

Static EVENT_POPUP_ELEMENT_SELECTED

EVENT_POPUP_ELEMENT_SELECTED: string = "EVENT_POPUP_ELEMENT_SELECTED"

Static EVENT_ROTATION_CHANGED

EVENT_ROTATION_CHANGED: string = "EVENT_ROTATION_CHANGED"

Static EVENT_TARGET_SELECTED

EVENT_TARGET_SELECTED: string = "EVENT_TARGET_SELECTED"

Static EVENT_TILES_LOADING

EVENT_TILES_LOADING: string = "EVENT_TILES_LOADING"

Static EVENT_USER_INTERACTION

EVENT_USER_INTERACTION: string = "EVENT_USER_INTERACTION"

Static EVENT_ZOOM_CHANGED

EVENT_ZOOM_CHANGED: string = "EVENT_ZOOM_CHANGED"

Static HIGHLIGHT_ADD

HIGHLIGHT_ADD: string = "HIGHLIGHT_ADD"

Static HIGHLIGHT_REMOVE

HIGHLIGHT_REMOVE: string = "HIGHLIGHT_REMOVE"

Static HIGHLIGHT_SET

HIGHLIGHT_SET: string = "HIGHLIGHT_SET"

Static TYPE_HIGHLIGHTER

TYPE_HIGHLIGHTER: string = "highlighters"

Static TYPE_ICON

TYPE_ICON: string = "icons"

Static TYPE_ID

TYPE_ID: string = "ids"

Static TYPE_LAYER

TYPE_LAYER: string = "layers"

Static TYPE_POINT

TYPE_POINT: string = "points"

Static TYPE_TEXT

TYPE_TEXT: string = "texts"

Static version

version: number[] = [2, 0, 0]

Methods

edit

edit(oFeaturesIdsList: string[], oEditOptions?: IEasyGuideMapsEngineEditOptionsType): Promise<boolean>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:663
Parameters
- oFeaturesIdsList: string[]
- Optional oEditOptions: IEasyGuideMapsEngineEditOptionsType
Returns Promise<boolean>

fit

fit(oPointsIdsListOrFeaturesIdsListOrCoordinatesList: string[] | Array<[number, number]>): Promise<boolean>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:548
Parameters
- oPointsIdsListOrFeaturesIdsListOrCoordinatesList: string[] | Array<[number, number]>
Returns Promise<boolean>

focus

focus(oPointIdOrFeatureIdOrCoordinates: string | [number, number], oEasyGuideMapsEngineFocusOptions?: IEasyGuideMapsEngineFocusOptionsType): Promise<boolean>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:529
Parameters
- oPointIdOrFeatureIdOrCoordinates: string | [number, number]
- Optional oEasyGuideMapsEngineFocusOptions: IEasyGuideMapsEngineFocusOptionsType
Returns Promise<boolean>

get

get(sSettingKey: IEasyGuideMapsEngineGetSetEnum): Promise<boolean | number | number[] | string>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:491
Parameters
- sSettingKey: IEasyGuideMapsEngineGetSetEnum
Returns Promise<boolean | number | number[] | string>

getIdsByPoint

getIdsByPoint(sPointId: string, oGetIdsByPointOptions?: IEasyGuideMapsEngineGetIdsByPointOptionsType): Promise<string[]>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:644
Parameters
- sPointId: string
- Optional oGetIdsByPointOptions: IEasyGuideMapsEngineGetIdsByPointOptionsType
Returns Promise<string[]>

highlight

highlight(oElementsToHighlightIdsList: string[], oEasyGuideMapsEngineHighlighOptions: IEasyGuideMapsEngineHighlighOptionsType): Promise<string[]>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:567
Parameters
- oElementsToHighlightIdsList: string[]
- oEasyGuideMapsEngineHighlighOptions: IEasyGuideMapsEngineHighlighOptionsType
Returns Promise<string[]>

popup

popup(oPointIdOrFeatureIdOrCoordinates: string | [number, number], sHtml: string, oPopupOptions?: IEasyGuideMapsEnginePopupOptionsType): Promise<boolean>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:587
Parameters
- oPointIdOrFeatureIdOrCoordinates: string | [number, number]
- sHtml: string
- Optional oPopupOptions: IEasyGuideMapsEnginePopupOptionsType
Returns Promise<boolean>

refresh

refresh(): Promise<boolean>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:434
Returns Promise<boolean>

reset

reset(): Promise<boolean>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:415
Returns Promise<boolean>

retrieve

retrieve(sType: IEasyGuideMapsEngineTypesEnum, oRetrieveOptions?: IEasyGuideMapsEngineRetrieveOptionsType): Promise<string[]>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:472
Parameters
- sType: IEasyGuideMapsEngineTypesEnum
- Optional oRetrieveOptions: IEasyGuideMapsEngineRetrieveOptionsType
Returns Promise<string[]>

retrieveClosestPointByCoordinates

retrieveClosestPointByCoordinates(oLongitudeLatitudeCoordinates: [number, number], oEasyGuideMapsEngineRetrieveClosestPointByCoordinatesOptions?: IEasyGuideMapsEngineRetrieveClosestPointByCoordinatesOptionsType): Promise<string[]>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:625
Parameters
- oLongitudeLatitudeCoordinates: [number, number]
- Optional oEasyGuideMapsEngineRetrieveClosestPointByCoordinatesOptions: IEasyGuideMapsEngineRetrieveClosestPointByCoordinatesOptionsType
Returns Promise<string[]>

route

route(oWayPointsIdsList: string[], oEasyGuideMapsEngineRouteOptions?: IEasyGuideMapsEngineRouteOptionsType): Promise<IEasyGuideMapsEngineRouteReturnType>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:606
Parameters
- oWayPointsIdsList: string[]
- Default value oEasyGuideMapsEngineRouteOptions: IEasyGuideMapsEngineRouteOptionsType = {}
Returns Promise<IEasyGuideMapsEngineRouteReturnType>

screenshot

screenshot(): Promise<boolean>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:453
Returns Promise<boolean>

set

set(sSettingKey: IEasyGuideMapsEngineGetSetEnum, sSettingValue: boolean | number | number[] | string): Promise<boolean | number | number[] | string>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:510
Parameters
- sSettingKey: IEasyGuideMapsEngineGetSetEnum
- sSettingValue: boolean | number | number[] | string
Returns Promise<boolean | number | number[] | string>

toString

toString(): string

- Defined in EasyGuideMapsEngine_V2.0.0.ts:400
Returns string

Static imageUrlToBase64Encoding

imageUrlToBase64Encoding(sImageUrl: string): Promise<string>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:259
Parameters
- sImageUrl: string
Returns Promise<string>

Static supports

supports(nProject: number): Promise<IEasyGuideMapsEngineSupportsResponseType>

- Defined in EasyGuideMapsEngine_V2.0.0.ts:194
Parameters
- nProject: number
Returns Promise<IEasyGuideMapsEngineSupportsResponseType>

Static toString

toString(): string

- Defined in EasyGuideMapsEngine_V2.0.0.ts:190
Returns string

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

oEasyGuideMapsEngineOptions: IEasyGuideMapsEngineOptions

Returns EasyGuideMapsEngine

Properties

_bDebug

_nProject

oEasyGuideMapsEngineOptions

Static ENABLE_CORS_PROXY

Static EVENT_FLOOD_COMPLETED

Static EVENT_FUNCTION_RETURN

Static EVENT_LAYER_CHANGED

Static EVENT_LOADED

Static EVENT_POPUP_ELEMENT_SELECTED

Static EVENT_ROTATION_CHANGED

Static EVENT_TARGET_SELECTED

Static EVENT_TILES_LOADING

Static EVENT_USER_INTERACTION

Static EVENT_ZOOM_CHANGED

Static HIGHLIGHT_ADD

Static HIGHLIGHT_REMOVE

Static HIGHLIGHT_SET

Static TYPE_HIGHLIGHTER

Static TYPE_ICON

Static TYPE_ID

Static TYPE_LAYER

Static TYPE_POINT

Static TYPE_TEXT

Static version

Methods

edit

Parameters

oFeaturesIdsList: string[]

Optional oEditOptions: IEasyGuideMapsEngineEditOptionsType

Returns Promise<boolean>

fit

Parameters

oPointsIdsListOrFeaturesIdsListOrCoordinatesList: string[] | Array<[number, number]>

Returns Promise<boolean>

focus

Parameters

oPointIdOrFeatureIdOrCoordinates: string | [number, number]

Optional oEasyGuideMapsEngineFocusOptions: IEasyGuideMapsEngineFocusOptionsType

Returns Promise<boolean>

get

Parameters

sSettingKey: IEasyGuideMapsEngineGetSetEnum

Returns Promise<boolean | number | number[] | string>

getIdsByPoint

Parameters

sPointId: string

Optional oGetIdsByPointOptions: IEasyGuideMapsEngineGetIdsByPointOptionsType

Returns Promise<string[]>

highlight

Parameters

oElementsToHighlightIdsList: string[]

oEasyGuideMapsEngineHighlighOptions: IEasyGuideMapsEngineHighlighOptionsType

Returns Promise<string[]>

popup

Parameters

oPointIdOrFeatureIdOrCoordinates: string | [number, number]

sHtml: string

Optional oPopupOptions: IEasyGuideMapsEnginePopupOptionsType

Returns Promise<boolean>

refresh

Returns Promise<boolean>

reset

Returns Promise<boolean>

retrieve

Parameters

sType: IEasyGuideMapsEngineTypesEnum

Optional oRetrieveOptions: IEasyGuideMapsEngineRetrieveOptionsType

Returns Promise<string[]>

retrieveClosestPointByCoordinates