PINE LIBRARY

Pitchfork

Library "Pitchfork"
Pitchfork class

method tostring(this)
Converts PitchforkTypes/Fork object to string representation
Namespace types: Fork
Parameters:
this (Fork): PitchforkTypes/Fork object
Returns: string representation of PitchforkTypes/Fork

method tostring(this)
Converts Array of PitchforkTypes/Fork object to string representation
Namespace types: array<Fork>
Parameters:
this (array<Fork>): Array of PitchforkTypes/Fork object
Returns: string representation of PitchforkTypes/Fork array

method tostring(this, sortKeys, sortOrder)
Converts PitchforkTypes/PitchforkProperties object to string representation
Namespace types: PitchforkProperties
Parameters:
this (PitchforkProperties): PitchforkTypes/PitchforkProperties object
sortKeys (bool): If set to true, string output is sorted by keys.
sortOrder (int): Applicable only if sortKeys is set to true. Positive number will sort them in ascending order whreas negative numer will sort them in descending order. Passing 0 will not sort the keys
Returns: string representation of PitchforkTypes/PitchforkProperties

method tostring(this, sortKeys, sortOrder)
Converts PitchforkTypes/PitchforkDrawingProperties object to string representation
Namespace types: PitchforkDrawingProperties
Parameters:
this (PitchforkDrawingProperties): PitchforkTypes/PitchforkDrawingProperties object
sortKeys (bool): If set to true, string output is sorted by keys.
sortOrder (int): Applicable only if sortKeys is set to true. Positive number will sort them in ascending order whreas negative numer will sort them in descending order. Passing 0 will not sort the keys
Returns: string representation of PitchforkTypes/PitchforkDrawingProperties

method tostring(this, sortKeys, sortOrder)
Converts PitchforkTypes/Pitchfork object to string representation
Namespace types: Pitchfork
Parameters:
this (Pitchfork): PitchforkTypes/Pitchfork object
sortKeys (bool): If set to true, string output is sorted by keys.
sortOrder (int): Applicable only if sortKeys is set to true. Positive number will sort them in ascending order whreas negative numer will sort them in descending order. Passing 0 will not sort the keys
Returns: string representation of PitchforkTypes/Pitchfork

method createDrawing(this)
Creates PitchforkTypes/PitchforkDrawing from PitchforkTypes/Pitchfork object
Namespace types: Pitchfork
Parameters:
this (Pitchfork): PitchforkTypes/Pitchfork object
Returns: PitchforkTypes/PitchforkDrawing object created

method createDrawing(this)
Creates PitchforkTypes/PitchforkDrawing array from PitchforkTypes/Pitchfork array of objects
Namespace types: array<Pitchfork>
Parameters:
this (array<Pitchfork>): array of PitchforkTypes/Pitchfork object
Returns: array of PitchforkTypes/PitchforkDrawing object created

method draw(this)
draws from PitchforkTypes/PitchforkDrawing object
Namespace types: PitchforkDrawing
Parameters:
this (PitchforkDrawing): PitchforkTypes/PitchforkDrawing object
Returns: PitchforkTypes/PitchforkDrawing object drawn

method delete(this)
deletes PitchforkTypes/PitchforkDrawing object
Namespace types: PitchforkDrawing
Parameters:
this (PitchforkDrawing): PitchforkTypes/PitchforkDrawing object
Returns: PitchforkTypes/PitchforkDrawing object deleted

method delete(this)
deletes underlying drawing of PitchforkTypes/Pitchfork object
Namespace types: Pitchfork
Parameters:
this (Pitchfork): PitchforkTypes/Pitchfork object
Returns: PitchforkTypes/Pitchfork object deleted

method delete(this)
deletes array of PitchforkTypes/PitchforkDrawing objects
Namespace types: array<PitchforkDrawing>
Parameters:
this (array<PitchforkDrawing>): Array of PitchforkTypes/PitchforkDrawing object
Returns: Array of PitchforkTypes/PitchforkDrawing object deleted

method delete(this)
deletes underlying drawing in array of PitchforkTypes/Pitchfork objects
Namespace types: array<Pitchfork>
Parameters:
this (array<Pitchfork>): Array of PitchforkTypes/Pitchfork object
Returns: Array of PitchforkTypes/Pitchfork object deleted

method clear(this)
deletes array of PitchforkTypes/PitchforkDrawing objects and clears the array
Namespace types: array<PitchforkDrawing>
Parameters:
this (array<PitchforkDrawing>): Array of PitchforkTypes/PitchforkDrawing object
Returns: void

method clear(this)
deletes array of PitchforkTypes/Pitchfork objects and clears the array
Namespace types: array<Pitchfork>
Parameters:
this (array<Pitchfork>): Array of Pitchfork/Pitchfork object
Returns: void

PitchforkDrawingProperties
Pitchfork Drawing Properties object
Fields:
extend (series bool): If set to true, forks are extended towards right. Default is true
fill (series bool): Fill forklines with transparent color. Default is true
fillTransparency (series int): Transparency at which fills are made. Only considered when fill is set. Default is 80
forceCommonColor (series bool): Force use of common color for forks and fills. Default is false
commonColor (series color): common fill color. Used only if ratio specific fill colors are not available or if forceCommonColor is set to true.

PitchforkDrawing
Pitchfork drawing components
Fields:
medianLine (Line type from Trendoscope/Drawing/2): Median line of the pitchfork
baseLine (Line type from Trendoscope/Drawing/2): Base line of the pitchfork
forkLines (array<Line> type from Trendoscope/Drawing/2): fork lines of the pitchfork
linefills (array<Linefill> type from Trendoscope/Drawing/2): Linefills between forks

Fork
Fork object property
Fields:
ratio (series float): Fork ratio
forkColor (series color): color of fork. Default is blue
include (series bool): flag to include the fork in drawing. Default is true

PitchforkProperties
Pitchfork Properties
Fields:
forks (array<Fork>): Array of Fork objects
type (series string): Pitchfork type. Supported values are "regular", "schiff", "mschiff", Default is regular
inside (series bool): Flag to identify if to draw inside fork. If set to true, inside fork will be drawn

Pitchfork
Pitchfork object
Fields:
a (chart.point): Pivot Point A of pitchfork
b (chart.point): Pivot Point B of pitchfork
c (chart.point): Pivot Point C of pitchfork
properties (PitchforkProperties): PitchforkProperties object which determines type and composition of pitchfork
dProperties (PitchforkDrawingProperties): Drawing properties for pitchfork
lProperties (LineProperties type from Trendoscope/Drawing/2): Common line properties for Pitchfork lines
drawing (PitchforkDrawing): PitchforkDrawing object