PCB Processes

AdvancedRoute process
AlignComponents process
Annotate process
ApertureLibrary process
ArrangeComponents process
AutopositionComponentTexts process
AutoRoute process
BackAnnotate
BoardInformation process
BreakTrack process
ChangeComponentName process
ChangeObject process
Clear process
ComponentRuleCheck process
ConfigureHeadsUpDisplay process
ConnectSubnets process
ConvertSelected process
Copy process
CopyComponent process
CreateApertureList
CreateComponent
CrossProbeChoose process
CrossProbeNotify process
Cut process
DeleteComponentFromLibrary process
DeleteObjects process
DensityMap process
DeSelect process
DesignRuleCheck process
DocumentPreferences process
EditClasses process
EditFromTo process
EditInternalPlanes process
EditRules process
EngineeringChangeOrder process
EqualizeNetLengths process
ExplodeComponent process
Export process
Fanout process
FilterSelect process
FindTestPoints process
FirstComponent process
FlipSelectedObjects process
GenerateLibraryReport
GotoLibraryComponent process

GroupPrimitives process
FlipSelectedObjects process
GotoLibraryComponent process
GroupPrimitives process
HideConnections process
IdentifyNet process
Import process
Jump process
LastComponent process
LibraryBrowse process
ListAllSelectedPins process
ListComponents process
ListInternalPlanePins process
ListNets process
Manage Unions
ManageLayerSets
ManualRoute process
MeasureDistance process
MeasureSelectedObjects process
MoveAllComponentsToGrid process
MoveCursor process
MoveObject process
Netlist process
NextComponent process
OffsetSelection process
OutlineSelectedObjects process
Paste process
PasteComponent process
PinSwap process
PlaceArc process
PlaceBoardOutline process
PlaceComponent process
PlaceComponentBody process
PlaceComponentFromLibraryEditor process
PlaceComponentsFromFile process
PlaceCoordinate process
PlaceDifferentialPair process
PlaceDimension process
Place EmbeddedBoard
PlaceFill process
PlacePad process
PlacePolygonPlane process

PlaceRoom process
PlaceSplitPlane process
PlaceString process
PlaceTrack process
PlaceVia process
PreviousComponent process
PrimitiveSelect process
PrintDocument process
ReAnnotate process
Redo process
ReportBoardSpecs process
ReportBOM process
ReportLayerStackUpCompatibility process
ReportNetlistStatus process
ReportPickPlace process
ResetAllErrorMarkers process
ResetOrigin process
ResetCamera process
RotateSelectedObjects process
RunQuery process
RunQueryBuilder process
RunConvertedDrilledSMTPadsToMultiplayer
RunPolygonManager
RunScissors process
RunSpecctraForDos
RunSpecctraForWindows
Select process
SelectionMemory process
SetComponentReference process
SetCurrentLayer process
SetOrigin process
Setup process
SetupPreferences process
SetupPrinter process
ShowApplicableRules process
ShoveComponents process
ShowConnections process
ShowNetlistLength process
SnapGrid process
SwitchTo2D3D
TearDropSelectedPads process
TestGraphicsSystem process
ToggleSelection process
Undo process
UnRoute process
UpdateFootprints process
UpdateRotationOnSelectedComponents process
Zoom process

Alignment

MoveComponentsToGrid, MoveRoomsToGrid, Bottom, Left, Right, Top, CenterHorizontal, CenterVertical, ExpandHorizontal, ExpandVertical, ContractHorizontal, ContractVertical, SpreadHorizontal, SpreadVertical

If the Alignment parameter and its value is not supplied, then the Align Components dialog appears.

Action

ArrangeWithinRoom, ArrangeWithinRectangle, ArrangeOutsideBoard

The Action parameter with one of the values specifies how components can be arranged within a room on the PCB document.

TextType

Name, Comment

If TextType value is not specified or invalid, then the Autoposition dialog appears.

Autoposition

LEFT-ABOVE, LEFT-CENTER, LEFT-BELOW, CENTER-ABOVE, CENTER-CENTER, CENTER-BELOW, RIGHT-ABOVE, RIGHT-CENTER, RIGHT-BELOW

Specifies how strings can be auto positioned in respect to components on the PCB document.

Action

Start,Net,Connection,Component,SingleComponent,Area,Room,SingleRoom,Setup,Stop,Reset,Pause,Restart, ExportRoutes

If SingleComponent value is specified for the Action parameter, you will need to specify the ContextObject which is usually Component
If SingleRoom value is specified for the Action parameter, you will need to specify the ContextObject which is usually Room.

SeeFile

RenameDSN

If Action=ExportRoutes, you need to specify the SeeFile parameter.

Action

RepourAllPolygons, RepourSelectedPolygons,RepourSinglePolygon, RepourViolatingPolygons,
ConvertHatchedPolygonsToSolid

Assign ContextObject = Polygon first for Single Polygon, Selected Polygons or All Polygons.

ContextObject

Polygon, Net

If ContextObject = Polygon, then only these single polygon, all polygons or selected polygons will be repoured.
If ContextObject = Net, then Change Properties dialog for a Single Net will appear.

Object

Prompt, Focused

Specifies how objects are deleted; whether they are focused or you are prompted to delete them.

Scope

All, InsideArea, OutsideArea, Free, Layer

Defaults to All if no parameters are specified

InsideArea

Location1.X, Location1.Y, Location2.X, Location2.Y

All four parameters must be supplied as integers otherwise you are prompted to define the select rectangle.

OutsideArea

Location1.X, Location1.Y, Location2.X, Location2.Y

All four parameters must be supplied as integers otherwise you are prompted to define the select rectangle.

Layer

Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste, Bottomsolder, Drilldrawing,Drillguide,Keepout, Mechanical1, Mechanical2, Mechanical3, Mechanical4, Mechanical5, Mechanical6, Mechanical7, Mechanical8, Mechanical9, echanical10, Mechanical11, Mechanical12, Mechanical13, Mechanical14, Mechanical15, Mechanical16, Mechanical17, Mechanical18, Mechanical19, Mechanical20, Mechanical21, Mechanical22, Mechanical23, Mechanical24, Mechanical25, Mechanical26, Mechanical27, Mechanical28, Mechanical29, Mechanical30, Mechanical31, Mechanical32, Mid1, Mid10, Mid11, Mid12, Mid13, Mid14, Mid15, Mid16, Mid17, Mid18, Mid19, Mid20, Mid21, Mid22, Mid23, Mid24, Mid25, Mid26, Mid27, Mid28, Mid29, Mid30, Mid2, Mid3, Mid4, Mid5, Mid6, Mid7, Mid8, Mid9, Bottompaste, Bottomsolder, Drilldrawing, Drillguide, Plane1, Plane2, Plane3, Plane4, Plane5, Plane6, Plane7, Plane8, Plane9,Plane10, Plane11, Plane12, Plane13, Plane14, Plane15, Plane16, Toppaste, Topsolder

However, you can only place arcs on available used layers of the current PCB document. The layer list is a list of all possible layers that the PCB editor can support. If no layer is specified then this process defaults to the current layer.

InspectViolation

True, False

Defaults to false. If True, and Index not specified, all violations are shown.

Index

(1..n)

Specify which violation to display. If no value supplied, all violations are shown.

'NoLayer','TopSignal','Mid1', 'Mid2', 'Mid3', 'Mid4', 'Mid5', 'Mid6', 'Mid7', 'Mid8', 'Mid9', 'Mid10','Mid11','Mid12','Mid13','Mid14','Mid15', 'Mid16', 'Mid17', 'Mid18', 'Mid19', 'Mid20', 'Mid21', 'Mid22', 'Mid23', 'Mid24', 'Mid25', 'Mid26','Mid27','Mid28','Mid29','Mid30',
'BottomSignal','TopOverlay','BottomOverlay','TopPaste','BottomPaste','TopSolder','BottomSolder',
'Plane1', 'Plane2', 'Plane3', 'Plane4', 'Plane5', 'Plane6', 'Plane7', 'Plane8','Plane9', 'Plane10', 'Plane11', 'Plane12', 'Plane13','Plane14','Plane15','Plane16',
'DrillGuide','KeepOut','Mechanical1','Mechanical2','Mechanical3','Mechanical4','Mechanical5','Mechanical6','Mechanical7','Mechanical8','Mechanical9','Mechanical10','Mechanical11','Mechanical12','Mechanical13','Mechanical14','Mechanical15','Mechanical16','Mechanical17','Mechanical18','Mechanical19','Mechanical20','Mechanical21','Mechanical22','Mechanical23','Mechanical24','Mechanical25','Mechanical26','Mechanical27','Mechanical28','Mechanical29','Mechanical30','Mechanical31','Mechanical32','DrillDrawing','MultiLayer','ShowDRCErrors','ShowVisibleGrid1','ShowVisibleGrid2','ShowPadHoles','ShowViaHoles'

True, False, Toggle

One of the three states sets the visibility of the specified layer. If true, the specified layer is displayed, if false, the layer is not displayed. If the Toggle parameter is used, the visibility of the layer is toggled.

SnapGrid

Real

Denotes the size of the snap grid. X and Y sizes are the same. The snap grid is used to define the alignment grid for manual movement and placement.

SnapGridX

Real

Denotes the snap grid X size (horizontal value set)

SnapGridY

Real

Denotes the snap grid Y size (horizontal value set)

ComponentGrid

Real

The ComponentGridSize is set in internal coordinates. (X and Y values are the same for this parameter).

ComponentGridX

Real

Denotes the component grid in X size in current PCB Units.

ComponentGridY

Real

Denotes the component grid in Y size in current PCB Units.

RoutingTrackGrid

Real

Denotes the track grid size in current PCB Units.

RoutingViaGrid

Real

Denotes the via grid size in current PCB Units.

VisibleGrid1

Real

Denotes the size of the first visible grid size in current PCB Units.

VisibleGrid2

Real

Denotes the size of the second visible grid size in current PCB Units.

VisibleGridMultFactor1

Real

Denotes the size of the visible grid multi factor1 in current PCB Units.

VisibleGridMultFactor2

Real

Denotes the size of the visible grid multi factor 2 in current PCB Units.

ElectricalGridRange

Real

Denotes the electrical grid size in current PCB Units. See MeasurementUnit parameter.

ElectricalGridMultFact

Real

Denotes the electrical grid multi factor value in current PCB Units. See MeasurementUnit parameter.

ElectricalGridEnabled

True, False, Toggle

Denotes whether the electrical grid is enabled or not.

MeasurementUnit

Imperial, Metric, Toggle

This denotes the default measurement units for the current PCB document. Defaults to imperial units. The default units are used to display any distance related information on screen or in reports. They are also used if units are not specified when editing a distance value in an object dialog field. The Toggle value changes from one unit to the other.

VisibleGridKind

Dots,
Lines, Toggle

Denotes the visible grid type on the PCB document. By default the grid contains lines.

ShowSheet

True, False, Toggle

Denotes whether to display the sheet behind the board on the PCB document.

MaskLevel

Increase, Decrease

When the INCREASE parameter is applied, the MaskLevel is increased by one unit and when DECREASE parameter is applied, the MaskLevel is decreased by one unit.

ChangeFromLegacyToDXPPlaneMode

True, False

Change from legacy mode to DXP plane mode when importing from legacy designs and updating them.

Tab

LayerStack, DrillPairs, Mechanical, Layers,
<empty>

When Tab is set to one of the following values, the appropriate dialog is displayed, for example, Tab = LayerStack, the Layer Stack manager dialog is invoked and displayed. Tab = DrillPairs, Drill Pairs dialog appears. Tab = Mechanical or Layers, the View Configurations dialog appears. When Tab is empty or invalid string, the Board Options dialog appears.

Format

PROTEL NETLIST, SPECCTRA DESIGN, DXF, HYPERLINX, IPC, NETLIST, SHAPE, SELECTED

Specifies the file format for the current PCB document to be converted to.

Filename

String

Denotes the full path and filename of the PCB document to be exported.

Action

All, PowerPlaneNets, SignalNets, Room, Component, Selected, Net, Connection, Pad, SingleComponent, SingleRoom

If SingleRoom or SingleComponent values used, then specify the value (Room, Component) for the ContextObject parameter as well.

ContextObject

Component, Room

If Action = SingleRoom or SingleComponent, then ContextObject has to be assigned to Room or Component respectively.

Edit

True, False

True to display the PCB Filter panel

Value

String

a valid expression or expressions.

Action

ClearAllTestPoints

If no parameter supplied, test points are created.

Action

Explode, CreateComponentUnion, BreakComponentUnion, BreakAllComponentUnions

If Action = Explode then use the following parameters; Object (Component, Coordinate, Dimension, Polygon)

Object

Component, Coordinate, Dimension, Polygon

By default, free selected primitives are grouped into a component you have selected.

ContextObject

Polygon, Component

To explode a single polygon or component, you need to specify the ContextObject.

Hide

All, Net, ComponentNets

All: Hides all ratsnest connections; Net: Hides a specified net and you will be prompted to choose which net to hide.
ComponentNets: Hides nets connected to components only

Format

PROTEL NETLIST, SPECCTRA DESIGN, DXF, HYPERLINX, IPC, NETLIST, SHAPE, SELECTED

Specifies the file format to be imported into Altium Designer.

Filename

String

Denotes the full path and filename of the PCB document to be imported.

Object

Relative, Selected, Absolute, Location, Component, Net, Pad, String, DRCError,JumpToLocation1, JumpToLocation2, JumpToLocation3,JumpToLocation4,JumpToLocation5,JumpToLocation6,JumpToLocation7,JumpToLocation8,JumpToLocation9,JumpToLocation10, PlaceLocation1, PlaceLocation2,PlaceLocation3,PlaceLocation4,PlaceLocation5,PlaceLocation6,PlaceLocation7,PlaceLocation8,PlaceLocation9,PlaceLocation10

Relative: the jump process jumps to the reference point of the component
Selected: depending on the Type parameter, the Jump process jumps to a selected primitive or a selected group of primitives.
Absolute: jump to the absolute origin
Location: jump to the specified location
Component: jump to the specified component
Net: jump to the specified net
Pad: jump to the specified pad
String: jump to the specified string object
DRCError, jump to the specified string object.
To define a location marker (1..n), execute a jump process with a location marker and then click on the screen to define the coordinates. To jump to this defined marker, execute the jump process with a JumpToLocationX parameter.

Type

First, Previous, Next, Last, FirstGroup, PreviousGroup, NextGroup, LastGroup

Jump to first, previous, next or last selected primitive or group only if Object = Selected.

InternalPlane

(1..16)

Only can display internal planes 1 to 16. Otherwise the Power Pins information dialog appears.

SetIndex

0..4 (system)
5..X (user defined if any)

0 = All Layers
1 = Signal Layers
2 = Plane Layers
3 = Non Signal Layers
4 = Mechanical Layers
5 onwards correspond to any existing user defined layer sets.

mode

line

By default, interactive router is active when no parameters are supplied. To place a line, mode = line. To place a track (signal aware), mode = line | keepout = true.

keepout

True, False

Set it to true and when a signal aware track is being placed the keepout restrictions are observed. The keepout layer generally defines areas on the PCB document that you don't want automatically or manually routed, and this can include clearance areas around mounting hole pads or high voltage components for example.

SnapToGrid

(True,False)

Defaults to True. If true, the cursor snaps to a grid point.

Repeat

(True,False)

Defaults to True

Primitives

(True,False)

Defaults to False. When Primitives is true, you are prompted to click on two primitives.

Grid

Real

Specifies the grid value to move components to. If no parameters are used then a dialog box will prompt for a value.

GridX

Real

Specifies the grid X value to move components to. If no parameters are used then a dialog box will prompt for a value.

GridY

Real

Specifies the grid Y value to move components to. If no parameters are used then a dialog box will prompt for a value.

Position

Up10, Down10, Left10, Right10, Up, Down, Left, Right

Up10 = Up 10 snap grid units. Up = Up 1 snap grid unit.

Drag

True, False

If the Drag parameter is set to true, the object and its associated objects are moved together when it is being dragged.

Object

Component, Reroute, TrackEnd, Selection, PolygonVertices, Polygon, BoardOutlineVertices, BoardOutline, SheetAutoposition, Selection, Room, Room_Vertices

If TrackEnd, then the end of the track segment is repositioned. For the BoardOutlineVertices, you are prompted to edit the boardoutline, for the BoardOutline, you are prompted to move the outline.

ContextObject

Component, Polygon, Room

Specify the objects type when the MoveObject process is being carried out.

Action

EditNets, UpdateFreePrimitiveNets, ClearAllNets, ExportNetlistFromPCB, CreateNetlistFromConnectedCopper, CleanupNets, CleanUpSingleNets, AnalyseSingleNets

Specifies a specific action for the current netlist.

Mode

Special

Set the Mode to Special and this feature enables you to control what happens to certain object attributes when they are pasted back into the workspace. The special features allow you to create arrays of objects or create a panelized PCB layout. The Paste Special dialog appears allowing you to toggle the paste attributes.

OnCurrentLayer

True, False

If pasting on the current layer of the PCB document, specify true.

Array

True,False

If pasting an array of objects, specify true. An array of objects needs to be specified and copied to the clip board.

Action

RubberStamp

If Action = RubberStamp, you can click on the board multiple copies of the same object.

Method

Circle, Edge,EdgeAnyAngle

Defaults to Center if no parameter supplied.

Location.X

Real

X-location of the arc center point.

Location.Y

Real

Y-location of the arc center point.

Width

Real

Specifies the width of the arc in current PCB units.

StartAngle

Real: 0-360

Specifies the starting angle of the arc

Radius

Real

Specifies the radius of the arc

EndAngle

Real: 0-360

Specifies the ending angle of the arc

Keepout

True, False

Defaults to False if no parameters supplied.

Selected

True, False, Toggle

Specifies whether the arc is selected or not.

DRCError

True, False, Toggle

Specifies whether the arc has a DRC error or not

Locked

True, False, Toggle

Specifies whether the arc is locked from being graphically edited or not.

Layer

Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste, Bottomsolder, Drilldrawing, Drillguide, Keepout, Mechanical1..32, Mid1..30, Bottompaste, Bottomsolder, Drilldrawing, Drillguide, Plane1..16, Toppaste, Topsolder

Specifies the layer the arc object is on.

Mode

BOARDOUTLINE_FROM_SEL_PRIMS

By default, you have to define the vertices on the PCB document to draw a board outline. If the mode is set to BOARDOUTLINE_FROM_SEL_PRIMS parameter then the board outline is generated by the selected primitives.

NameOn

True, False

Sets the designator visibility on or off.

CommentOn

True, False

Sets the comment visibility on or off.

NameAutoPosition(0..10)

Manual,TopLeft,CenterLeft, BottomLeft,TopCenter, CenterCenter, BottomCenter,TopRight, CenterRight, BottomRight
CommentAutoPosition (0...10) Manual,TopLeft,CenterLeft, BottomLeft,TopCenter, CenterCenter, BottomCenter,TopRight, CenterRight, BottomRight

Sets the auto position of the name (Designator) object relative to the component.

UnionIndex

Integer

Unions are sets of components that will be manipulated as a block for the PCB placement. Components in a union maintain their relative positions within the union as they are moved.

GroupNum

Integer

Not used internally. Can use for specific purposes such as a tag.

Height

Real

Sets the height of the component

Pattern

String

See the footprint parameter.

FileName

String

The filename of the component.

Footprint

String

Name of the component to be place from a library in the current library list.

Location.X

Real

Location of the component on the x axis.

Location.Y

Real

Location of the component on the y axis.

Rotation

Real: 0-360

Defaults to 0 degrees.

Layer

Top, Bottom

Defaults to Top layer.

Designator.Text

String

String of the designator

Designator.Visible

Boolean

Visibility of the designator

Designator.Location.X

Real

Location of the designator in X coordinate

Designator.Location.Y

Real

Location of the designator in Y coordinate

Designator.Height

Real

Height of the designator in the current PCB Units

Designator.Font

Default, SansSerif, Serif

Set to one of the available 3 fonts (default, SansSerif or Serif). You can use True Type font instead (UseTTFonts parameter instead).

Designator.Rotation

Real

Rotation of the designator in degrees

Designator.Mirror

Boolean

Set it to true to mirror the designator text. If Mirror is set to true, the text string is flipped across the vertical axis.

Designator.Width

Real

The width of the designator in pixels.

Designator.UseTTFonts

Boolean

Use True Type fonts if set to true, otherwise use Comment.Font parameter.

Designator.Bold

Boolean

Set it to true to set the designator font style to bold.

Designator.Italic

Boolean

Set it to true to set the designator font style to italic.

Designator.FontName

String

Specify the font name for the Designator if UseTTFont parameter is set to true.

Designator.WideString

String

Wide String of the Designator bypassing the character limit.

Comment.Text

String

String of the commentr

Comment.Visible

Boolean

Visibility of the comment

Comment.Location.X

Real

Location of the comment in X coordinate

Comment.Location.Y

Real

Location of the comment in Y coordinate

Comment.Height

Real

Height of the comment in the current PCB Units

Comment.Font

Default, SansSerif, Serif

Set to one of the available 3 fonts (default, SansSerif or Serif). You can use True Type font instead (UseTTFonts parameter instead).

Comment.Rotation

Real

Rotation of the comment in degrees

Comment.Mirror

Boolean

Set it to true to mirror the comment text. If Mirror is set to true, the text string is flipped across the vertical axis.

Comment.Width

Real

The width of the comment in pixels.

Comment.UseTTFonts

Boolean

Use True Type fonts if set to true, otherwise use Comment.Font parameter.

Comment.Bold

Boolean

Set it to true to set the designator font style to bold.

Comment.Italic

Boolean

Set it to true to set the designator font style to italic.

Comment.FontName

String

Specify the font name for the CommentTTFont parameter is set to true.

Comment.WideString

WideString

Wide String of the Comment bypassing the character limit.

Location.X

Real

The X location of the coordinate object.

Location.Y

Real

The Y location of the coordinate object.

Size

Real

The length of the marker of the coordinate object.

LineWidth

Real

The current line width used to draw the coordinate marker lines, which form a cross centered on the measurement point of the coordinate.
Set a value in internal coordinates.

TextHeight

Real

The current height of the coordinate characters. The character width used to display or print the text is automatically proportioned to the height. A minimum height of 36mil (0.9mm) will allow the string to be legibly photoplotted.
Set a value in internal coordinates

TextWidth

Real

The current coordinate text stroke width
- the "thickness" of the lines used to produce the lettering. Set a value in internal coordinates for the text stroke width (range between 0.001 to 255mil).

Font

Serif, SansSerif, Default

The Default style is a simple vector font which supports pen plotting and vector
photoplotting. The Sans Serif and Serif fonts are more complex and will slow down vector output generation, such as Gerber. Stroke-based fonts are built into the software and cannot be changed. All three fonts have the full IBM extended ASCII character set that supports English and other European languages.

Style

None, Normal, Brackets

The current setting for the display style of coordinate units. The available values are:
None : No units are displayed, only the coordinates [eg. 1220, 3400].
Normal : Units are displayed with units after each value [eg. 1220mil, 3400mil].
Brackets : Units are displayed in brackets at the end of the coordinate [eg. 1220, 3400 (mil)].

Rotation

Real

Specifies the orientation of the coordinate object in degrees.

Selected

True, False, Toggle

Specifies the selected state of the object

DRCError

True, False, Toggle

Specifies whether this object has a DRC Error status or not.

Locked

True, False, Toggle

Specifies whether this object is locked from editing or not.

Layer

Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste, Bottomsolder, Drilldrawing, Drillguide, Keepout, Mechanical1..32, Mid1..30, Bottompaste, Bottomsolder, Drilldrawing, Drillguide, Plane1..16, Toppaste, Topsolder

Specifies the layer the coordinate object will be on.

DimensionKind

Original, Linear, Angular, Radial, Leader, Datum, Baseline, Center, LinearDiameter, RadialDiameter

Specirfies the dimension type.

Location.X

Real

The X location of the dimension object.

Location.Y

Real

The Y location of the dimension object.

Size

Real

The length of the marker of the dimension object.

LineWidth

Real

The current line width used to draw the extension dimension lines.
Set a value in internal coordinates.

TextHeight

Real

The current height of the characters in the dimension object. The character width used to display or print the text is automatically proportioned to the height. A minimum height of 36mil (0.9mm) will allow the string to be legibly photoplotted.
Set a value in internal coordinates

TextWidth

Real

The current text stroke width
- the "thickness" of the lines used to produce the lettering. Set a value in internal coordinates for the text stroke width (range between 0.001 to 255mil).

Font

Serif, SansSerif, Default

The Default style is a simple vector font which supports pen plotting and vector
photoplotting. The Sans Serif and Serif fonts are more complex and will slow down vector output generation, such as Gerber. Stroke-based fonts are built into the software and cannot be changed. All three fonts have the full IBM extended ASCII character set that supports English and other European languages.

Style

None, Normal, Brackets

The current setting for the display style of dimension units. The available values are:
None : No units are displayed, only the coordinates [eg. 1220, 3400].
Normal : Units are displayed with units after each value [eg. 1220mil, 3400mil].
Brackets : Units are displayed in brackets at the end of the coordinate [eg. 1220, 3400 (mil)].

Rotation

Real

Specifies the orientation of the dimension object in degrees.

Selected

True, False, Toggle

Specifies the selected state of the object

DRCError

True, False, Toggle

Specifies whether this object has a DRC Error status or not.

Locked

True, False, Toggle

Specifies whether this object is locked from editing or not.

Layer

Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste,Bottomsolder,Drilldrawing,Drillguide,Keepout,Mechanical1..32,Mid1..30,Bottompaste,Bottomsolder,Drilldrawing,Drillguide,Plane1..16,Toppaste,Topsolder

Specifies the layer the dimension object will be on.

Location1.X

Real

The X location of the fill object from left bottom

Location1.Y

Real

The Y location of the fill object from left bottom

Location2.X

Real

The X location of the fill object from top right

Location2.Y

Real

The Y location of the fill object from top right

Rotation

Real

Specifies the orientation of the fill object in degrees.

Selected

True, False,Toggle

Specifies the selected state of the object

Keepout

True, False

Specifies whether this object is used as a keep out object or not.

DRCError

True, False,Toggle

Specifies whether this object has a DRC Error status or not.

Locked

True, False,Toggle

Specifies whether this object is locked from editing or not.

Layer

Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste,
Bottomsolder,
Drilldrawing,
Drillguide,
Keepout,
Mechanical1..32,
Mid1..30,
Bottompaste,
Bottomsolder,
Drilldrawing,
Drillguide,
Plane1..16,
Toppaste,
Topsolder

Specifies the layer the fill object will be on.

Location.X

Real

The X location of the pad object from left bottom

Location.Y

Real

The Y location of the pad object from left bottom

Layer

Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste,
Bottomsolder,
Drilldrawing,
Drillguide,
Keepout,
Mechanical1..32,
Mid1..30,
Bottompaste,
Bottomsolder,
Drilldrawing,
Drillguide,
Plane1..16,
Toppaste,
Topsolder

Specifies the layer the pad object will be on

Locked

True, False

Whether or not the pad should be locked

Name

String

The designator for the pad

XSize

Real

The X size of the pad (for simple stackups)

YSize

Real

The Y size of the pad (for simple stackups)

Shape

Round, Octagonal, Rectangle, RoundedRectangle

The shape of the pad (for simple stackups)

TopXSize

Real

The X Size of the pad on the top layer (for a top-middle-bottom stackup)

TopYSize

Real

The Y Size of the pad on the top layer (for a top-middle-bottom stackup)

MidXSize

Real

The X Size of the pad on the mid layers (for a top-middle-bottom stackup)

MidYSize

Real

The Y Size of the pad on the mid layers (for a top-middle-bottom stackup)

BotXSize

Real

The X Size of the pad on the bottom layer (for a top-middle-bottom stackup)

BotYSize

Real

The Y Size of the pad on the bottom layer (for a top-middle-bottom stackup)

Rotation

Real

Rotation of the pad (in degrees)

HoleSize

Real

Size of the pad hole

HoleType

0, 1, 2

Type of hole - 0 for Round, 1 for Square, and 2 for slotted

HoleWidth

Real

Width of the hole (for slotted holes)

HoleRotation

Real

Rotation of the hole (in degrees)

Daisychain

Source, Load, Terminator

Specifies the electrical type of the pad

Plated

True, False

Whether or not the pad is plated

PourOver

Integer

0 = None 1 = SameNet 2 = SameNetPolygons

RemoveDead

True, False,Toggle

Set it to true to remove any regions of "dead" copper within the polygon. Dead copper is created when an area of the polygon can not be connected to the selected net.

GridSize

Real

Specifies grid size used when pouring polygon

TrackWidth

Real

Specifies track width used when pouring polygon

MinPrimLength

Real

The current minimum allowable primitive length for the polygon pour. Polygons pours can contain many small primitives to create smooth edges around existing objects on the board. A larger value will give faster pour times, screen redraws and output generation, at the expense of the smoothness of curved polygon edges.

HatchStyle

90Degree, 45Degree, Vertical, Horizontal, None

Specifies the hatching style of the polygon pour.

Netname

String

Specifies the netname of the net that the polygon is connected to.

UseOctagons

True, False,Toggle

Set the UseOctagon parameter true to surround enclosed pads with octagons when pouring the polygon. This results in smaller Gerber files and faster photoplotting. Set it to false to use arcs instead.

PolygonType

Polygon, Split Plane

Set the Polygon type to Polygon or split plane.

Kind(n)

0, 1

Segment kind, 0 specifies track segment, 1 specifies arc segment

Vx(n)

Real

Starting point of vertex (n)

Vy(n)

Real

End point of vertex (n)

Cx(n)

Real

X center point of arc segment (n)

Cy(n)

Real

Y center point of arc segment (n)

SA(n)

Real

Starting Angle of arc segment (n)

EA(n)

Real

End Angle of arc segment (n)

R(n)

Real

Radius of arc segment (n)

Selected

True, False,Toggle

Specifies the selected state of the object

DRCError

True, False,Toggle)

Specifies whether this object has a DRC Error status or not.

Locked

True, False,Toggle

Specifies whether this object is locked from editing or not.

PrimitiveLock

True, False,Toggle

Set this to true to allow all tracks that form the polygon pour to be treated as a single object. If you want to individually edit the tracks that make up the polygon, set the value to false.

Layer

Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste, Bottomsolder, Drilldrawing, Drillguide, Keepout, Mechanical1..32, Mid1..30, Bottompaste, Bottomsolder, Drilldrawing, Drillguide, Plane1..16, Toppaste, Topsolder

Specifies the layer the polygon object will be on.

ModeFit

Polygonal_room, Create_Centers, Create_NonOrtho, Create_Ortho, Create_Rectangle, Fit_Centers, Fit_NonOrtho, Fit_Ortho, Fit_Rectangle

Create_Centers: Creates a Room from Component Centers
Create_NonOrtho: Create Non-Orthogonal Room from Components
Create_Ortho: Create Orthogonal Room from Components
Create_Rectangle: Create Rectangular Room from Components
Fit_Centers: Wrap Room Around Member Component Centers
FIt_NonOrtho: Wrap Non-Orthogonal Room Around Member Components
Fit_Ortho: Wrap Orthogonal Room Around Member Components
Fit_Rectangle Wrap Rectangular Room Around Member Components

ContextObject

Room

PourOver

Integer

0 = None 1 = SameNet 2 = SameNetPolygons

RemoveDead

True, False,Toggle

Set it to true to remove any regions of "dead" copper within the polygon. Dead copper is created when an area of the polygon can not be connected to the selected net.

GridSize

Real

Specifies grid size used when pouring polygon

TrackWidth

Real

Specifies track width used when pouring polygon

MinPrimLength

Real

The current minimum allowable primitive length for the polygon pour. Polygons pours can contain many small primitives to create smooth edges around existing objects on the board. A larger value will give faster pour times, screen redraws and output generation, at the expense of the smoothness of curved polygon edges.

HatchStyle

90Degree, 45Degree, Vertical, Horizontal, None

Specifies the hatching style of the polygon pour.

Netname

String

Specifies the netname of the net that the polygon is connected to.

UseOctagons

True, False,Toggle

Set the UseOctagon parameter true to surround enclosed pads with octagons when pouring the polygon. This results in smaller Gerber files and faster photoplotting. Set it to false to use arcs instead.

PolygonType

Polygon, Split Plane

Set the Polygon type to Polygon or split plane.

Kind(n)

0, 1

Segment kind, 0 specifies track segment, 1 specifies arc segment

Vx(n)

Real

Starting point of vertex (n)

Vy(n)

Real

End point of vertex (n)

Cx(n)

Real

X center point of arc segment (n)

Cy(n)

Real

Y center point of arc segment (n)

SA(n)

Real

Starting Angle of arc segment (n)

EA(n)

Real

End Angle of arc segment (n)

R(n)

Real

Radius of arc segment (n)

Selected

True, False,Toggle

Specifies the selected state of the object

DRCError

True, False,Toggle)

Specifies whether this object has a DRC Error status or not.

Locked

True, False,Toggle

Specifies whether this object is locked from editing or not.

PrimitiveLock

True, False,Toggle

Set this to true to allow all tracks that form the polygon pour to be treated as a single object. If you want to individually edit the tracks that make up the polygon, set the value to false.

Layer

Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste, Bottomsolder, Drilldrawing, Drillguide, Keepout, Mechanical1..32, Mid1..30, Bottompaste, Bottomsolder, Drilldrawing, Drillguide, Plane1..16, Toppaste, Topsolder

Specifies the layer the split plane object will be on.

Height

Real

The height of the string. Defaults to 60mils

Width

Real

The width of the letters in a string. Defaults to 10mils

Font

String: Default, SansSerif, Serif

The type of font for the string object.

Rotation

Real: 0-360

Specifies the orientation of the string object in degrees.

Mirror

True, False

Specifies the mirrored status of the string. If Mirror is set to true, the text string is flipped across the vertical axis.

Text

String

Upto 255 characters. Special strings can be used. See footnote for more information on special strings.

Location.X

Real

The X location of the string object from left bottom

Location.Y

Real

The Y location of the string object from left bottom

Selected

True, False,Toggle

Specifies the selected state of the object

DRCError

True, False,Toggle

Specifies whether this object has a DRC Error status or not.

Locked

True, False,Toggle

Specifies whether this object is locked from editing or not.

Layer

Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste,Bottomsolder,Drilldrawing,Drillguide,Keepout,Mechanical1..32,Mid1..30,Bottompaste,Bottomsolder,Drilldrawing,Drillguide,Plane1..16,,Toppaste,Topsolder

Specifies the layer the string object will be on.

Width

Real

The Width of the track object

Location1.X

Real

The X location of the track object from left bottom

Location1.Y

Real

The Y location of the track object from left bottom

Location2.X

Real

The X location of the track object from top right

Location2.Y

Real

The Y location of the track object from top right

UserRouted

True, False,Toggle

Specifies whether this object has been manually routed or not.

TearDrop

True, False,Toggle

Specifies whether this object has been used for teardrop

Selected

True, False.Toggle

Specifies the selected state of the object

DRCError

True, False,Toggle

Specifies whether this object has a DRC Error status or not.

Locked

True, False,Toggle

Specifies whether this object is locked from editing or not.

Layer

Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste, Bottomsolder, Drilldrawing, Drillguide, Keepout, Mechanical1..32, Mid1..30, Bottompaste, Bottomsolder, Drilldrawing, Drillguide, Plane1..16, Toppaste, Topsolder

Specifies the layer the track object will be on.

Diameter

Real

Specifies the diameter of the via

HoleSize

Real

Specifies the holesize of the via

Location.X

Real

The X location of the via object from the center of this via

Location.Y

Real

The Y location of the track object from the center of this via

UserRouted

True, False,Toggle

Specifies whether this object has been manually routed or not.

StartLayer

Top, Mid1..Mid30, Bottom

Specifies the top layer the via object will be on.

EndLayer

Top, Mid1..Mid30,Bottom

Specifies the bottom layer the via object will be on.

Expr

string

The Expr refers to the valid expression statement or statements (with OR and AND keywords in the expression) that the Query engine parses first before taking action. Refer to the Query documentation for more details on numerous parameters for this RunQuery process.

Action

FindSimilar, FindSimilarUnderCursor

If Action is set to FindSimilar, you are prompted to choose a template PCB design object before the Find Similar Object dialog appears.
If Action is set to FindSimilarUnderCursor, those objects that appear under the cursor

Zoom

True,False

If true, and the query expression is valid, the objects affected by the query are zoomed into.

Mask

True,False

If true, and the query expression
is valid, the objects affected by the query are masked.

Select

True,False

If true, and the query expression
is valid, the objects affected by the query are selected.

Clear

True,False

If true, the current query is cleared.

Source

Favorite, History, Example

To choose a favorite query and use it for querying, set the Source to Favorite / History and specify the Index (indexed favorite), Apply, Zoom, Mask, Select, Clear parameters.

Apply

True, False

If true, the Query expression are processed immediately. If false or parameter not set, the Query expression is added to the PCB filter and you then can set the filter options and then press Apply button. You need to have the Expr, and other parameters set up first.

LaunchMode

UnderCursor

Defaults to blank. If UnderCursor, the QueryBuilder dialog appears with a query for the current state of selection of objects on a PCB document.

RunRuleWizard

True, False

If True, the Query Builder wizard appears and assist you with building a query.

Mode

Cut_Polygons, Cut_Rooms, SmartCut_Rooms

Cut_Polygons = slice polygons
Cut_Rooms =Slice a room object
SmartCut_Rooms = Slice a room object including those created by the Component Class Creation.

ContextObject

Room, Polygon

You need to provide the context for the Scissors process. Use Room or Polygon.

Scope

InsideArea, OutsideArea, All, Board, Net, ConnectedCopper, PhysicalConnection, Layer, Free,Locked, OffGridPads, RoomConnections, ComponentConnections, ComponentNets

If RoomConnections, ComponentConnections or ComponentNets then you might need to specify the ContextObject parameter where possible values are Room or Component.

Action

ShowDialog, Store, Recall, StorePlus, RecallPlus, Clear, Apply

The action parameter specifies how the operation for the SelectionMemory is to be carried out. You will need to specify the Index parameter as well.

Index

1..8

Choose one of the 8 memory locations.

Location

Pin, Center

Specify the location parameter to set the reference point of a component object.

LayerName

NextSignal, Next, Previous, PreviousSignal

Specify the layername to the next signal layer, next available layer, previous layer or previous signal layer in respect to the current layer.

Location.X

Real

Specifies the X coordinate of the origin on the PCB document.

Location.Y

Real

Specifies the Y coordinate of the origin on the PCB document.

DefaultPrimitives

SAVE, LOAD

If the DefaultPrimitives parameter set to 'SAVE', the default primitives are saved to a default file, otherwise if the parameter is set to 'LOAD', the default primitives are loaded into the PCB Editor - Defaults page of the Preferences dialog. Note, the LOAD or SAVE values must be in Uppercase.

Tab

Display, Colors, SystemColors, PreferredWidths, PreferredVias, Show/Hide, Defaults, Board Insight Display, Board Insight Modes, Board Insight Lens, Interactive Routing, Truye Type Fonts, Mouse Wheel Configuration, Layer Colors, PCB Legacy 3D.

Defaults to running Preferences dialog with the Options page active if no parameters supplied. Otherwise the tab parameter sets the page of the preferences dialog active.

SelectHidden

True, False, Toggle

Not Implemented.
Use the Toggle value to toggle from True to False or False to True.

SnapToCenter

True, False, Toggle

If SnapToCenter parameter is set to True, the cursor jumps automatically to a defined reference point on the object when you select it and be "held" by that point as you reposition it. For free pads or vias, the cursor will snap to the center of the object, with components, the cursor snaps to the reference point of the component. For tracks, the cursor snaps to the vertex point.
Otherwise if the parameter is set to False, objects will be "held" by the point at which you click on them.
Use the Toggle value to toggle from True to False or False to True.

SmartComponentSnap

True, False, Toggle

If the parameter is set to True, the cross hair cursor appears on the nearest pad of this associated component in respect to where the cursor is. When False, the cross hair cursor always appears on the pad reference point of this component when it is clicked on.
Use the Toggle value to toggle from True to False or False to True.

SmartDrag

True,False, Toggle

Set the SmartDrag parameter to true to preserve the angles of tracks and arcs when you are dragging them on the PCB document.

ClickClearsSelection

True,False, Toggle

Set the ClickClearsSelection parameter if you want to deselect all design objects by clicking any where on the PCB workspace.
Otherwise set it to false if you do not want to have this click anywhere to deselect all ability and you can click on a selected design object to deselect it without affecting other selected design objects and the selection process is cumulative.

ToggleMustHoldShiftToSelect

True,False, Toggle

Set the parameter to true so that single design objects can be selected by Shift and Click. Set it to false and objects can clicked to be selected.
See HoldShiftToSelect_<DesignObject> parameters for finer control.

MustHoldShiftToSelect

True,False, Toggle

Set the parameter to true so that single design objects can be selected by Shift and Click. Set it to false and objects can clicked to be selected.
See HoldShiftToSelect_<DesignObject> parameters for finer control.

NearestComponent

True,False, Toggle

Not implemented.

AutoPan

True,False, Toggle

If the parameter is set to True, the Auto panning of the PCB document can be carried out. When False, the PCB document cannot be auto panned..
Use the Toggle value to toggle from True to False or False to True.

RemoveDuplicates

True,False, Toggle

When this parameter to check for and remove duplicate primitives when the system is preparing data for output. Enable this option when outputting to a vector device, such as a pen plotter or a vector photo-plotter.

AutoVia

True,False, Toggle

Not implemented.

OnlineDRC

True,False, Toggle

When this parameter is set to true, Altium Designer monitors all PCB design rules interactively as you work and immediately highlight any rule violations. If this option is disabled, design rule violations will not be highlighted as you work.

LoopRemoval

True,False, Toggle

Set this parameter to true to automatically remove any redundant loops that are created during manual routing on the current PCB document. This allows you to re-route a connection without having to manually remove redundant tracks.

RoutingMode

'IGNORE', 'AVOID', 'PUSH', 'CYCLE'

When parameter is set to Ignore, Interactive Router allows the track to completely ignore obstacles while routing. If set to Push, the router moves existing tracks out of the way while routing. If set to Avoid, the Router traces around existing tracks, pads and vias while routing.
If set to cycle, the router cycles from a current routing mode to the next mode.

RestrictRoutingTo9045

True,False, Toggle

When the parameter is set to True, the changes of direction during interactive routing are restricted to using 45° or 90° angled tracks. When parameter is set to false, the full range of corner modes is available (any angle, 45°, 45° with arc, 90° and 90° with arc).

DuplicateDesignators

True,False, Toggle

If set to true, duplicate designators are allowed for the current PCB document.

ConfirmDelete

True,False, Toggle

Set the parameter to true to have a confirmation dialog appear before clearing a Selection Memory entry. Selection Memories can be used to store the selection state of a set of objects and are accessed via the Selection Memory dialog (open using the button to the left of the Mask Level button, lower right-hand corner of the main design window).

ConfirmGlobalEdit

True,False, Toggle

When the parameter is set to True, the confirmation dialog appears before you can commit or cancel a global editing action. If the parameter is set to False, global editing changes will be made as soon as you click the OK button in a global editing dialog.

ConfirmDragTracks

True,False, Toggle

When the parameter is set to True, the confirmation dialog appears before you can drag tracks.

RotationStep

A real value between 0-and 360 degrees.

The value is in real format. The Default value is 90.000. The Minimum angular resolution is 0.001degrees.

ComponentDrag

None,
ConnectedTracks

When the parameter is set to None, and you drag a component, only the component moves. Any attached tracks will be disconnected and left in place.
When the parameter is set to ConnectedTracks and you drag a component, any connected tracks will remain attached to the component.
This affects how connected tracks are handled when you drag a component.

CursorType

Large90
Small90
Small45

If Parameter set to Small90 - Small crosshair cursor like a cross (+). This is the default.
If set to Large90 - Cursor like a cross (+) spanning the width of the screen.
If set to Small45 - a small crosshair cursor and the lines are at a 45° (eg. X).

ShowInvisibleObjects

True,False, Toggle

This parameter corresponds to the Origin Marker. If parameter is set to True, the coordinate origin marker (bottom left corner) is displayed. All objects in the PCB design are positioned relative to the origin marker. Use the Toggle value to toggle from True to False or False to True.

ConvertSpecialStrings

True,False, Toggle

If parameter is set to True, the special strings are converted to their literal values. Special strings act as place holders for various system data, eg. layers names, hole counts and drawing legends. Normally, special strings are interpreted during printing or plotting.
Use the Toggle value to toggle from True to False or False to True.

HighlightInFull

True,False, Toggle

Set the parameter to true to have selected objects completely highlighted in the current selection color. Set this parameter to false and selected objects are only outlined in the current selection color.

UseNetColorForHighlight

True,False, Toggle

Set the parameter to true and the color is assigned to a particular net for highlighting when you select a net ( Edit » Select » Net in PCB ). Set this parameter to false and a selected net is highlighted in the default selection color.

CleanRedraw

True,False, Toggle

Set this parameter to true, the the document is refreshed with minimal corruption during redrawing but this option is computionally intensive. Turn this option off to use less computing resources.

RedrawLayers

True,False, Toggle

Set this parameter to true to redraw the screen each time you toggle to a different layer, with the current layer being redrawn last. Set this parameter to false and the screen is not redrawed when moving to a different layer.

SingleLayerMode

True,False, Toggle

Set the parameter to True/False the the current single layer mode is cycled. If Gray Scale Other layers were set then Not In Single layer Mode is set and vice versa.

TransparentLayers

True,False, Toggle

Set the parameter to true and when objects are masked, you can see through them to objects on layers underneath the mask.

UseColorDithering

True,False, Toggle

Set the parameter to true and the colors are dithered using least colors. Set it to false, and maximal colors offered by the PC are used.

HoldShiftToSelect_NoObject

True, False, Toggle

If the parameter is false, then all objects to be selected, you need to use the Shfit Click to select. If Parameter is true, you can select design objects nnormally.

HoldShiftToSelect_Arc

True,False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single arc object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Pad

True,False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single pad object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Via

True,False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single via object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Track

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single track object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Text

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single text object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Fill

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single fill object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Connection

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single connection object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Net

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single net object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Component

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single component object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Poly

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single polygon object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_PolyRegion

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single region object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_ComponentBody

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single component body object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Dimension

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single dimension object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Coordinate

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single coordinate object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Class

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single class object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Rule

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single rule object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_FromTo

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single fromto object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_DifferentialPair

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single differential pair object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Violation

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single violation object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Embedded

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single embedded object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_EmbeddedBoard

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single embedded board object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_SplitPlane

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single split plane object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Trace

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single trace object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_SpareVia

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single spare via object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_Board

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single board object to select it. Set it to false and you can click on the object to select it.

HoldShiftToSelect_BoardOutline

True,
False, Toggle

If the parameter is true, you need to use the SHIFT key as well as clicking on a single board outline object to select it. Set it to false and you can click on the object to select it.

TopSignalColor

Integer

Set the parameter to a RGB integer value to set the color for this top signal layer.

Mid1Color-Mid30Color

Integer

Set the parameter to a RGB integer value to set the color for this middle layer.

BottomSignalColor

Integer

Set the parameter to a RGB integer value to set the color for this bottom signal layer.

TopOverlayColor,BottomOverlayColor

Integer

Set the parameter to a RGB integer value to set the color for this top/bottom overlay layer.

TopPasteColor, BottomPasteColor

Integer

Set the parameter to a RGB integer value to set the color for this top/bottom paste layer.

TopSolderColor, BottomSolderColor

Integer

Set the parameter to a RGB integer value to set the color for this top/bottom solder layer.

Plane1Color - Plane16Color

Integer

Set the parameter to a RGB integer value to set the color for this internal plane layer.

DrillGuideColor

Integer

Set the parameter to a RGB integer value to set the color for this drill guide layer.

KeepOutColor

Integer

Set the parameter to a RGB integer value to set the color for this keep out layer.

Mechanical1Color - Mechanical32Color

Integer

Set the parameter to a RGB integer value to set the color for this mechanical layer.

DrillDrawingColor

Integer

Set the parameter to a RGB integer value to set the color for this drill drawing layer.

MultiLayerColor

Integer

Set the parameter to a RGB integer value to set the color for this multi layer.

ConnectLayerColor

Integer

Set the parameter to a RGB integer value to set the color for this connect layer.

SelectionColor

Integer

Set the parameter to a RGB integer value to set the color for this selection layer.

DRCErrorColor

Integer

Set the parameter to a RGB integer value to set the color for this DRC Error layer.

BackgroundColor

Integer

Set the parameter to a RGB integer value to set the color for this background layer.

PadHoleColor

Integer

Set the parameter to a RGB integer value to set the color for this pad hole layer.

ViaHoleColor

Integer

Set the parameter to a RGB integer value to set the color for this via hole layer.

VisibleGrid1Color

Integer

Set the parameter to a RGB integer value to set the color for this visible grid 1 layer.

VisibleGrid2Color

Integer

Set the parameter to a RGB integer value to set the color for this visible grid 2 layer.

ArcQuality

Full, Draft, Hidden

The parameter sets the display mode for arcs.

FillQuality

Full, Draft, Hidden

The parameter sets the display mode for fills.

PadQuality

Full, Draft, Hidden

The parameter sets the display mode for pads.

PolygonQuality

Full, Draft, Hidden

The parameter sets the display mode for polygons.

DimensionQuality

Full, Draft, Hidden

The parameter sets the display mode for dimensions.

StringQuality

Full, Draft, Hidden

The parameter sets the display mode for strings.

TrackQuality

Full, Draft, Hidden

The parameter sets the display mode for tracks.

ViaQuality

Full, Draft, Hidden

The parameter sets the display mode for vias.

ComponentQuality

Full, Draft, Hidden

The parameter sets the display mode for components.

AllQuality

Full, Draft, Hidden

The parameter sets the display mode for All primitives

DraftTrackThreshold

Real

This parameter shows the current minimum track width that determines whether or not tracks are displayed as single lines or outlines in Draft display mode. Tracks of the defined width, or narrower, will be displayed as a single line. Tracks of greater width will be displayed as an outline when displayed in Draft Mode.
Specify a value in Real type for the Parameter to change the width. The width is based on the current unit used by the PCB Editor.
Default units (metric or imperial) are determined by the Measurement Unit setting in the Board Options dialog ( Design » Board Options ).
When DirectX is being used this DraftTrackThreshold is ignored.

DraftStringThreshold

Integer

Set the parameter to the current minimum string height (in screen pixels) that determines whether or not the text on the document is displayed in full or as an outline box only. Strings equal to or greater than the set number of pixels in height at the current zoom level will be displayed as text. Otherwise the text is replaced by an outline box. The default is 4 pixels. When DirectX is being used this DraftStringThreshold is ignored.

ShowPadNumbers

True, False, Toggle

Set the parameter to true to display Pad Numbers for pad objects.

ShowPadNets

True, False, Toggle

Set the parameter to true to display Nets for pad objects.

ShowViaNets

True, False, Toggle

Set the parameter to true to display Nets for via objects.

ShowTextPoints

True, False, Toggle

Set the parameter to true to display Test Points on the PCB document. Notice the spelling "Text". ShowTextPoints parameter corresponds to the test points.

ShowStatusInfo

True, False, Toggle

Set the parameter to true and the status information for the current PCB object is displayed on the status bar of Altium Designer. The information displayed includes the location of this object on a PCB document, the layer it is on and the net it is connected to (showing the width and length of this net as well).

ShowComponentRefPoint

True, False, Toggle

Set the parameter to true to display the component reference point markers for components.

ShowComponentBodies

True, False, Toggle

Set the parameter to true to display extruded 3D bodies whenever the view configuration Show Simple 3D Bodies setting is set to Use System Settings.

ShowComponentStepModels

True, False, Toggle

Set the parameter to true to display 3D STEP models whenever the view configuration Show STEP Models setting is set to Use System Settings.

ShowComponentSnapMarkers

True, False, Toggle

Set the parameter to true to display Snap Markers for components when in 3D mode.

ShowBoardCore

True, False, Toggle

Set the parameter to true to display the board core when in 3D mode.

ShowBoardPrepreg

True, False, Toggle

Set the parameter to true to display the board prepreg when in 3D mode

ShowTopSilkScreen

True, False, Toggle

Set the parameter to true to display the top silk screen when in 3D mode

ShowBotSilkScreen

True, False, Toggle

Set the parameter to true to display the bottom silk screen when in 3D mode

PlaneDrawMode

0,1

If PlaneDrawMode parameter set to 0, outlined Layer Colored. If parameter is set to 1, Solid Net Colored.

DisplayNetNamesOnTracks

0,1,2

If DisplayNetNamesOnTracks parameter set to 0, Netnames are not displayed on tracks. If 1, Net names are Single
And
Centered and displayed on tracks. If 2, Net names are repeated on tracks.

OriginMarkerColor

Integer

Specifies the Origin Marker color with the RGB value converted from 6 digit hexidecimal number. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)). Examples: Color=0 is black Color=255 is red Color=65280 is green Color=16711680 is blue Color=16777215 is white.

ComponentRefPointColor

Integer

Specifies the Component Reference Point color with the RGB value converted from 6 digit hexidecimal number. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)). Examples: Color=0 is black Color=255 is red Color=65280 is green Color=16711680 is blue Color=16777215 is white.

PositiveTopSolderMask

True, False, Toggle

Set the PositiveTopSolderMask to true to display the top solder mask in positive. If False, this solder mask is in negative.

PositiveBottomSolderMask

True, False, Toggle

Set the PositiveBottomSolderMask to true to display the bottom solder mask in positive. If False, this solder mask is in negative.

FromTosDisplayMode

0,1,2

Set the parameter to 0, and the FromToDisplay Mode is set to automatic. If 1, the From To Display mode is hidden. If 2, the From To Display mode is shown.

PadTypesDisplayMode

0,1,2

Set the parameter to 0, and the Pad Types Display Mode is set to automatic. If 1, the Pad Types Display mode is hidden. If 2, the Pad Types Display mode is shown.

BoardThicknessScaling

Double

Define the board thickness in scale (0 to 100).

WorkspaceLuminanceVariation

Integer

Specifies the Workspace Luminance Variation color with the RGB value converted from 6 digit hexidecimal number. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)). Examples: Color=0 is black Color=255 is red Color=65280 is green Color=16711680 is blue Color=16777215 is white.

WorkspaceColor3D

Integer

Specifies the Workspace Color 3D color with the RGB value converted from 6 digit hexidecimal number. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)). Examples: Color=0 is black Color=255 is red Color=65280 is green Color=16711680 is blue Color=16777215 is white.

BoardCoreColor3D

Integer

Specifies the Board Core Color 3D color with the RGB value converted from 6 digit hexidecimal number. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)). Examples: Color=0 is black Color=255 is red Color=65280 is green Color=16711680 is blue Color=16777215 is white.

BoardPrepregColor3D

Integer

Specifies the Board Prepreg Color 3D color with the RGB value converted from 6 digit hexidecimal number. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)). Examples: Color=0 is black Color=255 is red Color=65280 is green Color=16711680 is blue Color=16777215 is white.

TopSolderMaskColor3D

Integer

Specifies the Top Solder Mask 3D color with the RGB value converted from 6 digit hexidecimal number. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)). Examples: Color=0 is black Color=255 is red Color=65280 is green Color=16711680 is blue Color=16777215 is white.

BotSolderMaskColor3D

Integer

Specifies the Bottom Solder Mask Color 3D color with the RGB value converted from 6 digit hexidecimal number. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)). Examples: Color=0 is black Color=255 is red Color=65280 is green Color=16711680 is blue Color=16777215 is white.

CopperColor3D

Integer

Specifies the Copper Color 3D color with the RGB value converted from 6 digit hexidecimal number. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)). Examples: Color=0 is black Color=255 is red Color=65280 is green Color=16711680 is blue Color=16777215 is white.

TopSilkScreenColor3D

Integer

Specifies the Top Silk Screen Color 3D color with the RGB value converted from 6 digit hexidecimal number. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)). Examples: Color=0 is black Color=255 is red Color=65280 is green Color=16711680 is blue Color=16777215 is white.

BotSilkScreenColor3D

Integer

Specifies the Bottom Silk Screen Color 3D color with the RGB value converted from 6 digit hexidecimal number. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)). Examples: Color=0 is black Color=255 is red Color=65280 is green Color=16711680 is blue Color=16777215 is white.

WorkspaceColor3D_Opacity

Single

Set opacity value between 0 and 1 to set the Workspace Color 3D.

BoardCoreColor3D_Opacity

Single

Set opacity value between 0 and 1 to set the Board Core Color 3D.

BoardPrepregColor3D_Opacity

Single

Set opacity value between 0 and 1 to set the Board Prepreg Color 3D.

TopSolderMaskColor3D_Opacity

Single

Set opacity value between 0 and 1 to set the Top Solder Mask Color 3D.

BotSolderMaskColor3D_Opacity

Single

Set opacity value between 0 and 1 to set the Bottom Solder Mask Color 3D.

CopperColor3D_Opacity

Single

Set opacity value between 0 and 1 to set the Copper Color 3D.

TopSilkScreenColor3D_Opacity

Single

Set opacity value between 0 and 1 to set the Top Silk Screen Color 3D.

BotSilkScreenColor3D_Opacity

Single

Set opacity value between 0 and 1 to set the Bottom Silk Screen Color 3D.

Binary

True, False

Defaults to unary rule if no parameter is specified. If True, you are prompted to select two objects.

Method

SetShoveDepth

If Method = SetShoveDepth, you will be prompted with a Shove Depth dialog.

Show

Net, ComponentNets, All

If Net, then the specified net is shown only and you will be prompted to choose which net. If All, all connections are shown. If ComponentNets, only nets to components will be shown.

Size

1Mil, 5Mil, 10Mil, 20MIl, 25Mil, 50MIl, 100Mil, 0.025MM, 0.100MM, 0.250MM, 0.500MM, 1.000MM, 2.500MM

If Size not specified, you are prompted to define a snap grid.

Axis

X,Y

When Axis = X or Y, you are required to also specify a value in current Units for the X or Y. If the Value is not specified for either X or Y, you will be prompted to enter a value for either X or Y.

Value

String

Possible values for the X or Y axis are: 1Mil, 5Mil, 10Mil, 20MIl, 25Mil, 50MIl, 100Mil, 0.025MM, 0.100MM, 0.250MM, 0.500MM, 1.000MM, 2.500MM. If Value not specified, you are prompted to define a snap grid.

Object

Arc, Component, Fill, Pad, Track, Via, String, Coordinate, Dimension, Polygon, Net

The process prompts for a object to be selected depending on which object is targeted. If Object is not specified, the process selects any object you click on.If the Click Clears Selection
option is enabled in the PCB Editor - General page then it clears previous seletions first.

Object

All, Net, Room, SingleRoom, Connection, Component, SingleComponent

When Object = SingleRoom or SingleComponent, you need to specify the value for the ContextObject (Room or Component respectively)

ContextObject

Room, Component

Specify the ContextObject if you wish to specify the Object parameter as a single room or single component.

Mode

All

If mode is set to All, all PCB footprints from the PCB library are updated. If mode is set to empty, the current PCB footprint from the PCB library is updated.

ZoomLevel

Real

Prompts for a zoom value if not specified.

Action

In, Out, All, Filtered, Board, Last, MicroIn, MicroOut, Pan, Point, Redraw, RedrawCurrent,Selected, Sheet, Window

If Action is set to area, then the four following parameters will be used (Location1.x, Location1.Y, Location2.X and Location2.Y)