Class MapViewRoutesCollection

Hierarchy (View Summary)

GemList<Route>
- MapViewRoutesCollection

Constructors

constructor

new MapViewRoutesCollection(id: any, mapId: number): MapViewRoutesCollection
Parameters
- id: any
- mapId: number
Returns MapViewRoutesCollection
Overrides GemList.constructor
- Defined in core/mapviewroutescollection.ts:14

Accessors

first

get first(): T
Returns T
Inherited from GemList.first
- Defined in core/types.ts:762

isEmpty

get isEmpty(): boolean
Returns boolean
Inherited from GemList.isEmpty
- Defined in core/types.ts:754

isNotEmpty

get isNotEmpty(): boolean
Returns boolean
Inherited from GemList.isNotEmpty
- Defined in core/types.ts:758

last

get last(): T
Returns T
Inherited from GemList.last
- Defined in core/types.ts:769

length

get length(): number
Returns number
Inherited from GemList.length
- Defined in core/types.ts:750

mainRoute

get mainRoute(): Route | null
Returns Route | null
- Defined in core/mapviewroutescollection.ts:92
set mainRoute(route: Route | null): void
Parameters
- route: Route | null
Returns void
- Defined in core/mapviewroutescollection.ts:131

mapId

get mapId(): number
Returns number
Inherited from GemList.mapId
- Defined in core/types.ts:683

pointerId

get pointerId(): any
Returns any
Inherited from GemList.pointerId
- Defined in core/types.ts:682

Methods

[iterator]

"[iterator]"(): Iterator<Route>
Returns Iterator<Route>
Inherited from GemList.[iterator]
- Defined in core/types.ts:710

add

add(
    route: Route,
    bMainRoute: boolean,
    options?: {
        autoGenerateLabel?: boolean;
        label?: string;
        labelIcons?: Img[] | null;
        routeRenderSettings?: RouteRenderSettings;
    },
): void
Parameters
- route: Route
- bMainRoute: boolean
- options: {
      autoGenerateLabel?: boolean;
      label?: string;
      labelIcons?: Img[] | null;
      routeRenderSettings?: RouteRenderSettings;
  } = {}
Returns void
- Defined in core/mapviewroutescollection.ts:39

addMapViewRoute

addMapViewRoute(route: MapViewRoute): void
Parameters
- route: MapViewRoute
Returns void
- Defined in core/mapviewroutescollection.ts:75

at

at(position: number): Route
Parameters
- position: number
Returns Route
Inherited from GemList.at
- Defined in core/types.ts:729

clear

clear(): void
Returns void
- Defined in core/mapviewroutescollection.ts:79

clearAllButMainRoute

clearAllButMainRoute(): Promise<void>
Returns Promise<void>
- Defined in core/mapviewroutescollection.ts:83

contains

contains(element: Route): boolean
Parameters
- element: Route
Returns boolean
Inherited from GemList.contains
- Defined in core/types.ts:776

dispose

dispose(): void
Returns void
Inherited from GemList.dispose
- Defined in core/types.ts:743

elementAt

elementAt(index: number): Route
Parameters
- index: number
Returns Route
Inherited from GemList.elementAt
- Defined in core/types.ts:785

every

every(predicate: (item: Route) => boolean): boolean
Parameters
- predicate: (item: Route) => boolean
Returns boolean
Inherited from GemList.every
- Defined in core/types.ts:836

filter

filter(predicate: (item: Route) => boolean): Route[]
Parameters
- predicate: (item: Route) => boolean
Returns Route[]
Inherited from GemList.filter
- Defined in core/types.ts:818

find

find(predicate: (item: Route) => boolean): Route | undefined
Parameters
- predicate: (item: Route) => boolean
Returns Route | undefined
Inherited from GemList.find
- Defined in core/types.ts:854

findIndex

findIndex(predicate: (item: Route) => boolean): number
Parameters
- predicate: (item: Route) => boolean
Returns number
Inherited from GemList.findIndex
- Defined in core/types.ts:863

forEach

forEach(callback: (item: Route) => void): void
Parameters
- callback: (item: Route) => void
Returns void
Inherited from GemList.forEach
- Defined in core/types.ts:804

getLabel

getLabel(route: Route): string
Parameters
- route: Route
Returns string
- Defined in core/mapviewroutescollection.ts:87

getMapViewRoute

getMapViewRoute(index: number): MapViewRoute | null
Parameters
- index: number
Returns MapViewRoute | null
- Defined in core/mapviewroutescollection.ts:98

getRenderSettings

getRenderSettings(route: Route): RouteRenderSettings | null
Parameters
- route: Route
Returns RouteRenderSettings | null
- Defined in core/mapviewroutescollection.ts:150

getRoute

getRoute(index: number): Route | null
Parameters
- index: number
Returns Route | null
- Defined in core/mapviewroutescollection.ts:104

hideLabel

hideLabel(route: Route): void
Parameters
- route: Route
Returns void
- Defined in core/mapviewroutescollection.ts:110

indexOf

indexOf(route: Route): number
Parameters
- route: Route
Returns number
- Defined in core/mapviewroutescollection.ts:114

isMainRoute

isMainRoute(route: Route): boolean
Parameters
- route: Route
Returns boolean
- Defined in core/mapviewroutescollection.ts:119

join

join(separator?: string): string
Parameters
- separator: string = ''
Returns string
Inherited from GemList.join
- Defined in core/types.ts:874

map

map<R>(transform: (item: Route) => R): R[]
Type Parameters
- R
Parameters
- transform: (item: Route) => R
Returns R[]
Inherited from GemList.map
- Defined in core/types.ts:810

reduce

reduce<R>(combine: (accumulator: R, item: Route) => R, initialValue: R): R
Type Parameters
- R
Parameters
- combine: (accumulator: R, item: Route) => R
- initialValue: R
Returns R
Inherited from GemList.reduce
- Defined in core/types.ts:828

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from GemList.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:14

remove

remove(route: Route): void
Parameters
- route: Route
Returns void
- Defined in core/mapviewroutescollection.ts:140

setLabel

setLabel(route: Route, text: string): void
Parameters
- route: Route
- text: string
Returns void
- Defined in core/mapviewroutescollection.ts:124

setRenderSettings

setRenderSettings(route: Route, settings: RouteRenderSettings): void
Parameters
- route: Route
- settings: RouteRenderSettings
Returns void
- Defined in core/mapviewroutescollection.ts:144

size

size(): number
Returns number
Inherited from GemList.size
- Defined in core/types.ts:720

some

some(predicate: (item: Route) => boolean): boolean
Parameters
- predicate: (item: Route) => boolean
Returns boolean
Inherited from GemList.some
- Defined in core/types.ts:845

toArray

toArray(): Route[]
Returns Route[]
Inherited from GemList.toArray
- Defined in core/types.ts:792

toSet

toSet(): Set<Route>
Returns Set<Route>
Inherited from GemList.toSet
- Defined in core/types.ts:800

`Static`create

create(): MapViewRoutesCollection
Creates a new instance of MapViewRoutesCollection. Utilizes the GemKitPlatform to request the creation of a new object and parses the resulting JSON to instantiate the collection.

Returns MapViewRoutesCollection
A new MapViewRoutesCollection instance.
- Defined in core/mapviewroutescollection.ts:30

`Static`init

init<T>(
    pointerId: any,
    mapId: number,
    className: string,
    initializer: (data: any, mapId: number) => T,
): GemList<T>
Type Parameters
- T
Parameters
- pointerId: any
- mapId: number
- className: string
- initializer: (data: any, mapId: number) => T
Returns GemList<T>
Inherited from GemList.init
- Defined in core/types.ts:700

Class MapViewRoutesCollection

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns MapViewRoutesCollection

Accessors

first

Returns T

isEmpty

Returns boolean

isNotEmpty

Returns boolean

last

Returns T

length

Returns number

mainRoute

Returns Route | null

Parameters

Returns void

mapId

Returns number

pointerId

Returns any

Methods

[iterator]

Returns Iterator<Route>

add

Parameters

Returns void

addMapViewRoute

Parameters

Returns void

at

Parameters

Returns Route

clear

Returns void

clearAllButMainRoute

Returns Promise<void>

contains

Parameters

Returns boolean

dispose

Returns void

elementAt

Parameters

Returns Route

every

Parameters

Returns boolean

filter

Parameters

Returns Route[]

find

Parameters

Returns Route | undefined

findIndex

Parameters

Returns number

forEach

Parameters

Returns void

getLabel

Parameters

Returns string

getMapViewRoute

Parameters

Returns MapViewRoute | null

getRenderSettings

Parameters

Returns RouteRenderSettings | null

getRoute

Parameters

Returns Route | null

`Protected`registerAutoReleaseObject

`Static`create

`Static`init