plantuml_URL: Generate PlantUML Server URL

View source: R/plantUML_URL.R

plantuml_URLR Documentation

Generate PlantUML Server URL

Description

Generate PlantUML Server URL

Usage

plantuml_URL(
  plantuml = "@startuml\nBob -> Alice : hello\n@enduml",
  server_url = getPlantumlOption("server_url"),
  server_port = getPlantumlOption("server_port"),
  type = "svg",
  open_in_browser = FALSE
)

Arguments

plantuml

The plantuml code. If NULL, only the base URL consisting of server and (if specified) port will be returned.

server_url

The base url of the server. Should end with a single / If NULL, encoding, including the ttpe, will be returned.

server_port

port on which the plantuml server is

type

the type of the returned figure. At the moment supported: png, svg txt, or map. See https://plantuml.com/server for further details. If NULL, encoding, excluding the tytpe, will be returned. The return value is invalid if server_url is given!

open_in_browser

if TRUE, the result will be opened in the browser.

Value

complete url to retrieve the graph.


rkrug/plantuml documentation built on June 3, 2023, 6:24 a.m.