Charts API - Revision history

Mudrd8mz: Text replacement - "`" to ""`


2021-07-15T08:26:47Z
Text replacement - "<code (.*)>" to "<syntaxhighlight lang="$1">"

				
				
				
				
				
				← Older revision
				Revision as of 08:26, 15 July 2021
				
Line 252:
Line 252:
Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with a container with '''dir''' tag. Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with a container with '''dir''' tag.



<code PHP> <syntaxhighlight lang="PHP">
echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']); echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']);
</syntaxhighlight> </syntaxhighlight>



Mudrd8mz: Text replacement - "" to ""

2021-07-14T13:38:06Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"
Show changes


Mudrd8mz: Text replacement - "" to ""
2021-07-14T13:02:18Z
Text replacement - "</code>" to "</syntaxhighlight>"
Show changes


Dongsheng at 03:24, 11 May 2021
2021-05-11T03:24:21Z


				
				
				
				
				
				← Older revision
				Revision as of 03:24, 11 May 2021
				
Line 250:
Line 250:



=== RTL === === RTL ===
Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with a container with <code>dir</code> tag. Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with a container with '''dir''' tag.



<code PHP> <code PHP>
echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']); echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']);
</code> </code>



Dongsheng at 03:23, 11 May 2021
2021-05-11T03:23:40Z


				
				
				
				
				
				← Older revision
				Revision as of 03:23, 11 May 2021
				
Line 250:
Line 250:



=== RTL === === RTL ===
Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with container with dir tag. Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with a container with <code>dir</code> tag.



<code PHP> <code PHP>
echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']); echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']);
</code> </code>



Dongsheng at 03:21, 11 May 2021
2021-05-11T03:21:24Z


				
				
				
				
				
				← Older revision
				Revision as of 03:21, 11 May 2021
				
Line 253:
Line 253:



<code PHP> <code PHP>
echo html_writer::tag('div', $OUTPUT->render($chart), array_merge(['dir' => 'ltr'])); echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']);
</code> </code>



Dongsheng at 03:14, 11 May 2021
2021-05-11T03:14:51Z


				
				
				
				
				
				← Older revision
				Revision as of 03:14, 11 May 2021
				
Line 247:
Line 247:
$chart->set_legend_options(['display' => false]);  // Hide chart legend. $chart->set_legend_options(['display' => false]);  // Hide chart legend.
$chart->set_legend_options(['position' => 'left']);  // Change legend position to left side. $chart->set_legend_options(['position' => 'left']);  // Change legend position to left side.
</code>

=== RTL ===
Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with container with dir tag.

<code PHP>
echo html_writer::tag('div', $OUTPUT->render($chart), array_merge(['dir' => 'ltr']));
</code> </code>



Lameze at 00:45, 17 June 2020
2020-06-17T00:45:20Z


				
				
				
				
				
				← Older revision
				Revision as of 00:45, 17 June 2020
				
Line 239:
Line 239:
<code php> <code php>
$CFG->chart_colorset = ['#001f3f', '#01ff70', '#F012BE', '#85144b', '#B10DC9']; $CFG->chart_colorset = ['#001f3f', '#01ff70', '#F012BE', '#85144b', '#B10DC9'];
</code>

=== Legend options ===
It is possible to customize some aspects of the chart legend such position and visibility. In order to do that you need to call set_legend_options() method
and pass an array of options supported by ChartJS. 
<code php>
$chart->set_legend_options(['display' => false]);  // Hide chart legend.
$chart->set_legend_options(['position' => 'left']);  // Change legend position to left side.
</code> </code>



Drcuriosity: Clarifying text in "Show chart data table"; fixing "Rendering" section heading.
2020-04-20T08:28:46Z
Clarifying text in "Show chart data table"; fixing "Rendering" section heading.

				
				
				
				
				
				← Older revision
				Revision as of 08:28, 20 April 2020
				
Line 221:
Line 221:
[[File:bar_line_chart.png]] [[File:bar_line_chart.png]]



== Renderering ==    == Rendering ==   
All charts are rendered by render_chart() located on outputrenderers.php, once the chart object is ready, it must be passed to render() or render_chart(). All charts are rendered by render_chart() located on outputrenderers.php, once the chart object is ready, it must be passed to render() or render_chart().
<code php> <code php>
Line 228:
Line 228:



=== Show chart data table === === Show chart data table ===
To make the chart data accessible to users with special needs, a link on the bottom of the chart will display a table containing all data.   By default, in order to make chart data accessible to users with special needs, a link at the bottom of the chart will display a table containing all of its data.  
In some cases, the same information is displayed on the page and might not be necessary display chart table.   If that information is already displayed on the page in some other fashion, it may not be necessary to display the chart data table.  
In that case, you need to pass false as the second parameter when calling the render_chart: To remove it, a '''false''' value can be passed as the second parameter when calling the render_chart function:
<code php> <code php>
echo $OUTPUT->render_chart($chart, false); echo $OUTPUT->render_chart($chart, false);



Vadimon: /* Renderering */
2017-04-22T07:24:54Z
Renderering

				
				
				
				
				
				← Older revision
				Revision as of 07:24, 22 April 2017
				
Line 222:
Line 222:



== Renderering ==    == Renderering ==   
All charts are rendered by render_chart() located on outputrenderers.php, once the chart object is ready, it must be passed to chart_render. All charts are rendered by render_chart() located on outputrenderers.php, once the chart object is ready, it must be passed to render() or render_chart().
<code php> <code php>
echo $OUTPUT->render($chart); echo $OUTPUT->render($chart);
Line 230:
Line 230:
To make the chart data accessible to users with special needs, a link on the bottom of the chart will display a table containing all data.   To make the chart data accessible to users with special needs, a link on the bottom of the chart will display a table containing all data.  
In some cases, the same information is displayed on the page and might not be necessary display chart table.   In some cases, the same information is displayed on the page and might not be necessary display chart table.  
In that case, you need to pass false as the second parameter when calling the render: In that case, you need to pass false as the second parameter when calling the render_chart:
<code php> <code php>
echo $OUTPUT->render($chart, false); echo $OUTPUT->render_chart($chart, false);
</code> </code>

← Older revision		Revision as of 08:26, 15 July 2021
Line 252:		Line 252:
	Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with a container with '''dir''' tag.		Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with a container with '''dir''' tag.

	<~~code~~ PHP>		<syntaxhighlight lang="PHP">
	echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']);		echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']);
	</syntaxhighlight>		</syntaxhighlight>

← Older revision		Revision as of 03:24, 11 May 2021
Line 250:		Line 250:

	=== RTL ===		=== RTL ===
	Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with a container with ~~<code>~~dir~~</code>~~ tag.		Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with a container with '''dir''' tag.

	<code PHP>		<code PHP>
	echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']);		echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']);
	</code>		</code>

← Older revision		Revision as of 03:23, 11 May 2021
Line 250:		Line 250:

	=== RTL ===		=== RTL ===
	Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with container with dir tag.		Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with a container with <code>dir</code> tag.

	<code PHP>		<code PHP>
	echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']);		echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']);
	</code>		</code>

← Older revision		Revision as of 03:21, 11 May 2021
Line 253:		Line 253:

	<code PHP>		<code PHP>
	echo html_writer::tag('div', $OUTPUT->render($chart), ~~array_merge(~~['dir' => 'ltr']));		echo html_writer::tag('div', $OUTPUT->render($chart), ['dir' => 'ltr']);
	</code>		</code>

← Older revision		Revision as of 03:14, 11 May 2021
Line 247:		Line 247:
	$chart->set_legend_options(['display' => false]); // Hide chart legend.		$chart->set_legend_options(['display' => false]); // Hide chart legend.
	$chart->set_legend_options(['position' => 'left']); // Change legend position to left side.		$chart->set_legend_options(['position' => 'left']); // Change legend position to left side.
			</code>

			=== RTL ===
			Please note numerical ranges should be displayed in LTR, and not in RTL for both RTL and LTR languages, you can wrap the chart with container with dir tag.

			<code PHP>
			echo html_writer::tag('div', $OUTPUT->render($chart), array_merge(['dir' => 'ltr']));
	</code>		</code>

← Older revision		Revision as of 08:28, 20 April 2020
Line 221:		Line 221:
	[[File:bar_line_chart.png]]		[[File:bar_line_chart.png]]

	== ~~Renderering~~ ==		== Rendering ==
	All charts are rendered by render_chart() located on outputrenderers.php, once the chart object is ready, it must be passed to render() or render_chart().		All charts are rendered by render_chart() located on outputrenderers.php, once the chart object is ready, it must be passed to render() or render_chart().
	<code php>		<code php>
Line 228:		Line 228:

	=== Show chart data table ===		=== Show chart data table ===
	To make ~~the~~ chart data accessible to users with special needs, a link on the bottom of the chart will display a table containing all data.		By default, in order to make chart data accessible to users with special needs, a link at the bottom of the chart will display a table containing all of its data.
	~~In some cases, the same~~ information is displayed on the page ~~and might~~ not be necessary display chart table.		If that information is already displayed on the page in some other fashion, it may not be necessary to display the chart data table.
	~~In that case~~, ~~you need to pass~~ false as the second parameter when calling the render_chart:		To remove it, a '''false''' value can be passed as the second parameter when calling the render_chart function:
	<code php>		<code php>
	echo $OUTPUT->render_chart($chart, false);		echo $OUTPUT->render_chart($chart, false);

← Older revision		Revision as of 07:24, 22 April 2017
Line 222:		Line 222:

	== Renderering ==		== Renderering ==
	All charts are rendered by render_chart() located on outputrenderers.php, once the chart object is ready, it must be passed to ~~chart_render~~.		All charts are rendered by render_chart() located on outputrenderers.php, once the chart object is ready, it must be passed to render() or render_chart().
	<code php>		<code php>
	echo $OUTPUT->render($chart);		echo $OUTPUT->render($chart);
Line 230:		Line 230:
	To make the chart data accessible to users with special needs, a link on the bottom of the chart will display a table containing all data.		To make the chart data accessible to users with special needs, a link on the bottom of the chart will display a table containing all data.
	In some cases, the same information is displayed on the page and might not be necessary display chart table.		In some cases, the same information is displayed on the page and might not be necessary display chart table.
	In that case, you need to pass false as the second parameter when calling the ~~render~~:		In that case, you need to pass false as the second parameter when calling the render_chart:
	<code php>		<code php>
	echo $OUTPUT->~~render~~($chart, false);		echo $OUTPUT->render_chart($chart, false);
	</code>		</code>