FormsGraph_Doc.pdf | Oracle Database | Java (Programming ...

August 26, 2017 | Author: Anonymous | Category: Java, Oracle
Share Embed


Short Description

The column label by default shows in the graph's legend. The demo application to this help file contains an example impl...

Description

Forms Wrapper for Oracle Data Visualization Components (Graphs) The FormsGraph bean is a wrapper for BIGraphBean. Original code was developed by Frank Nimphius and later extended by Holmen Paper IT. The FormsGraph package now includes the FormsGauge bean to display data as gauges.

Contents Forms Wrapper for Oracle Data Visualization Components (Graphs) ......................................................... 1 About ...................................................................................................................................................... 5 How to install .......................................................................................................................................... 5 Known issue with Oracle 9i Forms .......................................................................................................... 5 Examples ................................................................................................................................................. 6 Description .............................................................................................................................................. 7 How does the bean work ........................................................................................................................ 7 Building a simple graph ....................................................................................................................... 9 HowTo master-detail ........................................................................................................................... 9 Forms implementation ...................................................................................................................... 10 Deployment ....................................................................................................................................... 11 Properties registered in the FormsGraph wrapper ............................................................................... 11 Named colors ........................................................................................................................................ 11 Known issues ......................................................................................................................................... 11 FormsGraph Properties ......................................................................................................................... 12 ADD_DATA_TO_GRAPH..................................................................................................................... 12 ADD_ROWDATA ................................................................................................................................ 12 ADD_INDEX_LINE (Deprecated) ........................................................................................................ 13 ADD_REFERENCE_OBJECT ................................................................................................................. 14 ALIGN_TITLE_TEXT ............................................................................................................................ 15 CLEAR_GRAPH ................................................................................................................................... 15 COLUMNCOUNT ................................................................................................................................ 15 DEBUG ............................................................................................................................................... 16 DISPLAY_INDEX_LINE (Deprecated) .................................................................................................. 16 ENABLE_TOOLTIPS ............................................................................................................................ 16

EXPLODE_PIESLICE ............................................................................................................................ 17 ENABLE_MARKERTEXT ...................................................................................................................... 18 ENABLE_GRADIENT ........................................................................................................................... 18 EXPORT_CLIPBOARD ......................................................................................................................... 18 FRAME_POS ...................................................................................................................................... 18 GET_DELIMITER ................................................................................................................................. 19 GRAPHTYPE ....................................................................................................................................... 19 HIDE_AXIS ......................................................................................................................................... 19 HIDE_TITLE ........................................................................................................................................ 20 HIDE_SUBTITLE .................................................................................................................................. 20 HIDE_FOOTER.................................................................................................................................... 20 HIDE_X_TITLE .................................................................................................................................... 20 HIDE_Y_TITLE .................................................................................................................................... 20 HIDE_FRAME ..................................................................................................................................... 20 HIDE_GRAPH ..................................................................................................................................... 21 MAX_SCALE_Y_AXIS .......................................................................................................................... 21 MIN_SCALE_Y_AXIS ........................................................................................................................... 21 MAX_SCALE_Y2_AXIS ........................................................................................................................ 21 MIN_SCALE_Y2_AXIS ......................................................................................................................... 22 MOUSE_ACTIVE ................................................................................................................................. 22 MOUSEACTION .................................................................................................................................. 22 MODIFY_ROW_DATA ........................................................................................................................ 22 POSITION_LEGEND ............................................................................................................................ 23 ROTATE_X_LABEL .............................................................................................................................. 23 REMOVE_DATA ................................................................................................................................. 23 RETURN_VALUES_ON_CLICK ............................................................................................................. 23 RESET_GRAPH ................................................................................................................................... 24 SCROLLBAR ........................................................................................................................................ 24 SET_BACKGROUND ........................................................................................................................... 24 SET_DEPTH ........................................................................................................................................ 25 SET_DEBUG_PREFIX .......................................................................................................................... 25 SET_DELIMITER ................................................................................................................................. 25

SET_FRAME_HEIGHT_WIDTH ............................................................................................................ 26 SET_FOOTER ...................................................................................................................................... 26 SET_FOOTER_BACKGROUND............................................................................................................. 26 SET_GRAPHIC_ANTIALIASING............................................................................................................ 27 SET_GRAPH_BASELINE ...................................................................................................................... 27 SET_LEGEND_BORDER ...................................................................................................................... 27 SET_LINEGRAPH_MARKERS ............................................................................................................... 28 SET_NO_DATA_FOUND ..................................................................................................................... 28 SET_PLOT_AREA_COLOR ................................................................................................................... 28 SET_SCALED_LOGARITHMIC .............................................................................................................. 28 SET_SUBTITLE .................................................................................................................................... 29 SET_SUBTITLE_BACKGROUND ........................................................................................................... 29 SET_SERIES_MARKER_TYPE............................................................................................................... 29 SET_SERIES_WIDTH ........................................................................................................................... 30 SET_SERIES_COLOR ........................................................................................................................... 30 SET_SERIES_Y_AXIS ........................................................................................................................... 30 SET_STYLE ......................................................................................................................................... 31 SET_XML_STYLE ................................................................................................................................ 31 SET_TITLE .......................................................................................................................................... 32 SET_TITLE_BACKGROUND ................................................................................................................. 32 SET_X_LABEL ..................................................................................................................................... 32 SET_X_VALUE_FONT ......................................................................................................................... 32 SET_Y_LABEL ..................................................................................................................................... 33 SET_Y2_LABEL ................................................................................................................................... 33 SET_Y1_NUMBER_TYPE .................................................................................................................... 33 SET_Y1_SCALE_DOWN ...................................................................................................................... 33 SET_Y_DECIMAL_DIGITS.................................................................................................................... 33 SET_Y2_DECIMAL_DIGITS.................................................................................................................. 34 SHOW_COLUMNS_AS_ROWS ........................................................................................................... 34 SHOW_FRAME .................................................................................................................................. 34 SHOW_GRAPH_IN_FRAME ................................................................................................................ 34 SHOW_GRAPH ................................................................................................................................... 34

SHOW_GRID ...................................................................................................................................... 35 SHOW_LABELS................................................................................................................................... 35 SHOW_LEGEND ................................................................................................................................. 35 SHOW_PIE_LABELS ............................................................................................................................ 35 Custom item events .............................................................................................................................. 35 RETURNED_COLUMN_NUMBER........................................................................................................ 35 GRAPH_ACTION................................................................................................................................. 35 GRAPH_INFO ..................................................................................................................................... 35 CURRENT_DELIMITER ........................................................................................................................ 35 DELIMITER_INFO ............................................................................................................................... 35 Graph types ........................................................................................................................................... 36

About The BI Graph integration for Forms was developed in 2002 for the Oracle9i Forms demo package and since then upgraded to Oracle Forms 10g.

How to install The FormsGraph.jar file contains all the files required to run the new version of the Forms BI Graph bean integration. If you have installed the Oracle Forms 10g demos, the BI Graph bean demo is available on your computer with the FormsGraph.jar file located in the \ forms90\ demos\ jars directory. Backup and replace the FormsGraph.jar file in this directory with the jar file contained in this patch. The FormsGraph.jar file of this patch is backwards compatible and no functionality has been removed.

Known issue with Oracle 9i Forms The graph images that used in the Oracle Forms demo module are contained in the FormsGraph.jar. The images are stored in the "images" subdirectory of the FormsGraph.jar. All existing references in the Oracle9i Forms demo module graph90.fmx/fmb must be changed to "images/", otherwise the images don't show on the buttons in the demo form.

Examples

Description Many Oracle Forms applications require a graphical representation of data stored in a Forms table or the database. So far Oracle Graphics has been used and still can be used to render interactive graphs in Oracle Forms applications. For each Forms user process, Oracle Graphics runs in its own separate process on the middle tier server. Many customers regard a separate process for embedded charts too much an overhead and look for an alternative solution to Oracle Graphics. Oracle Forms Services provide a runtime environment for Java beans that allows Forms developers to add missing or extra functionality built in Java to their Web applications. With the BI Bean Graph Oracle also provides a powerful set of Java classes that can be used to render many types of charts when run in a Java environment. Because the BI Bean became a strategic product at Oracle, Oracle products like OracleAS Reports, OracleAS Discoverer Oracle JDeveloper and OracleAS Portal use the BI Bean Graph for their users to create graphical displays. To make the BI Bean Graph work in OracleAS Forms Services applications all that is required is a Bean wrapper to work within the Forms Bean Container. The wrapper can be built dynamically using the Forms Bean Manager or manually coded using Java. The FormsGraph component is a generic wrapper built in Java that exposes a set of functionality and properties provided within the BI Bean Graph to Forms. Using this wrapper allows customers to use the BI Bean Graph within their own applications, not requiring any additional line of Java code. The demo application to this help file contains an example implementation of the generic BI Bean Graph wrapper. This sample works with Oracle Forms and was not tested with Forms6i.

How does the bean work The FormsGraph class instantiates the BI Bean Graph when added to the implementation class property of a Bean Container in Forms. Data is added to the graph by Forms calls to: SET_CUSTOM_PROPERTY('BeanContainer',1,ADD_ROWDATA.''). The data is passed in a character delimited string, where the default value defined as a delimiter is the comma. The delimiter can, and sometimes must, be changed by a call to: SET_CUSTOM_PROPERTY('BeanContainer',1, 'SET_DELIMITER','') column label

row label

value

The name of the data group, like salary, sales or home runs hit. The column label by default shows in the graph's legend. The row label, in combination with the column label, defines the the cell for the data value. For the salary column this can be employee names and for the sales column the name of departments. The value is defined as double 00.00. Though the value is passed as a string it gets converted to double within the FormsGraph wrapper.

ADD_ROWDATA is a registered property in the FormsGraph wrapper class that creates one relational row with each calls. This property can be called many times and the data is stored within the FormsGraph instance until it is explicitly deleted by a call to: SET_CUSTOM_PROPERTY('BeanContainer',1, 'CLEAR_GRAPH','') Note that even if no argument is required when setting a property it still needs to be passed in Forms. The following code uses a cursor to create rows in the graph for two columns, 'Sales Total' and 'Sales Tax'. ... OPEN PopulateGraphWithData; FETCH PopulateGraphWithData INTO vName, nOrder, vDate, nTotalValue, nTaxValue; while (PopulateGraphWithData%FOUND) LOOP vData :='Sales Total '||vDelimiter||vDate||vDelimiter||nTotalValue; SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_ROWDATA',vData); vData :='Sales Tax '||vDelimiter||vDate||vDelimiter||nTaxValue; SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_ROWDATA',vData); FETCH PopulateGraphWithData INTO vName, nOrder, vDate, nTotalValue, nTaxValue; END LOOP; SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_DATA_TO_GRAPH',''); CLOSE PopulateGraphWithData; ... The graph is shown in Forms after a call to: SET_CUSTOM_PROPERTY('BeanContainer',1,'ADD_DATA_TO_GRAPH','') The FormsGraph bean can be used for static charts and for drill down charts alike. The call to ADD_DATAROW can optionally have a forth argument, representing the primary key used for the drill down or drill across operation. Drill actions are handled by the same bean but in another Forms Bean Container. This ensures that the control over the operation is left to the Forms application developer.

Building a simple graph A simple graph is a graph that does not have any drill down or drill across actions. To create a graph in Forms, you first need to place a Bean Container to the Forms canvas hosting the graph. Open the bean container's property palette and edit the value of the 'Implementation class' property to oracle.forms.demos.bigraph. FormsGraph. This instantiates the FormsGraph bean. The graph is not shown until the registered property ADD_DATA_TO_GRAPH is called using the Forms SET_CUSTOM_PROPERTY() built-in. Calling this property before adding data to the graph internal data store leaves the graph empty. Use the ADD_ROWDATA property to pass data to the graph bean, again using the SET_CUSTOM_ PROPERTY() built-in. The data rendered in the BI Bean graph is queried by and passed from Forms, which means that the Forms developer always in control. The ADD_ROWDATA property can be called as many times as needed, even after calling the ADD_DATA_TO_GRAPH property. To create a new graph, exposing new data, the CLEAR_GRAPH needs to be called before adding new data with additional calls to ADD_ROWDATA. Without expecting too much, this is all that needs to be done to create a simply bar graph based on custom data in Forms. All other bean properties exposed through the FormsGraph wrapper class can be used for additional graph modification. HowTo master-detail A master-detail behavior in the graph is made of two bean containers, each running an instance of oracle.forms.demos.bigraph.FormsGraph . The master-detail behavior is controlled by Forms, where Forms acts like a controller accessed from the master-bean by the WHEN-CUSTOM-ITEM-EVENT trigger attached to the bean container of the master graph in Forms. Assume two Bean Conatiners created on one Forms canvas, "block1.masterBeanCon" and "block1.detailBeanCon". The block1.masterBeanCon component has an attached WHEN-CUSTOM-ITEMEVENT trigger listening to events raised by the graph bean. Further assuming the block1.masterBeanCon to be that simple graph explained above, the following calls to SET_CUSTOM_PROPERTY() must be performed to have the bean returning a value to the Bean container: SET_CUSTOM_PROPERTY(' block1.masterBeanCon',1,'MOUSEACTION',true); SET_CUSTOM_PROPERTY('block1.masterBeanCon',1,'RETURN_VALUES_ON_CLICK','PRIMARY_KEY'); For the bean to return the primary key for a graph component that the user clicked on, a fourth argument must be passed when calling the ADD_ROWDATA property. SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_ROWDATA','Europe,Sales,25000'); renders a row that does not have a primary key. Simply add the primary key as a fourth argument to be used in master-detail behaviors. SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_ROWDATA','Europe,Sales,25000,12');

If a user clicks onto the bar that represents the sales value 25000 for Europe, then the bean returns the primary key 12, raising a WHEN-CUSTOM-ITEM-EVENT trigger attached to the bean container. The code in the WHEN-CUSTOM-ITEM-EVENT trigger looks like: DECLARE eventName varchar2(30) := :system.custom_item_event; tempString varchar2(100); eventValues ParamList; eventValueType number; BEGIN IF (eventName='GRAPH_ACTION') THEN eventValues := get_parameter_list(:system.custom_item_event_parameters); get_parameter_attr(eventValues,'GRAPH_INFO',eventValueType, tempString); -- clear data stored and shown in block1.detailBeanCon FORMSGRAPHSAMPLE.clearData('block1.detailBeanCon'); -- call a procedure that populates the detail graph, by repeated calls to -- ADD_ROWDATA and one to ADD_DATA_TO_GRAPH FORMSGRAPHSAMPLE.populateDetailGraphData('block1.detailBeanCon',tempString,','); ELSE null; END IF; END; You can debug the graph bean independently for both bean containers. You can provide a debugging prefix to distinguish the messages written to the Java panel. E.g. to have all messages of the master bean pre-fixed with "block1.master bean:" set_custom_property('block1.masterBeanCon',1,'SET_DEBUG_PREFIX','block1.master bean:'); This creates a simple master-detail behavior controlled by Forms. Forms implementation 1. Open a Forms canvas and add a Forms Bean container to it 2. Open the Bean container property palette and add oracle.forms.demos.bigraph.FormsGraph to the implementation class property field 3. Set the bean properties exposed by the FormsGraph wrapper using the SET_CUSTOM_PROPERTY() built-in

Deployment 1. Add the FormsGraph.jar file to the application definition in the formsweb.cfg file. The FormsGraph.jar file contains all BI Bean Graph classes and the FormsGraph wrapper class used. The file size is 1.6 MB and is permanently stored on the client after a first time download. 2. Copy the FormsGraph.jar file into the forms90/java directory of the Forms Services installation 3. Set imagebase=codebase if you want to use graph icons, provided in the FormsGraph.jar file, within your application Example formsweb.cfg entry: [BIGraph] ... imagebase=codebase ... archive_jini=f90all_jinit.jar,/formsdemo/jars/FormsGraph.jar,/formsdemo/jars/demo90.jar ...

Properties registered in the FormsGraph wrapper Properties are named identifiers that map to a specific functionality in the BI Bean Graph component. Properties are called by the SET_CUSTOM_PROPERTY() built-in and may or may not require additional arguments to be passed.

Named colors The following colors can be used by their name and do not require RGB encoding: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white, yellow

Known issues This implementation is treated as a reusable component and Java code is shipped with the Forms demo. The source code can be edited within all projects in JDeveloper that have the BI Bean Graph added. The following is a list of known issues The Forms Graph overlaps Alerts and lists in Forms. This behavior is caused by heavy weight components (awt classes) in a lightweight interface (Oracle ewt). This may get addressed in the future, but no promises are made to this time. This has been fixed by using the MOUSE_ACTIVE property. For interactive graphs to work, the combination of column label, row label and value must be unique. This is required for retrieving the primary key stored within a different Java object.

FormsGraph Properties ADD_DATA_TO_GRAPH The ADD_DATA_TO_GRAPH property applies the data stored in the FormsGraph internal datastore to the actual BI Graph instance managed by a BeanContainer in Forms. Forms Example: SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_DATA_TO_GRAPH',''); Call this property to update the graphical representation whenever changes have been made to the represented data stored in the bean data store.

ADD_ROWDATA Data rows can be added to the FormsGraph internal data store before and after calling ADD_DATA_TO_GRAPH. However, if no data is available when the ADD_DATA_TO_GRAPH property is set, then no graph will show. The ADD_ROWDATA property appends a new row to the datastore. The syntax of the argument passed with ADD_ROWDATA is determined by the BI Bean Graph relational API and expects the column label to be passed as a first argument, the row label as a second and the cell value as a third. If the Graph is to be used as a master in a master/detail relation, then optional a forth argument can be passed representing the primary key. SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_ROWDATA','Europe,Sales,25000'); or SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_ROWDATA','Europe,Sales,25000,12'); In both cases the Series, or column name, is 'Europe', while the data, or row label, is 'Sales'. The first example shows a row with no primary key added, while the second example contains the primary key. The comma is the default delimiter for the number of arguments passed. The delimiter can be changed using the SET_DELIMITER property, which you may find helpful in situations where e.g. labels contain commas. To create three rows (Sales,Taxes,Savings) with 2 columns (Europe,USA) and to show them in the graph, in Forms you call SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_ROWDATA','Europe,Sales,25000'); SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_ROWDATA','USA,Sales,70000'); SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_ROWDATA','Europe,Taxes,2500'); SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_ROWDATA','USA,Taxes,2500'); SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_ROWDATA','Europe,Savings,22500'); SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_ROWDATA','USA,Savings,67500'); SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'ADD_DATA_TO_GRAPH',''); The row labels show on the X-axis for vertically presented graphs and on the Y-axis for horizontal graph types. The Column labels show in the graph legend.

ADD_INDEX_LINE (Deprecated) Property registered to show an index line in the graph. The index line can be used to show boundary conditions like min-revenue. The following arguments are expected in this order: 1. 2. 3. 4. 5. 6.

String = the text that is associated with the index line boolean = show/hide index label in graph legend. Valid values are true or false String = the axis, valid values are y-axis and x-axis int = each axis can have max 3 index lines. The counting of the lines is from 0 to 2 double = the value of the index line the color of the index line: Accepted colors: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white 7. int index line width, a value > 0 to determine the width of the index line Note that following arguments have default values, which means they can be omitted: line width [default = 1], color of index line [default = red] Forms Example: The following example sets an index line with the label "Min Revenue". The label "Min Revenue" is shown in the graph's legend, indicated by the second argument 'true'. The index line is set for the Y axis, as indicated by the third argument 'y-axis'. Its the first index line - indicated by the argument 0 - and its displayed in the hight of the y-axis value 1000. The index line color is specified as green and its thickness as 2. set_custom_property('BeanArea',1,'ADD_INDEX_LINE','Min Revenue,true,y-axis,0,1000.00,green,2');

Updated info In newer versions of oracle.dss.graph.Graph there is support for an unlimited number of index lines. To use this updated functionality, use ADD_REFERENCE_OBJECT. Valid Association axis values Y1AXIS (Default) Y2AXIS X1AXIS SERIES x-axis (Kept for backwards compatibility, maps to X1AXIS)

ADD_REFERENCE_OBJECT Adds a reference value to the graph like an index line or area. Values are expected in the following order: 1. 2. 3. 4. 5. 6. 7. 8. 9. 10.

Type (AREA or LINE) Text Association axis Color Show in legend as boolean Line width as integer Line style (SOLID, DASH, DASH_DOT or DOTTED) Location (FRONT or BACK) Value as double (Low value for AREA, line value for LINE) Value as double (High value for AREA, optional for LINE)

set_custom_property('block1.BeanArea1',1,'LINE,Reference1,Y1AXIS,red,true,2,SOLID,FRONT,1000'); set_custom_property('block1.BeanArea1',1,'AREA,Reference2,Y1AXIS,blue,true,1,SOLID,BACK,1000,200 0'); Valid Association axis values Y1AXIS (Default) Y2AXIS X1AXIS SERIES

ALIGN_TITLE_TEXT The ALIGN_TITLE_TEXT property is used to align the text of either the title, the subtitle or the footer. Allowed alignment attributes are "LEFT", "RIGHT" and "CENTER". One property call can be used to set multiple title alignments. The following argument syntax sets the alignment of the title, the subtitle and finally the footer: 'title=CENTER,subtitle=LEFT,footnote=CENTER'. The default delimiter is a comma (',') if not set other using the SET_DELIMITER property. Values can be omitted from right to left, which means that the footnote attribute can be omitted when setting the title and subtitle alignment. The subtitle attribute can be omitted if the footnote as well is omitted. set_custom_property('block1.BeanArea1',1,'ALIGN_TITLE_TEXT','title=CENTER,subtitle=LEFT'); The example above aligns the title to the center of the graph and the subtitle to the left.

CLEAR_GRAPH Clears the graph data store. This must be done before adding new data to the datastore. If using ADD_ROWDATA without before calling CLEAR_DATA, then the new row is appended to the list of existing rows. In a drilldown scenario CLEAR_GRAPH makes sure that the detail graph shows the right data. CLEAR_GRAPH does not require an additional argument to be passed. set_custom_property('block1.BeanArea1',1,'CLEAR_GRAPH','');

COLUMNCOUNT Property registered to retrieve the number of groups shown in the graph. A group in the relational world is a column in a row (e.g. Salary, Commission). The column count is returned in a when-custom-event trigger. Forms Example: set_custom_property('block1.BeanArea1',1,'COLUMNCOUNT',''); In a when-custom-item-event trigger DECLARE eventName varchar2(30) := :system.custom_item_event; tempString varchar2(100); BEGIN IF (eventName='RETURNED_COLUMN_NUMBER') THEN eventValues := get_parameter_list(:system.custom_item_event_parameters); get_parameter_attr(eventValues,'GRAPH_INFO',eventValueType, tempString); /*... do something with the value stored in tempString ...*/ END;

Column count can also be called using the Forms get_custom_property() built-in, eliminating the need for a custom event to be raised Forms Example: count := get_custom_property('block1.BeanArea1',1,'COLUMNCOUNT');

DEBUG The debug property turns a verbose debugging on or off. The debug information is written to the Java console of the Jinitiator panel. Debugging can be enabled and disabled to any time, thus allowing a close look to the problem area. set_custom_property('block1.BeanArea1',1,'DEBUG','TRUE'); Arguments used with the DEBUG property are either 'TRUE', to turn debugging on, or 'FALSE', to turn it off. By default no debug message is written to the panel.

DISPLAY_INDEX_LINE (Deprecated) Show or hide a specific index line. Forms Example: set_custom_property();

ENABLE_TOOLTIPS Hovering the mouse over a graph component like a bar in a bar graph, shows a configurable set of information in form of tooltips. Tooltips are not shown by default. Allowed arguments when calling ENABLE_TOOLTIPS from a Forms SET_CUSTOM_PROPERTY() built-in are "ALL" - show detail information (default) "LABELS" - labels only "VALUES" - show dat avalues only "NONE" - show no tooltips Examples set_custom_property('block1.BeanArea1',1,'ENABLE_TOOLTIPS','ALL'); set_custom_property('block1.BeanArea1',1,'ENABLE_TOOLTIPS','VALUES'); set_custom_property('block1.BeanArea1',1,'ENABLE_TOOLTIPS','NONE');

EXPLODE_PIESLICE This property is registered to be used with pie graphs. By specifying a slice in a pie by its number and an integer value for the distance, the slice gets exploded from the rest of the pie. Note that the slice is not returned automatically but must be returned manually. By this it is possible to explode more than one slice in a graph. set_custom_property('block1.BeanArea1',1,'EXPLODE_PIESLICE','2,60'); The current number of slices shown in a graph can be retrieved by a call to the COLUMN_COUNT registered property. This returns the number of slices in a pie within a WHEN-CUSTOM-EVENT trigger attached to the Bean area. SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'COLUMNCOUNT',''); The slices of a pie are numbered starting with 0. The following WHEN-CUSTOM-EVENT code retrives the number of columns shown and populates a list in Forms for the user to select a slice number from. ... IF (eventName='RETURNED_COLUMN_NUMBER') THEN eventValues := get_parameter_list(:system.custom_item_event_parameters); get_parameter_attr(eventValues,'GRAPH_INFO',eventValueType, tempString); /** * populate list CONTROL.SLICE_NUMBER */ col:=to_number(tempString); rg := Create_Group('ColumnCount'); /* Add two number columns to the record group */ gc1 := Add_Group_Column(rg, 'slice', CHAR_COLUMN,30); gc2 := Add_Group_Column(rg, 'slice_no', CHAR_COLUMN,30); FOR i IN 1..col LOOP Add_Group_Row(rg,i); Set_Group_Char_Cell(gc1, i,to_char(i)); -- columns in the pie Graph start counting by 0, so the first slice is 0 (i-1) Set_Group_Char_Cell(gc2, i,to_char(i-1)); END LOOP; populate_list('bloxk1.list1',rg); delete_group(rg); -- set initial value :CONTROL.SLICE_NUMBER:=0; ELSIF ...

ENABLE_MARKERTEXT Description: Forms Example: set_custom_property();

ENABLE_GRADIENT Description: Forms Example: set_custom_property();

EXPORT_CLIPBOARD Exports the currently displayed graph into the system clipboard. Forms Example: set_custom_porperty('BeanArea', 1, 'EXPORT_CLIPBOARD' ,'');

FRAME_POS Property registered to determine the xy position of the external graph window on the screen. The default position is 0:0. set_custom_property('block1.BeanArea1',1,'FRAME_POS','100,200');

GET_DELIMITER Property registered to retrieve the current delimiter string returned in a WHEN-CUSTOM-EVENT trigger attached to the Bean area. set_custom_property('block1.BeanArea1',1,'GET_DELIMITER',''); The WHEN-CUSTOM-EVENT trigger code would look like ... IF (eventName='CURRENT_DELIMITER') THEN eventValues := get_parameter_list(:system.custom_item_event_parameters); get_parameter_attr(eventValues,'DELIMITER_INFO',eventValueType, tempString); //handle delimiter stored in tempString ... ELSIF ...

GRAPHTYPE The GRAPHTYPE property is registered to set the type of the graph from Forms. Note that some of th esupported graph types show the values in percent. However, the tooltips always show the value in absolute numbers. The following graph types are supported, where the name in uppercase is supplied as an argument with the call to GRAPHTYPE. Examples: RING_BAR ==> set_custom_property('block1.BeanArea1',1,'GRAPHTYPE','RING_BAR_GRAPH'); PIE_BAR ==> set_custom_property('block1.BeanArea1',1,'GRAPHTYPE','PIE_BAR_GRAPH'); MULTI_PIE_GRAPH ==> set_custom_property('block1.BeanArea1',1,'GRAPHTYPE','MULTI_PIE_GRAPH');

HIDE_AXIS Forms property registered to hide the graph's x, y1 and y2 axis. Allowed values are X, Y1, Y2, XY1, XY1Y2, Y1Y2, XY2. To hide the X andY1 axis but show the Y2 axis, call the set_custom_property() built-in with XY1 in the argument. Forms Example: Hiding the X and Y1 axis, showing Y2 axis if used set_custom_property('BeanArea',1,'HIDE_AXIS','XY1'); Hiding the Y1 and Y2 axis, showing the X axis set_custom_property('BeanArea',1,'HIDE_AXIS','Y1Y2');

to reset set_custom_property('BeanArea',1,'HIDE_AXIS','');

HIDE_TITLE Property that hides the graph title text if displayed set_custom_property('block1.BeanArea1',1,'HIDE_TITLE','');

HIDE_SUBTITLE Property that hides the graph subtitle text if displayed set_custom_property('block1.BeanArea1',1,'HIDE_SUBTITLE','');

HIDE_FOOTER Property that hides the graph footer text if displayed set_custom_property('block1.BeanArea1',1,'HIDE_FOOTER','');

HIDE_X_TITLE Property that hides the graph title text defines for the x-axis if displayed set_custom_property('block1.BeanArea1',1,'HIDE_X_TITLE','');

HIDE_Y_TITLE Property that hides the graph title text defines for the x-axis if displayed set_custom_property('block1.BeanArea1',1,'HIDE_Y_TITLE','');

HIDE_FRAME Property called to hide the external graph frame. set_custom_property('BeanArea',1,'HIDE_FRAME','');

HIDE_GRAPH Property called to hide the graph, not showing in the Bean area container. This functionality is e.g. useful to hide the graph when no data was provided or as a result of a user action. Alternatively to hiding the graph when no data is shown, a customizable text string can be shown. Showing a string is useful e.g. in a master/detail scenario where not all master records have details. set_custom_property('block1.BeanArea1',1,'HIDE_GRAPH','');

MAX_SCALE_Y_AXIS Property registered to define the scale of the y-axis to a fixed maximum value. To use this functionality, pass an integer value as a string argument in the call to set_custom_property(). The string arguments represents the max Y value shown in the graph. To reset to automatic scaling, use 'AUTO' as an argument Forms Example: set_custom_property('BeanArea',1,'MAX_SCALE_Y_AXIS','150'); To reset back to default: set_custom_property('BeanArea',1,'MAX_SCALE_Y_AXIS','AUTO');

MIN_SCALE_Y_AXIS Property registered to define the scale of the y-axis to a fixed minimum value. To use this functionality, pass an integer value as a string argument in the call to set_custom_property(). The string arguments represent the min Y value shown in the graph. To reset to automatic scaling, use 'AUTO' as an argument Forms Example: set_custom_property('BeanArea',1,'MIN_SCALE_Y_AXIS','100'); to reset set_custom_property('BeanArea',1,'MIN_SCALE_Y_AXIS','AUTO');

MAX_SCALE_Y2_AXIS Description: Forms Example: set_custom_property();

MIN_SCALE_Y2_AXIS Description: Forms Example: set_custom_property();

MOUSE_ACTIVE Use to enable or disable mouse interaction with the graph. This property has been implemented to fix the heavy / lightweight component bug in Java. When not using this property the graph will be placed over all other Forms components when the graph gets mouse input events. An example of when to use this property is when a form looses its focus. When the active form looses its focus, set this property to false so the graph won't get any mouse events. When the form gains focus, set this property back to true. Forms Example: set_custom_property();

MOUSEACTION Property registered to enable or disable mouse interactivity requiring Forms Server interaction. This property should be called to switch off mouse interactivity whenever no values shall be returned from the Graph to Forms (static graphs). Allowed arguments passed with the call to MOUSEACTION property are 'true' or 'false', where true is used to enable mouse actions while false disables it. set_custom_property('block1.BeanArea1',1,'MOUSEACTION','false');

MODIFY_ROW_DATA Property registered to change one column in a bar graph or one slice in a pie graph for a partial graph update. The row that needs an update is identified by its current column label, row label and value. The new value is passed as a forth argument set_custom_property('block1.BeanArea1',1,'MODIFY_ROW_DATA','ColumnName,RowName,OldValue,N ewValue'); The default delimiter, as shown in this example, is a comma, but can be chosen different calling the SET_DELIMITER property.

POSITION_LEGEND Property registered to manually set the position of the legend shown in the graph. The default setting is to auto layout the legend. Use TOP, LEFT, RIGHT, BOTTOM or AUTO as an argument when calling set_custom_property() set_custom_property('block1.BeanArea1',1,'POSITION_LEGEND','LEFT');

ROTATE_X_LABEL Property registered to rotate the x-Label by 0, 90 or 270 degrees Forms Example: set_custom_property('BeanArea',1,'ROTATE_X_LABEL','90');

REMOVE_DATA Property registered to remove a data row from the graph without refreshing the whole graph data storage. If the data row has an associated primary key, then this gets deleted as well. The row to delete is identified by the column label, the row label and the current value. The limitation is that the combination of these three values must be unique within the graph for this feature to work. set_custom_property('block1.BeanArea1',1,'REMOVE_DATA','SALARY,SMITH,1700');

RETURN_VALUES_ON_CLICK Property registered to determine the type of data returned by the bean as a result of a user mouse click. Allowed arguments are ALL ROWLABEL COLUMNLABEL VALUE PRIMARY_KEY The primary is returned only if it was passed using the ADD_ROW_DATA property. Forms Example: Forms example for a master/detail Graph. Code added to the WHEN-CUSTOM-EVENT Trigger on the PJC.MASTERGRAPH set_custom_property('block1.BeanArea',1,'RETURN_VALUES_ON_CLICK','ALL');

to retrieve the returned data value in Forms: DECLARE eventName varchar2(30) := :system.custom_item_event; tempString varchar2(100); eventValues ParamList; eventValueType number; BEGIN IF (eventName='GRAPH_ACTION') THEN eventValues := get_parameter_list(:system.custom_item_event_parameters); get_parameter_attr(eventValues,'GRAPH_INFO',eventValueType, tempString); /* ... do something with value in tempString ... */ ELSE ...

RESET_GRAPH Description: Forms Example: set_custom_property();

SCROLLBAR Property registered to display a scrollbar on the Graph if needed. Set value to true for enablig the scrollbar (default) or false to disable the scrollbar. The default is false as this feature is only required if too many data columns are shown that do not fit into the graph set_custom_property('block1.BeanArea1',1,'SCROLLBAR','true');

SET_BACKGROUND Property registered to set the graph's background color. The background color excludes the plot area which can be set by another property.The color must be passed as sRGB color in a comma separated string, with the specified red, green, and blue values in the range (0 - 255), e.g. '255,255,255' for white. Basic colors: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white can be passed in clear text. set_custom_property('block1.BeanArea1',1,'SET_BACKGROUND','120,234,123');

SET_DEPTH SET_DEPTH is a property to create a 3D appearance of a graph by creating it's shadow. The depth is provided in pixel for the width and a degree between 0 and 180 for the orientation. Specify both values in one call, where the fist value determines the depth and the second the angle. The delimiter is the actual delimiter defined or ',' if choosing the default. To se a depth of 20 pixel and a radius of 10 degrees, set the attribute value of this Forms property to '20,10' (if the default delimiter id used). set_custom_property('block1.BeanArea1',1,'SET_DEPTH','30,75');

SET_DEBUG_PREFIX The BI Bean Graph can have multiple instances in one Forms application, each in its own Forms Bean Container. If debugging is activated for all graphs then the debug information written to the Java console (the Jinitiator panel) does not tell which bean is writing it. To distinguish bean messages the SET_DEBUG_PREFIX property can be set to identify the output of a bean container. set_custom_property('block1.BeanArea1',1,'SET_DEBUG_PREFIX','block1.BeanArea1'); The debug output generated by this bean now looks like block1.BeanArea1 ==> ENABLE_TOOLTIPS: setting label tooltips block1.BeanArea1 ==> RETURN VALUES: trying to set return value .... block1.BeanArea1 ==> RETURN VALUES: ... to COLUMNLABEL

SET_DELIMITER Property registered to change the default string delimiter, a comma, to another string. This is required, e.g. when setting a title string including a RGB encoded font color. The RGB encoded color requires a comma as the delimiter so tha this character cannot be used with the rest of the string. The following examples will make this clearer. SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'SET_DELIMITER','#'); SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'SET_TITLE','Hello World#120,255,120#bi#12'); SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'SET_DELIMITER',','); In this example the delimiter is set to '#' before the graph title is set to "Hello World". The color for this string is encoded by 120,255,120 (a light green) using a comma as a delimiter. Finally the delimiter is set back to the default value.

SET_FRAME_HEIGHT_WIDTH Property registered to set the width and hight for the Graph external frame. The size is passed as a string representing two integer values. The syntax is height width. This property is defaulted to 200,300 and if set only has an effect on graphs running in a separate frame. set_custom_property('block1.BeanArea1',1,'SET_FRAME_HEIGHT_WIDTH','200,300');

SET_FOOTER property registered to set the graph Footer title, font, font style, font size and color. The following string format is expected "title string,color,font style,font size,font" For example to set a Subtitle to "Hello World", the Font to TimesNewRoman, the font style to bold [b] and italic [i] and the color to red the string shows: 'Hello World,red,bi,10,TimesNewRoman' The color can be specified as color name or as a sRGB value in a range from (0..255). Values can be omitted from right to left. Passing color values as RGB values may require switching the default delimiter as the comma must be used to set RGB values Forms Example: set_custom_property('block1.BeanArea1',1,'SET_FOOTER','Hello World,red,bi,10,TimesNewRoman'); or set_custom_property('BeanArea',1,'SET_DELIMITER','#'); set_custom_property('BeanArea',1,'SET_FOOTER','Hello World#120,234,120#bi#10#TimesNewRoman'); set_custom_property('BeanArea',1,'SET_DELIMITER',',');

SET_FOOTER_BACKGROUND Property registered to set the background color of the graph footer text field. Normally the color is set to the same value then the background, but sometimes having this appear in a different color may make sense. The color must be passed as RGB color in a comma separated string, with the specified red, green, and blue values in the range (0 - 255), e.g. '255,255,255' for white. Basic colors: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white can be passed in clear text. set_custom_property('block1.BeanArea1',1,'SET_FOOTER_BACKGROUND','120,255,120');

SET_GRAPHIC_ANTIALIASING Graphic antialiasing, if set to "true" smoothes the representation of line graphs and shows curves instead of steps from one value to the next. Allowed values are true and false Forms Example: set_custom_property('BeanArea',1,'GRAPH_ANTIALIASING','true');

SET_GRAPH_BASELINE Description: Forms Example: set_custom_property();

SET_LEGEND_BORDER Property registered to set the border and background color of the legend shown in a graph. The color can be provided as a RGB encoded value e.g. 120,234,220 or as a named color e.g. red, orange or green. The first value passed is for the border, the second for the background. '120,200,220|223,223,100' If one or both setting should be transparent, then pass 'TRANSPARENT' as a color name. E.g. 'Transparent|123,334,120'. Note that in this case the default delimiter must be changed since the color coding requires ',' as a delimiter Forms Example: set_custom_property('block1.BeanArea1',1,'SET_LEGEND_BORDER','blue,yellow'); or set_custom_property('block1.BeanArea1',1,'SET_DELIMITER','#'); set_custom_property('block1.BeanArea1',1,'SET_LEGEND_BORDER','120,120,120#220,23,120'); set_custom_property('block1.BeanArea1',1,'SET_DELIMITER',','); or set_custom_property('block1.BeanArea1',1,'SET_DELIMITER','#'); set_custom_property('block1.BeanArea1',1,'SET_LEGEND_BORDER','TRANSPARENT#220,23,120'); set_custom_property('block1.BeanArea1',1,'SET_DELIMITER',',');

SET_LINEGRAPH_MARKERS Property registered to enable / disable symbolic data value markers shown in line graphs. To enable this feature pass 'true' as an argument with the set_custom_property() call. Use 'false' to switch it off (default) set_custom_property('block1.BeanArea1',1,'SET_LINEGRAPH_MARKER','true');

SET_NO_DATA_FOUND Property registered to set the message shown when no data is available for the graph to render. This is the case whenever a master-detail relationship does not have detail data. set_custom_property('block1.BeanArea1',1,'SET_NO_DATA_FOUND','Sorry - we are out of data today'); Note that the default delimiter needs to be changed if the message contains a comma.

SET_PLOT_AREA_COLOR Property registered to set the color of the Plot Area. If not set then the area is chosen to be white. The color must be passed as RGB color in a comma separated string, with the specified red, green, and blue values in a range of (0 - 255), e.g. '255,255,255' for white. Basic colors: black, blue, cyan, darkGray, gray,green, lightGray, magenta, orange, pink, red, white can be passed in clear text. set_custom_property('block1.BeanArea1',1,'SET_PLOT_AREA_COLOR','120,255,120');

SET_SCALED_LOGARITHMIC Property registered to logarithmic scale the Y and X Axis. The following information must be passed as an argument when calling SET_SCALED_LOGARITHMIC.: The axis identifier - 'X' or 'Y' 'true' or 'false' to symbolize whether logarithmic scale is enabled The value for the logarithmic base. The delimiter used must match the currently defined delimiter, which is by default ','. Forms Example: set_custom_property('BeanArea',1,'SET_SCALED_LOGARITHMIC','Y,true,2'); This creates a graphs with a logarithmic scaled Y axis with a base of 2. The base is provided as a double value. set_custom_property('block1.BeanArea1',1,'SET_SCALED_LOGARITHMIC','X,true');

Note that there is always only one axis that shows the value of the graph. The ability to set the X axis to scale logarithmic in this bean is not used because the row label is of type String. This may change in a future version based on customer feedback.

SET_SUBTITLE Property registered to set the graph Sub title, font, font style, font size and color. The following string format is expected: "title string,color,font style,font size,font". For example to set a Subtitle to "Hello World", the Font to TimesNewRoman, the font style to bold [b] and italic [i] and the color to red the string shows: 'Hello World,red,bi,10,TimesNewRoman' The color can be specified as color name or as a sRGB value in a range from (0..255). Values can be omitted from right to left. Passing color values as RGB values may require switching the default delimiter as the comma must be used to set RGB values set_custom_property('block1.BeanArea1',1,'SET_SUBTITLE','Hello World,red,bi,10,TimesNewRoman'); or set_custom_property('block1.BeanArea1',1,'SET_DELIMITER','#'); set_custom_property('block1.BeanArea1',1,'SET_SUBTITLE','Hello World#120,234,120#bi#10#TimesNewRoman'); set_custom_property('block1.BeanArea1',1,'SET_DELIMITER',',');

SET_SUBTITLE_BACKGROUND Property registered to set the background color of the subtitle title text field. Normally you want that color be set to the same value as the background, but sometimes having this appear in a different color makes sense. The color must be passed as RGB color in a comma separated string, with the specified red, green, and blue values in the range (0 - 255), e.g. '255,255,255' for white. Basic colors: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white can be passed in clear text. Forms Example: set_custom_property('block1.BeanArea1',1,'SET_SUBTITLE_BACKGROUND','120,255,220');

SET_SERIES_MARKER_TYPE Property registered to set the marker type of a series identified by its name. The default value is MT_DEFAULT. Other values are MT_AREA and MT_BAR. To show a line graph in front of a bar graph, call SET_SERIES_MARKER_TYPE for the series name that should be rendered as a bar graph. Note that the graph type must be set to one of the graph series types for this feature to work. Forms Example:

set_custom_property('BeanArea',1,'SET_SERIES_MARKER_TYPE',','); To show a specific series as a bar graph within a line chart set_custom_property('BeanArea',1,'SET_SERIES_MARKER_TYPE','Salary,MT_BAR'); To show a specific series as an area graph within a line chart set_custom_property('BeanArea',1,'SET_SERIES_MARKER_TYPE','Salary,MT_AREA');

SET_SERIES_WIDTH Property registered to set the width of a series identified by its name. The default width size is 3. Forms Example: set_custom_property('BeanArea',1,'SET_SERIES_WIDTH',','); set_custom_property('BeanArea',1,'SET_SERIES_WIDTH','Salary,10');

SET_SERIES_COLOR Property registered to set the color of a named series. The color must be passed as RGB color in a comma separated string, with the specified red, green, and blue values in the range (0 - 255), e.g. '255,255,255' for white. Basic colors: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white can be passed in plain text. Forms Example: set_custom_property('BeanArea',1,'SET_SERIES_COLOR',','); set_custom_property('BeanArea',1,'SET_SERIES_COLOR','Salary,255,255,255'); set_custom_property('BeanArea',1,'SET_SERIES_COLOR','Salary,red');

SET_SERIES_Y_AXIS Description: Forms Example: set_custom_property();

SET_STYLE Description: Sets the graph style using predefined styles. Valid style names are: April Autumn_simple Blackwhite Comet Confetti Earth Executive Financial Glass Gradient Nautical Projection Regatta_simple Southwest Transparent

Forms Example: set_custom_property();

SET_XML_STYLE Sets the graph style like colors and effects using an XML string. In the JAR archive named dvt-jclient.jar there is an oracle/dss/graph/Graph.dtd which hints about the structure of the style XML. Forms Example: set_custom_property();

SET_TITLE Property registered to set the graph title, title font, title font style, title font size and title color, expecting the following string format title string,color,fontstyle,font size,fontname. For example to set a Subtitle to "Hello World", the Font to TimesNewRoman, the font style to bold [b] and italic [i] and the color to red the string shows: 'Hello World,red,bi,10,TimesNewRoman' The color can be specified as color name or as a sRGB value in a range from (0..255). Values can be omitted from right to left. BEGIN -- the color is defined with comma separated rgb values. The default delimiter -- must be changed temporarily. Alos set the font type to bold and italic (bi) SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'SET_DELIMITER','#'); SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'SET_TITLE','Hello World#120,234,120#bi#12'); SET_CUSTOM_PROPERTY('block1.BeanArea1',1,'SET_DELIMITER',','); END;

SET_TITLE_BACKGROUND Property registered to set the background color of the title text field. Normally you want that color be set to the same value as the background, but sometimes having this appear in a different color may make sense. The color must be passed as RGB color in a comma separated string, with the specified red, green, and blue values in the range (0 - 255), e.g. '255,255,255' for white. Basic colors: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white can be passed in clear text. set_custom_property('BeanArea',1,'SET_TITLE_BACKGROUND','255,255,255');

SET_X_LABEL Property registered to set the x-Axis label. set_custom_property('block1.BeanArea1',1,'SET_X_LABEL','Hello World X'); or set_custom_property('block1.BeanArea1',1,'SET_X_LABEL','Hello World X,TimeNewRoman,bi');

SET_X_VALUE_FONT Set font face, style, size and color of the O1 tick label. Expects the following parameters: color,style,size,font face For blue bold + italic Arial of size 12: set_custom_property('block1.BeanArea1',1,'SET_X_VALUE_FONT','blue,bi,12,Arial');

SET_Y_LABEL Property registered to set the y-Axis title set_custom_property('block1.BeanArea1',1,'SET_Y_LABEL','Hello World Y');

SET_Y2_LABEL Description: Forms Example: set_custom_property();

SET_Y1_NUMBER_TYPE Property registered to set the y-Axis number type to a custom string. The number type is shown as a prefix in front of the number value. Forms Example: --Setting a currency value for Euro set_custom_property('BeanArea',1,'SET_Y1_NUMBER_TYPE','EURO'); --Setting value to $ set_custom_property('BeanArea',1,'SET_Y1_NUMBER_TYPE','$'); -Setting back to normal set_custom_property('BeanArea',1,'SET_Y1_NUMBER_TYPE','GENERAL');

SET_Y1_SCALE_DOWN Description: Forms Example: set_custom_property();

SET_Y_DECIMAL_DIGITS Description: Forms Example: set_custom_property();

SET_Y2_DECIMAL_DIGITS Description: Forms Example: set_custom_property();

SHOW_COLUMNS_AS_ROWS Forms property registered to show columns as rows and rows as columns in the Graph. If specifying the argument passed as "true" then the columns will show as series data and the rows as group data. To switch this presentation back to normal mode, call the same property again and pass "false" as an argument. set_custom_property('block1.BeanArea1',1,'SHOW_COLUMNS_AS_ROWS','true');

SHOW_FRAME Forms property registered to show the external graph frame. This feature is used when running the Graph in an external frame to the Forms window. It is to unhide a frame that previously was hidden. set_custom_property('block1.BeanArea1',1,'SHOW_FRAME','');

SHOW_GRAPH_IN_FRAME Calling this property from Forms will show the graph in a separate frame. For the BI Bean Graph to initialize it is important that the Forms Bean Container used is visible on the Canvas and at least has a size of 1x1 pixel. You can hide this widget by setting its border to 'None' and the background color to the color of the canvas, using the property palette of the Bean Area. set_custom_property('BeanArea',1,'SHOW_GRAPH_IN_FRAME','');

SHOW_GRAPH This property shows the BI Bean Graph inside of the Bean container specified. The other option is to display the Graph in an external frame. set_custom_property('block1.BeanArea1',1,'SHOW_GRAPH',''); This command actually renders the graph in the Forms application.

SHOW_GRID Property registered to show/hide the grid in a graph. The default value is set to true, use false to hide the grid in the graph set_custom_property('block1.BeanArea1',1,'SHOW_GRID','false');

SHOW_LABELS Forms property registered to show/hide the labels shown on the x and y axis. Labels are shown by default, to hide labels pass a value of false as an argument for the Forms property. Use the following syntax: 'x=false,y1=true' to show labels for the y1 axis but to hide labels for the x axis. You can omit the outer right value if no change is needed e.g. 'x=true'. set_custom_property('block1.BeanArea1',1,'SHOW_LABELS','x=false,y=true');

SHOW_LEGEND Forms property registered to show/hide the graph legend. Argument value are 'true' to show the legend (default) and 'false' to hide the legend set_custom_property('block1.BeanArea1',1,'SHOW_LEGEND','true');

SHOW_PIE_LABELS Shows the legend text within a pie graph. Takes 'TEXT','VALUE','PERCENT' or TEXT_PERCENT' as an argument. The default setting is 'PERCENT'. Forms Example: set_custom_property('BeanArea',1,'SHOW_PIE_LABELS','VALUE');

Custom item events RETURNED_COLUMN_NUMBER GRAPH_ACTION GRAPH_INFO CURRENT_DELIMITER DELIMITER_INFO

Graph types This bean is able to render a number of different graph types listed in this table. Old names are kept for backwards compatibility. New name AREA_HORIZ_ABS AREA_HORIZ_ABS_SPLIT2Y AREA_HORIZ_PERCENT AREA_HORIZ_STACK AREA_HORIZ_STACK_SPLIT2Y AREA_VERT_ABS

Old name

Description

VERTICAL_AREA_GRAPH

area graph with vertical value axis

AREA_VERT_PERCENT

VERTICAL_PERCENT_AREA_GRAP H

AREA_VERT_STACK

VERTICAL_STACKED_AREA_GRAP H

area graph with vertical value axis and column values shown in percent area graph with vertical value axis and column values shown absolute

AREA_VERT_ABS_SPLIT2Y

AREA_VERT_STACK_SPLIT2Y

BAR_HORIZ_CLUST

HORIZONTAL_BAR

bar graph with horizontal value axis

HORIZONTAL_PERCENT_BAR

bar graph with horizontal value axis. The columns are shown as stacked values showing their value in percent

BAR_HORIZ_CLUST_2Y

BAR_HORIZ_CLUST_SPLIT2Y BAR_HORIZ_PERCENT

Example

BAR_HORIZ_STACK

HORIZONTAL_STACKED_BAR

bar graph with a horizontal value axis. The columns are shown stacked

BAR_VERT_CLUST

VERTICAL_BAR

BAR_VERT_CLUST_SPLIT2Y

VERTICAL_BAR_2Y

bar graph with vertical value axis. This is defined as the default graph type. bar graph with two vertical value axis

BAR_HORIZ_STACK_2Y

BAR_HORIZ_STACK_SPLIT2Y

BAR_VERT_CLUST2Y

BAR_VERT_PERCENT

VERTICAL_PERCENT_BAR

BAR_VERT_STACK

VERTICAL_STACKED_BAR

BAR_VERT_STACK_SPLIT2Y

BAR_VERT_STACK2Y

BUBBLE

bar graph with vertical value axis. The columns are shown as stacked values showing their value in percent bar graph with vertical value axis. The columns are shown stacked

BUBBLE_2Y

BUBBLE_LABELS BUBBLE_LABELS_2Y COMBINATION_VERT_ABS

COMBINATION_VERT_ABS_2 Y HIST_HORIZ HIST_VERT LINE_HORIZ_ABS

LINE_HORIZ_ABS_2Y LINE_HORIZ_ABS_SPLIT2Y LINE_HORIZ_PERCENT LINE_HORIZ_STACK

LINE_HORIZ_STACK_2Y LINE_HORIZ_STACK_SPLIT2Y LINE_VERT_ABS

HORIZONTAL_LINE_GRAPH

line graph with a horizontal value axis

HORIZONTAL_STACKED_LINE_GR APH

line graph with a horizontal value axis. A line is based on top of the values of its predecessor

VERTICAL_LINE_GRAPH

line graph with a vertical value axis

VERTICAL_STACKED_LINE_GRAPH

line graph with a vertical value axis. A line is based on

LINE_VERT_ABS_2Y

LINE_VERT_ABS_SPLIT2Y

LINE_VERT_PERCENT

LINE_VERT_STACK

top of the values of its predecessor LINE_VERT_STACK_2Y

LINE_VERT_STACK_SPLIT2Y

VERTICAL_LINE_SPLIT_GRAPH

line graph showing the second group )column) in its own diagram. If e.g. four groups are shown, then 1,3,4 display in the first diagram and 2 in its own diagram below

PIE

PIE_GRAPH

pie graph with values shown in percent

PIE_BAR

PIE_BAR_GRAPH

PIE_MULTI

MULTI_PIE_GRAPH

PIE_MULTI_PROP

MULTI_PIE_PROPORTIONAL_GRA PH

pie graph with a separate graph showing the detail values building the graph total. Clicking on a graph slice changes the details shown showing one pie graph per row label. E.g. show salary and bonus for SMITH, salary and bonus for JONES ... same as MULTI_PIE_GRAP H but showing the size of the graph proportional to its total value compared to the

LINE_SELECT_POINT PARETO

other POLAR

POLAR_2Y RADAR_AREA RADAR_LINE

RADAR

shows graph as a radar line. This graph does not make sense with only one or two groups (columns) displayed per each row

RING_BAR

RING_BAR_GRAPH

Also known as the 'donough' graph. Column values are shown in percent

RING_MULTI

MULTI_RING_GRAPH

RING_MULTI_PROP

MULTI_RING_PROPORTIONAL_GR APH

showing one ring graph per row label. E.g. show salary and bonus for SMITH, salary and bonus for JONES ... same as MULTI_RING_GRA PH but showing the size of the graph proportional to its total value compared to the other

SCATTER

SCATTER_GRAPH

RADAR_LINE_2Y RING

SCATTER_2Y

SCATTER_LABELS SCATTER_LABELS_2Y SPECTRAL STOCK_2Y STOCK_CANDLE

STOCK_CANDLE_VOLUME

STOCK_HILO

STOCK_HILO_2Y STOCK_HILO_CLOSE

STOCK_HILO_CLOSE2Y STOCK_HILO_CLOSE_SPLIT2Y STOCK_HILO_CLOSE_VOLUM E STOCK_HILO_SPLIT2Y STOCK_HILO_VOLUME STOCK_OPEN_HILO_CLOSE

STOCK_OHLC_CANDLE

STOCK_OHLC_CANDLE_VOLU ME STOCK_SPLIT_2Y

STOCK_HIGHLOW_GRAPH

shows the high and low values of each group (column) grouped by low values and high values

STOCK_VOLUME

THREED_AREA_GROUP

3D_AREA_GROUP_GRAPH

THREED_AREA_SERIES

3D_AREA_GRAPH

THREED_BAR

3D_BAR_GRAPH

THREED_CUBE

3D_CUBE_GRAPH

THREED_DIAMOND THREED_OCTAGON THREED_PYRAMID THREED_RIBBON_GROUP THREED_RIBBON_SERIES

THREED_START THREED_SURFACE

THREED_SURFACE_HONEYCO MB THREED_SURFACE_SIDES THREED_END FUNNEL

area graph with vertical value axis and strong 3D appearance group orientation area graph with vertical value axis and strong 3D appearance series orientation bar graph with vertical value axis and strong 3D appearance vertical axis graph showing cubes representing group/series value data

View more...

Comments

Copyright © 2017 DATENPDF Inc.