Logo ROOT  
Reference Guide
ROOT::Experimental::RWebDisplayHandle Class Reference

Definition at line 40 of file RWebDisplayHandle.hxx.

Classes

class  BrowserCreator
 
class  ChromeCreator
 
class  Creator
 
class  FirefoxCreator
 

Public Member Functions

 RWebDisplayHandle (const std::string &url)
 
virtual ~RWebDisplayHandle ()=default
 
std::string GetUrl () const
 

Static Public Member Functions

static std::unique_ptr< RWebDisplayHandleDisplay (const RWebDisplayArgs &args)
 Create web display. More...
 
static bool DisplayUrl (const std::string &url)
 Display provided url in configured web browser. More...
 
static bool ProduceImage (const std::string &fname, const std::string &json, int width=800, int height=600)
 Produce image file using JSON data as source Invokes JSROOT drawing functionality in headless browser - Google Chrome. More...
 

Static Protected Member Functions

static std::unique_ptr< Creator > & FindCreator (const std::string &name, const std::string &libname="")
 Search for specific browser creator If not found, try to add one. More...
 
static std::map< std::string, std::unique_ptr< Creator > > & GetMap ()
 !< URL used to launch display More...
 

Protected Attributes

std::string fUrl
 

#include <ROOT/RWebDisplayHandle.hxx>

Inheritance diagram for ROOT::Experimental::RWebDisplayHandle:
[legend]

Constructor & Destructor Documentation

◆ RWebDisplayHandle()

ROOT::Experimental::RWebDisplayHandle::RWebDisplayHandle ( const std::string &  url)
inline

Definition at line 101 of file RWebDisplayHandle.hxx.

◆ ~RWebDisplayHandle()

virtual ROOT::Experimental::RWebDisplayHandle::~RWebDisplayHandle ( )
virtualdefault

Member Function Documentation

◆ Display()

std::unique_ptr< ROOT::Experimental::RWebDisplayHandle > ROOT::Experimental::RWebDisplayHandle::Display ( const RWebDisplayArgs args)
static

Create web display.

Parameters
args- defines where and how to display web window Returns RWebDisplayHandle, which holds information of running browser application Can be used fully independent from RWebWindow classes just to show any web page

Definition at line 500 of file RWebDisplayHandle.cxx.

◆ DisplayUrl()

bool ROOT::Experimental::RWebDisplayHandle::DisplayUrl ( const std::string &  url)
static

Display provided url in configured web browser.

Parameters
url- specified URL address like https://root.cern Browser can specified when starting root --web=firefox Returns true when browser started It is convenience method, equivalent to:
RWebDisplayArgs args;
args.SetUrl(url);
args.SetStandalone(false);
auto handle = RWebDisplayHandle::Display(args);

Definition at line 564 of file RWebDisplayHandle.cxx.

◆ FindCreator()

std::unique_ptr< ROOT::Experimental::RWebDisplayHandle::Creator > & ROOT::Experimental::RWebDisplayHandle::FindCreator ( const std::string &  name,
const std::string &  libname = "" 
)
staticprotected

Search for specific browser creator If not found, try to add one.

Parameters
name- creator name like ChromeCreator
libname- shared library name where creator could be provided

Definition at line 60 of file RWebDisplayHandle.cxx.

◆ GetMap()

std::map< std::string, std::unique_ptr< ROOT::Experimental::RWebDisplayHandle::Creator > > & ROOT::Experimental::RWebDisplayHandle::GetMap ( )
staticprotected

!< URL used to launch display

Static holder of registered creators of web displays.

Definition at line 48 of file RWebDisplayHandle.cxx.

◆ GetUrl()

std::string ROOT::Experimental::RWebDisplayHandle::GetUrl ( ) const
inline

Definition at line 106 of file RWebDisplayHandle.hxx.

◆ ProduceImage()

bool ROOT::Experimental::RWebDisplayHandle::ProduceImage ( const std::string &  fname,
const std::string &  json,
int  width = 800,
int  height = 600 
)
static

Produce image file using JSON data as source Invokes JSROOT drawing functionality in headless browser - Google Chrome.

Definition at line 580 of file RWebDisplayHandle.cxx.

Member Data Documentation

◆ fUrl

std::string ROOT::Experimental::RWebDisplayHandle::fUrl
protected

Definition at line 93 of file RWebDisplayHandle.hxx.


The documentation for this class was generated from the following files:
ROOT::Experimental::RWebDisplayHandle::Display
static std::unique_ptr< RWebDisplayHandle > Display(const RWebDisplayArgs &args)
Create web display.
Definition: RWebDisplayHandle.cxx:500