Create a girafe objectSource:
Create an interactive graphic with a ggplot object
to be used in a web browser. The function should replace function
girafe( code, ggobj = NULL, pointsize = 12, width_svg = NULL, height_svg = NULL, options = list(), dependencies = NULL, ... )
Plotting code to execute
ggplot object to print. Argument
codewill be ignored if this argument is supplied.
the default pointsize of plotted text in pixels, default to 12.
- width_svg, height_svg
The width and height of the graphics region in inches. The default values are 6 and 5 inches. This will define the aspect ratio of the graphic as it will be used to define viewbox attribute of the SVG result.
If you use
girafe()in an 'R Markdown' document, we recommend not using these arguments so that the knitr options
fig.heightare used instead.
Additional widget HTML dependencies, see
arguments passed on to
geom_zzz_interactive to create interactive graphical elements.
Difference from original functions is that some extra aesthetics are understood: the interactive_parameters.
Tooltips can be displayed when mouse is over graphical elements.
If id are associated with points, they get animated when mouse is over and can be selected when used in shiny apps.
When a zoom effect is set, "zoom activate", "zoom desactivate" and "zoom init" buttons are available in a toolbar.
When selection type is set to 'multiple' (in Shiny applications), lasso selection and lasso anti-selections buttons are available in a toolbar.
girafe animations can be customized with function
Options are available to customize tooltips, hover effects, zoom effects
selection effects and toolbar.
girafe graphics are responsive, which mean, they will be resized
according to their container. There are two responsive behavior
implementations: one for Shiny applications and flexdashboard documents
and one for other documents (i.e. R markdown and
Graphics are created by an R graphic device (i.e pdf, png, svg here) and
need arguments width and height to define a graphic region.
height_svg are used as corresponding
values. They are defining the aspect ratio of the graphic. This proportion is
always respected when the graph is displayed.
When a girafe graphic is in a Shiny application,
graphic will be resized according to the arguments
height of the function
values are '100\
outer bounding box of the graphic (the HTML element that will
contain the graphic with an aspect ratio).
When a girafe graphic is in an R markdown document (producing an HTML
document), the graphic will be resized according to the argument
width of the
girafe. Its value is beeing used to define a relative
width of the graphic within its HTML container. Its height is automatically
adjusted regarding to the argument
width and the aspect ratio.
If this behavior does not fit with your need, I recommend you to use package widgetframe that wraps htmlwidgets inside a responsive iframe.