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
{
Rect rectHotSpot; // used internally
ProEssentials.Enum.HotSpotType nHotSpotType; // see below
int w1; // extra data, ususally store an index related to hot spot
int w2; // extra data, ususally store an index related to hot spot
}
public enum HotSpotType
{
None = 0,
Subset = 1,
Point = 2,
Graph = 3,
Table = 4,
DataPoint = 5,
Annotation = 6,
XAxisAnnotation = 7,
YAxisAnnotation = 8,
HorzLineAnnotation = 9,
VertLineAnnotation = 10,
MainTitle = 11,
SubTitle = 12,
MultiSubTitle = 13,
MultiBottomTitle = 14,
YAxisLabel = 15,
XAxisLabel = 16,
YAxis = 17,
XAxis = 18,
YAxisGridNumber = 19,
RYAxisGridNumber = 20,
XAxisGridNumber = 21,
TXAxisGridNumber = 22,
TableAnnotation0 = 23,
TableAnnotation1 = 24,
. . . . more table annotation types . . . .
TableAnnotation58 = 81,
TableAnnotation59 = 82,
ZAxisGridNumber = 83,
}
|
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
|
