DrawingMethods

16 ก.พ. 2023

Library "DrawingMethods"

tostring(this, sortKeys, sortOrder, includeKeys)
  Converts DrawingTypes/Point object to string representation
  Parameters:
    this: DrawingTypes/Point 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
    includeKeys: Array of string containing selective keys. Optional parmaeter. If not provided, all the keys are considered
  Returns: string representation of DrawingTypes/Point

tostring(this, sortKeys, sortOrder, includeKeys)
  Converts DrawingTypes/LineProperties object to string representation
  Parameters:
    this: DrawingTypes/LineProperties 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
    includeKeys: Array of string containing selective keys. Optional parmaeter. If not provided, all the keys are considered
  Returns: string representation of DrawingTypes/LineProperties

tostring(this, sortKeys, sortOrder, includeKeys)
  Converts DrawingTypes/Line object to string representation
  Parameters:
    this: DrawingTypes/Line 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
    includeKeys: Array of string containing selective keys. Optional parmaeter. If not provided, all the keys are considered
  Returns: string representation of DrawingTypes/Line

tostring(this, sortKeys, sortOrder, includeKeys)
  Converts DrawingTypes/LabelProperties object to string representation
  Parameters:
    this: DrawingTypes/LabelProperties 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
    includeKeys: Array of string containing selective keys. Optional parmaeter. If not provided, all the keys are considered
  Returns: string representation of DrawingTypes/LabelProperties

tostring(this, sortKeys, sortOrder, includeKeys)
  Converts DrawingTypes/Label object to string representation
  Parameters:
    this: DrawingTypes/Label 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
    includeKeys: Array of string containing selective keys. Optional parmaeter. If not provided, all the keys are considered
  Returns: string representation of DrawingTypes/Label

tostring(this, sortKeys, sortOrder, includeKeys)
  Converts DrawingTypes/Linefill object to string representation
  Parameters:
    this: DrawingTypes/Linefill 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
    includeKeys: Array of string containing selective keys. Optional parmaeter. If not provided, all the keys are considered
  Returns: string representation of DrawingTypes/Linefill

tostring(this, sortKeys, sortOrder, includeKeys)
  Converts DrawingTypes/BoxProperties object to string representation
  Parameters:
    this: DrawingTypes/BoxProperties 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
    includeKeys: Array of string containing selective keys. Optional parmaeter. If not provided, all the keys are considered
  Returns: string representation of DrawingTypes/BoxProperties

tostring(this, sortKeys, sortOrder, includeKeys)
  Converts DrawingTypes/BoxText object to string representation
  Parameters:
    this: DrawingTypes/BoxText 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
    includeKeys: Array of string containing selective keys. Optional parmaeter. If not provided, all the keys are considered
  Returns: string representation of DrawingTypes/BoxText

tostring(this, sortKeys, sortOrder, includeKeys)
  Converts DrawingTypes/Box object to string representation
  Parameters:
    this: DrawingTypes/Box 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
    includeKeys: Array of string containing selective keys. Optional parmaeter. If not provided, all the keys are considered
  Returns: string representation of DrawingTypes/Box

delete(this)
  Deletes line from DrawingTypes/Line object
  Parameters:
    this: DrawingTypes/Line object
  Returns: Line object deleted

delete(this)
  Deletes label from DrawingTypes/Label object
  Parameters:
    this: DrawingTypes/Label object
  Returns: Label object deleted

delete(this)
  Deletes Linefill from DrawingTypes/Linefill object
  Parameters:
    this: DrawingTypes/Linefill object
  Returns: Linefill object deleted

delete(this)
  Deletes box from DrawingTypes/Box object
  Parameters:
    this: DrawingTypes/Box object
  Returns: DrawingTypes/Box object deleted

delete(this)
  Deletes lines from array of DrawingTypes/Line objects
  Parameters:
    this: Array of DrawingTypes/Line objects
  Returns: Array of DrawingTypes/Line objects

delete(this)
  Deletes labels from array of DrawingTypes/Label objects
  Parameters:
    this: Array of DrawingTypes/Label objects
  Returns: Array of DrawingTypes/Label objects

delete(this)
  Deletes linefill from array of DrawingTypes/Linefill objects
  Parameters:
    this: Array of DrawingTypes/Linefill objects
  Returns: Array of DrawingTypes/Linefill objects

delete(this)
  Deletes boxes from array of DrawingTypes/Box objects
  Parameters:
    this: Array of DrawingTypes/Box objects
  Returns: Array of DrawingTypes/Box objects

clear(this)
  clear items from array of DrawingTypes/Line while deleting underlying objects
  Parameters:
    this: array<DrawingTypes/Line>
  Returns: void

clear(this)
  clear items from array of DrawingTypes/Label while deleting underlying objects
  Parameters:
    this: array<DrawingTypes/Label>
  Returns: void

clear(this)
  clear items from array of DrawingTypes/Linefill while deleting underlying objects
  Parameters:
    this: array<DrawingTypes/Linefill>
  Returns: void

clear(this)
  clear items from array of DrawingTypes/Box while deleting underlying objects
  Parameters:
    this: array<DrawingTypes/Box>
  Returns: void

draw(this)
  Creates line from DrawingTypes/Line object
  Parameters:
    this: DrawingTypes/Line object
  Returns: line created from DrawingTypes/Line object

draw(this)
  Creates lines from array of DrawingTypes/Line objects
  Parameters:
    this: Array of DrawingTypes/Line objects
  Returns: Array of DrawingTypes/Line objects

draw(this)
  Creates label from DrawingTypes/Label object
  Parameters:
    this: DrawingTypes/Label object
  Returns: label created from DrawingTypes/Label object

draw(this)
  Creates labels from array of DrawingTypes/Label objects
  Parameters:
    this: Array of DrawingTypes/Label objects
  Returns: Array of DrawingTypes/Label objects

draw(this)
  Creates linefill object from DrawingTypes/Linefill
  Parameters:
    this: DrawingTypes/Linefill objects
  Returns: linefill object created

draw(this)
  Creates linefill objects from array of DrawingTypes/Linefill objects
  Parameters:
    this: Array of DrawingTypes/Linefill objects
  Returns: Array of DrawingTypes/Linefill used for creating linefills

draw(this)
  Creates box from DrawingTypes/Box object
  Parameters:
    this: DrawingTypes/Box object
  Returns: box created from DrawingTypes/Box object

draw(this)
  Creates labels from array of DrawingTypes/Label objects
  Parameters:
    this: Array of DrawingTypes/Label objects
  Returns: Array of DrawingTypes/Label objects

createLabel(this, lblText, tooltip, properties)
  Creates DrawingTypes/Label object from DrawingTypes/Point
  Parameters:
    this: DrawingTypes/Point object
    lblText: Label text
    tooltip: Tooltip text. Default is na
    properties: DrawingTypes/LabelProperties object. Default is na - meaning default values are used.
  Returns: DrawingTypes/Label object

createLine(this, other, properties)
  Creates DrawingTypes/Line object from one DrawingTypes/Point to other
  Parameters:
    this: First DrawingTypes/Point object
    other: Second DrawingTypes/Point object
    properties: DrawingTypes/LineProperties object. Default set to na - meaning default values are used.
  Returns: DrawingTypes/Line object

createLinefill(this, other, fillColor, transparency)
  Creates DrawingTypes/Linefill object from DrawingTypes/Line object to other DrawingTypes/Line object
  Parameters:
    this: First DrawingTypes/Line object
    other: Other DrawingTypes/Line object
    fillColor: fill color of linefill. Default is color.blue
    transparency: fill transparency for linefill. Default is 80
  Returns: Array of DrawingTypes/Linefill object

createBox(this, other, properties, textProperties)
  Creates DrawingTypes/Box object from one DrawingTypes/Point to other
  Parameters:
    this: First DrawingTypes/Point object
    other: Second DrawingTypes/Point object
    properties: DrawingTypes/BoxProperties object. Default set to na - meaning default values are used.
    textProperties: DrawingTypes/BoxText object. Default is na - meaning no text will be drawn
  Returns: DrawingTypes/Box object

createBox(this, properties, textProperties)
  Creates DrawingTypes/Box object from DrawingTypes/Line as diagonal line
  Parameters:
    this: Diagonal DrawingTypes/PoLineint object
    properties: DrawingTypes/BoxProperties object. Default set to na - meaning default values are used.
    textProperties: DrawingTypes/BoxText object. Default is na - meaning no text will be drawn
  Returns: DrawingTypes/Box object

15 พ.ค. 2023

เอกสารเผยแพร่

v2

Updated:
method tostring(this, sortKeys, sortOrder, includeKeys)
  Converts DrawingTypes/Box object to string representation
  Namespace types: dr.Box
  Parameters:
    this (Box type from HeWhoMustNotBeNamed/DrawingTypes/2): DrawingTypes/Box 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
    includeKeys (string[]): Array of string containing selective keys. Optional parmaeter. If not provided, all the keys are considered
  Returns: string representation of DrawingTypes/Box

method delete(this)
  Deletes boxes from array of DrawingTypes/Box objects
  Namespace types: dr.Box[]
  Parameters:
    this (Box[] type from HeWhoMustNotBeNamed/DrawingTypes/2): Array of DrawingTypes/Box objects
  Returns: Array of DrawingTypes/Box objects

method clear(this)
  clear items from array of DrawingTypes/Box while deleting underlying objects
  Namespace types: dr.Box[]
  Parameters:
    this (Box[] type from HeWhoMustNotBeNamed/DrawingTypes/2): array<DrawingTypes/Box>
  Returns: void

method draw(this)
  Creates labels from array of DrawingTypes/Label objects
  Namespace types: dr.Box[]
  Parameters:
    this (Box[] type from HeWhoMustNotBeNamed/DrawingTypes/2): Array of DrawingTypes/Label objects
  Returns: Array of DrawingTypes/Label objects

method createLabel(this, lblText, tooltip, properties)
  Creates DrawingTypes/Label object from DrawingTypes/Point
  Namespace types: dr.Point
  Parameters:
    this (Point type from HeWhoMustNotBeNamed/DrawingTypes/2): DrawingTypes/Point object
    lblText (string): Label text
    tooltip (string): Tooltip text. Default is na
    properties (LabelProperties type from HeWhoMustNotBeNamed/DrawingTypes/2): DrawingTypes/LabelProperties object. Default is na - meaning default values are used.
  Returns: DrawingTypes/Label object

method createLine(this, other, properties)
  Creates DrawingTypes/Line object from one DrawingTypes/Point to other
  Namespace types: dr.Point
  Parameters:
    this (Point type from HeWhoMustNotBeNamed/DrawingTypes/2): First DrawingTypes/Point object
    other (Point type from HeWhoMustNotBeNamed/DrawingTypes/2): Second DrawingTypes/Point object
    properties (LineProperties type from HeWhoMustNotBeNamed/DrawingTypes/2): DrawingTypes/LineProperties object. Default set to na - meaning default values are used.
  Returns: DrawingTypes/Line object

method createLinefill(this, other, fillColor, transparency)
  Creates DrawingTypes/Linefill object from DrawingTypes/Line object to other DrawingTypes/Line object
  Namespace types: dr.Line
  Parameters:
    this (Line type from HeWhoMustNotBeNamed/DrawingTypes/2): First DrawingTypes/Line object
    other (Line type from HeWhoMustNotBeNamed/DrawingTypes/2): Other DrawingTypes/Line object
    fillColor (color): fill color of linefill. Default is color.blue
    transparency (int): fill transparency for linefill. Default is 80
  Returns: Array of DrawingTypes/Linefill object

method createBox(this, properties, textProperties)
  Creates DrawingTypes/Box object from DrawingTypes/Line as diagonal line
  Namespace types: dr.Line
  Parameters:
    this (Line type from HeWhoMustNotBeNamed/DrawingTypes/2): Diagonal DrawingTypes/PoLineint object
    properties (BoxProperties type from HeWhoMustNotBeNamed/DrawingTypes/2): DrawingTypes/BoxProperties object. Default set to na - meaning default values are used.
    textProperties (BoxText type from HeWhoMustNotBeNamed/DrawingTypes/2): DrawingTypes/BoxText object. Default is na - meaning no text will be drawn
  Returns: DrawingTypes/Box object