mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 18:54:58 +00:00
77 lines
2.3 KiB
PHP
77 lines
2.3 KiB
PHP
<?php
|
|
|
|
/**
|
|
* GeneratorInterface.php
|
|
* Copyright (c) 2019 james@firefly-iii.org
|
|
*
|
|
* This file is part of Firefly III (https://github.com/firefly-iii).
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Generator\Chart\Basic;
|
|
|
|
/**
|
|
* Interface GeneratorInterface.
|
|
*/
|
|
interface GeneratorInterface
|
|
{
|
|
public function multiCurrencyPieChart(array $data): array;
|
|
|
|
/**
|
|
* Will generate a Chart JS compatible array from the given input. Expects this format.
|
|
*
|
|
* Will take labels for all from first set.
|
|
*
|
|
* 0: [
|
|
* 'label' => 'label of set',
|
|
* 'type' => bar or line, optional
|
|
* 'yAxisID' => ID of yAxis, optional, will not be included when unused.
|
|
* 'fill' => if to fill a line? optional, will not be included when unused.
|
|
* 'entries' =>
|
|
* [
|
|
* key => [value => x, 'currency_symbol' => 'x']
|
|
* ]
|
|
* ]
|
|
* 1: [
|
|
* 'label' => 'label of another set',
|
|
* 'type' => bar or line, optional
|
|
* 'yAxisID' => ID of yAxis, optional, will not be included when unused.
|
|
* 'fill' => if to fill a line? optional, will not be included when unused.
|
|
* 'entries' =>
|
|
* [
|
|
* key => [value => x, 'currency_symbol' => 'x']
|
|
* ]
|
|
* ]
|
|
*
|
|
* // it's five.
|
|
*/
|
|
public function multiSet(array $data): array;
|
|
|
|
/**
|
|
* Expects data as:.
|
|
*
|
|
* key => value
|
|
*/
|
|
public function pieChart(array $data): array;
|
|
|
|
/**
|
|
* Will generate a (ChartJS) compatible array from the given input. Expects this format:.
|
|
*
|
|
* 'label-of-entry' => value
|
|
*/
|
|
public function singleSet(string $setLabel, array $data): array;
|
|
}
|