PitchforkMethods

Feb 16, 2023

Library "PitchforkMethods"
Methods associated with Pitchfork and Pitchfork Drawing. Depends on the library PitchforkTypes for Pitchfork/PitchforkDrawing objects which in turn use DrawingTypes for basic objects Point/Line/LineProperties. Also depends on DrawingMethods for related methods

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

tostring(this)
  Converts Array of PitchforkTypes/Fork object to string representation
  Parameters:
    this: Array of PitchforkTypes/Fork object
  Returns: string representation of PitchforkTypes/Fork array

tostring(this, sortKeys, sortOrder)
  Converts PitchforkTypes/PitchforkProperties object to string representation
  Parameters:
    this: PitchforkTypes/PitchforkProperties object
    sortKeys: If set to true, string output is sorted by keys.
    sortOrder: 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

tostring(this, sortKeys, sortOrder)
  Converts PitchforkTypes/PitchforkDrawingProperties object to string representation
  Parameters:
    this: PitchforkTypes/PitchforkDrawingProperties object
    sortKeys: If set to true, string output is sorted by keys.
    sortOrder: 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

tostring(this, sortKeys, sortOrder)
  Converts PitchforkTypes/Pitchfork object to string representation
  Parameters:
    this: PitchforkTypes/Pitchfork object
    sortKeys: If set to true, string output is sorted by keys.
    sortOrder: 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

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

createDrawing(this)
  Creates PitchforkTypes/PitchforkDrawing array from PitchforkTypes/Pitchfork array of objects
  Parameters:
    this: array of PitchforkTypes/Pitchfork object
  Returns: array of PitchforkTypes/PitchforkDrawing object created

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

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

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

delete(this)
  deletes array of PitchforkTypes/PitchforkDrawing objects
  Parameters:
    this: Array of PitchforkTypes/PitchforkDrawing object
  Returns: Array of PitchforkTypes/PitchforkDrawing object deleted

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

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

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

May 15, 2023

Release Notes

v2

Updated:
method tostring(this, sortKeys, sortOrder)
  Converts PitchforkTypes/Pitchfork object to string representation
  Namespace types: p.Pitchfork
  Parameters:
    this (Pitchfork type from HeWhoMustNotBeNamed/PitchforkTypes/2): 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 array from PitchforkTypes/Pitchfork array of objects
  Namespace types: p.Pitchfork[]
  Parameters:
    this (Pitchfork[] type from HeWhoMustNotBeNamed/PitchforkTypes/2): array of PitchforkTypes/Pitchfork object
  Returns: array of PitchforkTypes/PitchforkDrawing object created

method draw(this)
  draws from PitchforkTypes/PitchforkDrawing object
  Namespace types: p.PitchforkDrawing
  Parameters:
    this (PitchforkDrawing type from HeWhoMustNotBeNamed/PitchforkTypes/2): PitchforkTypes/PitchforkDrawing object
  Returns: PitchforkTypes/PitchforkDrawing object drawn

method delete(this)
  deletes underlying drawing in array of PitchforkTypes/Pitchfork objects
  Namespace types: p.Pitchfork[]
  Parameters:
    this (Pitchfork[] type from HeWhoMustNotBeNamed/PitchforkTypes/2): Array of PitchforkTypes/Pitchfork object
  Returns: Array of PitchforkTypes/Pitchfork object deleted

method clear(this)
  deletes array of PitchforkTypes/Pitchfork objects and clears the array
  Namespace types: p.Pitchfork[]
  Parameters:
    this (Pitchfork[] type from HeWhoMustNotBeNamed/PitchforkTypes/2): Array of Pitchfork/Pitchfork object
  Returns: void