vtkPlotlyJsonExporter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPlotlyJsonExporter_h
#define vtkPlotlyJsonExporter_h

#include "vtkAbstractChartExporter.h"
#include "vtkPVVTKExtensionsFiltersRenderingModule.h" // needed for export macro

#include <string> // needed for std::string

class VTKPVVTKEXTENSIONSFILTERSRENDERING_EXPORT vtkPlotlyJsonExporter
  : public vtkAbstractChartExporter
{
public:
  static vtkPlotlyJsonExporter* New();
  vtkTypeMacro(vtkPlotlyJsonExporter, vtkAbstractChartExporter);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);

  using vtkAbstractChartExporter::ExporterModes;
  bool Open(ExporterModes mode = STREAM_ROWS) override;

  void Close() override;

  void Abort() override;


  void WriteHeader(vtkFieldData*) override;
  void WriteData(vtkFieldData*) override;

  void AddColumn(vtkAbstractArray* yarray, const char* yarrayname = nullptr,
    vtkDataArray* xarray = nullptr) override;

  void AddStyle(vtkPlot* plot, const char* plotName) override;

  void SetGlobalStyle(vtkChart* chart) override;


  vtkSetMacro(WriteToOutputString, bool);
  vtkGetMacro(WriteToOutputString, bool);
  vtkBooleanMacro(WriteToOutputString, bool);

  // When WriteToOutputString is set this can be used to retrieve the string respresentation.
  std::string GetOutputString() const;

protected:
  vtkPlotlyJsonExporter();
  ~vtkPlotlyJsonExporter() override;

private:
  vtkPlotlyJsonExporter(const vtkPlotlyJsonExporter&) = delete;
  void operator=(const vtkPlotlyJsonExporter&) = delete;

  char* FileName = nullptr;
  class vtkInternals;
  bool WriteToOutputString = false;
  vtkInternals* Internals;
};

#endif