livemap.layer.marker.options.PopupOptions Class Reference

Optional settings for popup overlays. More...

Inheritance diagram for livemap.layer.marker.options.PopupOptions:

Collaboration diagram for livemap.layer.marker.options.PopupOptions:

Properties
double?	MaxWidth [get, set]
	Maximum width of the popup, in pixels.
double?	MinWidth [get, set]
	Minimum width of the popup, in pixels.
double?	MaxHeight [get, set]
	If set, creates a scrollable container of the given height inside a popup if its content exceeds it.
bool?	AutoPan [get, set]
	Set it to false if you don't want the map to do panning animation to fit the opened popup.
Point?	AutoPanPaddingTopLeft [get, set]
	The margin between the popup and the top left corner of the map view after autopanning was performed.
Point?	AutoPanPaddingBottomRight [get, set]
	The margin between the popup and the bottom right corner of the map view after autopanning was performed.
Point?	AutoPanPadding [get, set]
	Equivalent of setting both top left and bottom right autopan padding to the same value.
bool?	KeepInView [get, set]
	Set it to true if you want to prevent users from panning the popup off of the screen while it is open.
bool?	CloseButton [get, set]
	Controls the presence of a close button in the popup.
bool?	AutoClose [get, set]
	Set it to false if you want to override the default behavior of the popup closing when another popup is opened.
bool?	CloseOnEscapeKey [get, set]
	Set it to false if you want to override the default behavior of the ESC key for closing of the popup.
bool?	CloseOnClick [get, set]
	Set it if you want to override the default behavior of the popup closing when user clicks on the map.
Properties inherited from livemap.layer.marker.options.DivOverlayOptions
Point?	Offset [get, set]
	The offset of this overlay position.
string?	ClassName [get, set]
	A custom CSS class name to assign to this overlay.
string?	Content [get, set]
	Sets the HTML contents of this overlay.
Properties inherited from livemap.layer.marker.options.InteractiveLayerOptions
bool?	BubblingMouseEvents [get, set]
	When true, a mouse event on this marker will trigger the same event on the map.
bool?	Interactive [get, set]
	If false, this marker will not emit mouse events and will act as a part of the underlying map.
Properties inherited from livemap.layer.marker.options.LayerOptions
string?	Pane [get, set]
	Map pane where this marker will be added.
string?	Attribution [get, set]
	String to be shown in the attribution control.

Detailed Description

Optional settings for popup overlays.

Property Documentation

AutoClose

bool? livemap.layer.marker.options.PopupOptions.AutoClose

getset

Set it to false if you want to override the default behavior of the popup closing when another popup is opened.

AutoPan

bool? livemap.layer.marker.options.PopupOptions.AutoPan

getset

Set it to false if you don't want the map to do panning animation to fit the opened popup.

AutoPanPadding

Point? livemap.layer.marker.options.PopupOptions.AutoPanPadding

getset

Equivalent of setting both top left and bottom right autopan padding to the same value.

AutoPanPaddingBottomRight

Point? livemap.layer.marker.options.PopupOptions.AutoPanPaddingBottomRight

getset

The margin between the popup and the bottom right corner of the map view after autopanning was performed.

AutoPanPaddingTopLeft

Point? livemap.layer.marker.options.PopupOptions.AutoPanPaddingTopLeft

getset

The margin between the popup and the top left corner of the map view after autopanning was performed.

CloseButton

bool? livemap.layer.marker.options.PopupOptions.CloseButton

getset

Controls the presence of a close button in the popup.

CloseOnClick

bool? livemap.layer.marker.options.PopupOptions.CloseOnClick

getset

Set it if you want to override the default behavior of the popup closing when user clicks on the map.

CloseOnEscapeKey

bool? livemap.layer.marker.options.PopupOptions.CloseOnEscapeKey

getset

Set it to false if you want to override the default behavior of the ESC key for closing of the popup.

KeepInView

bool? livemap.layer.marker.options.PopupOptions.KeepInView

getset

Set it to true if you want to prevent users from panning the popup off of the screen while it is open.

MaxHeight

double? livemap.layer.marker.options.PopupOptions.MaxHeight

getset

If set, creates a scrollable container of the given height inside a popup if its content exceeds it.

The scrollable container can be styled using the leaflet-popup-scrolled CSS class selector

MaxWidth

double? livemap.layer.marker.options.PopupOptions.MaxWidth

getset

Maximum width of the popup, in pixels.

MinWidth

double? livemap.layer.marker.options.PopupOptions.MinWidth

getset

Minimum width of the popup, in pixels.

---

The documentation for this class was generated from the following file:

• src/layer/marker/options/PopupOptions.cs