R/rlo_figure.R

In rlo: Utilities for Writing to 'LibreOffice Writer' Documents

#' Insert an SVG graph into the connected document
#'
#' Inserts a figure at the current position of the view cursor.
#'
#' @importFrom PythonInR pyExec pySet
#' @param svg_file Path to an SVG file
#' @param caption The caption to use for the figure
#' @param aspect The aspect ratio (height/width) to use
#' @param width The width in cm
#' @param height The height in cm
#' @export

rlo_figure <- function(svg_file, caption, aspect = 1, width = 17, height = aspect * width)
{
  rlo_scursor()

  # Insert the SVG file {{{3
  pyExec("fig = doc.createInstance('com.sun.star.text.GraphicObject')")
  pySet("url", paste0("file:///", normalizePath(svg_file)))
  pyExec("fig.GraphicURL = url")
  pyExec("fig.AnchorType = 'AT_PARAGRAPH'")
  rlo_width = width * 1000
  pyExec(paste0("fig.Width = ", rlo_width))
  pyExec(paste0("fig.Height = ", rlo_width * height/width))
  pyExec("text.insertTextContent(scursor, fig, False)")

  # Add the caption {{{3
  pyExec("scursor.setPropertyValue('ParaStyleName', 'Figure')")
  pyExec("text.insertString(scursor, 'Figure ', False)")

  rlo_dispatch(".uno:InsertField",
    list(Type = 23, SubType = 127, Name = "Figure", Content = "", Format = 4, Separator = " "))
  pyExec("text.insertString(scursor, ': ', False)")
  pySet("captiontext", caption)
  pyExec("text.insertString(scursor, captiontext, False)")
  pyExec("text.insertControlCharacter(scursor, 0, False)")
}