README

PHP for Mermaid.js pie charts.

For license information see the LICENSE file.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist beastbytes/mermaid-pie-chart

or add

"beastbytes/mermaid-pie-chart": "{{versionConstraint}}"

to the require section of your composer.json.

Usage

• Create a PieChart instance using the Mermaid::create() method
• Configure the chart
• Render the chart

Example

/** @var array<string, float|int> $values */
echo Mermaid::create(PieChart::class)
    ->withValues($values)
    ->render()
;

API

PieChart

PieChart represents a pie chart.

addValues()

Returns a new instance of PieChart with the given values added to any existing values.

Note: New values with the same name as existing values will overwrite the existing values.

Parameters

render()

Returns a string that is the Mermaid Pie Chart wrapped in a HTML <pre class="mermaid"> tag.

Parameters

Return Type: string

showData()

Returns a new instance of PieChart with showData set. The rendered Pie Chart will show values after the legend text.

Return Type: PieChart

withComment()

Returns a new instance of PieChart with a comment.

Parameters

withTitle()

Returns a new instance of PieChart with a title.

Parameters

withValues()

Returns a new instance of PieChart with the given values.

Parameters