wladiz2001/visjs

Visjs 4 Integration for Laravel > 5.5

1.0.3 2019-03-10 02:15 UTC

This package is not auto-updated.

Last update: 2024-05-28 01:50:32 UTC


README

Latest Version on Packagist Total Downloads Build Status StyleCI

Simple package to facilitate and automate the use of (network) charts in Laravel 5.x

using Visjs.

Code is 'inspired' from laravel-chartjs.

Installation

Via Composer

$ composer require wladiz2001/visjs

Finaly, for now, you must install and add to your layouts / templates the Visjs library that can be easily found for download at: http://visjs.org/. This setting will also be improved.

Usage

You can request to Service Container the service responsible for building the charts and passing through fluent interface the chart settings.

$service = app()->visjs
    ->name()
    ->type()
    ->size()
    ->datasets()
    ->options();

For now the builder needs the name of the chart, the type of chart that can be anything that is supported by visjs and the other custom configurations like, datasets, size and options.

In the dataset interface you can pass any configuration and option to your chart. All options available in visjs documentation are supported. Just write the configuration with php array notations and its work!

Advanced visjs options

Since the current version allows it to add simple json string based options, it is not possible to generate options like:

    options: {
        scales: {
            xAxes: [{
                type: 'time',
                time: {
                    displayFormats: {
                        quarter: 'MMM YYYY'
                    }
                }
            }]
        }
    }

Using the method optionsRaw(string) its possible to add a the options in raw format:

        $chart->optionsRaw = "{
            legend: {
                display:false
            },
            scales: {
                xAxes: [{
                    gridLines: {
                        display:false
                    }  
                }]
            }
        }";

Examples

1 - Network Chart:

// ExampleController.php

$edges = [
    ["from" => 7905, "to" => "7886", "label" => 50068, "length" => 10],
    ["from" => -1, "to" => "7905", "label" => 100, "group" => 40]
];
$nodes = [
	["id" => -10, "shape" => "circularImage", "size" => 40, "color" => '#999', "borderWidth" => 1],
	["id" => 7905, "label" => "loyal", "value" => 500, "group" => 'big1'],
	["id" => 7886, "label" => "sensitive", "value" => 100, "group" => 'big2']
];

$visjs = app()->visjs
        ->name('networkChartTest')
        ->type('Network')
        ->size(['width' => 400, 'height' => 200])
        ->datasets(["nodes" => $nodes, "edges" => $edges])
        ->options([]);

return view('example', compact('visjs'));


 // example.blade.php

<div style="width:75%;">
    {!! $visjs->render() !!}
</div>

OBS:

This README as well as the package is in development but will be constantly updated and will keep you informed as soon as are ready for production. Thank you for understanding.

Any questions or suggestions preferably open a issue!

License

VisJs is open-sourced software licensed under the MIT license.

Change log

Please see the changelog for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email author email instead of using the issue tracker.

Credits