Class MapViewPathCollection

Collection of paths for a map view.

This class should not be instantiated directly. Instead, use the MapViewPreferences.paths getter to obtain an instance.

Index

Constructors

Accessors

Methods

add clear getBorderColorAt getBorderSizeAt getFillColorAt getInnerSizeAt getPathAt getPathByName hitTest remove removeAt

Constructors

constructor

new MapViewPathCollection(
    id: number,
    mapId: number,
    mapPointerId: number,
): MapViewPathCollection
Parameters
- id: number
- mapId: number
- mapPointerId: number
Returns MapViewPathCollection
- Defined in core/path.ts:153

Accessors

mapId

get mapId(): number
Returns number
- Defined in core/path.ts:146

mapPointerId

get mapPointerId(): number
Returns number
- Defined in core/path.ts:149

pointerId

get pointerId(): number
Returns number
- Defined in core/path.ts:143

size

get size(): number
Get the number of paths in this collection.

Returns number
The number of paths
- Defined in core/path.ts:290

Methods

add

add(
    path: Path,
    options?: {
        colorBorder?: Color;
        colorInner?: Color;
        szBorder?: number;
        szInner?: number;
    },
): void
Add a path to the collection.
Parameters
- path: Path
  The path to be added.
- Optionaloptions: { colorBorder?: Color; colorInner?: Color; szBorder?: number; szInner?: number }
  Optional object for path appearance:
  
  colorBorder: The border color of the path. By default, the one from the current map view style is used.
  
  colorInner: The inner color of the path. By default, the one from the current map view style is used.
  
  szBorder: The border size of the path in mm. If < 0, the one from the current map view style is used.
  
  szInner: The inner size of the path in mm. If < 0, the one from the current map view style is used.
Returns void
- Defined in core/path.ts:169

clear

clear(): void
Remove all paths from the collection.

Returns void
- Defined in core/path.ts:192

getBorderColorAt

getBorderColorAt(index: number): Color
Get the border color for the path specified by index.

If the result is transparent, then the index does not exist in the collection.
Parameters
- index: number
  The path index
Returns Color
The border color
- Defined in core/path.ts:204

getBorderSizeAt

getBorderSizeAt(index: number): number
Get the border size for the path specified by index.

If the result is -1, then the index does not exist in the collection.
Parameters
- index: number
  The path index
Returns number
The border size
- Defined in core/path.ts:222

getFillColorAt

getFillColorAt(index: number): Color
Get the fill color for the path specified by index.

If the result is transparent, then the index does not exist in the collection.
Parameters
- index: number
  The path index
Returns Color
The inner color
- Defined in core/path.ts:235

getInnerSizeAt

getInnerSizeAt(index: number): number
Get the inner size for the path specified by index.

If the result is -1, then the index does not exist in the collection.
Parameters
- index: number
  The path index
Returns number
The inner size
- Defined in core/path.ts:248

getPathAt

getPathAt(index: number): Path | null
Get the path specified by index.
Parameters
- index: number
  The path index
Returns Path | null
The path or null if index is invalid
- Defined in core/path.ts:259

getPathByName

getPathByName(name: string): Path | null
Get the path specified by name.
Parameters
- name: string
  The path name
Returns Path | null
The path or null if not found
- Defined in core/path.ts:275

hitTest

hitTest(area: RectangleGeographicArea): PathMatch[]
Hit test in path collection.

Checks for paths within the given area.
Parameters
- area: RectangleGeographicArea
  The RectangleGeographicArea where to search for paths.
Returns PathMatch[]
List of PathMatch objects
- Defined in core/path.ts:321

remove

remove(path: Path): void
Remove the path from the collection.
Parameters
- path: Path
  The path to be removed
Returns void
- Defined in core/path.ts:300

removeAt

removeAt(index: number): void
Remove the path specified by index.
Parameters
- index: number
  The path index
Returns void
- Defined in core/path.ts:309

Class MapViewPathCollection

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns MapViewPathCollection

Accessors

mapId

Returns number

mapPointerId

Returns number

pointerId

Returns number

size

Returns number

Methods

add

Parameters

Returns void

clear

Returns void

getBorderColorAt

Parameters

Returns Color

getBorderSizeAt

Parameters

Returns number

getFillColorAt

Parameters

Returns Color

getInnerSizeAt

Parameters

Returns number

getPathAt

Parameters

Returns Path | null

getPathByName

Parameters

Returns Path | null

hitTest

Parameters

Returns PathMatch[]

remove

Parameters

Returns void

removeAt

Parameters

Returns void

Settings

On This Page