Bug 132031

Summary: access to chart scripting methods and related documentation
Product: z_Archived Reporter: Vladimir <vladperl>
Component: BIRTAssignee: David Michonneau <dmichonneau>
Status: RESOLVED FIXED QA Contact:
Severity: enhancement    
Priority: P1 Keywords: plan
Version: unspecified   
Target Milestone: 2.2.0 RC2   
Hardware: PC   
OS: Windows XP   
Whiteboard:
Bug Depends on: 179300, 183132, 188862    
Bug Blocks:    
Attachments:
Description Flags
mockup none

Description Vladimir CLA 2006-03-15 16:01:00 EST 
It's very strange that access to chart scipting methods available only from 
script tab related to whole chart item. 
This approach is not consistent comparing to how script defined for such report items as table or dataset.
That why inside of chart's script tab we see comment out bunch of chart scripting methods.
I suggest that every component on chart item that have corresponding scripting methods must have separate script tab with set predefined methods.
Beside that it would be nice to have at least some documentation and axamples on this topic.
Comment 1 David Michonneau CLA 2006-03-20 07:47:22 EST 
I think this is a valid enhancement, this requires support in the designer, so 
I reassign it to designer team.

Regarding the examples,there are already some in the 
org.eclipse.birt.chart.examples plugin. For the documentation, I believe it's 
under progress.
Comment 2 Wang Qiangsheng CLA 2006-03-20 20:50:00 EST 
David, Could you please own this bug? 
If you need GUI team to add support, please file another item and let this item depends on the created one.
Comment 3 David Michonneau CLA 2007-03-26 09:46:23 EDT 
The changes planned are as follows:

The chart script is the reportitem's onRender script. There is no 
onCreate/onPrepare for charts.
The chart script events are subfunctions of the onRender function.
The UI will provide a second button to help users create function bodies for 
charts (mockup attached)
The Palette will for now hide the BIRT functions, not yet supported inside 
chart scripts.

Auto-completion support for chart scripting is under investigation.
Comment 4 David Michonneau CLA 2007-03-26 09:48:58 EDT 
Created attachment 61975 [details]
mockup
Comment 5 David Michonneau CLA 2007-03-26 09:51:17 EDT 
Implementation tasks:

Implement the getMethods() function in IReportItem to return function 
signatures, tooltips and javadoc.
Return the chart script on getProperty("onRender") instead of 
getProperty("script")
Implement Palette provider support to hide BIRT functions (possibly show some 
specific chart ones)
Comment 6 David Michonneau CLA 2007-04-03 11:07:37 EDT 
deferred to RC0
Comment 7 David Michonneau CLA 2007-05-14 12:49:50 EDT 
deferred to RC1 as 148405 was also deferred.
Comment 8 David Michonneau CLA 2007-05-31 11:32:39 EDT 
fixed. Note that the dropdown does not exactly look like in the UI since SWT 
doesn't have such control outside menu bars. It is a standard dropdown control, 
but the behavior is the one intended by the mockup.