tech.tablesaw.plotly.Plot Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tablesaw-jsplot Show documentation
There is a newer version: 0.43.1
package tech.tablesaw.plotly;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.UncheckedIOException;
import java.io.Writer;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.UUID;
import tech.tablesaw.plotly.components.Figure;
import tech.tablesaw.plotly.components.Page;
import tech.tablesaw.plotly.display.Browser;

/**
 * Displays plots in a development setting, by exporting a file containing the HTML and Javascript,
 * and then opening the file in the default browser on the developer's machine.
 */
public class Plot {

  protected static final String DEFAULT_DIV_NAME = "target";
  protected static final String DEFAULT_OUTPUT_FILE = "output.html";
  protected static final String DEFAULT_OUTPUT_FILE_NAME = "output";
  protected static final String DEFAULT_OUTPUT_FOLDER = "testoutput";

  public static void show(Figure figure, String divName, File outputFile) {
    Page page = Page.pageBuilder(figure, divName).build();
    String output = page.asJavascript();

    try {
      try (Writer writer =
          new OutputStreamWriter(new FileOutputStream(outputFile), StandardCharsets.UTF_8)) {
        writer.write(output);
      }
      new Browser().browse(outputFile);
    } catch (IOException e) {
      throw new UncheckedIOException(e);
    }
  }

  /**
   * Opens the default browser on the given HTML page. This is a convenience method for anyone who
   * wants total control over the HTML file containing one or more plots, but still wants to use the
   * mechanism for opening the default browser on it.
   *
   * @param html An arbitrary HTML page, it doesn't even need plots
   * @param outputFile The file where the page will be written
   */
  public static void show(String html, File outputFile) {
    try {
      try (Writer writer =
          new OutputStreamWriter(new FileOutputStream(outputFile), StandardCharsets.UTF_8)) {
        writer.write(html);
      }
      new Browser().browse(outputFile);
    } catch (IOException e) {
      throw new UncheckedIOException(e);
    }
  }

  public static void show(Figure figure, String divName) {
    show(figure, divName, defaultFile());
  }

  public static void show(Figure figure) {
    show(figure, randomFile());
  }

  public static void show(Figure figure, File outputFile) {
    show(figure, DEFAULT_DIV_NAME, outputFile);
  }

  protected static File defaultFile() {
    Path path = Paths.get(DEFAULT_OUTPUT_FOLDER, DEFAULT_OUTPUT_FILE);
    try {
      Files.createDirectories(path.getParent());
    } catch (IOException e) {
      throw new UncheckedIOException(e);
    }
    return path.toFile();
  }

  protected static File randomFile() {
    Path path = Paths.get(DEFAULT_OUTPUT_FOLDER, randomizedFileName());
    try {
      Files.createDirectories(path.getParent());
    } catch (IOException e) {
      throw new UncheckedIOException(e);
    }
    return path.toFile();
  }

  protected static String randomizedFileName() {
    return DEFAULT_OUTPUT_FILE_NAME + UUID.randomUUID().toString() + ".html";
  }
}