Skip to content

Latest commit

 

History

History
211 lines (177 loc) · 5.82 KB

README.md

File metadata and controls

211 lines (177 loc) · 5.82 KB
Raw

Vizualizator

Integrity check codecov Latest Stable Version Latest Unstable Version License: MIT PHPStan Enabled

Smart engine for creating elegant images and graphic visualizations.

Render to SVG, PNG and JPG. All output is in base64 format valid in HTML document.

Installation

composer require mathematicator-core/vizualizator

Usage

Imagine you can render all your images by simple objective request.

First inject Renderer to your script and create request:

$renderer = new Renderer;
$request = $renderer->createRequest();

Now you can add some lines and more:

$request->addLine(10, 10, 35, 70);
$request->addLine(35, 70, 70, 35);

And render to page (output is valid HTML code, base64 or svg tag):

// Render specific format:

echo $request->render(Renderer::FORMAT_PNG);
echo $request->render(Renderer::FORMAT_JPG);
echo $request->render(Renderer::FORMAT_SVG);

// Or use default renderer and __toString() method

echp $request;

Full simple short example

This example use short fluid-syntax. Final image size is 200x100:

echo (new Renderer)->createRequest(200, 100)
    ->addLine(10, 10, 35, 70, '#aaa')
    ->addLine(35, 70, 70, 35, 'red');

Mathematicator Framework tools structure

The biggest advantage is that you can choose which layer best fits your needs and start build on the top of it, immediately, without the need to create everything by yourself. Our tools are tested for bugs and tuned for performance, so you can save a significant amount of your time, money, and effort.

Framework tend to be modular as much as possible, so you should be able to create an extension on each layer and its sublayers.

Mathematicator framework layers ordered from the most concrete one to the most abstract one:

Search Modular search engine layer that calls its sublayers and creates user interface.
Vizualizator Elegant graphic visualizer that can render to SVG, PNG, JPG and Base64.
Extensions: Mandelbrot set generator
Calculator Modular advance calculations layer.
Extensions: Integral Solver , Statistics
Engine Core logic layer that maintains basic controllers, DAOs, translator, common exceptions, routing etc.
Tokenizer Tokenizer that can convert string (user input / LaTeX) to numbers and operators.
Numbers Fast & secure storage for numbers with arbitrary precision. It supports Human string and LaTeX output and basic conversions.

Third-party packages:

⚠️ Not guaranteed!

REST API Install the whole pack as a REST API service on your server (Docker ready) or access it via public cloud REST API.

Contribution

Tests

All new contributions should have its unit tests in /tests directory.

Before you send a PR, please, check all tests pass.

This package uses Nette Tester. You can run tests via command:

composer test

Before PR, please run complete code check via command:

composer cs:install # only first time
composer fix # otherwise pre-commit hook can fail