The fnGetPivotLevel function is used to get the value of a Pivot Point line.
After the fnGetPivotLevel function has been added to a Drawing, it is configured by clicking the (+) button along the bottom of the Element.
The Function Configuration window allows you to select values for each parameter.
Parameter Name |
Data type |
Description |
name |
string |
The name of the pivot point line to get the value for, as defined in the basename parameter of the fnDrawPivotPoint function. Note: The name entered in the parameter must exactly match the basename parameter of the fnDrawPivotPoint function. |
mode |
PIVOT value (string) |
Defined what line to use to capture the value: PIVOT_MAIN PIVOT_S1 PIVOT_S2 PIVOT_S3 PIVOT_R1 PIVOT_R2 PIVOT_R3 . Note: In order to capture the values of any of the support or resistance lines using the function fnGetPivotLevel, the lines must be drawn using the fnDrawPivotPoints function. |
shift |
integer |
The count index of where to capture the pivot point value.The count is defined in the fnDrawPivotPoints function. |
