Members
-
(static) Priority :string
-
Type:
- string
Properties:
Name Type Default Description CRITICAL
string CRITICAL PERFORMANCE
string PERFORMANCE LOW
string BIKE_SHEDDING NONE
string NONE -
(static) State :string
-
Type:
- string
Properties:
Name Type Default Description OPEN
string OPEN IN_PROGRESS
string IN_PROGRESS COMPLETE
string COMPLETE VERIFIED
string VERIFIED -
ctx_ :up.api.Context|up.api.ComponentContext
-
@private
Type:
- up.api.Context | up.api.ComponentContext
- Inherited From:
-
isFootprint :boolean
-
Type:
- boolean
- Inherited From:
-
isPadstack :boolean
-
Type:
- boolean
- Inherited From:
-
isPlatedThroughHole :boolean
-
Type:
- boolean
- Inherited From:
-
isPour :boolean
-
Type:
- boolean
- Inherited From:
-
isTrace :boolean
-
Type:
- boolean
- Inherited From:
-
isVia :boolean
-
Type:
- boolean
- Inherited From:
-
(non-null) nets :Array.<up.api.core.Net>
-
Type:
- Array.<up.api.core.Net>
- Inherited From:
Methods
-
addNote(color, startPosnon-null, endPosnon-null) → {up.api.issue.Note}
-
Parameters:
Name Type Description color
string The color for the note. startPos
up.api.core.Point One corner of the rectangle. endPos
up.api.core.Point The opposide corner of the rectangle. Returns:
- Type
- up.api.issue.Note
-
addThread(title, opt_noteopt, opt_commentopt, opt_assigneeopt, opt_priorityopt, opt_stateopt) → (non-null) {up.api.issue.Thread}
-
Create an issue.
Parameters:
Name Type Attributes Description title
string opt_note
up.api.issue.Note <optional>
Defaults to the current note in the notelistManager. opt_comment
string <optional>
opt_assignee
string <optional>
opt_priority
up.api.issue.Issues.Priority <optional>
opt_state
up.api.issue.Issues.State <optional>
Returns:
- Type
- up.api.issue.Thread
-
closeCheckAndCall(toCall) → {function}
-
Parameters:
Name Type Description toCall
function - Inherited From:
Returns:
- Type
- function
-
defineGetAndSetFunctions(propertyName, getFunction, setFunction)
-
Parameters:
Name Type Description propertyName
string getFunction
function setFunction
function - Inherited From:
-
defineGetFunction(propertyName, getFunction)
-
Parameters:
Name Type Description propertyName
string getFunction
function - Inherited From:
-
isNet(netName) → {boolean}
-
Returns true <=> the object is in the provided net.
Parameters:
Name Type Description netName
string - Inherited From:
Returns:
- Type
- boolean
-
isValid() → {boolean}
-
- Inherited From:
Returns:
- Type
- boolean
-
onLayer(layer) → {boolean}
-
Returns true <=> the pcb object is on the provided layer. Default False for proxyobjects.
Parameters:
Name Type Description layer
string - Inherited From:
Returns:
- Type
- boolean