Class: Sketch

Members

(non-null) camera :Array.<up.api.common.Camera>

Type:

• Array.<up.api.common.Camera>

ctx_ :up.api.Context|up.api.ComponentContext

@private

Type:

• up.api.Context | up.api.ComponentContext

Inherited From:

• up.api.core.ProxyObject#ctx_

(non-null) hover :Object.<string, !Array.<!up.api.core.ProxyObject>>

Type:

• Object.<string, !Array.<!up.api.core.ProxyObject>>

isFootprint :boolean

Type:

• boolean

Inherited From:

• up.api.core.ProxyObject#isFootprint

isPadstack :boolean

Type:

• boolean

Inherited From:

• up.api.core.ProxyObject#isPadstack

isPlatedThroughHole :boolean

Type:

• boolean

Inherited From:

• up.api.core.ProxyObject#isPlatedThroughHole

isPour :boolean

Type:

• boolean

Inherited From:

• up.api.core.ProxyObject#isPour

isTrace :boolean

Type:

• boolean

Inherited From:

• up.api.core.ProxyObject#isTrace

isVia :boolean

Type:

• boolean

Inherited From:

• up.api.core.ProxyObject#isVia

(non-null) nets :Array.<up.api.core.Net>

Type:

• Array.<up.api.core.Net>

Inherited From:

• up.api.core.ProxyObject#nets

(non-null) selection :Object.<string, !Array.<!up.api.core.ProxyObject>>

Type:

• Object.<string, !Array.<!up.api.core.ProxyObject>>

(non-null) symbols :Array.<up.api.sketch.Symbol>

Type:

• Array.<up.api.sketch.Symbol>

Methods

addComponent(libraryId, locnon-null, opt_attributesopt, opt_symbolIndexopt, opt_footprintIndexopt) → (non-null) {up.api.core.Component}

Parameters:

Name	Type	Attributes	Description
libraryId	string
loc	up.api.core.Point
opt_attributes	Object.<string, string>	<optional>	A dictionary of attributes to set on the new component.
opt_symbolIndex	number	<optional>
opt_footprintIndex	number	<optional>

Returns:

A proxy object for the created Component.

Type

up.api.core.Component

addFlag(libraryId, locnon-null, flagName, opt_symbolIndexopt) → (non-null) {up.api.core.Component}

Parameters:

Name	Type	Attributes	Description
libraryId	string
loc	up.api.core.Point
flagName	string
opt_symbolIndex	number	<optional>

Returns:

A proxy object for the created Flag.

Type

up.api.core.Component

addModule(libraryId, actionId, locnon-null, opt_attributesopt, opt_symbolIndexopt, opt_layerMappingopt, non-null) → (non-null) {up.api.core.Module}

Parameters:

Name	Type	Attributes	Description
libraryId	string
actionId	number		The actionId to load the module at.
loc	up.api.core.Point
opt_attributes	Object.<string, string>	<optional>	A dictionary of attributes to set on the new component.
opt_symbolIndex	number	<optional>
opt_layerMapping	Object.<string, string>	<optional>	The layer mapping.

Returns:

A proxy object for the created module.

Type

up.api.core.Module

addNet(locationsnon-null, opt_busopt, opt_busAttachmentopt) → (non-null) {Object}

Parameters:

Name	Type	Attributes	Description
locations	Array.<up.api.core.Point, up.common.Point, up.api.sketch.Pin>
opt_bus	boolean	<optional>	If the net to add is a bus.
opt_busAttachment	string	<optional>	The attachment to make to the bus.

Returns:

The objects added as part of the net creation (bus connections and net points).

Type

Object

closeCheckAndCall(toCall) → {function}

Parameters:

Name	Type	Description
toCall	function

Inherited From:

• up.api.core.ProxyObject#closeCheckAndCall

Returns:

Type

function

defineGetAndSetFunctions(propertyName, getFunction, setFunction)

Parameters:

Name	Type	Description
propertyName	string
getFunction	function
setFunction	function

Inherited From:

• up.api.core.ProxyObject#defineGetAndSetFunctions

defineGetFunction(propertyName, getFunction)

Parameters:

Name	Type	Description
propertyName	string
getFunction	function

Inherited From:

• up.api.core.ProxyObject#defineGetFunction

deleteSelection()

Delete the selection.

isNet(netName) → {boolean}

Returns true <=> the object is in the provided net.

Parameters:

Name	Type	Description
netName	string

Inherited From:

• up.api.core.ProxyObject#isNet

Returns:

Type

boolean

isValid()

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:

• up.api.core.ProxyObject#onLayer

Returns:

Type

boolean

selectAll()

Select all things.