https://github.com/egormkn/latexview

🔢 JavaFX component that renders LaTeX text and math formulas
https://github.com/egormkn/latexview

formula fxml java javafx javafx-component javafx-components jlatexmath latex

Last synced: 3 months ago
JSON representation

🔢 JavaFX component that renders LaTeX text and math formulas

• Host: GitHub
• URL: https://github.com/egormkn/latexview
• Owner: egormkn
• License: gpl-3.0
• Created: 2019-01-22T22:26:10.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-06-24T17:52:38.000Z (over 5 years ago)
• Last Synced: 2024-09-28T22:04:49.575Z (4 months ago)
• Topics: formula, fxml, java, javafx, javafx-component, javafx-components, jlatexmath, latex
• Language: Java
• Homepage:
• Size: 87.9 KB
• Stars: 9
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LatexView

[![Build Status](https://travis-ci.com/egormkn/latexview.svg?branch=master)](https://travis-ci.com/egormkn/latexview) [![Maven Central](https://img.shields.io/maven-central/v/io.github.egormkn/latexview.svg)](https://search.maven.org/artifact/io.github.egormkn/latexview/) [![](https://img.shields.io/nexus/r/https/oss.sonatype.org/io.github.egormkn/latexview.svg)](https://oss.sonatype.org/content/repositories/releases/io/github/egormkn/latexview/) ![License](https://img.shields.io/github/license/egormkn/latexview.svg)

LatexView is a custom JavaFX component that renders LaTeX text and formulas using [JLatexMath](https://github.com/opencollab/jlatexmath) library.

![Demo App](src/test/resources/demo/demo.png)

Use [Demo](src/test/demo/Demo.java) application to test LaTeX rendering and syntax support.

See [JLatexMath](https://github.com/opencollab/jlatexmath) documentation for supported LaTeX features.

## Installation

### Maven dependency

```xml

  io.github.egormkn

  latexview

  0.6.1

```

### Gradle dependency

```gradle

implementation 'io.github.egormkn:latexview:0.6.1'

```

### Other build systems

Installation details for other build systems can be found on [Central Repository](https://search.maven.org/artifact/io.github.egormkn/latexview/) page.

## Usage

### With FXML

See [ExampleFXML.java](src/test/java/ExampleFXML.java)

```fxml

    \overset{\text{Lorenz system}}{

        \begin{cases}

        \frac { \partial \vec v }{\partial t} + \left( \vec v \nabla \right) \vec v = -\frac {\nabla p}{\rho} + \nu \nabla ^2 \vec v + \vec g \\

        \frac { \partial \rho }{\partial t} + \nabla \cdot \left( \rho \vec v \right) = 0 \\

        \frac { \partial T }{\partial t} + \nabla \cdot \left( T \vec v \right) = \chi \nabla ^2 T \\

        \rho = \rho_0 \left( 1 - \gamma \left( T - T_0 \right) \right)

        \end{cases}

    }

```

### Without FXML

See [ExampleJFX.java](src/test/java/ExampleJFX.java)

```java

LatexView latex = new LatexView("\\LaTeX");

latex.setSize(30);

VBox vbox = new VBox(latex);

Scene scene = new Scene(vbox, 640, 480);

```

## License

This project is released under the GPLv3 license.

For more details, take a look at the [LICENSE](LICENSE) file.