nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

use scripting to remove a series and legend entry

tapani108

Hello, 
 
How do I remove both a series and the corresponding legend entry from a chart? My attempt below: 
 
<pre class='_prettyXprint _lang-auto _linenums:0'>

/**
* Called before generation of chart model to GeneratedChartState.
*
* @param chart
* Chart
* @param icsc
* IChartScriptContext
*/

function beforeGeneration(chart, icsc)

{
importPackage( Packages.org.eclipse.birt.chart.model.attribute );

// hiding first series in case we are dealing with a time period
xAxis = chart.getBaseAxes()[0];
yAxis = chart.getOrthogonalAxes( xAxis, true)[0];

//use 0 in the following for the first series and 1
//for the second series
seriesDef = yAxis.getSeriesDefinitions().get(0);
runSeries = seriesDef.getRunTimeSeries();
firstRunSeries = runSeries.get(0);

if(some conditions apply)
firstRunSeries.setVisible(false);

// attempt to remove first legend entry
firstLegendEntry = chart.getLegend().eContents().get(0);

if(some conditions apply)
firstLegendEntry.setVisible(false);

}

</pre>
 
With the above, I manage to hide the correct series, but the legend entry is still there. How do I get a hold of the corresponding legend entry? 
 
Regards, 
T

Find more posts tagged with

Comments

mwilliams

Hi T,

You should be able to hide a label in the legend with something like the following:

function beforeDrawLegendItem(lerh, bounds, icsc)
{
if (lerh.getLabel().getCaption().getValue() == "someValue"){
lerh.getLabel().setVisible(false);
}
}

ATirumalas

I was able to remove the series in the chart and the legend with the below script. But the symbol in the legend does not vanish. (pdf output attached) 
 
Report Description: 
RP_Selection : Contains selection 1,2,3 
2 Series in the report - "Series1 & Series2 
Condition: 
- To display both Series1 & Series2 for when RP_Selection is 1 
- To display only Series1 when RP_Selection is 2 or 3 
 
 
<pre class='_prettyXprint _lang-auto _linenums:0'>
function beforeGeneration( gcs, icsc )

{
importPackage( Packages.org.eclipse.birt.chart.model.attribute );

var chart = icsc.getChartInstance();
var xAxis = chart.getAxes().get(0);
var yAxis = xAxis.getAssociatedAxes().get(0);

var selection = icsc.getExternalContext().getScriptable().getParameterValue( "RP_Selection" );

if (selection == 1)
{
yAxis.getSeriesDefinitions().get(0).getRunTimeSeries().get(0).setVisible(true);
yAxis.getSeriesDefinitions().get(1).getRunTimeSeries().get(0).setVisible(true);
}
else if (selection == 2 || selection == 3)
{
yAxis.getSeriesDefinitions().get(0).getRunTimeSeries().get(0).setVisible(true);
yAxis.getSeriesDefinitions().get(1).getRunTimeSeries().get(0).setVisible(false);
}

}
</pre>
 
<pre class='_prettyXprint _lang-auto _linenums:0'>
function beforeDrawLegendItem(lerh, bounds, icsc)
{
var selection = icsc.getExternalContext().getScriptable().getParameterValue( "RP_Selection" );

if (lerh.getLabel().getCaption().getValue() == "Series2")
{
if (selection == 2 || selection == 3)
lerh.getLabel().setVisible(false);
else
lerh.getLabel().setVisible(true);

}
}
</pre>

mwilliams

When do you know if you'll hide the chart series or not? If you know based on a user parameter or something, you could always drop the series completely in the beforeFactory method of your report.

ATirumalas

Many Thanks!! it worked with following code in beforeFactory. 
 
P.S: "MyChart01" is the name given to the chart. 
 
<pre class='_prettyXprint _lang-auto _linenums:0'>
cht = reportContext.getDesignHandle().findElement("MyChart01");
mychart = cht.getReportItem().getProperty( "chart.instance" );

xAxis =mychart.getAxes().get(0);
yAxis1 = xAxis.getAssociatedAxes().get(0);

if( params["RP_Selection"].value == 2 || params["RP_Selection"].value == 3 )
{
yAxis1.getSeriesDefinitions().remove( 1 );
}
</pre>

mwilliams

You're very welcome! Let us know whenever you have questions!

ATirumalas

How do I hide the legend completely using beforeFactory Method?

I want to hide Legend visibility when selected option is 1
I tried to use the beforeDrawBlock, This works without the param check (like below). Once I uncomment it, it does not work.

function beforeDrawBlock( block, icsc )
{
if ( block.isLegend( ) )
{
//if( params["RP_Selection"].value == 1 )
//{
block.setVisible(false);
//}
}
}

mwilliams

Try passing the parameter value in through a persistentGlobalVariable and then recalling the PGV in your chart script.

Set it in your initialize method or something with reportContext.setPersistentGlobalVariable() and then recall it with this in your chart script:

icsc.getExternalContext().getScriptable().getPersistentGlobalVariable("myVarName");

ATirumalas

Thanks!! 
 
Was able to to do as follows: 
 
1) In Initialize 
Create a Global variable rp_selection and assign the report selection value to it. 
<pre class='_prettyXprint _lang-auto _linenums:0'>reportContext.setPersistentGlobalVariable("rp_selection", reportContext.getParameterValue("RP_Selection"));</pre>
 
2) In beforeFactory (to use the report parameter in the before factory) 
I have two options to read the selection 
//from the global variable 
<pre class='_prettyXprint _lang-auto _linenums:0'>reportContext.getPersistentGlobalVariable("rp_selection");</pre>
or 
//directly from the report param selection 
<pre class='_prettyXprint _lang-auto _linenums:0'>params["RP_Selection"].value</pre>
 
3) In beforeDrawBlock (to read the report parameter and hide the legend based on the option selected) 
<pre class='_prettyXprint _lang-auto _linenums:0'>if ( block.isLegend( ) )
{
importPackage(Packages.org.eclipse.birt.chart.model.type.impl);
var sel = icsc.getExternalContext().getScriptable().getPersistentGlobalVariable("rp_selection");
if ( sel == 1)
block.setVisible(false);
}</pre>
 
* RP_Selection is the report Parameter name 
* rp_selection is the global variable name declared in the script 
* sel is another local variable declared in the beforeDrawBlock

mwilliams

Not a problem. Glad to help!

Baku

Hi, 
 
It seems to be the appropriate topic. I am trying to completely remove a legend (not the serie). 
I know how to hide the label & the picture with this code in beforeDrawLegendItem() : 
 
<pre class='_prettyXprint _lang-auto _linenums:0'>bounds.setHeight(0);
bounds.setWidth(0);
lerh.getLabel().setVisible(false);
</pre>
 
But the legend keep taking a space between the others legends. 
 
So, how to completely remove a legend ? 
 
Thx in advance

mwilliams

I think this is a topic that needs an enhancement request logged for it. I don't know that there's a good way to remove the space. You can log an enhancement request at http://www.birt-exchange.org/org/resources/bug-reporting/

Baku

<blockquote class='ipsBlockquote' data-author="'mwilliams'" data-cid="82661" data-time="1315943646" data-date="13 September 2011 - 12:54 PM">
I think this is a topic that needs an enhancement request logged for it. I don't know that there's a good way to remove the space. You can log an enhancement request at <a class='bbc_url' href='http://www.birt-exchange.org/org/resources/bug-reporting/'>http://www.birt-exchange.org/org/resources/bug-reporting/</a> </blockquote>
 
Okay, I did it. 
If anyone is interested by this problem, it is the bug #357715

Baku

mwilliams

Thanks for the update!

Elias123

Hello mwilliams, seems you are a hero in Birt!

I have an issue and I couldn't solve it for more than 3 days!

I have a chart displaying some values. In x-axis, it is displaying the date, in y-axis, it is displaying the number of workorders and grouped by persons also.

I need to draw a line showing the total number for each day (should be on top). The points are coming on top-right. And the legend is displayed twice when I added this line.

attached is a picture.

Please I need your help. Thanks in advance.

mwilliams

What is your BIRT version? What does your data look like and how is your chart set up? In the newest version, I don't see this issue, anymore. I know it used to be like your image.