GetHotSpotData
public ProEssentials.Structs.HotSpotData PeFunction.GetHotSpotData ( )
This method is used to retrieve hot spot data for the most recent hot spot event. For more info, see example 014 within the demo.
Returns
A ProEssentials.Structs.HotSpotData. Depending upon the HotSpotType, w1 and w2 fields have various meanings.
public struct HotSpotData
|
Type
|
Member
|
Description
|
|
Rect
|
rectHotSpot
|
Used internally.
|
|
HotSpotType
|
nHotSpotType
|
See HotSpotType enumeration below.
|
|
int
|
w1
|
Extra data, usually stores an index related to hot spot.
|
|
int
|
w2
|
Extra data, usually stores an index related to hot spot.
|
public enum HotSpotType
|
Value
|
HotSpotType
|
|
0
|
None
|
|
1
|
Subset
|
|
2
|
Point
|
|
3
|
Graph
|
|
4
|
Table
|
|
5
|
DataPoint
|
|
6
|
Annotation
|
|
7
|
XAxisAnnotation
|
|
8
|
YAxisAnnotation
|
|
9
|
HorzLineAnnotation
|
|
10
|
VertLineAnnotation
|
|
11
|
MainTitle
|
|
12
|
SubTitle
|
|
13
|
MultiSubTitle
|
|
14
|
MultiBottomTitle
|
|
15
|
YAxisLabel
|
|
16
|
XAxisLabel
|
|
17
|
YAxis
|
|
18
|
XAxis
|
|
19
|
YAxisGridNumber
|
|
20
|
RYAxisGridNumber
|
|
21
|
XAxisGridNumber
|
|
22
|
TXAxisGridNumber
|
|
23 - 82
|
TableAnnotation0 through TableAnnotation59
|
|
83
|
ZAxis
|
|
nHotSpotType Parameter
|
w1/w2 Description
|
|
Subset
|
w1=subset index
|
|
Point
|
w1=point index
|
|
DataPoint
|
w1=subset index, w2=point index
|
|
Graph
|
see PeFunction.GetGraphLoc
|
|
Table
|
w1=subset index, w2=point index
|
|
Annotation
|
w1=annotation index
|
|
XAxisAnnotation
|
w1=annotation index
|
|
YAxisAnnotation
|
w1=annotation index
|
|
HorzLineAnnotation
|
w1=annotation index
|
|
VertLineAnnotation
|
w1=annotation index
|
|
MultiSubtitle
|
w1=index, w2=0-left, 1-center, 2-right
|
|
MultiBottomTitle
|
w1=index, w2=0-left, 1-center, 2-right
|
|
YAxisLabel
|
w1=axis, w2=0-left, 1-right
|
|
XAxisLabel
|
w1=0-bottom, 1-top
|
|
YAxis
|
w1=axis, w2 = 0-left, 1-right
|
|
XAxis
|
w1=0-bottom, 1-top
|
|
TableAnnotation0
|
w1=table row w2=table column
|
|
.. more table annotations ..
|
w1=table row w2=table column
|
|
TableAnnotation59
|
w1=table row w2=table column
|
Comments
See Also: GetHotSpot
See example 014 within the demo.
PeFunction.GetHotSpotData members of Pego.PeFunction, Pesgo.PeFunction, Pe3do.PeFunction, Pepso.PeFunction, Pepco.PeFunction
|
