Oracle
®
Developer
Graphics Builder
Reference
RELEASE 6.0
March, 1999
Part No. A66594-04
Enabling the Information Age
™
Through Network Computing
Oracle
®
Developer Graphics Builer Reference Release 6.0
The part number for this volume is A66594-04
Copyright © 1999, Oracle Corporation. All rights reserved.
Portions copyright © Blue Sky Software Corporation. All rights reserved.
Contributors: Fred Bethke, Kenneth Chu, Eric Greenbaum, Leanne Soylemez, Tony Wolfram
The programs are not intended for use in any nuclear, aviation, mass transit, medical, or
other inherently dangerous applications. It shall be licensee's responsibility to take all
appropriate fail-safe, back up, redundancy and other measures to ensure the safe use of
such applications if the Programs are used for such purposes, and Oracle disclaims liability
for any damages caused by such use of the Programs.
This Program contains proprietary information of Oracle Corporation; it is provided under a
license agreement containing restrictions on use and disclosure and is also protected by
copyright, patent and other intellectual property law. Reverse engineering of the software is
prohibited.
The information contained in this document is subject to change without notice. If you find
any problems in the documentation, please report them to us in writing. Oracle Corporation
does not warrant that this document is error free. No part of this document may be
reproduced or transmitted in any form or by any means, electronic or mechanical, for any
purpose, without the express written permission of Oracle Corporation
If this Program is delivered to a U.S. Government Agency of the Department of Defense, then
it is delivered with Restricted Rights and the following legend is applicable:
Restricted Rights Legend Programs delivered subject to the DOD FAR Supplement are
"commercial computer software" and use, duplication and disclosure of the Programs shall be
subject to the licensing restrictions set forth in the applicable Oracle license agreement.
Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted
computer software" and use, duplication and disclosure of the Programs shall be subject to the
restrictions in FAR 52.227-14, Rights in Data -- General, including Alternate III (June 1987).
Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065.
Oracle is a registered trademark, and Oracle Developer, Express, Oracle Browser, Oracle
Forms, Oracle Graphics, Oracle Installer, Oracle Reports, Oracle7, Oracle8, Oracle Web
Application Server, Personal Oracle, Personal Oracle Lite, and PL/SQL are trademarks or
registered trademarks of Oracle Corporation. All other company or product names mentioned
are used for identification purposes only and may be trademarks of their respective owners.
i
Table of Contents
BUILT INS............................................................................................................................ 1
C
HART
B
UILT
-
INS
.......................................................................................................... 1
OG_D
ELETE
_C
OLUMN
................................................................................................. 1
OG_D
ELETE
_F
IELD
....................................................................................................... 2
OG_G
ET
_C
HART
_E
LEMENT
......................................................................................... 2
OG_G
ET
_C
OLUMN
....................................................................................................... 3
OG_G
ET
_F
IELD
............................................................................................................. 4
OG_G
ET
_R
OW
.............................................................................................................. 4
OG_I
NSERT
_F
IELD
........................................................................................................ 5
OG_M
AKE
_C
HART
....................................................................................................... 6
OG_U
PDATE
_C
HART
.................................................................................................... 6
D
ATABASE
B
UILT
-
INS
.................................................................................................... 8
OG_C
ONNECT
............................................................................................................... 8
OG_L
OGGED
_O
N
.......................................................................................................... 8
OG_L
OGOFF
.................................................................................................................. 9
OG_L
OGON
................................................................................................................... 9
D
ISPLAY
B
UILT
-
INS
...................................................................................................... 10
OG_C
LOSE
_D
ISPLAY
.................................................................................................. 10
OG_G
ENERATE
_D
ISPLAY
........................................................................................... 11
OG_G
ET
_D
ISPLAY
...................................................................................................... 11
OG_I
SNULL
................................................................................................................. 12
OG_O
PEN
_D
ISPLAY
.................................................................................................... 14
OG_S
AVE
_D
ISPLAY
.................................................................................................... 15
G
RAPHIC
O
BJECT
B
UILT
-
INS
....................................................................................... 16
OG_C
LONE
(O
BJECT
).................................................................................................. 17
OG_D
AMAGE
(O
BJECT
) .............................................................................................. 17
OG_D
ELETE
_C
HILD
.................................................................................................... 18
OG_D
ELETE
_C
MPTEXT
............................................................................................... 19
OG_D
ELETE
_P
OINT
.................................................................................................... 20
OG_D
ELETE
_P
ROPERTY
.............................................................................................. 20
OG_D
ELETE
_S
MPTEXT
................................................................................................ 22
OG_D
ESTROY
(O
BJECT
) .............................................................................................. 23
OG_D
RAW
................................................................................................................... 24
OG_E
XPORT
_D
RAWING
(D
ISPLAY
)............................................................................ 24
OG_E
XPORT
_D
RAWING
(O
BJECT
/L
AYER
) ................................................................ 27
OG_E
XPORT
_D
RAWING
(W
INDOW
).......................................................................... 29
OG_E
XPORT
_I
MAGE
................................................................................................... 31
OG_G
ET
_C
HAR
_P
ROPERTY
....................................................................................... 34
OG_G
ET
_C
HILD
.......................................................................................................... 35
OG_G
ET
_C
MPTEXT
..................................................................................................... 35
OG_G
ET
_D
ATE
_P
ROPERTY
........................................................................................ 36
OG_G
ET
_N
UM
_P
ROPERTY
......................................................................................... 37
OG_G
ET
_O
BJECT
........................................................................................................ 37
OG_G
ET
_P
OINT
.......................................................................................................... 38
OG_G
ET
_S
MPTEXT
...................................................................................................... 39
OG_I
MPORT
_D
RAWING
.............................................................................................. 40
OG_I
MPORT
_I
MAGE
................................................................................................... 41
OG_I
NSERT
_C
HILD
..................................................................................................... 43
OG_I
NSERT
_C
MPTEXT
................................................................................................ 44
ii
OG_I
NSERT
_P
OINT
..................................................................................................... 45
OG_I
NSERT
_S
MPTEXT
................................................................................................. 46
OG_M
AKE
_E
LLIPSE
.................................................................................................... 47
OG_M
AKE
_G
ROUP
..................................................................................................... 48
OG_M
AKE
_I
MAGE
...................................................................................................... 48
OG_M
AKE
_L
INE
......................................................................................................... 49
OG_M
AKE
_P
OLY
........................................................................................................ 50
OG_M
AKE
_R
ECT
........................................................................................................ 50
OG_M
AKE
_R
RECT
...................................................................................................... 51
OG_M
AKE
_S
YMBOL
................................................................................................... 52
OG_M
AKE
_T
EXT
......................................................................................................... 52
OG_M
OVE
................................................................................................................... 53
OG_P
OINT
_I
N
............................................................................................................. 54
OG_P
OINT
_N
EAR
....................................................................................................... 55
OG_P
ROPERTY
_E
XISTS
............................................................................................... 56
OG_R
OTATE
................................................................................................................ 57
OG_S
AME
.................................................................................................................... 58
OG_S
CALE
................................................................................................................... 59
OG_S
ET
_E
DGECOLOR
................................................................................................. 60
OG_S
ET
_F
ILLCOLOR
................................................................................................... 61
OG_S
ET
_P
ROPERTY
.................................................................................................... 61
OG_S
YNCHRONIZE
..................................................................................................... 62
OG_U
PDATE
_B
BOX
..................................................................................................... 63
L
AYER
B
UILT
-
INS
......................................................................................................... 64
OG_A
CTIVATE
_L
AYER
............................................................................................... 64
OG_G
ET
_L
AYER
......................................................................................................... 65
OG_H
IDE
_L
AYER
........................................................................................................ 66
OG_S
HOW
_L
AYER
...................................................................................................... 66
M
ISCELLANEOUS
B
UILT
-
INS
........................................................................................ 67
DO_SQL...................................................................................................................... 68
OG_A
PPEND
_D
IRECTORY
.......................................................................................... 68
OG_A
PPEND
_F
ILE
...................................................................................................... 69
OG_C
ENTER
................................................................................................................ 70
OG_D
AMAGE
(R
EGION
) ............................................................................................. 71
OG_G
ET
_A
TTR
(A
PPLICATION
)................................................................................. 72
OG_G
ET
_A
TTR
(A
XIS
)................................................................................................ 72
OG_G
ET
_A
TTR
(D
ISPLAY
).......................................................................................... 73
OG_G
ET
_A
TTR
(F
IELD
T
EMPLATE
)............................................................................ 73
OG_G
ET
_A
TTR
(F
RAME
T
EMPLATE
).......................................................................... 74
OG_G
ET
_A
TTR
(O
BJECT
)............................................................................................ 75
OG_G
ET
_A
TTR
(P
RINTER
).......................................................................................... 76
OG_G
ET
_A
TTR
(Q
UERY
) ............................................................................................ 76
OG_G
ET
_A
TTR
(R
EFERENCE
L
INE
)............................................................................ 77
OG_G
ET
_A
TTR
(S
OUND
)............................................................................................ 78
OG_G
ET
_A
TTR
(T
IMER
) ............................................................................................. 78
OG_G
ET
_A
TTR
(W
INDOW
) ........................................................................................ 79
OG_G
ET
_B
UTTONPROC
.............................................................................................. 79
OG_H
ELP
.................................................................................................................... 80
OG_H
OST
.................................................................................................................... 81
OG_P
AUSE
................................................................................................................... 82
OG_P
RINT
................................................................................................................... 83
OG_Q
UIT
..................................................................................................................... 83
iii
OG_R
OOT
_O
BJECT
...................................................................................................... 84
OG_S
ET
_A
TTR
(A
PPLICATION
).................................................................................. 84
OG_S
ET
_A
TTR
(A
XIS
)................................................................................................. 85
OG_S
ET
_A
TTR
(C
HART
E
LEMENT
) ............................................................................ 85
OG_S
ET
_A
TTR
(D
ISPLAY
)........................................................................................... 86
OG_S
ET
_A
TTR
(F
IELD
T
EMPLATE
)............................................................................. 87
OG_S
ET
_A
TTR
(F
RAME
T
EMPLATE
)........................................................................... 88
OG_S
ET
_A
TTR
(O
BJECT
)............................................................................................. 88
OG_S
ET
_A
TTR
(P
RINTER
)........................................................................................... 90
OG_S
ET
_A
TTR
(Q
UERY
) ............................................................................................. 90
OG_S
ET
_A
TTR
(R
EFERENCE
L
INE
)............................................................................. 91
OG_S
ET
_A
TTR
(S
OUND
)............................................................................................. 91
OG_S
ET
_A
TTR
(T
IMER
) .............................................................................................. 92
OG_S
ET
_A
TTR
(W
INDOW
)......................................................................................... 93
OG_T
RANSLATE
_E
NVVAR
.......................................................................................... 93
OG_U
SER
_E
XIT
........................................................................................................... 94
P
ARAMETER
B
UILT
-
INS
................................................................................................ 95
OG_D
ELETE
_P
ARAM
.................................................................................................. 95
OG_G
ET
_C
HAR
_P
ARAM
............................................................................................ 96
OG_G
ET
_D
ATE
_P
ARAM
............................................................................................. 96
OG_G
ET
_N
UM
_P
ARAM
............................................................................................. 97
OG_G
ET
_P
ARAM
_T
YPE
.............................................................................................. 97
OG_P
ARAM
_E
XISTS
.................................................................................................... 98
OG_S
ET
_P
ARAM
......................................................................................................... 99
Q
UERY
B
UILT
-
INS
...................................................................................................... 100
OG_A
PPEND
_R
OW
................................................................................................... 100
OG_C
LEAR
_Q
UERY
.................................................................................................. 101
OG_D
ATA
_C
HANGED
.............................................................................................. 102
OG_D
ATA
_Q
UERIED
................................................................................................ 103
OG_D
ESTROY
(Q
UERY
)............................................................................................. 104
OG_E
XECUTE
_Q
UERY
............................................................................................... 105
OG_G
ET
_C
HARCELL
................................................................................................ 106
OG_G
ET
_D
ATECELL
................................................................................................. 107
OG_G
ET
_N
EWROWS
................................................................................................. 107
OG_G
ET
_N
UMCELL
.................................................................................................. 108
OG_G
ET
_Q
UERY
....................................................................................................... 109
OG_G
ET
_S
CHEMA
.................................................................................................... 110
OG_I
NSERT
_C
OLUMN
.............................................................................................. 110
OG_M
AKE
_Q
UERY
................................................................................................... 112
OG_N
EXT
_R
OW
........................................................................................................ 113
OG_N
UMCOLS
.......................................................................................................... 114
OG_N
UMROWS
......................................................................................................... 115
OG_S
ET
_C
HARCELL
................................................................................................. 116
OG_S
ET
_D
ATECELL
.................................................................................................. 117
OG_S
ET
_N
UMCELL
................................................................................................... 117
OG_S
ET
_S
CHEMA
..................................................................................................... 118
OG_S
TART
_F
ROM
..................................................................................................... 119
S
OUND
B
UILT
-
INS
...................................................................................................... 120
OG_D
ESTROY
(S
OUND
) ............................................................................................ 120
OG_E
XPORT
_S
OUND
................................................................................................ 121
OG_G
ET
_S
OUND
...................................................................................................... 122
OG_I
MPORT
_S
OUND
................................................................................................ 122
iv
OG_M
AKE
_S
OUND
................................................................................................... 124
OG_P
LAY
_S
OUND
.................................................................................................... 125
OG_R
ECORD
_S
OUND
............................................................................................... 126
OG_S
TOP
_S
OUND
..................................................................................................... 126
T
EMPLATE
B
UILT
-
INS
................................................................................................. 127
OG_C
LONE
(T
EMPLATE
)........................................................................................... 127
OG_D
ELETE
_F
TEMP
.................................................................................................. 128
OG_D
ELETE
_R
EFLINE
............................................................................................... 129
OG_D
ESTROY
(T
EMPLATE
)....................................................................................... 130
OG_E
XPORT
_T
EMPLATE
........................................................................................... 131
OG_G
ET
_A
XIS
........................................................................................................... 132
OG_G
ET
_F
TEMP
........................................................................................................ 132
OG_G
ET
_R
EFLINE
..................................................................................................... 133
OG_G
ET
_T
EMPLATE
................................................................................................. 134
OG_I
MPORT
_T
EMPLATE
........................................................................................... 134
OG_I
NSERT
_F
TEMP
................................................................................................... 135
OG_I
NSERT
_R
EFLINE
................................................................................................ 137
OG_M
AKE
_T
EMPLATE
............................................................................................. 138
T
IMER
B
UILT
-
INS
........................................................................................................ 140
OG_A
CTIVATE
_T
IMER
.............................................................................................. 140
OG_D
EACTIVATE
_T
IMER
......................................................................................... 140
OG_D
ESTROY
(T
IMER
).............................................................................................. 141
OG_G
ET
_T
IMER
........................................................................................................ 142
OG_M
AKE
_T
IMER
.................................................................................................... 142
TOOLS_INT B
UILT
-
INS
............................................................................................ 143
TOOL_INT.ADD_PARAMETER .......................................................................... 143
TOOL_INT.CREATE_PARAMETER_LIST.......................................................... 144
TOOL_INT.DELETE_PARAMETER .................................................................... 145
TOOL_INT.DESTROY_PARAMETER_LIST....................................................... 146
TOOL_INT.GET_PARAMETER_ATTR ............................................................... 147
TOOL_INT.GET_PARAMETER_LIST.................................................................. 148
TOOL_INT.ISNULL................................................................................................ 148
TOOL_INT.RUN_PRODUCT................................................................................ 149
TOOL_INT.SET_PARAMETER_ATTR ................................................................ 151
W
INDOW
B
UILT
-
INS
.................................................................................................. 152
OG_D
ESTROY
(W
INDOW
)......................................................................................... 152
OG_G
ET
_W
INDOW
................................................................................................... 153
OG_H
IDE
_W
INDOW
................................................................................................. 153
OG_M
AKE
_W
INDOW
............................................................................................... 154
OG_S
HOW
_W
INDOW
............................................................................................... 155
PROPERTIES................................................................................................................... 157
A
PPLICATION
P
ROPERTIES
........................................................................................ 157
C
ONNECTION
S
TRING
P
ROPERTY
............................................................................. 157
C
URSOR
P
ROPERTY
.................................................................................................... 158
H
ORIZONTAL
L
AYOUT
R
ESOLUTION
P
ROPERTY
...................................................... 159
H
ORIZONTAL
S
CREEN
R
ESOLUTION
P
ROPERTY
....................................................... 159
P
ASSWORD
P
ROPERTY
............................................................................................... 160
P
LATFORM
P
ROPERTY
............................................................................................... 160
U
SERNAME
P
ROPERTY
............................................................................................... 161
V
ERTICAL
L
AYOUT
R
ESOLUTION
P
ROPERTY
............................................................ 162
V
ERTICAL
S
CREEN
R
ESOLUTION
P
ROPERTY
............................................................. 162
A
RC
P
ROPERTIES
........................................................................................................ 162
v
B
ASE
A
RC
P
ROPERTY
................................................................................................. 163
C
LOSURE
P
ROPERTY
.................................................................................................. 164
F
ILL
P
ROPERTY
.......................................................................................................... 165
A
XIS
(D
ATE
) P
ROPERTIES
.......................................................................................... 166
A
UTO
M
AXIMUM
P
ROPERTY
..................................................................................... 166
A
UTO
M
INIMUM
P
ROPERTY
...................................................................................... 168
A
UTO
S
TEP
P
ROPERTY
............................................................................................... 169
C
USTOM
F
ORMAT
P
ROPERTY
.................................................................................... 170
D
AY
F
ORMAT
P
ROPERTY
........................................................................................... 171
F
IRST
M
ONTH
P
ROPERTY
.......................................................................................... 172
L
ABELS
P
ROPERTY
..................................................................................................... 173
M
AXIMUM
P
ROPERTY
................................................................................................ 175
M
INIMUM
P
ROPERTY
................................................................................................. 176
M
ONTH
F
ORMAT
P
ROPERTY
..................................................................................... 177
Q
UARTER
F
ORMAT
P
ROPERTY
.................................................................................. 178
S
KIP
W
EEKENDS
P
ROPERTY
...................................................................................... 179
S
TEP
P
ROPERTY
.......................................................................................................... 180
Y
EAR
F
ORMAT
P
ROPERTY
......................................................................................... 181
A
XIS
(G
ENERIC
) P
ROPERTIES
.................................................................................... 182
A
XIS
L
ABEL
P
ROPERTY
.............................................................................................. 182
A
XIS
T
YPE
P
ROPERTY
................................................................................................ 184
C
USTOM
L
ABEL
P
ROPERTY
........................................................................................ 185
D
IRECTION
P
ROPERTY
............................................................................................... 186
M
AJOR
G
RID
P
ROPERTY
............................................................................................ 187
M
AJOR
T
ICKS
P
ROPERTY
........................................................................................... 188
M
INOR
G
RID
P
ROPERTY
............................................................................................ 189
M
INOR
T
ICKS
P
ROPERTY
........................................................................................... 190
M
INOR
T
ICKS
P
ER
I
NTERVAL
P
ROPERTY
.................................................................. 191
P
OSITION
P
ROPERTY
.................................................................................................. 192
T
ICK
L
ABEL
R
OTATION
P
ROPERTY
........................................................................... 193
T
ICK
L
ABELS
P
ROPERTY
............................................................................................ 194
T
ICK
P
OSITION
P
ROPERTY
......................................................................................... 195
A
XIS
(D
ISCRETE
) P
ROPERTIES
................................................................................... 196
A
UTO
M
AXIMUM
P
ROPERTY
..................................................................................... 196
A
UTO
M
INIMUM
P
ROPERTY
...................................................................................... 197
D
ATE
F
ORMAT
P
ROPERTY
......................................................................................... 198
M
AXIMUM
N
UMBER OF
C
ATEGORIES
P
ROPERTY
..................................................... 199
M
INIMUM
N
UMBER OF
C
ATEGORIES
P
ROPERTY
...................................................... 200
N
UMBER
F
ORMAT
P
ROPERTY
.................................................................................... 201
A
XIS
(C
ONTINUOUS
) P
ROPERTIES
............................................................................. 202
A
UTO
M
AXIMUM
P
ROPERTY
..................................................................................... 202
A
UTO
M
INIMUM
P
ROPERTY
...................................................................................... 204
A
UTO
S
TEP
P
ROPERTY
............................................................................................... 205
M
AXIMUM
P
ROPERTY
................................................................................................ 206
M
INIMUM
P
ROPERTY
................................................................................................. 207
N
UMBER
F
ORMAT
P
ROPERTY
.................................................................................... 208
P
ERCENT BY
P
ROPERTY
............................................................................................. 209
P
ERCENT OF
P
ROPERTY
............................................................................................. 210
S
CALE
P
ROPERTY
....................................................................................................... 211
S
TEP
P
ROPERTY
.......................................................................................................... 212
C
HART
E
LEMENT
P
ROPERTIES
.................................................................................. 213
B
UTTON
P
ROCEDURE
P
ROPERTY
............................................................................... 213
vi
E
VENTS
P
ROPERTY
..................................................................................................... 215
E
XPLOSION
P
ROPERTY
............................................................................................... 216
N
AME
P
ROPERTY
....................................................................................................... 217
C
HART
P
ROPERTIES
................................................................................................... 218
A
UTO
U
PDATE
P
ROPERTY
......................................................................................... 218
E
ND
R
OW
P
ROPERTY
................................................................................................. 219
F
ILTER
P
ROPERTY
...................................................................................................... 220
Q
UERY
P
ROPERTY
...................................................................................................... 221
R
ANGE
P
ROPERTY
...................................................................................................... 222
S
IZE AND
P
OSITION
P
ROPERTY
................................................................................. 223
S
TART
R
OW
P
ROPERTY
.............................................................................................. 224
T
EMPLATE
P
ROPERTY
................................................................................................ 225
T
ITLE
P
ROPERTY
........................................................................................................ 226
C
OMPOUND
T
EXT
P
ROPERTIES
................................................................................. 227
S
IMPLE
T
EXT
C
OUNT
P
ROPERTY
............................................................................... 227
D
ISPLAY
P
ROPERTIES
................................................................................................. 228
C
LOSE
T
RIGGER
P
ROPERTY
....................................................................................... 228
D
ATE
F
ORMAT
P
ROPERTY
......................................................................................... 229
H
EIGHT
P
ROPERTY
.................................................................................................... 230
O
PEN
T
RIGGER
P
ROPERTY
......................................................................................... 230
W
IDTH
P
ROPERTY
...................................................................................................... 231
F
RAME
(A
XIS
C
HART
) P
ROPERTIES
........................................................................... 232
B
ASELINE
A
XIS
P
ROPERTY
......................................................................................... 232
B
ASELINE
V
ALUE
P
ROPERTY
..................................................................................... 233
C
ATEGORY
W
IDTH
P
ROPERTY
.................................................................................. 234
C
USTOM
D
ATE
F
ORMAT
P
ROPERTY
.......................................................................... 235
C
USTOM
N
UMBER
F
ORMAT
P
ROPERTY
..................................................................... 236
R
EFERENCE
L
INE
C
OUNT
P
ROPERTY
........................................................................ 237
S
ECOND
Y A
XIS
P
ROPERTY
....................................................................................... 238
F
RAME
(G
ENERIC
) P
ROPERTIES
................................................................................. 239
D
EPTH
S
IZE
P
ROPERTY
.............................................................................................. 239
F
IELD
T
EMPLATE
C
OUNT
P
ROPERTY
........................................................................ 241
F
RAME
T
YPE
P
ROPERTY
............................................................................................. 242
L
EGEND
P
ROPERTY
.................................................................................................... 243
L
EGEND
C
OLUMN
C
OUNT
P
ROPERTY
...................................................................... 244
N
AME
P
ROPERTY
....................................................................................................... 245
P
LOT
F
RAME
P
ROPERTY
............................................................................................ 246
R
OOT
P
ROPERTY
........................................................................................................ 247
S
HADOW
D
IRECTION
P
ROPERTY
............................................................................... 248
S
HADOW
S
IZE
P
ROPERTY
.......................................................................................... 249
F
RAME
(P
IE
C
HART
) P
ROPERTIES
............................................................................. 250
C
ATEGORIES
P
ROPERTY
............................................................................................. 250
C
ATEGORY
D
ATE
F
ORMAT
P
ROPERTY
...................................................................... 252
C
ATEGORY
N
UMBER
F
ORMAT
P
ROPERTY
................................................................. 253
D
ATA
V
ALUES
P
ROPERTY
.......................................................................................... 254
N
O
O
VERLAP
P
ROPERTY
........................................................................................... 255
O
THER
P
ROPERTY
...................................................................................................... 256
P
ERCENT
F
ORMAT
P
ROPERTY
................................................................................... 257
P
ERCENT
V
ALUES
P
ROPERTY
.................................................................................... 258
P
LOT
O
RDER
P
ROPERTY
............................................................................................ 259
T
ICKS
P
ROPERTY
........................................................................................................ 260
U
SAGE
P
ROPERTY
...................................................................................................... 261
vii
U
SAGE
V
ALUE
P
ROPERTY
.......................................................................................... 262
V
ALUE
F
ORMAT
P
ROPERTY
....................................................................................... 263
F
RAME
(T
ABLE
C
HART
) P
ROPERTIES
........................................................................ 264
A
UTO
M
AXIMUM
P
ROPERTY
..................................................................................... 264
A
UTO
M
INIMUM
P
ROPERTY
...................................................................................... 265
C
OLUMN
N
AMES
P
ROPERTY
..................................................................................... 266
G
RID
C
OUNT
P
ROPERTY
............................................................................................ 267
H
ORIZONTAL
G
RID
P
ROPERTY
................................................................................. 268
M
AXIMUM
N
UMBER OF
R
OWS
P
ROPERTY
................................................................ 269
M
INIMUM
N
UMBER OF
R
OWS
P
ROPERTY
................................................................. 270
V
ERTICAL
G
RID
P
ROPERTY
....................................................................................... 271
F
IELD
T
EMPLATE
(G
ENERIC
) P
ROPERTIES
................................................................ 272
C
OLOR
R
OTATION
P
ROPERTY
................................................................................... 272
D
ATE
F
ORMAT
P
ROPERTY
......................................................................................... 274
N
AME
P
ROPERTY
....................................................................................................... 275
N
UMBER
F
ORMAT
P
ROPERTY
.................................................................................... 276
R
OOT
P
ROPERTY
........................................................................................................ 277
F
IELD
T
EMPLATE
(A
XIS
C
HART
) P
ROPERTIES
.......................................................... 278
A
XIS
P
ROPERTY
.......................................................................................................... 278
C
URVE
F
IT
P
ROPERTY
................................................................................................ 279
L
ABEL
R
OTATION
P
ROPERTY
.................................................................................... 280
L
INE
S
TYLE
P
ROPERTY
............................................................................................... 281
O
VERLAP
P
ROPERTY
.................................................................................................. 282
P
LOT
P
OSITION
P
ROPERTY
........................................................................................ 283
P
LOT
T
YPE
P
ROPERTY
................................................................................................ 284
G
ENERIC
P
ROPERTIES
................................................................................................ 285
B
UTTON
P
ROCEDURE
P
ROPERTY
............................................................................... 286
C
OLUMN
P
ROPERTY
.................................................................................................. 287
E
VENTS
P
ROPERTY
..................................................................................................... 288
E
XECUTE
Q
UERY
P
ROPERTY
...................................................................................... 289
F
ORMAT
T
RIGGER
P
ROPERTY
.................................................................................... 290
H
IDE
O
BJECT
P
ROPERTY
............................................................................................ 291
I
NNER
B
OUNDING
B
OX
P
ROPERTY
........................................................................... 292
N
AME
P
ROPERTY
....................................................................................................... 293
O
BJECT
T
YPE
P
ROPERTY
............................................................................................ 294
O
UTER
B
OUNDING
B
OX
P
ROPERTY
........................................................................... 295
P
ARENT
P
ROPERTY
.................................................................................................... 296
S
ET
P
ARAMETER
P
ROPERTY
...................................................................................... 297
G
RAPHIC
P
ROPERTIES
................................................................................................ 298
B
ACKGROUND
E
DGE
C
OLOR
P
ROPERTY
................................................................... 298
B
ACKGROUND
F
ILL
C
OLOR
P
ROPERTY
..................................................................... 300
B
EVEL
S
TYLE
P
ROPERTY
............................................................................................ 301
C
AP
S
TYLE
P
ROPERTY
................................................................................................ 302
D
ASH
S
TYLE
P
ROPERTY
............................................................................................. 303
E
DGE
P
ATTERN
P
ROPERTY
........................................................................................ 304
E
DGE
W
IDTH
P
ROPERTY
........................................................................................... 305
F
ILL
P
ATTERN
P
ROPERTY
.......................................................................................... 306
F
OREGROUND
E
DGE
C
OLOR
P
ROPERTY
................................................................... 306
F
OREGROUND
F
ILL
C
OLOR
P
ROPERTY
..................................................................... 307
J
OIN
S
TYLE
P
ROPERTY
............................................................................................... 308
R
OTATION
A
NGLE
P
ROPERTY
................................................................................... 309
T
RANSFER
M
ODE
P
ROPERTY
..................................................................................... 310
viii
G
ROUP
P
ROPERTIES
................................................................................................... 311
C
HILD
C
OUNT
P
ROPERTY
......................................................................................... 311
C
LIP
F
LAG
P
ROPERTY
................................................................................................ 312
I
MAGE
P
ROPERTIES
.................................................................................................... 313
C
LIP
R
ECTANGLE
P
ROPERTY
..................................................................................... 313
D
ITHER
P
ROPERTY
..................................................................................................... 314
H
EIGHT
P
ROPERTY
.................................................................................................... 315
P
OSITION
P
ROPERTY
.................................................................................................. 316
Q
UALITY
P
ROPERTY
.................................................................................................. 317
W
IDTH
P
ROPERTY
...................................................................................................... 318
L
INE
P
ROPERTIES
....................................................................................................... 319
A
RROW
S
TYLE
P
ROPERTY
.......................................................................................... 319
E
ND
P
OINT
P
ROPERTY
............................................................................................... 320
S
TART
P
OINT
P
ROPERTY
............................................................................................ 321
P
OLYGON
P
ROPERTIES
.............................................................................................. 322
C
LOSURE
P
ROPERTY
.................................................................................................. 322
P
OINT
C
OUNT
P
ROPERTY
.......................................................................................... 323
P
RINTER
P
ROPERTIES
P
ROPERTY
............................................................................... 324
C
OPIES
P
ROPERTY
...................................................................................................... 324
E
ND
P
AGE
P
ROPERTY
................................................................................................ 325
L
ANDSCAPE
P
ROPERTY
............................................................................................. 326
N
AME
P
ROPERTY
....................................................................................................... 327
P
AGE
S
IZE
P
ROPERTY
................................................................................................ 328
P
RINT
F
ILE
P
ROPERTY
............................................................................................... 329
S
TART
P
AGE
P
ROPERTY
............................................................................................. 330
Q
UERY
P
ROPERTIES
................................................................................................... 331
C
ACHE
T
YPE
P
ROPERTY
............................................................................................ 331
C
USTOM
Q
UERY
P
ROCEDURE
P
ROPERTY
................................................................. 332
D
ATE
F
ORMAT
P
ROPERTY
......................................................................................... 333
E
XECUTE ON
O
PEN
P
ROPERTY
.................................................................................. 334
E
XECUTE ON
T
IMER
P
ROPERTY
................................................................................. 335
M
AXIMUM
R
OWS
P
ROPERTY
..................................................................................... 336
M
AXIMUM
R
OWS
F
LAG
P
ROPERTY
........................................................................... 337
N
AME
P
ROPERTY
....................................................................................................... 338
P
OST
-Q
UERY
T
RIGGER
P
ROCEDURE
P
ROPERTY
....................................................... 339
Q
UERY
S
OURCE
P
ROPERTY
........................................................................................ 340
Q
UERY
T
YPE
P
ROPERTY
............................................................................................. 341
R
ECTANGLE
P
ROPERTIES
P
ROPERTY
......................................................................... 342
B
ASE
R
ECTANGLE
P
ROPERTY
.................................................................................... 342
R
EFERENCE
L
INE
P
ROPERTIES
................................................................................... 344
A
XIS
P
ROPERTY
.......................................................................................................... 344
D
ATE
V
ALUE
P
ROPERTY
............................................................................................ 345
L
ABEL
P
ROPERTY
....................................................................................................... 346
N
UMBER
V
ALUE
P
ROPERTY
...................................................................................... 347
R
OUNDED
R
ECTANGLE
P
ROPERTIES
......................................................................... 348
B
ASE
R
ECTANGLE
P
ROPERTY
.................................................................................... 348
C
ORNER
R
ADII
P
ROPERTY
......................................................................................... 349
S
IMPLE
T
EXT
P
ROPERTIES
.......................................................................................... 350
C
OLOR
P
ROPERTY
...................................................................................................... 350
F
ONT
P
ROPERTY
........................................................................................................ 351
T
EXT
S
TRING
P
ROPERTY
............................................................................................ 353
S
OUND
P
ROPERTIES
P
ROPERTY
................................................................................. 354
ix
N
AME
P
ROPERTY
....................................................................................................... 354
S
YMBOL
P
ROPERTIES
P
ROPERTY
............................................................................... 355
C
ENTER
P
ROPERTY
.................................................................................................... 355
I
NDEX
P
ROPERTY
....................................................................................................... 356
S
YMBOL
S
IZE
P
ROPERTY
............................................................................................ 357
T
EXT
P
ROPERTIES
....................................................................................................... 358
B
OUNDING
B
OX
H
EIGHT
P
ROPERTY
......................................................................... 359
B
OUNDING
B
OX
W
IDTH
P
ROPERTY
.......................................................................... 360
C
HARACTER
S
ET
P
ROPERTY
...................................................................................... 361
C
OLOR
P
ROPERTY
...................................................................................................... 363
C
OMPOUND
T
EXT
C
OUNT
P
ROPERTY
....................................................................... 364
C
USTOM
S
PACING
P
ROPERTY
................................................................................... 365
F
IXED
B
OUNDING
B
OX
P
ROPERTY
............................................................................ 366
H
ORIZONTAL
A
LIGNMENT
P
ROPERTY
..................................................................... 367
H
ORIZONTAL
O
RIGIN
P
ROPERTY
.............................................................................. 368
I
NVISIBLE
P
ROPERTY
.................................................................................................. 369
K
ERNING
P
ROPERTY
.................................................................................................. 370
N
EAREST
P
ROPERTY
.................................................................................................. 371
O
RIGIN
P
OINT
P
ROPERTY
.......................................................................................... 372
P
OINT
S
IZE
P
ROPERTY
............................................................................................... 373
S
CALABLE
B
OUNDING
B
OX
P
ROPERTY
..................................................................... 374
S
CALABLE
F
ONT
P
ROPERTY
...................................................................................... 375
S
PACING
P
ROPERTY
................................................................................................... 376
S
TYLE
P
ROPERTY
........................................................................................................ 377
S
YNTHESIZE
P
ROPERTY
............................................................................................. 378
T
YPEFACE
P
ROPERTY
................................................................................................. 379
V
ERTICAL
A
LIGNMENT
P
ROPERTY
........................................................................... 380
V
ERTICAL
O
RIGIN
P
ROPERTY
.................................................................................... 381
W
EIGHT
P
ROPERTY
.................................................................................................... 382
W
IDTH
P
ROPERTY
...................................................................................................... 383
W
RAPAROUND
P
ROPERTY
........................................................................................ 385
T
IMER
P
ROPERTIES
.................................................................................................... 386
A
CTIVE
P
ROPERTY
..................................................................................................... 386
I
NTERVAL
P
ROPERTY
................................................................................................. 387
N
AME
P
ROPERTY
....................................................................................................... 388
P
ROCEDURE
P
ROPERTY
............................................................................................. 389
W
INDOW
P
ROPERTIES
............................................................................................... 390
H
EIGHT
P
ROPERTY
.................................................................................................... 390
H
ELP
T
ARGET
P
ROPERTY
.......................................................................................... 391
N
AME
P
ROPERTY
....................................................................................................... 392
P
OSITION
P
ROPERTY
.................................................................................................. 393
W
IDTH
P
ROPERTY
...................................................................................................... 394
ATTRIBUTES .................................................................................................................. 396
U
SING
A
TTRIBUTE
R
ECORDS
..................................................................................... 396
O
VERVIEW
.................................................................................................................. 396
A
TTRIBUTE
C
LASSES
.................................................................................................. 396
C
OMBINED
A
TTRIBUTE
R
ECORDS
............................................................................. 399
M
ASK
A
TTRIBUTES
.................................................................................................... 399
M
ASK
C
ONSTANTS
.................................................................................................... 399
C
REATEABLE
, S
ETABLE
, G
ETABLE
A
TTRIBUTES
....................................................... 401
S
HORTCUT
B
UILT
-
INS
................................................................................................ 402
A
PPLICATION
A
TTRIBUTE
R
ECORD
.......................................................................... 402
x
A
RC
C
OMBINED
A
TTRIBUTE
R
ECORD
....................................................................... 404
A
RC
A
TTRIBUTE
R
ECORD
.......................................................................................... 404
C
ONTINUOUS
A
XIS
C
OMBINED
A
TTRIBUTE
R
ECORD
.............................................. 406
C
ONTINUOUS
A
XIS
A
TTRIBUTE
R
ECORD
.................................................................. 406
D
ATE
A
XIS
C
OMBINED
A
TTRIBUTE
R
ECORD
............................................................ 408
D
ATE
A
XIS
A
TTRIBUTE
R
ECORD
............................................................................... 408
D
ISCRETE
A
XIS
C
OMBINED
A
TTRIBUTE
R
ECORD
..................................................... 411
D
ISCRETE
A
XIS
A
TTRIBUTE
R
ECORD
......................................................................... 411
A
XIS
A
TTRIBUTE
R
ECORD
......................................................................................... 412
C
HART
C
OMBINED
A
TTRIBUTE
R
ECORD
.................................................................. 413
C
HART
A
TTRIBUTE
R
ECORD
..................................................................................... 413
C
HART
E
LEMENT
C
OMBINED
A
TTRIBUTE
R
ECORD
................................................. 414
C
HART
E
LEMENT
A
TTRIBUTE
R
ECORD
..................................................................... 415
D
ISPLAY
A
TTRIBUTE
R
ECORD
................................................................................... 417
A
XIS
F
IELD
T
EMPLATE
C
OMBINED
A
TTRIBUTE
R
ECORD
......................................... 418
A
XIS
F
IELD
T
EMPLATE
A
TTRIBUTE
R
ECORD
............................................................. 418
F
IELD
T
EMPLATE
A
TTRIBUTE
R
ECORD
..................................................................... 420
A
XIS
F
RAME
C
OMBINED
A
TTRIBUTE
R
ECORD
.......................................................... 421
A
XIS
F
RAME
A
TTRIBUTE
R
ECORD
............................................................................. 421
F
RAME
A
TTRIBUTE
R
ECORD
...................................................................................... 423
P
IE
F
RAME
C
OMBINED
A
TTRIBUTE
R
ECORD
............................................................ 425
P
IE
F
RAME
A
TTRIBUTE
R
ECORD
............................................................................... 425
T
ABLE
F
RAME
C
OMBINED
A
TTRIBUTE
R
ECORD
....................................................... 427
T
ABLE
F
RAME
A
TTRIBUTE
R
ECORD
.......................................................................... 427
G
ENERIC
A
TTRIBUTE
R
ECORD
.................................................................................. 428
G
RAPHIC
C
OMBINED
A
TTRIBUTE
R
ECORD
............................................................... 430
G
RAPHIC
A
TTRIBUTE
R
ECORD
.................................................................................. 430
G
ROUP
C
OMBINED
A
TTRIBUTE
R
ECORD
.................................................................. 432
G
ROUP
A
TTRIBUTE
R
ECORD
..................................................................................... 433
I
MAGE
C
OMBINED
A
TTRIBUTE
R
ECORD
................................................................... 434
I
MAGE
A
TTRIBUTE
R
ECORD
...................................................................................... 434
L
INE
C
OMBINED
A
TTRIBUTE
R
ECORD
...................................................................... 436
L
INE
A
TTRIBUTE
R
ECORD
......................................................................................... 436
P
OLYGON
C
OMBINED
A
TTRIBUTE
R
ECORD
.............................................................. 437
P
OLYGON
A
TTRIBUTE
R
ECORD
................................................................................. 437
P
RINTER
A
TTRIBUTE
R
ECORD
................................................................................... 438
Q
UERY
A
TTRIBUTE
R
ECORD
...................................................................................... 439
R
ECTANGLE
C
OMBINED
A
TTRIBUTE
R
ECORD
.......................................................... 441
R
ECTANGLE
A
TTRIBUTE
R
ECORD
............................................................................. 441
R
EFERENCE
L
INE
A
TTRIBUTE
R
ECORD
..................................................................... 442
R
OUNDED
R
ECTANGLE
C
OMBINED
A
TTRIBUTE
R
ECORD
........................................ 443
R
OUNDED
R
ECTANGLE
A
TTRIBUTE
R
ECORD
........................................................... 443
S
OUND
A
TTRIBUTE
R
ECORD
..................................................................................... 444
S
YMBOL
C
OMBINED
A
TTRIBUTE
R
ECORD
................................................................ 445
S
YMBOL
A
TTRIBUTE
R
ECORD
.................................................................................... 445
T
EXT
A
TTRIBUTES
O
VERVIEW
................................................................................... 446
T
EXT
C
OMBINED
A
TTRIBUTE
R
ECORD
...................................................................... 446
T
EXT
A
TTRIBUTE
R
ECORD
......................................................................................... 446
F
ONT
A
TTRIBUTE
R
ECORD
........................................................................................ 451
C
OMPOUND
T
EXT
E
LEMENT
A
TTRIBUTE
R
ECORD
................................................... 456
S
IMPLE
T
EXT
E
LEMENT
A
TTRIBUTE
R
ECORD
........................................................... 457
T
IMER
A
TTRIBUTES
.................................................................................................... 458
xi
W
INDOW
A
TTRIBUTE
R
ECORD
.................................................................................. 460
GLOBAL VARIABLES .................................................................................................. 461
B
UILT
-
IN
G
LOBAL
V
ARIABLES
................................................................................... 461
OG_A
PP
..................................................................................................................... 461
OG_I
NCH
................................................................................................................... 461
OG_N
ULL
_A
XIS
........................................................................................................ 462
OG_N
ULL
_B
UTTONPROC
......................................................................................... 462
OG_N
ULL
_D
ISPLAY
.................................................................................................. 462
OG_N
ULL
_F
TEMP
..................................................................................................... 462
OG_N
ULL
_L
AYER
..................................................................................................... 462
OG_N
ULL
_O
BJECT
.................................................................................................... 462
OG_N
ULL
_Q
UERY
.................................................................................................... 463
OG_N
ULL
_R
EFLINE
.................................................................................................. 463
OG_N
ULL
_S
OUND
.................................................................................................... 463
OG_N
ULL
_T
EMPLATE
.............................................................................................. 463
OG_N
ULL
_T
IMER
..................................................................................................... 463
OG_N
ULL
_W
INDOW
................................................................................................ 463
xii
Oracle Developer Graphics Bulder Reference xiii
Preface
Welcome to Release 6.0 of the
Oracle Developer Graphics Builder
Reference
.
This reference guide includes information to help you effectively
work with Oracle Developer Graphics Builder and contains detailed
information about the following:
•
Built ins
•
Properties
•
Attributes
•
Global variables
This preface explains how this user’s guide is organized and
introduces other sources of information that can help you use Oracle
Developer Graphics Builder.
Oracle Developer Graphics Bulder Referencexiv
Prerequisites
You should be familiar with your computer and its operating system.
For example, you should know the commands for deleting and
copying files and understand the concepts of search paths,
subdirectories, and path names. Refer to your Microsoft Windows 95
or NT and DOS product documentation for more information.
You should also understand the fundamentals of Microsoft
Windows, such as the elements of an application window. You
should also be familiar with such programs as the Explorer, Taskbar
or Task Manager, and Registry.
Notational Conventions
The following typographical conventions are used in this guide:
Convention Meaning
fixed-width font
Text in a fixed-width font indicates commands
that you enter exactly as shown. Text typed on a
PC is not case-sensitive unless otherwise noted.
In commands, punctuation other than brackets
and vertical bars must be entered exactly as
shown.
lowercase
Lowercase characters in a command statement
represent a variable. Substitute an appropriate
value.
UPPERCASE
Uppercase characters within the text represent
command names, SQL reserved words, and
keywords.
boldface
Boldface is used to indicate user interface items
such as menu choices and buttons.
C>
C> represents the DOS prompt. Your prompt
may differ.
Related Publications
You may also wish to consult the following Oracle documentation:
Title Part Number
Oracle Developer: Guidelines for Building
Applications
A58766
SQL*Plus User's Guide and Reference Version 3.1 A24801
Oracle Developer Graphics Bulder Reference 1
Built Ins
Chart Built-ins
OG_Delete_Column
OG_Delete_Field
OG_Get_Chart_Element
OG_Get_Column
OG_Get_Field
OG_Get_Row
OG_Insert_Field
OG_Make_Chart
OG_Update_Chart
OG_Delete_Column
Description This procedure deletes a column from a custom query.
Syntax
PROCEDURE OG_Delete_Column
(
query_hdl
OG_Query,
indx
NUMBER,
total
NUMBER);
Parameters
query_hdl Is the handle to the query from which to delete
the column.
indx Is the index of the first column to delete from
the query.
total Is the total number of columns to delete.
Oracle Developer Graphics Bulder Reference2
OG_Delete_Column Example
/* The following procedure deletes a column
** from the query ‘query0’:
*/
PROCEDURE example(col_num number) IS
query OG_Query;
BEGIN
query:=OG_Get_Query(‘query0’);
OG_Delete_Column(query, col_num, 1);
END;
OG_Delete_Field
Description This procedure deletes one or more fields from the specified chart object.
Syntax
PROCEDURE OG_Delete_Field
(
chart_hdl
OG_Object,
indx
NUMBER,
total
NUMBER);
Parameters
chart_hdl Is the handle to the chart object.
indx Is the index of the first field to delete from the
field list.
total Is the total number of fields to delete.
Usage Notes Deleting a field only removes it from the specified chart. It does not delete (or otherwise
modify) the field template that the field may reference. In addition, any changes you make to the chart's
field list will not be applied until the chart is updated via a call to OG_Update_Chart.
OG_Delete_Field Examples
/* Suppose one chart currently displays plots for both salary
** and commission data, and you want to remove the
** commission plot from that chart and plot it on another one.
*/
PROCEDURE transfer_comm(chart1 IN OG_Object, chart2 IN
OG_Object, field_index in number) IS
the_field OG_Field;
BEGIN
the_field:=OG_Get_Field(Chart1, field_index);
OG_Delete_Field(Chart1, field_index, 1);
OG_Insert_Field(Chart2, the_field, OG_Last);
OG_Update_Chart(Chart1, OG_All_Chupda);
OG_Update_Chart(Chart2, OG_All_Chupda);
END;
OG_Get_Chart_Element
Description Given the handle to a group of chart elements (bars, pie slices, etc) and a row number, this
function returns the individual element corresponding to that row number.
Oracle Developer Graphics Bulder Reference 3
Syntax
FUNCTION OG_Get_Chart_Element
(
group_hdl
OG_Object,
row_num
NUMBER)
RETURN OG_Object;
Parameters
group_hdl Is the handle to the group containing the chart
element.
row_num Is the row number corresponding to the chart
element you wish to get.
Returns The individual chart element for the specified row number.
Usage Notes The group handle can be retrieved from the chart object using OG_Get_Object with the
appropriate name.
OG_Get_Chart_Element Examples
/* The following procedure changes the color of the first:
** bar in a column chart, regardless of its value:
*/
PROCEDURE example(chart OG_Object) IS
bars_group OG_Object;
elem OG_Object;
BEGIN
bars_group := OG_Get_Object('Sal_Bars', chart);
elem := OG_Get_Chart_Element(Bars_Group, 0);
OG_Set_Fillcolor(Elem, 'red');
END;
OG_Get_Column
Description This function returns the name of the query column represented by a specific chart element.
Syntax
FUNCTION OG_Get_Column
(
chelement_hdl
OG_Object)
RETURN VARCHAR2;
Parameters
chelement_hdl Is the handle to the chart element.
Returns The name of the column associated with the chart element.
OG_Get_Column Examples
/* The following function returns the query column represented by
** the first bar in a column chart:
*/
FUNCTION example(chart OG_Object) RETURN CHAR IS
bars OG_Object;
elem OG_Object;
col VARCHAR2(15);
BEGIN
bars := OG_Get_Object('Sal_Bars', chart);
elem := OG_Get_Chart_Element(Bars, 0);
col := OG_Get_Column(Elem);
RETURN(col);
Oracle Developer Graphics Bulder Reference4
END;
OG_Get_Field
Description This function returns a record containing the field's attribute values in the specified chart.
Syntax
FUNCTION OG_Get_Field
(
chart_hdl
OG_Object,
indx
NUMBER)
RETURN OG_Field;
Parameters
chart_hdl Is the handle to the chart object.
indx Is the index of the field in the chart's field list
to be returned.
Returns The attributes of the specified field.
OG_Get_Field Examples
/* Suppose one chart currently displays plots for both salary
** and commission data, and you want to remove the
** commission plot from that chart and plot it on another one:
*/
PROCEDURE transfer_comm(chart1 IN OG_Object, chart2 IN
OG_Object, field_index IN NUMBER) IS
the_field OG_Field
BEGIN
the_field:=OG_Get_Field(The_Chart, field_index);
OG_Delete_Field(Chart1, field_index, 1);
OG_Insert_Field(Chart2, the_field, OG_Last);
END;
OG_Get_Row
Description This function returns the query row number that is represented by a specific chart element.
Syntax
FUNCTION OG_Get_Row
(
chelement_hdl
OG_Object,
RETURN NUMBER;
Parameters
chelement_hdl Is the handle to the chart element.
Returns The row number associated with the chart element.
OG_Get_Row Examples
/* The following format trigger explodes the pie slice
** representing SAL for employee 'SMITH':
*/
PROCEDURE OGFORMATTRIG0(elem IN OG_Object,
query IN OG_Query) IS
ename VARCHAR2(10);
Oracle Developer Graphics Bulder Reference 5
chart OG_Object;
row_num NUMBER;
BEGIN
ename := OG_Get_Charcell(Query, 'ENAME');
IF ename = 'SMITH' THEN
chart := OG_Get_Object('Chart0');
row_num := OG_Get_Row(Elem);
OG_Set_Explosion(Chart, row_num, 'SAL', 25);
END IF;
END;
OG_Insert_Field
Description This procedure inserts a new field into the specified chart.
Syntax
PROCEDURE OG_Insert_Field
(
chart_hdl
OG_Object,
field_rec
OG_Field,
indx
NUMBER);
Parameters
chart_hdl Is the handle to the chart object,
field_rec Is the record containing the field's attributes.
indx Is the index at which to insert the new field in
the chart's field list. This argument must be an
integer between 0 and n (inclusive), where n is
the number of fields in the chart prior to the
insertion. The value of this argument may
also be one of the following built-in constants:
OG_First Means insert the new field at the
beginning of the chart's field list (index = 0).
OG_Last Means insert the new field at the
end of the chart's field list (index = the
number of fields in the chart prior to the
insertion).
Usage Notes Any changes you make to the chart's field list are not applied until the chart is updated via a
call to OG_Update_Chart.
OG_Insert_Field Examples
/* Suppose one chart currently displays plots for both
** salary and commission data, and you want to remove
** the commission plot from that chart and plot it on another one:
*/
PROCEDURE transfer_comm (chart1 IN OG_Object, chart2 IN
OG_Object, field_index IN NUMBER) IS
the_field OG_Field;
BEGIN
the_field:=OG_Get_Field(The_Chart, field_index);
OG_Delete_Field(Chart1, field_index, 1);
OG_Insert_Field(Chart2, the_field, OG_Last);
END;
Oracle Developer Graphics Bulder Reference6
OG_Make_Chart
Description This function creates a chart.
Syntax
FUNCTION OG_Make_Chart
(
position
OG_Point,
height
NUMBER,
width
NUMBER,
template
OG_Template,
query
OG_Query)
RETURN OG_Object;
Parameters
position The x- and y-coordinates of the chart frame.
height The chart height.
width The chart width.
template The template to use for the chart.
query The query to use for the chart.
Returns A handle to the newly created chart.
Usage Notes The chart will not be complete until you add fields to it using OG_Insert_Field and update it
using OG_Update_Chart.
OG_Make_Chart Examples
/* The following function creates a chart using
** the specified template and query:
*/
FUNCTION example(template OG_Template, query OG_Query) RETURN OG_Object IS
chart OG_Object;
pos OG_Point;
height NUMBER;
width NUMBER;
BEGIN
pos.x := OG_Inch;
pos.y := OG_Inch;
height := 4* OG_Inch;
width := 4* OG_Inch;
chart := OG_Make_Chart(Pos, height, width, template, query);
RETURN(chart);
END;
OG_Update_Chart
Description This procedure updates the specified part(s) of the specified chart to reflect new query results
or new attributes that have been applied to chart elements. You must have executed the query at least once
before you can update a chart that is based upon it.
Syntax
PROCEDURE OG_Update_Chart
(
chart_hdl
OG_Object,
chart_mask
NUMBER,
damage
BOOLEAN := TRUE,
update_bbox
BOOLEAN := TRUE);
Parameters
Oracle Developer Graphics Bulder Reference 7
chart_hdl Is the handle to the chart to be updated.
chart_mask Specifies which part(s) of the chart should be
updated. The value of this argument may be
one of the following built-in constants:
OG_All_Chupda Means update the entire
chart.
OG_Dep1axis_Chupda Means update only
the parts of the chart associated with the first
dependent axis..
OG_Dep2axis_Chupda Means update only
the parts of the chart associated with the
second dependent axis..
OG_Frame_Chupda Means update only the
parts of the chart associated with the frame.
OG_Indaxis_Chupda Means update only
the parts of the chart associated with the
independent axis.
OG_Inframe_Chupda Means update only
the parts of the chart that appear within the
frame.
OG_Legend_Chupda Means update only
the parts of the chart associated with the
legend.
OG_None_Chupda Means do not update
any parts of the chart.
OG_Title_Chupda Means update only the
chart title.
damage Is the damage flag.
update_bbox Is the bounding box update flag.
Usage Notes When this procedure is invoked, Graphics Builder will destroy the current chart and rebuild
it, based on updated query results and attribute settings. Because of this, any changes to a chart element's
attribute settings since the last invocation of OG_Update_Chart will be lost. For example, if you use
OG_Set_Attr to set the attributes for a specific bar in the chart and then update it, you will see the desired
results. If you call OG_Update_Chart again, however, the changes will be lost and the bar will appear with
its default settings.
Remember, then, that each time you update the chart, you must first make the changes to the chart
elements. In many cases you will find that this extra step is desirable, since the criteria for modifying chart
elements may change as the data changes.
OG_Update_Chart Examples
/* Suppose you want to update a chart periodically.
** You could write the following timer trigger:
*/
PROCEDURE my_timer IS+
my_query OG_Query;
my_chart OG_Object;
BEGIN
my_query:=OG_Get_Query('Emp_Query');
my_chart:=OG_Get_Object('Emp_Chart');
OG_Execute_Query(My_Query);
OG_Update_Chart(My_Chart, OG_All_Chupda);
Oracle Developer Graphics Bulder Reference8
END;
Database Built-ins
OG_Connect
OG_Logged_On
OG_Logoff
OG_Logon
OG_Connect
Description This function shows the Connect dialog box.
Syntax
FUNCTION OG_Connect
RETURN BOOLEAN;
Parameters:
None.
OG_Connect Examples
/* Suppose your application requires the
** user to be connected to a database. The
** following procedure checks if a connection
** exists and, if not, prompts the user to
** connect by showing the Connect dialog box:
*/
PROCEDURE ensure_connection IS
BEGIN
IF NOT OG_Logged_On THEN
status:=OG_Connect;
END IF;
END;
OG_Logged_On
Description This function returns TRUE if the user is currently connected to a database, and FALSE if
not connected.
Syntax
FUNCTION OG_Logged_On
RETURN BOOLEAN;
Parameters:
None.
Returns
TRUE
If the user is connected to a database.
FALSE If the user is not connected to a database.
Oracle Developer Graphics Bulder Reference 9
OG_Logged_On Examples
/* Suppose your application requires the user to be
** connected to a database. The following procedure
** checks if a connection exists and, if not, prompts the
** user to connect by showing the Connect dialog box:
*/
PROCEDURE ensure_connection IS
BEGIN
IF NOT OG_Logged_On THEN
OG_Connect;
END IF;
END;
OG_Logoff
Description This procedure closes the existing database connection.
Syntax
PROCEDURE OG_Logoff;
Parameters:
None.
OG_Logoff Examples
/* Suppose you want to disconnect from a database when the display is closed.
** You could write the following Close Display trigger:
*/
PROCEDURE close_trig IS
BEGIN
IF OG_Logged_On THEN
OG_Logoff;
END IF;
END;
OG_Logon
Description This procedure connects to the specified database.
Syntax
PROCEDURE OG_Logon
(
username
VARCHAR2 := NULL,
password
VARCHAR2 := NULL,
connect_string
VARCHAR2 := NULL);
Parameters
username Is the username to use.
password Is the password to use.
connect_string Is the database connect string to use. To
connect to a remote database, you must
provide the appropriate SQL*Net database
connect string. For more information, see the
Oracle Network Manager Administrator's