Inherits: Area < DesignShape < CommonShape < DesignItem < ScriptObject

Areas are identifiable regions of a design with various properties.

Properties

NameTypeGet/SetBrief
AlternativeThermalGapboolYes/YesWhether to use an alternative thermal gap in this area.
BoardCutoutBoardCutoutYes/YesThe board cutout mode of this area.
ComponentPadRestrictionRestrictionYes/YesRule for component pads within this area.
ComponentRestrictionRestrictionYes/YesRule for components within this area.
CopperKeepOutboolYes/YesWhether to keep copper out of this area.
CopperPourAvoidboolYes/YesWhether copper pour should avoid this area.
DrillKeepOutboolYes/YesWhether to keep drilling holes out of this area.
MountingHoleRestrictionRestrictionYes/YesRule for mounting holes within this area.
NamestrYes/YesThe name of this area.
TestpointRestrictionRestrictionYes/YesRule for test points within this area.
TrackRestrictionRestrictionYes/YesRule for tracks within this area.
ViaRestrictionRestrictionYes/YesRule for vias within this area.

Enumerations

BoardCutout

Options for areas representing board cutouts.

NameValueDescription
No0This area does not represent a cutout.
Yes1This area represents a cutout.
Plated2This area represents a plated cutout.

Restriction

Options for how items should be restricted within an area.

NameValueDescription
Unrestricted0Do not restrict this item type.
KeepIn1Only allow items of this type within this area.
KeepOut2Do not allow items of this type within this area.
Exclusive3Keep out, except for tracks or vias which originate from a pad in this area. Only available for tracks and vias.

Property Details

AlternativeThermalGap

Type: bool

Whether to use an alternative thermal gap in this area.


BoardCutout

Type: BoardCutout

The board cutout mode of this area.


ComponentPadRestriction

Type: Restriction

Rule for component pads within this area.


ComponentRestriction

Type: Restriction

Rule for components within this area.


CopperKeepOut

Type: bool

Whether to keep copper out of this area.


CopperPourAvoid

Type: bool

Whether copper pour should avoid this area.


DrillKeepOut

Type: bool

Whether to keep drilling holes out of this area.


MountingHoleRestriction

Type: Restriction

Rule for mounting holes within this area.


Name

Type: str

The name of this area.


TestpointRestriction

Type: Restriction

Rule for test points within this area.


TrackRestriction

Type: Restriction

Rule for tracks within this area.


ViaRestriction

Type: Restriction

Rule for vias within this area.