Class: Symbol

Members

(non-null) annotations :Array.<up.api.sketch.Label>

The annotations associated with a symbol.

Type:

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

(non-null) component :up.api.core.Component

The component the symbol represents, if it exists.

Type:

• up.api.core.Component

(non-null) ctx_ :up.api.Context

@private

Type:

• up.api.Context

Inherited From:

• up.api.sketch.SketchObject#ctx_

(non-null) flag :up.api.core.Component

The flag that the symbol represents, if it exists.

Type:

• up.api.core.Component

flipped :boolean

True iff the schematic object is horizontally flipped.

Type:

• boolean

Inherited From:

• up.api.sketch.SketchObject#flipped

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) obj_ :up.scene.ShapeBody

@private

Type:

• up.scene.ShapeBody

Inherited From:

• up.api.sketch.SketchObject#obj_

(non-null) pins :Array.<up.api.sketch.Pin>

The pins on the symbol.

Type:

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

(non-null) position :up.api.core.Point

The position of the schematic object.

Type:

• up.api.core.Point

Inherited From:

• up.api.sketch.SketchObject#position

rotation :number

The rotation of the schematic object.

Type:

• number

Inherited From:

• up.api.sketch.SketchObject#rotation

Methods

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

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() → {boolean}

This:

• {!up.api.sketch.Symbol}

Returns:

Type

boolean

move()

Inherited From:

• up.api.sketch.SketchObject#move

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