1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
|
UnderlayDefinition
==================
.. module:: ezdxf.entities
:noindex:
:class:`UnderlayDefinition` (`DXF Reference`_) defines an underlay file, which can be placed by the :class:`Underlay` entity.
======================== ==============================================================
Subclass of :class:`ezdxf.entities.DXFObject`
DXF type internal base class
Factory function (1) :meth:`ezdxf.document.Drawing.add_underlay_def`
Factory function (2) :meth:`ezdxf.sections.objects.ObjectsSection.add_underlay_def`
======================== ==============================================================
.. class:: UnderlayDefinition
Base class of :class:`PdfDefinition`, :class:`DwfDefinition` and :class:`DgnDefinition`
.. attribute:: dxf.filename
Relative (to the DXF file) or absolute path to the underlay file as string.
.. attribute:: 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!
.. _DXF Reference: http://help.autodesk.com/view/OARX/2018/ENU/?guid=GUID-A4FF15D3-F745-4E1F-94D4-1DC3DF297B0F
PdfDefinition
-------------
======================== ==============================================================
Subclass of :class:`ezdxf.entities.UnderlayDefinition`
DXF type ``'PDFDEFINITION'``
Factory function (1) :meth:`ezdxf.document.Drawing.add_underlay_def`
Factory function (2) :meth:`ezdxf.sections.objects.ObjectsSection.add_underlay_def`
======================== ==============================================================
.. class:: PdfDefinition
PDF underlay file.
DwfDefinition
-------------
======================== ==============================================================
Subclass of :class:`ezdxf.entities.UnderlayDefinition`
DXF type ``'DWFDEFINITION'``
Factory function (1) :meth:`ezdxf.document.Drawing.add_underlay_def`
Factory function (2) :meth:`ezdxf.sections.objects.ObjectsSection.add_underlay_def`
======================== ==============================================================
.. class:: DwfDefinition
DWF underlay file.
DgnDefinition
-------------
======================== ==============================================================
Subclass of :class:`ezdxf.entities.UnderlayDefinition`
DXF type ``'DGNDEFINITION'``
Factory function (1) :meth:`ezdxf.document.Drawing.add_underlay_def`
Factory function (2) :meth:`ezdxf.sections.objects.ObjectsSection.add_underlay_def`
======================== ==============================================================
.. class:: DgnDefinition
DGN underlay file.
|