Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dot: Add the tooltip attribute #127

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

dot: Add the tooltip attribute #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/dGraphTreeLayout.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,7 @@ struct
mutable style : [ `Rounded | `Filled | `Solid | `Dashed | `Dotted | `Bold
| `Invis ] list;
mutable width : float option;
mutable tooltip : string option;
mutable fillcolor : int32 option;
}

Expand All @@ -257,6 +258,7 @@ struct
| `Shape shape -> vattrs.shape <- set_if_none vattrs.shape shape
| `Style s -> vattrs.style <- s :: vattrs.style
| `Width w -> vattrs.width <- set_if_none vattrs.width w
| `Tooltip t -> vattrs.tooltip <- set_if_none vattrs.tooltip t
| `Fillcolor c ->
vattrs.fillcolor <- set_if_none vattrs.fillcolor
(Graphviz.color_to_color_with_transparency c)
Expand Down Expand Up @@ -285,6 +287,7 @@ struct
shape = None;
style = [];
width = None;
tooltip = None;
fillcolor = None
} in
let dgraph_layout_default =
Expand Down Expand Up @@ -455,7 +458,8 @@ struct
mutable labelfontcolor : int option;
mutable labelfontname : string option;
mutable labelfontsize : int option;
mutable style : [ `Solid | `Dashed | `Dotted | `Bold | `Invis ] list
mutable style : [ `Solid | `Dashed | `Dotted | `Bold | `Invis ] list;
mutable tooltip : string option
}

let rec attributes_list_to_eattributes (eattrs:eattributes)
Expand Down Expand Up @@ -502,6 +506,9 @@ struct
| `Style s :: q ->
eattrs.style <- s :: eattrs.style;
attributes_list_to_eattributes eattrs q
| `Tooltip t :: q ->
eattrs.tooltip <- set_if_none eattrs.tooltip t;
attributes_list_to_eattributes eattrs q
| (`Arrowhead _ | `Arrowsize _ | `Arrowtail _ | `Comment _ | `Constraint _
| `Headlabel _ | `Headport _ | `Headurl _ | `Labelangle _
|`Labeldistance _ | `Labelfloat _ | `Layer _ | `Minlen _ | `Penwidth _
Expand All @@ -522,7 +529,8 @@ struct
labelfontcolor = None;
labelfontname = None;
labelfontsize = None;
style = [] }
style = [];
tooltip = None }
in
let dgraph_layout_default =
[ `Color 0xFF0000; `Decorate false; `Dir `Forward; `Fontcolor 0x00000;
Expand Down
9 changes: 9 additions & 0 deletions src/graphviz.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,8 @@ module CommonAttributes = struct
| `OrderingOut
(** Constrains order of out-edges in a subgraph according to
their file sequence *)
| `Tooltip of string
(** Sets the tooltip (mouse hover text) attached to the graph. *)
]

(** Attributes of nodes. *)
Expand Down Expand Up @@ -205,6 +207,8 @@ module CommonAttributes = struct
simultaneously. *)
| `Width of float
(** Sets the minimum width. Default value is [0.75]. *)
| `Tooltip of string
(** Sets the tooltip (mouse hover text) attached to the vertex. *)
]

(** Attributes of edges. *)
Expand Down Expand Up @@ -245,6 +249,8 @@ module CommonAttributes = struct
| `Style of [ `Solid | `Dashed | `Dotted | `Bold | `Invis ]
(** Sets the layout style of the edge. Several styles may be combined
simultaneously. *)
| `Tooltip of string
(** Sets the tooltip (mouse hover text) attached to the edge. *)
]

(** Pretty-print. *)
Expand All @@ -265,6 +271,7 @@ module CommonAttributes = struct
| `Pagedir a -> fprintf ppf "pagedir=%a" fprint_dir a
| `Size (x, y) -> fprintf ppf "size=\"%f,%f\"" x y
| `OrderingOut -> fprintf ppf "ordering=out"
| `Tooltip s -> fprintf ppf "tooltip=%a" fprint_string s

let fprint_shape ppf = function
| `Ellipse -> fprintf ppf "ellipse"
Expand Down Expand Up @@ -353,6 +360,7 @@ module CommonAttributes = struct
| `Shape a -> fprintf ppf "shape=%a" fprint_shape a
| `Style _ -> assert false
| `Width f -> fprintf ppf "width=%f" f
| `Tooltip s -> fprintf ppf "tooltip=%a" fprint_string s

let fprint_arrow_direction ppf = function
`Forward -> fprintf ppf "forward"
Expand All @@ -377,6 +385,7 @@ module CommonAttributes = struct
| `Labelfontsize i -> fprintf ppf "labelfontsize=%i" i
| `Penwidth f -> fprintf ppf "penwidth=%f" f
| `Style _ -> assert false
| `Tooltip s -> fprintf ppf "tooltip=%a" fprint_string s

let rec filter_style al sl l = match l with
| [] -> al, sl
Expand Down
6 changes: 6 additions & 0 deletions src/graphviz.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ module CommonAttributes : sig
| `OrderingOut
(** Constrains order of out-edges in a subgraph according to
their file sequence *)
| `Tooltip of string
(** Sets the tooltip (mouse hover text) attached to the graph. *)
]

(** Attributes of vertices. *)
Expand Down Expand Up @@ -178,6 +180,8 @@ module CommonAttributes : sig
Several styles may be combined simultaneously. *)
| `Width of float
(** Sets the minimum width. Default value is [0.75]. *)
| `Tooltip of string
(** Sets the tooltip (mouse hover text) attached to the vertex. *)
]

(** Attributes of edges. *)
Expand Down Expand Up @@ -223,6 +227,8 @@ module CommonAttributes : sig
| `Style of [ `Solid | `Dashed | `Dotted | `Bold | `Invis ]
(** Sets the layout style of the edge. Several styles may be combined
simultaneously. *)
| `Tooltip of string
(** Sets the tooltip (mouse hover text) attached to the edge. *)
]

end
Expand Down
10 changes: 5 additions & 5 deletions tests/dot.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ digraph G {
"task_eat";


"task_menu" -> "task_ingredients" [label=<f&#36;oo>, ];
"task_ingredients" -> "task_cook" [label=<f&#36;oo>, ];
"task_invitation" -> "task_cook" [label=<f&#36;oo>, ];
"task_cook" -> "task_eat" [label=<f&#36;oo>, ];
"task_table" -> "task_eat" [label=<f&#36;oo>, ];
"task_menu" -> "task_ingredients" [tooltip="description", label=<f&#36;oo>, ];
"task_ingredients" -> "task_cook" [tooltip="description", label=<f&#36;oo>, ];
"task_invitation" -> "task_cook" [tooltip="description", label=<f&#36;oo>, ];
"task_cook" -> "task_eat" [tooltip="description", label=<f&#36;oo>, ];
"task_table" -> "task_eat" [tooltip="description", label=<f&#36;oo>, ];

}
========= END output graph =========
2 changes: 1 addition & 1 deletion tests/dot.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ module Display = struct
let default_vertex_attributes _ = []
let vertex_attributes _ = []
let default_edge_attributes _ = []
let edge_attributes _ = [ `HtmlLabel "f&#36;oo" ]
let edge_attributes _ = [ `HtmlLabel "f&#36;oo"; `Tooltip "description" ]
let get_subgraph _ = None
end
module DotOutput = Graphviz.Dot(Display)
Expand Down