Skip to content

PrestoPlot Class

The PrestoPlot class gives an interface to high level and application features. It is the main entry point to all you can do by interacting with PrestoPlot. It gives access to several managers to handle different parts of the application and data.

Here is an example of creating a dataset :

pp = new PrestoPlot("PrestoPlot path")
newDataset = pp.datasetManager.createDataset("MyParameter")


Public Constructor

PrestoPlot(prestoPlotExecutable, visible, apiLevel)


Public Properties

calculator (read only)
currentPlugin (read only)
datasetManager (read only)
dateManager (read only)
fileManager (read only)
graphManager (read only)
options (read only)
ui (read only)
version (read only)


Public Functions

exit()
log(message)


Detailed Constructor Description

PrestoPlot

PrestoPlot(prestoPlotExecutable, visible, apiLevel)

Create an instance of PrestoPlot. The PrestoPlot application will immediately be started.

Parameters :

  • prestoPlotExecutable : The path to the PrestoPlot executable to use.

  • visible : (Optional) Whether PrestoPlot will be visible (True) or hidden (False). By default PrestoPlot will be hidden.

  • apiLevel : (Optional) The API version to use (see API versions). By default the latest is used.

Return : An instance of PrestoPlot.


Detailed Properties Descriptions

calculator (read only)

calculator

Get the Calculator object to deal with calculator features.

Return : An instance of Calculator.

currentPlugin (read only)

currentPlugin

Get the Plugin object for the current plugin.

Return : An instance of Plugin.

datasetManager (read only)

datasetManager

Get the DatasetManager object to handle dataset collection.

Return : An instance of DatasetManager.

dateManager (read only)

dateManager

Get the DateManager object to handle dates.

Return : An instance of DateManager.

fileManager (read only)

fileManager

Get the FileManager object to deal with files.

Return : An instance of FileManager.

graphManager (read only)

graphManager

Get the GraphManager object to handle graphs.

Return : An instance of GraphManager.

options (read only)

options

Get the OptionManager object to deal with PrestoPlot options.

Return : An instance of OptionManager.

ui (read only)

ui

Get the UserInterface object to interact with the user interface of the current PrestoPlot session.

Return : An instance of UserInterface.

version (read only)

version

This function returns the current PrestoPlot version as a string. For example, the function can return "25.07".

Return : A string representing the current PrestoPlot version.


Detailed Functions Descriptions

exit

exit()

This function will terminate and exit PrestoPlot.

log

log(message)

This function will output a message in the log file.

Parameters :

  • message : The message to write.