GetHotSpotData Method
*Within client side VBScript within a web page, use GetHotSpotDataEx
Scope All ProEssentials Interfaces
GetHotSpotData(pnHotSpotType As Integer, pnExtra1 As Long, pnExtra2 As Long)
|
Parameter
|
Description
|
|
pnHotSpotType
|
Variable to store hot spot type.
|
|
pnExtra1
|
Variable to store extra data.
|
|
pnExtra2
|
Variable to store extra data.
|
This method is used to retrieve hot spot data for the most recent hot spot event.
|
nHotSpotType Parameter
|
Extra1/Extra2 Description
|
|
PEHS_NONE (0)
|
|
|
PEHS_SUBSET (1)
|
Extra1=subset index
|
|
PEHS_POINT (2)
|
Extra1=point index**
|
|
PEHS_DATAPOINT (3)
|
Extra1=subset index, Extra2=point index
|
|
PEHS_GRAPH (4)
|
see below
|
|
PEHS_TABLE (5)
|
Extra1=subset index, Extra2=point index
|
|
PEHS_GRAPHANNOTATION (6)
|
Extra1=annotation index
|
|
PEHS_HORZLINEANNOTATION (7)
|
Extra1=annotation index
|
|
PEHS_VERTLINEANNOTATION (8)
|
Extra1=annotation index
|
|
PEHS_XAXISANNOTATION (9)
|
Extra1=annotation index
|
|
PEHS_YAXISANNOTATION (10)
|
Extra1=annotation index
|
|
PEHS_MAINTITLE (11)
|
|
|
PEHS_SUBTITLE (12)
|
|
|
PEHS_MULTISUBTITLE (13)
|
Extra1=index, Extra2=0-left, 1-center, 2-right
|
|
PEHS_MULTIBOTTOMTITLE (14)
|
Extra1=index, Extra2=0-left, 1-center, 2-right
|
|
PEHS_YAXISLABEL (15)
|
Extra1=axis, Extra2=0-left, 1-right
|
|
PEHS_XAXISLABEL (16)
|
Extra1=0-bottom, 1-top
|
|
PEHS_YAXIS (17)
|
Extra1=axis, w2 = 0-left, 1-right
|
|
PEHS_XAXIS (18)
|
Extra1=0-bottom, 1-top
|
|
PEHS_YAXISGRIDNUMBER (19)
|
|
|
PEHS_RYAXISGRIDNUMBER (20)
|
|
|
PEHS_XAXISGRIDNUMBER (21)
|
|
|
PEHS_TXAXISGRIDNUMBER (22)
|
|
|
PEHS_TABLEANNOTATION (23)
|
Extra1=table row Extra2=table column
|
|
PEHS_TABLEANNOTATION1(24)
|
Extra1=table row Extra2=table column
|
|
.. more table annotations ..
|
Extra1=table row Extra2=table column
|
|
PEHS_TABLEANNOTATION58 (81)
|
Extra1=table row Extra2=table column
|
|
PEHS_TABLEANNOTATION59 (82)
|
Extra1=table row Extra2=table column
|
|
PEHS_ZAXISGRIDNUMBER (83)
|
|
In the case of a PEHS_GRAPH, PEHS_YAXIS and PEHS_XAXIS, the developer must also use GetGraphLoc method to retrieve coordinates where the user clicked.
A PEHS_POINT event for the Pie Chart Object will also give the subset index in the Extra2 variable.
Above where Extra1 = axis, this is the zero based axis index and is only used if MultiAxesSubsets is implemented.
Comments
See Also: PEgethotspot, GetLastMouseMove, OCX Methods
Visual Basic 6 Example
|
Private Sub Pego1_MouseMove(Button As Integer, Shift As Integer, X As Single, Y As Single)
Dim PixelX As Integer
Dim PixelY As Integer
Pego1.GetLastMouseMove PixelX, PixelY
'** Call PEgethotspot **'
Pego1.PEgethotspot PixelX, PixelY
'** Now look at HotSpotData structure **'
Dim HotSpotType As Integer
Dim Extra1 As Long
Dim Extra2 As Long
Pego1.GetHotSpotData HotSpotType, Extra1, Extra2
If (HotSpotType = PEHS_DATAPOINT) Then
s = "DataPoint value " + Str$(Pego1.YData(Extra1, Extra2))
Form2.Caption = s
ElseIf (HotSpotType = PEHS_SUBSET) Then
s = "Subset Legend is " + Pego1.SubsetLabels(Extra1)
Form2.Caption = s
ElseIf (HotSpotType = PEHS_POINT) Then
s = "Point Label is " + Pego1.PointLabels(Extra1)
Form2.Caption = s
Else
Form2.Caption = "No Hot Spot"
End If
End Sub
|
SDK/DLL users, this method retrieves the same data as PEP_structHOTSPOTDATA, or HOTSPOTDATA structure.
|
