Class MapComponent

Hierarchy (View Summary)

GirafeHTMLElement
- MapComponent

Index

Constructors

constructor

Accessors

projection state

Constructors

constructor

new MapComponent(): MapComponent
Returns MapComponent
Overrides GirafeHTMLElement.constructor
- Defined in src/components/map/component.ts:98

Properties

activeTooltips

activeTooltips: any[] = []

callbacks

callbacks: Callback[] = []

closeSwiperButton

closeSwiperButton: HTMLButtonElement

cogManager

cogManager: CogManager

componentManager

componentManager: ComponentManager

configManager

configManager: ConfigManager

`Optional`displayStyle

displayStyle?: string

dragbox

dragbox: DragBox

focusFeature

focusFeature: FocusFeature

highlightedFeaturesCollection

highlightedFeaturesCollection: Collection<Feature<Geometry>> = ...

highlightLayer

highlightLayer: VectorLayer<VectorSource<Feature<Geometry>>, Feature<Geometry>>

loading

loading: boolean = false

localFileManager

localFileManager: LocalFileManager

map3d

map3d: any

map3dTarget

map3dTarget: HTMLDivElement

mapTarget

mapTarget: HTMLDivElement

name

name: string

olMap

olMap: Map

onChangeOrder

onChangeOrder: () => void = ...

osmManager

osmManager: OsmManager

pixelTolerance

pixelTolerance: number = 10

rendered

rendered: boolean = false

selectedFeaturesCollection

selectedFeaturesCollection: Collection<Feature<Geometry>> = ...

selectionLayer

selectionLayer: VectorLayer<VectorSource<Feature<Geometry>>, Feature<Geometry>>

shadow

shadow: ShadowRoot

srid

srid: ProjectionLike

stateManager

stateManager: StateManager

styleUrl

styleUrl: null | string = null

styleUrls

styleUrls: string[] = ...

swipeManager

swipeManager: SwipeManager

swiper

swiper: HTMLInputElement

template

template: Hole | () => Hole

templateUrl

templateUrl: string = './template.html'

`Optional`timeoutId

timeoutId?: Timeout

vectorTilesManager

vectorTilesManager: VectorTilesManager

viewManager

viewManager: ViewManager

wmsManager

wmsManager: WmsManager

wmsManager3d

wmsManager3d: null | WmsManager3d = null

wmtsManager

wmtsManager: WmtsManager

xyzManager

xyzManager: XyzManager

Accessors

projection

get projection(): null | Projection
Returns null | Projection
- Defined in src/components/map/component.ts:85

state

get state(): State
Returns State
Inherited from GirafeHTMLElement.state
- Defined in src/base/GirafeHTMLElement.ts:42

Methods

activateTooltips

activateTooltips(
    arrow: boolean,
    delay: [number, number],
    defaultPlacement: string,
): void
Parameters
- arrow: boolean
- delay: [number, number]
- defaultPlacement: string
Returns void
Inherited from GirafeHTMLElement.activateTooltips
- Defined in src/base/GirafeHTMLElement.ts:101

addAllActiveLayers3dMap

addAllActiveLayers3dMap(layer: BaseLayer): void
Parameters
- layer: BaseLayer
Returns void
- Defined in src/components/map/component.ts:571

connectedCallback

connectedCallback(): void
Returns void
- Defined in src/components/map/component.ts:367

create3dMap

create3dMap(): Promise<void>
Returns Promise<void>
- Defined in src/components/map/component.ts:438

deserialize

deserialize(_serializedElement: unknown): void
Deserialize an element and set the current element state to the deserialized one
Parameters
- _serializedElement: unknown
  The element serialization as returned by the serialize method
Returns void
Inherited from GirafeHTMLElement.deserialize
- Defined in src/base/GirafeHTMLElement.ts:263

disconnectedCallback

disconnectedCallback(): void
When the component is disconnected from the DOM all the callbacks will be unregistered

Returns void
Inherited from GirafeHTMLElement.disconnectedCallback
- Defined in src/base/GirafeHTMLElement.ts:298

getById

getById<T = HTMLElement>(id: string): T
Type Parameters
- T = HTMLElement
Parameters
- id: string
Returns T
Inherited from GirafeHTMLElement.getById
- Defined in src/base/GirafeHTMLElement.ts:46

getParentOfType

getParentOfType(
    parentNodeName: string,
    elem: null | Node,
    initialElem?: null | Node,
): null | Node
Parameters
- parentNodeName: string
- elem: null | Node
- initialElem: null | Node = elem
Returns null | Node
Inherited from GirafeHTMLElement.getParentOfType
- Defined in src/base/GirafeHTMLElement.ts:84

girafeTranslate

girafeTranslate(): void
Returns void
Inherited from GirafeHTMLElement.girafeTranslate
- Defined in src/base/GirafeHTMLElement.ts:54

hide

hide(): void
Hide the component (display: none).

Returns void
Inherited from GirafeHTMLElement.hide
- Defined in src/base/GirafeHTMLElement.ts:237

htmlUnsafe

htmlUnsafe(str: string): Hole
Convert the string in parameter with uHtml and return it. This allows to convert a string with html in a right html object. For example, htmlUnsafe('
') will return an html div object.
Parameters
- str: string
Returns Hole
Inherited from GirafeHTMLElement.htmlUnsafe
- Defined in src/base/GirafeHTMLElement.ts:185

isNullOrUndefined

isNullOrUndefined(val: unknown): boolean
NOTE REG: We cannot just use truthy here, because javascript comparaison table is really problematic. For example: 0 == false [] == false "" == false And there are cases where we want to check null or undefined, because 0 can be a right value. More here : https://dorey.github.io/JavaScript-Equality-Table/
Parameters
- val: unknown
Returns boolean
Inherited from GirafeHTMLElement.isNullOrUndefined
- Defined in src/base/GirafeHTMLElement.ts:76

isNullOrUndefinedOrBlank

isNullOrUndefinedOrBlank(val: unknown): boolean
Parameters
- val: unknown
Returns boolean
Inherited from GirafeHTMLElement.isNullOrUndefinedOrBlank
- Defined in src/base/GirafeHTMLElement.ts:80

listenOpenLayersEvents

listenOpenLayersEvents(): void
Returns void
- Defined in src/components/map/component.ts:257

loadConfig

loadConfig(): Promise<void>
Returns Promise<void>
Inherited from GirafeHTMLElement.loadConfig
- Defined in src/base/GirafeHTMLElement.ts:50

onAddLayers

onAddLayers(layerInfos: Layer[]): void
Parameters
- layerInfos: Layer[]
Returns void
- Defined in src/components/map/component.ts:680

onChangeBasemap

onChangeBasemap(basemap: Basemap): void
Parameters
- basemap: Basemap
Returns void
- Defined in src/components/map/component.ts:741

onChangeDarkMode

onChangeDarkMode(): void
Returns void
- Defined in src/components/map/component.ts:662

onChangeFilter

onChangeFilter(layerInfos: Layer): void
Parameters
- layerInfos: Layer
Returns void
- Defined in src/components/map/component.ts:734

onChangeOpacity

onChangeOpacity(layerInfos: Layer): void
Parameters
- layerInfos: Layer
Returns void
- Defined in src/components/map/component.ts:723

onChangeProjection

onChangeProjection(_oldSrid: string, newSrid: string): void
Parameters
- _oldSrid: string
- newSrid: string
Returns void
- Defined in src/components/map/component.ts:656

onChangeScale

onChangeScale(scale: number): void
Parameters
- scale: number
Returns void
- Defined in src/components/map/component.ts:637

onChangeSwiped

onChangeSwiped(layer: Layer): void
Parameters
- layer: Layer
Returns void
- Defined in src/components/map/component.ts:381

onClick

onClick(e: MapBrowserEvent<UIEvent>): void
Parameters
- e: MapBrowserEvent<UIEvent>
Returns void
- Defined in src/components/map/component.ts:307

onCustomGirafeEvent

onCustomGirafeEvent(
details: { action: string; extent: Extent; layer: Layer },
): void
Parameters
- details: { action: string; extent: Extent; layer: Layer }
Returns void
- Defined in src/components/map/component.ts:375

onDragSelection

onDragSelection(_e: DragBoxEvent): void
Parameters
- _e: DragBoxEvent
Returns void
- Defined in src/components/map/component.ts:319

onFeatureHighlighted

onFeatureHighlighted(features: Feature<Geometry>[]): void
Parameters
- features: Feature<Geometry>[]
Returns void
- Defined in src/components/map/component.ts:621

onFeaturesSelected

onFeaturesSelected(features: Feature<Geometry>[]): void
Parameters
- features: Feature<Geometry>[]
Returns void
- Defined in src/components/map/component.ts:610

onGlobeToggled

onGlobeToggled(): Promise<void>
Returns Promise<void>
- Defined in src/components/map/component.ts:581

onLayerToggled

onLayerToggled(layer: Layer): void
Parameters
- layer: Layer
Returns void
- Defined in src/components/map/component.ts:670

onLoadEnd

onLoadEnd(_e: MapEvent): void
Parameters
- _e: MapEvent
Returns void
- Defined in src/components/map/component.ts:285

onLoadStart

onLoadStart(_e: MapEvent): void
Parameters
- _e: MapEvent
Returns void
- Defined in src/components/map/component.ts:281

onMoveEnd

onMoveEnd(_e: MapEvent): void
Parameters
- _e: MapEvent
Returns void
- Defined in src/components/map/component.ts:293

onPointerMove

onPointerMove(e: MapBrowserEvent<UIEvent>): void
Parameters
- e: MapBrowserEvent<UIEvent>
Returns void
- Defined in src/components/map/component.ts:289

onPositionChanged

onPositionChanged(position: MapPosition): void
Parameters
- position: MapPosition
Returns void
- Defined in src/components/map/component.ts:630

onRemoveLayers

onRemoveLayers(layerInfos: Layer[]): void
Parameters
- layerInfos: Layer[]
Returns void
- Defined in src/components/map/component.ts:697

onSelectFeatures

onSelectFeatures(selectionParams: SelectionParam[]): Promise<void>
Parameters
- selectionParams: SelectionParam[]
Returns Promise<void>
- Defined in src/components/map/component.ts:335

panToCoordinate

panToCoordinate(coordinate: Coordinate): void
Parameters
- coordinate: Coordinate
Returns void
- Defined in src/components/map/component.ts:652

refreshRender

refreshRender(): void
Re-Render the component. The method should be called when the component has already been rendered and needs to be updated.

Returns void
Inherited from GirafeHTMLElement.refreshRender
- Defined in src/base/GirafeHTMLElement.ts:152

registerEvents

registerEvents(): void
Returns void
- Defined in src/components/map/component.ts:116

render

render(): void
Render the component's template.

Returns void
Overrides GirafeHTMLElement.render
- Defined in src/components/map/component.ts:172

renderEmpty

renderEmpty(): void
Renders a hidden span with the name of the component. Useful to render a placeholder for not visible component.

Returns void
Inherited from GirafeHTMLElement.renderEmpty
- Defined in src/base/GirafeHTMLElement.ts:173

resetAllSwipedLayers

resetAllSwipedLayers(layers: BaseLayer[]): void
Parameters
- layers: BaseLayer[]
Returns void
- Defined in src/components/map/component.ts:104

select

select(extent: number[]): void
Parameters
- extent: number[]
Returns void
- Defined in src/components/map/component.ts:324

serialize

serialize(): {}
Returns the serialization of the current element. This method should be overwritten by child classes

Returns {}
An object describing the current element serialized
Inherited from GirafeHTMLElement.serialize
- Defined in src/base/GirafeHTMLElement.ts:255

show

show(): void
Show the component (display: block).

Returns void
Inherited from GirafeHTMLElement.show
- Defined in src/base/GirafeHTMLElement.ts:244

simulateClick

simulateClick(e: KeyboardEvent): void
In the templates, sometimes for accessibility reasons, we have to support the KeyDown Event In those case, we often juste want to do the same as the click event when Enter or Space is pressed Then this method can be used : it just calls the click event on the same element
Parameters
- e: KeyboardEvent
Returns void
Inherited from GirafeHTMLElement.simulateClick
- Defined in src/base/GirafeHTMLElement.ts:224

subscribe(path: string, callback: Callback): Callback
Subscribes with to the state changes made on
Parameters
- path: string
- callback: Callback
Returns Callback
Inherited from GirafeHTMLElement.subscribe
- Defined in src/base/GirafeHTMLElement.ts:268
subscribe(path: RegExp, callback: Callback): Callback
Subscribes with to the state changes made on
Parameters
- path: RegExp
- callback: Callback
Returns Callback
Inherited from GirafeHTMLElement.subscribe
- Defined in src/base/GirafeHTMLElement.ts:269

unsubscribe

unsubscribe(callback: Callback): void
Parameters
- callback: Callback
  Unsubscribe all callbacks
Returns void
Inherited from GirafeHTMLElement.unsubscribe
- Defined in src/base/GirafeHTMLElement.ts:282
unsubscribe(callbacks: Callback[]): void
Parameters
- callbacks: Callback[]
Returns void
Inherited from GirafeHTMLElement.unsubscribe
- Defined in src/base/GirafeHTMLElement.ts:283

updateCloseSwiperPosition

updateCloseSwiperPosition(): void
updates icon position when swipe is moved

Returns void
- Defined in src/components/map/component.ts:389

zoomToExtent

zoomToExtent(extent: Extent): void
Parameters
- extent: Extent
Returns void
- Defined in src/components/map/component.ts:648

zoomToResolution

zoomToResolution(resolution: number): void
Parameters
- resolution: number
Returns void
- Defined in src/components/map/component.ts:641

zoomToZoom

zoomToZoom(zoom: number): void
Parameters
- zoom: number
Returns void
- Defined in src/components/map/component.ts:645

Class MapComponent

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MapComponent

Properties

activeTooltips

callbacks

closeSwiperButton

cogManager

componentManager

configManager

OptionaldisplayStyle

dragbox

focusFeature

highlightedFeaturesCollection

highlightLayer

loading

localFileManager

map3d

map3dTarget

mapTarget

name

olMap

onChangeOrder

osmManager

pixelTolerance

rendered

selectedFeaturesCollection

selectionLayer

shadow

srid

stateManager

styleUrl

styleUrls

swipeManager

swiper

template

templateUrl

OptionaltimeoutId

vectorTilesManager

viewManager

wmsManager

wmsManager3d

wmtsManager

xyzManager

Accessors

projection

Returns null | Projection

state

Returns State

Methods

activateTooltips

Parameters

Returns void

addAllActiveLayers3dMap

Parameters

Returns void

connectedCallback

Returns void

create3dMap

Returns Promise<void>

deserialize

Parameters

Returns void

disconnectedCallback

Returns void

getById

Type Parameters

Parameters

Returns T

getParentOfType

Parameters

Returns null | Node

girafeTranslate

`Optional`displayStyle

`Optional`timeoutId