Class MinimapControl

Index

Constructors

Methods

getDefaultPosition initialise onAdd onRemove setBackgroundColour setBackgroundOpacity show

Constructors

constructor

new MinimapControl(
    flatmap: FlatMap,
    options: MINIMAP_OPTIONS,
    styleSpecification: StyleSpecification,
): MinimapControl
Parameters
- flatmap: FlatMap
- options: MINIMAP_OPTIONS
- styleSpecification: StyleSpecification
Returns MinimapControl
- Defined in src/controls/minimap.ts:117

Methods

getDefaultPosition

getDefaultPosition(): ControlPosition
Returns ControlPosition
- Defined in src/controls/minimap.ts:126

initialise

initialise(): void
Returns void
- Defined in src/controls/minimap.ts:181

onAdd

onAdd(map: Map$1): HTMLElement
Parameters
- map: Map$1
Returns HTMLElement
- Defined in src/controls/minimap.ts:132

onRemove

onRemove(): void
Returns void
- Defined in src/controls/minimap.ts:173

setBackgroundColour

setBackgroundColour(colour: string): void
Sets the minimap's background colour.
Parameters
- colour: string
  The colour
Returns void
- Defined in src/controls/minimap.ts:410

setBackgroundOpacity

setBackgroundOpacity(opacity: number): void
Sets the minimap's background opacity.
Parameters
- opacity: number
  The opacity
Returns void
- Defined in src/controls/minimap.ts:425

show

show(showMinimap: boolean): void
Show and hide the minimap.
Parameters
- showMinimap: boolean
  Set false to hide minimap
Returns void
- Defined in src/controls/minimap.ts:440