UnderlayDefinition

UnderlayDefinition (DXF Reference) defines an underlay file, which can be placed by the Underlay entity.

Subclass of

ezdxf.entities.DXFObject

DXF type

internal base class

Factory function (1)

ezdxf.document.Drawing.add_underlay_def()

Factory function (2)

ezdxf.sections.objects.ObjectsSection.add_underlay_def()

class ezdxf.entities.UnderlayDefinition

Base class of PdfDefinition, DwfDefinition and DgnDefinition

dxf.filename

Relative (to the DXF file) or absolute path to the underlay file as string.

dxf.name

Defines which part of the underlay file to display.

“pdf”

PDF page number

“dgn”

always “default”

“dwf”

?

Warning

Do not instantiate object classes by yourself - always use the provided factory functions!

PdfDefinition

Subclass of

ezdxf.entities.UnderlayDefinition

DXF type

'PDFDEFINITION'

Factory function (1)

ezdxf.document.Drawing.add_underlay_def()

Factory function (2)

ezdxf.sections.objects.ObjectsSection.add_underlay_def()

class ezdxf.entities.PdfDefinition

PDF underlay file.

DwfDefinition

Subclass of

ezdxf.entities.UnderlayDefinition

DXF type

'DWFDEFINITION'

Factory function (1)

ezdxf.document.Drawing.add_underlay_def()

Factory function (2)

ezdxf.sections.objects.ObjectsSection.add_underlay_def()

class ezdxf.entities.DwfDefinition

DWF underlay file.

DgnDefinition

Subclass of

ezdxf.entities.UnderlayDefinition

DXF type

'DGNDEFINITION'

Factory function (1)

ezdxf.document.Drawing.add_underlay_def()

Factory function (2)

ezdxf.sections.objects.ObjectsSection.add_underlay_def()

class ezdxf.entities.DgnDefinition

DGN underlay file.