1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.chart

File ChartCustomizer.java

 

Code metrics

0
0
0
1
46
11
0
-
-
0
-

Classes

Class Line # Actions
ChartCustomizer 37 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.chart;
21   
22    import java.util.Map;
23   
24    import org.jfree.chart.JFreeChart;
25    import org.xwiki.component.annotation.Role;
26    import org.xwiki.stability.Unstable;
27   
28    /**
29    * Allows implementing JFreeChart customizations (colors, fonts, etc) for the drawn graphs.
30    *
31    * @version $Id: ec9f3f5804286933b68c3e0ac7fd7c2a2460ac95 $
32    * @since 7.4.3
33    * @since 8.0RC1
34    */
35    @Role
36    @Unstable
 
37    public interface ChartCustomizer
38    {
39    /**
40    * @param jFreeChart the JFree Chart instance representing the graph, on which customizations can be performed
41    * @param parameters the parameters passed to the Chart generator and controlling its aspect (e.g. the Chart Macro
42    * allows user to pass those parameters as a string, for example
43    * {@code range:B2-D5;series:columns;colors:C3E3F7,1D9FF5,015891,012A45}
44    */
45    void customize(JFreeChart jFreeChart, Map<String, String> parameters);
46    }