GetLayerInfo (Layout Editor)

Retrieves information on a specified layer in the Layout editor.

UI Access None
Parameters
Name Type Description
<LayerName> String Name of the layer
Return Value

An array of strings, as follows:

  • Type: type of name
  • TopBottomAssociation: "Top"|"Neither"|"Bottom"|"Template"|"Invalid"
  • Color: integer [representing rgb in hex]
  • IsVisible: "true"|"false". This is true if any these types of objects are visible:
    • IsVisibleShape: "true"|"false"[for stackup layer only]
    • IsVisiblePath: "true"|"false"[for stackup layer only]
    • IsVisiblePad: "true"|"false"[for stackup layer only]
    • IsVisibleHole: "true"|"false"[for stackup layer only]
    • IsVisibleComponent: "true"|"false"[for stackup layer only]
  • IsLocked: "true"|"false"
  • LayerId: integer [the ID for the layer]

The following are also in the array if the layer is a stackup layer:

  • Index: integer [the stackup order index]
  • LayerThickness: double [total layer thickness, in meters]
  • EtchFactor: double [This will not appear if the layer has no etch factor defined.]
  • IsIgnored: "true"|"false"
  • NumberOfSublayers: 1 [This is always 1.]
  • Material0: material name
  • FillMaterial0: material name
  • Thickness0: expression with units
  • LowerElevation0: expression with units
  • If roughness is defined, some or all of the following appear:
    • Roughness0Type: Groiss | Huray
    • Roughness0: value and units or surface ratio value for Huray
    • BottomRoughness0 Type: Groiss | Huray
    • BottomRoughness0: value and units or surface ratio value for Huray
    • SideRoughness0 Type: Groiss | Huray
    • SideRoughness0: value and units or surface ratio value for Huray

For example:
['Type: signal', 'TopBottomAssociation: Neither', 'Color: 32512d', 'IsVisible: true', ' IsVisibleShape: true', ' IsVisiblePath: true', ' IsVisiblePad: true', ' IsVisibleHole: true', ' IsVisibleComponent: true', 'IsLocked: false', 'LayerId: 7', 'Index: 0', 'LayerThickness: 0', 'IsIgnored: false', 'NumberOfSublayers: 1', 'Material0: copper', 'FillMaterial0: FR4_epoxy', 'Thickness0: 0mil', 'LowerElevation0: 62mil', 'Roughness0 Type: Huray', 'Roughness0: 0mil, 2.9', 'BottomRoughness0 Type: Huray', 'BottomRoughness0: 0mil, 2.9', 'SideRoughness0 Type: Huray', 'SideRoughness0: 0mil, 2.9']

 

Python Syntax GetLayerInfo(<layer_name>)
Python Example 
oEditor = oDesign.SetActiveEditor("Layout")
oEditor.GetLayerInfo("TopLayer")