Skip to main content

GeomapLine

<ui5-geomap-line>

The ui5-geomap-line defines the Line webcomponent.

ES6 Module Import​

import "@ui5/webcomponents-geomap/dist/GeomapLine.js";

Basic Sample​

Properties​

color​

DescriptionDescribes the color of the line.
Typestring
Default"black"

width​

DescriptionDescribes the width of the line.
Typenumber | null | undefined
Default0

opacity​

DescriptionDescribes the opacity of the line.
Typenumber
Default0.5

dragndrop​

DescriptionDescribes if the line is draggable & editable.
Typeboolean
Defaultfalse

minZoom​

DescriptionWhen the map's zoom property is less than this value, the layer will be hidden. Accepts values between 0 and 24.
Typenumber
Default0

maxZoom​

DescriptionWhen the map's zoom property is equal to, or greater than this value, the layer will be hidden Accepts values between 0 and 24.
Typenumber
Default0

filter​

DescriptionWhen set, only features, matching the filter, will be displayed
Typeobject
Default

displayedFeatures​

DescriptionDetermines which features the layer will display - All (default), only not-clustered, or only clustered Note: This property is ignored if the filter property is set Note: This property only makes sense when the layer is used for clustering (displays data from a ui5-geomap-cluster-source element)
Type"All" | "NotClustered" | "Clustered"
Default"All"

hidden​

DescriptionDetermines if the layer is hidden.
Typeboolean
Defaultfalse

zIndex​

DescriptionDescribes the zIndex of the layer. The layer with the highest zIndex will be on top.
Typenumber
Default0

layer​

DescriptionReturns the layer object in maplibre
Typeany
Default
Readonlytrue

Slots​

default​

DescriptionPoints describing the line itself.
TypeArray<HTMLElement>

Events​

line-dragndrop-end​

DescriptionFired when the polygon drag is finished.
TypeCustomEvent
BubblesYes
CancelableYes - via preventDefault()

layer-click​

DescriptionLayer clicked
TypeCustomEvent
BubblesNo
CancelableNo

layer-mouseenter​

DescriptionMouse entered layer
TypeCustomEvent
BubblesNo
CancelableNo

layer-mousemove​

DescriptionMouse moved in the layer
TypeCustomEvent
BubblesNo
CancelableNo

layer-mouseleave​

DescriptionMouse left the layer
TypeCustomEvent
BubblesNo
CancelableNo

layer-mousedown​

DescriptionMouse button down on the layer
TypeCustomEvent
BubblesNo
CancelableNo

layer-mouseup​

DescriptionMouse button up on the layer
TypeCustomEvent
BubblesNo
CancelableNo

Methods​

getPointAt​

Description-
Return typeany

getDistance​

Description-
Return typenumber

CSS Parts​

No CSS parts available for this component.