leaflet/src/icon.mli
2024-01-30 16:55:19 +01:00

36 lines
1.1 KiB
OCaml

(* BSD-2-Clause License *)
type t
(** [to_jv o] is [o] as {!Jv.t} *)
val to_jv : t -> Jv.t
(** [of_jv o] is [o] as {!Icon.t} *)
val of_jv : Jv.t -> t
(** type for icon option used to create an icon*)
type opt =
| Icon_retina_url of string
| Icon_size of Point.t
| Icon_anchor of Point.t
| Popup_anchor of Point.t
| Tooltip_anchor of Point.t
| Shadow_url of string
| Shadow_retina_url of string
| Shadow_size of Point.t
| Shadow_anchor of Point.t
| Class_name of string
| Cross_origin of string option
(** [create icon_url options] Creates an icon instance with the given [options],
and the required `iconUrl` option set to [icon_url] *)
val create : string -> opt array -> t
(** [create_div ~html ~bg_pos options] Creates an DivIcon instance with the
given [options], [bg_pos] is the optional relative position of the
background, in pixels [html] is custom HTML code to put inside the div
element, empty by default. *)
val create_div : html:string option -> bg_pos:Point.t option -> opt array -> t
(** Sets the path of the default icon *)
val set_default_image_path : string -> unit