plotly.hpp

Go to the documentation of this file.

#ifndef PLOTLY_PLOTLY_HPP
#define PLOTLY_PLOTLY_HPP

 
#include "plotly/abi_macros.hpp"
 
#include <filesystem>
#include <memory>
#include <nlohmann/json.hpp>

namespace plotly {
 
using Object = nlohmann::json;
using Array = std::vector<Object>;

class PLOTLY_EXPORT Figure {
private:
  class Impl;                   
  std::unique_ptr<Impl> _pimpl; 
 
public:
  Figure(const std::filesystem::path &webappPath =
             std::filesystem::path(PLOTLY_CPP_WEBAPP_PATH));

  Figure(const Figure &) = delete;
  auto operator=(const Figure &) -> Figure & = delete;
  ~Figure();

  auto openBrowser(bool headless = false) -> bool;

  [[nodiscard]] auto isOpen() const -> bool;

  void waitClose() const;

  auto downloadImage(const Object &opts = Object()) -> bool;

  auto newPlot(const Object &data, const Object &layout = Object(),
               const Object &config = Object()) -> bool;

  auto update(const Object &traceUpdate, const Object &layoutUpdate = Object())
      -> bool;

  auto relayout(const Object &layout = Object()) -> bool;

  auto redraw() -> bool;

  auto purge() -> bool;

  auto restyle(const Object &aobj, const Object &traces = Object()) -> bool;

  auto addTraces(const Object &traces, const Object &newIndices = Object())
      -> bool;

  auto deleteTraces(const Object &indices) -> bool;

  auto moveTraces(const Object &currentIndices, const Object &newIndices)
      -> bool;

  auto extendTraces(const Object &update, const Object &indices,
                    const Object &maxPoints = Object()) -> bool;

  auto prependTraces(const Object &update, const Object &indices) -> bool;

  auto react(const Object &data, const Object &layout = Object(),
             const Object &config = Object()) -> bool;

  auto addFrames(const Object &frames) -> bool;

  auto deleteFrames(const Object &frames) -> bool;

  auto animate(const Object &frameOrGroupNameOrFrameList,
               const Object &opts = Object()) -> bool;

  auto on(const std::string &event,
          const std::function<void(plotly::Object)> &callback) -> bool;

  auto removeAllListeners(const std::string &event) -> bool;

  auto setDownloadDirectory(const std::filesystem::path &directory,
                            int remoteDebuggingPort = 9222) -> bool;
};
 
} // namespace plotly
 
#endif // PLOTLY_PLOTLY_HPP