Fonction SAP BARC_GRAPHIC_PBO - Bar chart control (PBO)

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
ABAP_CMD NET_GRAPH-ABAP_CMD C 12 SPACE X Command to graphic
CONFIRM NET_SET-CONFIRM C 1 'X' X Indicator: Confirm mode
CONTROL_HANDLE CNTL_HANDLE 0 X Control handle
INSTANCE REF TO CL_GUI_BARCHART 0 X Bar chart object
OPEN_EDIT BCOPENEDIT u 16 X Field for edit window
PROFILE BCPROFILE u 17 X Graphics profile
PWDID NET_GRAPH-PWDID C 8 SPACE X Parent window ID
SET_FOCUS NET_GRAPH-FLAG C 1 'X' X Indicator: Set focus to graphic windows
SO_CONTENTS SOS00-S_OBJDES C 50 SPACE X Document title
SO_SEND NET_GRAPH-FLAG C 1 SPACE X Indicator: Send graphic
START_DATE BCSECTION-START C 20 SPACE X Start date
STAT NET_GRAPH-STAT C 1 SPACE X Status
STATUS_TEXT NET_GRAPH-STATUSTEXT C 80 SPACE X Text in status line
SUPER NET_GRAPH-SUPER C 8 SPACE X Parameter for closing windows
WAIT_FOR_INPUT NET_GRAPH-FLAG C 1 'X' X Indicator: Wait for input
WINID NET_GRAPH-WINID C 8 SPACE X Window ID

Paramètre Reférence Long. Facultatif Description
BOXES BCBOXES 20 X Graphic object in table area (box)
BOX_VALS BCVALS 88 X Attributes of graphic objects in table area
CURVES BCCURVE 12 X Curves
CURVE_VALS BCCURVVALS 244 X Curve attributes
DELETIONS BCDELETE 12 X Objects to be deleted
LINKS BCLINKS 24 X Links
LINK_VALS BCNVALS 92 X Link attributes
NODES BCNODES 16 X Graphic objects in graph area (nodes)
NODE_VALS BCNVALS 92 X Attributes of graphic objects in graph area
POSITIONS BCPOSITION 16 X Object positions

Exception Description
ERR_IN_PROFILE Error in the graphics profile
INV_PROFILE Incorrect graphics profile
INV_WINID Incorrect window ID

Notes
See parameter documentation.
Command which determines the type of reaction of the graphics.
The user commands (see function module 'BARC_GRAPHIC_PAI' Exportingparameter 'GRAPH_CMD') are generally confirmed here in confirm mode.
If a user command should not be executed, you must either set ABAP_CMD= SPACE or empty the transfer tables.
Im confirm and non-confirm modes, the status of the graphics can beinterrogated:
In 'BARC_GRAPHIC_PAI', 'SEL' provides all the marked objects in thecorresponding tables for GRAPH_CMD = 'SEL'.
In 'BARC_GRAPHIC_PAI', 'CUSTOM' returns the settings in the optionprofile for GRAPH_CMD = 'CUSTOM' in the exporting parameter SETTINGS.
In 'BARC_GRAPHIC_PAI', 'OVERLAP' returns all the lines containingoverlying nodes in GRAPH_CMD = 'OVERLAP'.
'ALIGN' returns all visible charts (height > 0) evenly at windowheight.
'VIEWRANGE' returns the date values of the display in'BARC_GRAPHIC_PAI' for GRAPH_CMD = 'VIEWRANGE'.
'PREPARE' enables you to start the graphics in a process parallel toABAP. ABAP again is given control before the graphics are set up, canfill the transfer tables with applications data and load it back intothe graphics.
If 'PREPARE' is used, no other function module of the function group'BRAC' may be used before calling the function module'BARC_GRAPHIC_PBO'.
(Should no longer be used).
The following constants are provided for the user commands in theInclude 'LBARCCON':
Command | Constant
---------+------------------------------
SEL |BC_CONST-GET_SELECTION
CUSTOM |BC_CONST-GET_SETTINGS
OVERLAP |BC_CONST-GET_OVERLAP
PREPARE |BC_CONST-PREPARE
ALIGN |BC_CONST-ALIGN
VIEWRANGE|BC_CONST-GET_VIEWRANGE
Confirm Mode: (CONFIRM <> SPACE)
---------------------------------
The user actions are reported to ABAP as requests. ABAP enables,forbids or extends them.
The user actions must be confirmed, see ABAP_CMD.
ABAP can assign the IDs when inserting graphic objects (nodes).
Non-confirm mode: (CONFIRM = SPACE, Default)
---------------------------------------------
The user actions are executed directly and reported to ABAP for loggingpurposes.
Non-confirm mode can only be used to display the bar chart graphics.The commands SELECT, CUSTOM and double clicking are supported.Maintenance mode is not implemented in non-confirm mode.

Description
Specifying the control handle automatically transmits the data to thecontrol.

Description
If this field string is filled, the input window on the field specifiedin the field string is opened. Normally this input window can only beopened in the graphics. It is also closed again each time you return toan input field and each time you switch to another session. You canprevent it from being closed by specifically setting this field string,for example when you make an incorrect entry.
Fields of the field string:
CHART_ID -> ID of the chart in which the field of the object for which
the window should be opened lies
OBJ_TYPE -> Object for whose field the window should be opened
All the objects that are possible are listed below:
Object|Value|Constant
------+-----+-------------------
Box |B |BC_CONST-BOX_OBJECT
OBJ_ID -> ID of the object for whose field a window should beopened.
FIELD_ID -> Field ID of the field for which the window should beopened.

Value range

Default
If the field string is initial, it is not sent.
The graphic profile defines what the graphic, the preset values and thepossible functions look like.
The graphic profile is maintained during customizing. You can call itas follows:
1. Transaction: OCNG
2. Menu : Bar chart
ID of the parent window; see interactive programming.
For <> SPACE, the focus is set to the graphic window for each functionmodule call.
Message identification
Identification: Send to SAP office
If not equal to SPACE, the graphic is not built up on the screen.Instead it is sent to the recipient specified in the send screen.If this date is set, the beginning of the diagram area for the bar chartgraphic is set to this time. Should the width of the diagram area beinsufficient to fill the entire window, then the beginning of thediagram area is set to the beginning of the time axis. This is also thestandard procedure, when no date is specified.
See Dialog Programming
Possible values for STAT are available in the SGRCCNST include file asconstants in the field string SGRC_CONST.
Possible Values for STAT:
========================
STAT |(Constant in the include file SGRCCNST)
|Meaning
-----+----------------------------------
SPACE|(SGRC_CONST-STAT_SPACE)
|Open window, reload
1 |(SGRC_CONST-STAT_1)
|Open window, reload
2 |(SGRC_CONST-STAT_2)
|Open window, reload
3 |(SGRC_CONST-STAT_3)
|Reload
4 |(SGRC_CONST-STAT_4)
|Reload
5 |(SGRC_CONST-STAT_5)
|Reload
6 |(SGRC_CONST-STAT_6)
|Reload
R |(SGRC_CONST-STAT_R)
|Reload
The text in the status line can be set for this.
Parameter for closing a window when dependent windows are closed;comp. dialog programming.

Description
If the identifier is initial, the graphic does not wait for input, butimmediately passes control to ABAP. This can be used to update thegraphics.
If the window ID is set, it must be called 'BARCx'. The followingvalues are available for x: SPACE, 1 thru to 9 and A thru to Z. Comp.dialog programming.
Table of the graphic objects in the table area (boxes) to be insertedin the graphic.
Table structure:
---------------
ID = Identification
The identification should start with 1 and be numbered
sequentially.
TYPE = Type of the graphic object. All possible entries are
listed below.
TYPE|Name or Meaning |Constants in LBARCCON
----+----------------------------------------+----------------------
B |Graphic object (border box) |BC_CONST-BORDER_BOX
|for the chart header |
R |Graphic object (row box) for the table |BC_CONST-ROW_BOX
|area header and the individual graphic |
|objects in the table area |
C |Column box |BC_CONST-COLUMN_BOX
The constants listed are in the include 'LBARCCON'
CHART_ID = ID of the chart in which the grpahic object should
be inserted
FORM_TYPE = Form type of the graphic object
The form types are maintained during customizing. If the
form type defined here does not exist in the specified
graphics profile, the default form type (00) is used.
COLOR_TYPE = Color type of the box
The color types are maintained during customizing. If the
color type defined here does not exist in the specified
graphics profile, the standard color type (00) is used.
Attributes of the graphic objects in the table area (boxes).
Table structure:
---------------
ID = Identification of the graphic object
FL = Type of the attribute
VAL = Value of the attribute
All the possible attribute types and the resulting attribute values arelisted in table form below.
FL | VAL |Constants in LBARCCON
---------+----------------------------------+--------------------------
'0' |Any 40-character text |
'1'-'99' |Any 40-character text |
'S' |'1' = graphic object mark |BC_CONST-SELECTED_BOX
|'0' = cancel mark
'L' |Line color of the graphic object |BC_CONST-LINE_COLOR
'B' |Backgr. color of the graphic obj. |BC_CONST-BACKGROUND_COLOR
'F' |Form type of the row box |BC_CONST-FORM_TYPE
'FB' |Form type of the border box |
'h' |Color type of the graphic object |BC_CONST-COLOR_TYPE
'C' |Field/field color, e.g. a/GREEN |BC_CONST-FIELD_COLOR
'?' |Object-specific menu |BC_CONST-SET_MENU
'@' |Edit object |
'i' |Hotspot |
Notes:
Constants are provided in the Include 'LBARCCON' for the attributetypes.
Edit objects control whether the fields of the box can be edited andare created with PERFORM ADD_EDITOBJECT(SAPLBARC), see LBARCF03.
Hotspots require you to specify the text container reserved for themand the symbol in VAL in the form 'text container/symbol'.
The following curve types are provided:
Type |Value |Constant
----------------+--------+---------------------------
Line |'l' |BC_CONST-LINE_CURVE
Capacity curve |'c' |BC_CONST-CAPACITY_CURVE
Step curve |'s' |BC_CONST-STEP_CURVE
In a line curve, lines are drawn between the supporting points.
A capacity curve is a histogram in which the given height at thesupporting point is assumed.
A step curve is a histogram in which the jump to the value given at thesupporting point is defined between two supporting points.
Curves can have the following attributes:
Value |Constant |Meaning
-----------+------------------------+----------------------------------
'0' -'1000'| |Supporting points, start with '0'
| | (VAL1 = x-axis, VAL2 = y-axis)
'h' |BC_CONST-COLOR_TYPE |Color type
'p' |BC_CONST-CURVE_PRIORITY |Drawing level
'f' |BC_CONST-FILL |Fill the surface between x-axis
| |and curve ('x'= yes, SPACE = no)
'd' |BC_CONST-FILL_DELTA |Fill the deltas between two curves
| |(VAL1 = second curve, VAL2 empty)
'a' |BC_CONST-ADD_CURVE |Add two curves graphically
| |(VAL1 = second curve, VAL2 empty)
'?' |BC_CONST-SET_MENU |Object-specific menu
'k' | |Cumulate the curve values
| | ('X'=yes, SPACE=no)
Table of objects to be deleted in the graphics.
Table structure:
---------------
CHART_ID = Identification of the chart to which the object is assigned
OBJ_TYPE = Type of the object
OBJ_ID = Identification of the object to be deleted
All the possible object types which can be deleted with the DELETIONS
table are listed below.
OBJ_TYPE|Meaning |Constants in LBARCCON
--------+---------------------------------+---------------------------
'B' |Graphic obj. in table area (box) |BC_CONST-BOX_OBJECT
'C' |Charts |BC_CONST-CHART_OBJECT
'D' |Date lines |BC_CONST-DATELINE_OBJECT
'G' |Grids |BC_CONST-GRID_OBJECT
'N' |Graphic obj. in chart area (node)|BC_CONST-NODE_OBJECT
'R' |Ribbons |BC_CONST-RIBBON_OBJECT
'K' |Links |BC_CONST-LINK_OBJECT
'c' |Curves (also 'V' or'v') |BC_CONST-CURVE_OBJECT
'A' |Calendar |BC_CONST-CALENDAR_OBJECT
'S' |Summary nodes |BC_CONST-SUMMARY_NODE_OBJECT
'I' |Time interval |BC_CONST-INTERVALL_OBJECT
'E' |Time object |BC_CONST-TIME_OBJECT
'X' |Axis |
't' |Vertical section (for curve) |
'z' |Row; height = 0 |
'm' |Row; move following rows |
Note:
The given constants are provided for the above object types (OBJ_TYPE)in the include 'LBARCCON'.
Table of the links to be inserted in the graphic
Table structure:
---------------
ID = Identification of the link
The link identification should start with 1 and be
numbered sequentially.
CHART_ID = ID of the chart in which the link should be inserted.
NODEPRE_ID = Identification of the predecessor object
NODESUC_ID = Identification of the successor object
FORM_TYPE = Form type of the node
The form types are maintained during customizing. If the
form type defined here does not exist in the graphics
profile, the standard form type (00) is used.
COLOR_TYPE = Color type of the node
The color type is maintained during customizing. If the
color type defined here does not exist in the graphics
profile, the standard color type (00) is used.
AOB = Type of relationship
The following values can be used here:
Value| Identification |Constant in LBARCCON
-----+-------------------+---------------------
AA | Starting seq. | BC_CONST-LINK_AOB_AA
AE | Starting-end seq. | BC_CONST-LINK_AOB_AE
EA | End-starting seq. | BC_CONST-LINK_AOB_EA
EE | End seq. | BC_CONST-LINK_AOB_EE
If no relationship is defined and the link attributes do not define thecourse of the link, a normal sequence is always inserted. The course ofa link with the above-specified relationships is described below:
Starting seq.(AOB = AA): End seq. (AOB = EE):
+---------------+ +---------------+
| | | |
+---+ +---+ +---+ +---+
| | | | | | | |
+---+ +---+ +---+ +---+
End-starting seq.(AOB = EA): Starting-end seq.(AOB = AE):
+-----------+ +-------------------+
| | | |
+---+ +---+ +---+ +---+
| | | | | | | |
+---+ +---+ +---+ +---+
Attributes of links.
Table structure:
--------------
ID = Identification of the link
CHART_ID = Identification of the chart in which the link should be
inserted
FL = Type of the attribute
VAL = Value of the attribute
All the possible values for the type and value of the attribute, itsmeaning and the constants reserved for it are listed below.
FL |VAL |Constant
---+-----------------------------------------+--------------------------
h |Color type of the link |BC_CONST-COLOR_TYPE
P |ID of the predecessor object of the link |BC_CONST-LINK_PREDECESSOR
S |ID of the successor object of the link |BC_CONST-LINK_SUCCESSOR
V |1 = visible (=default) 0 = invisible |BC_CONST-LINK_VISIBILITY
T |1 = orthogonal (=default) 0 = diagonal |BC_CONST-LINK_TYPE
Y |Values between 0 and 20 see port area |BC_CONST-LINK_PORT
L |Lowest prio.: 0, highest prio.: 128 |BC_CONST-LINK_PRIORITY
b |Value 0 - 128 defines arrow form at link |BC_CONST-LINK_BEGIN
e |Value 0 - 128 defines arrow form at link |BC_CONST-LINK_END
? |Object-specific menu |BC_CONST-SET_MENU
a |Start layer of link |BC_CONST-START_LAYER
z |End layer of link |BC_CONST-END_LAYER
m |Mark link with VAL = '1' |BC_CONST-MARK_LINK
|Unmark link with VAL = '0'
Port calculation
------------------
The port defines the position at which the link begins on thepredecessor object and where it leads to the successor object. Thisalso defines the type of relationship. In a port calculation, you haveto define the following for the predecessor and successor objects:
Predecessor: Successor:
+-----+ +-----+
| 1 | Link | 1 |
|0 2|--------------------------|0 2|
| 3 | | 3 |
+-----+ +-----+
The numbers within the object are used for the port calculation. Inorder to generate a link as displayed above, you must calculate theport according to the following formula:
Port = ( * 4 ) +
The port for the above link is calculated as follows:
Port = ( 2 * 4 ) + 0 = 8
Since the starting sequences, end sequences or jump sequences wouldalways start in the middle of the node in this way, there are specialports available which are described below:
Starting seq. with port 16: Starting seq. with port 17:
Constant: BC_CONST-LINK_PORT_16 Constant: BC_CONST-LINK_PORT_17
+---------------+ +---------------+
| | | |
+---+ +---+ +---+ +---+
| | | | | | | |
+---+ +---+ +---+ +---+
End seq. with port 18: End seq. with port 19:
Constant: BC_CONST-LINK_PORT_16 Constant: BC_CONST-LINK_PORT_17
+---------------+ +---------------+
| | | |
+---+ +---+ +---+ +---+
| | | | | | | |
+---+ +---+ +---+ +---+
End-start seq. with port 20: End-start seq. with port 21:
Constant: BC_CONST-LINK_PORT_16 Constant: BC_CONST-LINK_PORT_17
+-----------+ +-----------+
| | | |
+---+ +---+ +---+ +---+
| | | | | | | |
+---+ +---+ +---+ +---+
Start-end seq. with port 22 Start-end seq. with port 23/24
Constant: BC_CONST-LINK_PORT_16 Constant: BC_CONST-LINK_PORT_17
+-------------------+ +-------------------+
| | | |
+---+ +---+ +---+ +---+
| | | | | | | |
+---+ +---+ +---+ +---+
The relationship defined in the table links is converted to thefollowing ports:
AOB |Identification |Port |Constants in LBARCCON
----+-----------------+-----+-------------------------------------
AA |Starting seq. |16 |BC_CONST-LINK_PORT_16
EE |End seq. |18 |BC_CONST-LINK_PORT_18
AE |Start-end seq. |22 |BC_CONST-LINK_PORT_22
EA |End-start seq. |20 |BC_CONST-LINK_PORT_20
If you want to deviate from these default settings, the port of a linkmust be set explicitly as described above.
Table of the nodes to be inserted in the graphic.
Table structure:
---------------
ID = Identification of the node
The node identification should start with 1
and be numbered sequentially.
CHART_ID = ID of the chart in which the node should be inserted.
FORM_TYPE = Form type of the node
The form type is maintained during customizing. If the
form type defined here does not exist in the graphics
profile, the default form type (00) is used.
COLOR_TYPE = Color type of the node
The color type is maintained during customizing. If the
color type defined here does not exist in the graphics
profile, the default color type (00) is used.
Attributes of the nodes.
Table structure:
---------------
ID = ID of the node
CHART_ID = ID of the chart
FL = Type of the attribute
VAL = Values of the attribute
All the possible attribute types and the resulting attribute values aswell as the constants provided for the attribute types in the Includefile LBARCCON are listed in table form below.
FL | VAL |Constants in LBARCCON
--------+-----------------------------------------------------------
'A' |Set layer type |BC_CONST-ADD_LAYER
'R' |Remove layer type |BC_CONST-REMOVE_LAYER
'S' |'1' --> selects or |BC_CONST-SELECTED_NODE
|'0' --> cancels selection |
'C' |Set calendar |BC_CONST-SET_CALENDAR
'D' |Remove calendar |BC_CONST-REMOVE_CALENDAR
'M' |Macro |BC_CONST-ADD_MAKRO
'0' |Text |
'1'-'99'|Text or date |
'F' |Form type |BC_CONST-FORM_TYPE
'P' |Priority of sequence |BC_CONST-NODE_PRIORITY
'E' |Priority of character |
'?' |Object-specific menu |BC_CONST-SET_MENU
Notes:
Layer type: The layer types are maintained during customizing. If a
layer type that is defined here does not exist, the default
layer type (00) will be used.
Date: Has the form 'DD:MM:YYYY:HH:MM:SS' or specified as an
integer. The macro CONVERT_DATE or CONVERT_DATE_TO_INT
can be used in the include IBARCMAK to convert the macro.
Priority of sequence:
To control the order of the nodes within an expanded line.
Value range: -128 to +128.
Priority of character:
Position of overlying nodes.
Value range: -128 to +128.
Calendar: Only one calendar may be set for each node.
-> Uniqueness
Grouping:
The nodes are grouped according to the group specified in VAL. When youmove one node in a group, the whole group is moved. A prerequisite forthis is that you need to be able to move multiple nodes at the sametime ('BARC_SET_OPTIONS', parameter MULTMOVE <> '0').
Positions (lines) of the objects.
Table structure:
---------------
CHART_ID = ID of the chart
OBJ_TYPE = Object type
OBJ_ID = ID of the object
ROW_NUMBER = Row number for positioning the objects
All the possible values for the field OBJ_TYPE, their meaning and theconstants provided in the Include file LBARCCON are listed below.
OBJ_TYPE |Meaning |Constant in LBARCCON
---------+-------------------------------+--------------------------
'B' |Box |BC_CONST-BOX_OBJECT
'N' |Nodes |BC_CONST-NODE_OBJECT
'c' |Curve |BC_CONST-CURVE_OBJECT
'a' |Axis |BC_CONST-AXIS_OBJECT
'S' |Sum nodes |BC_CONST-SUMMARY_NODE_OBJECT
'G' |Grid |BC_CONST-GRID_OBJECT
'x' |Before row |
'y' |After row |
'z' |Exchange lines |
'v' |Move in row |
Note:
The positions of the curves must be sent prior to the positions of theaxes, and the positions of the boxes must be sent prior to thepositions of the boxes, otherwise the display does not function.
For 'x', 'y', 'z', the OBJ_ID is interpreted as row number (from).
For 'v', all objects in a row are moved to another position. Enter thebox ID as OBJ_ID. You can use this function only when all objects havealready been positioned. Use this function for all rows in the chart.