leaflet/src/popup.mli

46 lines
1.1 KiB
OCaml
Raw Normal View History

2022-04-12 13:46:37 +02:00
(* BSD-2-Clause License *)
2022-04-08 13:21:20 +02:00
type t
2022-06-20 10:05:35 +02:00
(** 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] changes the popup position to the given point*)
2022-04-07 14:45:11 +02:00
val set_latlng : Latlng.t -> unit
(** [set_content s] changes the popup content to [s]*)
2022-04-07 14:45:11 +02:00
val set_content : string -> unit
(** [open_on map] * Adds the popup to [map] and closes the previous one. *)
2022-04-07 14:45:11 +02:00
val open_on : Map.t -> unit
(** [close map] * closes the popup of [map]*)
2022-04-07 14:45:11 +02:00
val close : Map.t -> unit
2022-04-08 13:21:20 +02:00
(** [of_jv jv] is [jv] as {!t} *)
2022-04-09 22:21:22 +02:00
val of_jv : Jv.t -> t
2022-06-20 10:05:35 +02:00
(** [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 options] is a new popup setup withs [options] *)
val create : opt list -> t