leaflet/src/popup.mli
2026-03-19 21:49:00 +01:00

50 lines
1.5 KiB
OCaml

(* BSD-2-Clause License *)
type t
(** type for popup option used to create an popup*)
type opt =
| Pane of string
| Offset of Point.t
| Max_width of int
| Min_width of int
| Max_height of int
| Auto_pan of bool
| Auto_pan_padding_top_left of Point.t
| Auto_pan_padding_bottom_right of Point.t
| Auto_pan_padding of Point.t
| Keep_in_view of bool
| Close_button of bool
| Auto_close of bool
| Close_on_escape_key of bool
| Close_on_click of bool
| Class_name of string
(** [set_latlng latlng popup] sets [popup] position to the given point*)
val set_latlng : Latlng.t -> t -> unit
(** [set_content s popup] sets [popup] content to [s]*)
val set_content : string -> t -> unit
(** [set_content_to_el el s] sets [popup] content to [el]*)
val set_content_to_el : Brr.El.t -> t -> unit
(** [of_jv jv] is [jv] as {!t} *)
val of_jv : Jv.t -> t
(** [to_jv o] is [o] as {!Jv.t} *)
val to_jv : t -> Jv.t
(** [opt_to_string opt] is [opt] as {!string} *)
val opt_to_string : opt -> string
(** [opt_to_jv opt] is [opt] as {!Jv.t} *)
val opt_to_jv : opt -> Jv.t
(** [create ~content ~latlng options] is a new popup setup with [options],
position set to [latlng] and content to [s] *)
val create : content:string option -> latlng:Latlng.t option -> opt array -> t
(** [create_from_el el latlng options] is a new popup setup with [options],
position set to [latlng] and content to [el] *)
val create_from_el : Brr.El.t -> latlng:Latlng.t option -> opt array -> t