Layer

LAYER (DXF Reference) definition, defines attribute values for entities on this layer for their attributes set to BYLAYER.

Subclass of

ezdxf.entities.DXFEntity

DXF type

'LAYER'

Factory function

Drawing.layers.new()

class ezdxf.entities.Layer
dxf.handle

DXF handle (feature for experts)

dxf.owner

Handle to owner (LayerTable).

dxf.name

Layer name, case insensitive and can not contain any of this characters: <>/\":;?*|=` (str)

dxf.flags

Layer flags (bit-coded values, feature for experts)

1

Layer is frozen; otherwise layer is thawed; use is_frozen(), freeze() and thaw()

2

Layer is frozen by default in new viewports

4

Layer is locked; use is_locked(), lock(), unlock()

16

If set, table entry is externally dependent on an xref

32

If both this bit and bit 16 are set, the externally dependent xref has been successfully resolved

64

If set, the table entry was referenced by at least one entity in the drawing the last time the drawing was edited. (This flag is for the benefit of AutoCAD commands. It can be ignored by most programs that read DXF files and need not be set by programs that write DXF files)

dxf.color

Layer color, but use property Layer.color to get/set color value, because color is negative for layer status off (int)

dxf.true_color

Layer true color value as int, use property Layer.rgb to set/get true color value as (r, g, b) tuple.

(requires DXF R2004)

dxf.linetype

Name of line type (str)

dxf.plot

Plot flag (int)

1

plot layer (default value)

0

don’t plot layer

dxf.lineweight

Line weight in mm times 100 (e.g. 0.13mm = 13). Smallest line weight is 13 and biggest line weight is 200, values outside this range prevents AutoCAD from loading the file.

ezdxf.lldxf.const.LINEWEIGHT_DEFAULT for using global default line weight.

(requires DXF R13)

dxf.plotstyle_handle

Handle to plot style name?

(requires DXF R13)

dxf.material_handle

Handle to default Material.

(requires DXF R13)

rgb

Get/set DXF attribute dxf.true_color as (r, g, b) tuple, returns None if attribute dxf.true_color is not set.

layer.rgb = (30, 40, 50)
r, g, b = layer.rgb

This is the recommend method to get/set RGB values, when ever possible do not use the DXF low level attribute dxf.true_color.

New in version 0.10.

color

Get/set layer color, preferred method for getting the layer color, because dxf.color is negative for layer status off.

New in version 0.10.

description

Get/set layer description as string

New in version 0.10.

transparency

Get/set layer transparency as float value in the range from 0 to 1. 0 for no transparency (opaque) and 1 for 100% transparency.

New in version 0.10.

is_frozen() → bool

Returns True if layer is frozen.

freeze() → None

Freeze layer.

thaw() → None

Thaw layer.

is_locked() → bool

Returns True if layer is locked.

lock() → None

Lock layer, entities on this layer are not editable - just important in CAD applications.

unlock() → None

Unlock layer, entities on this layer are editable - just important in CAD applications.

is_off() → bool

Returns True if layer is off.

is_on() → bool

Returns True if layer is on.

on() → None

Switch layer on (visible).

off() → None

Switch layer off (invisible).

get_color() → int

Use property Layer.color instead.

set_color(value: int) → None

Use property Layer.color instead.

rename(name: str) → None

Rename layer and all known (documented) references to this layer.

Warning

Renaming layers may damage the DXF file in some circumstances!

Parameters

name – new layer name

Raises
  • ValueErrorname contains invalid characters: <>/”:;?*|=`

  • ValueError – layer name already exist

  • ValueError – renaming of layers '0' and 'DEFPOINTS' not possible