PyPl.pyi
class Core Class
def __init__(self) -> None:
def __reduce__(self) -> Any:
def className() -> str:
def processPlotState() -> ProcessPlotState:
def publishExecute(dsdDataObj: PyPl.DSDData, pConfig: PyPl.PlotConfig, bShowPlotProgress: bool) -> None:
class CustomSizeResult Class
ePossible: ClassVar[Self]
eMustCreatePC3: ClassVar[Self]
eRotationRequired: ClassVar[Self]
ePC3DirReadOnly: ClassVar[Self]
ePMPDirReadOnly: ClassVar[Self]
ePMPDirMissing: ClassVar[Self]
eUnknownErrPMPDir: ClassVar[Self]
ePC3FileReadOnly: ClassVar[Self]
eSizeTooBig: ClassVar[Self]
eException: ClassVar[Self]
eUnknownErrPC3File: ClassVar[Self]
eUnknownErrPMPFile: ClassVar[Self]
ePMPFileReadOnly: ClassVar[Self]
eWidthAndHeightMustBePositive: ClassVar[Self]
eDeviceLoadFailed: ClassVar[Self]
class DSDData Class
def __init__(self) -> None:
This utility class reads and writes DSD files. It holds an array of AcPlDSDEntry objects in
addition to DSD sheet set information.
def __reduce__(self) -> Any:
def categoryName(self) -> str:
def className() -> str:
def currentPrecision(self) -> str:
def desc() -> PyRx.RxClass:
Returns a pointer to the AcRxClass object representing the specific class, or most recent
parent class explicitly registered with ObjectARX of either the pointer type used to invoke
it or the class qualifier used with it. (Remember that when a static member function is
invoked via a pointer, the pointer type, not the object type, determines which
implementation of the function is invoked.) When working with a pointer to an object and
the proper AcRxClass object for the class of the object pointed to is desired, the
AcRxObject::isA() function should be used, since it is a virtual non-static method and is
therefore not pointer type dependent. Caching the value of the pointer returned by this
method is acceptable, provided the application knows that the AcRxClass object pointed to
by the returned pointer was created by an ObjectARX application that will not be unloaded.
def destinationName(self) -> str:
def get3dDwfOptions(self) -> tuple[bool, bool]:
def getDSDEntries(self) -> list[PyPl.DSDEntry]:
def getPrecisionEntries(self) -> list[PyPl.PrecisionEntry]:
def getUnrecognizedData(self) -> tuple:
def includeLayerInfo(self) -> bool:
def initializeLayouts(self) -> bool:
def isHomogeneous(self) -> bool:
def isSheetSet(self) -> bool:
def lineMerge(self) -> bool:
def logFilePath(self) -> str:
def majorVersion(self) -> int:
def minorVersion(self) -> int:
def noOfCopies(self) -> int:
def numberOfDSDEntries(self) -> int:
def password(self) -> str:
def plotStampOn(self) -> bool:
def projectPath(self) -> str:
def promptForDwfName(self) -> bool:
def promptForPassword(self) -> bool:
def pwdProtectPublishedDWF(self) -> bool:
def selectionSetName(self) -> str:
def set3dDwfOptions(self, groupByXrefHierarchy: bool, publishWithMaterials: bool) -> None:
def setCategoryName(self, val: str) -> None:
def setCurrentPrecision(self, val: str) -> None:
def setDSDEntries(self, entries: list[PyPl.DSDEntry]) -> None:
def setDestinationName(self, val: str) -> None:
def setIncludeLayerInfo(self, val: bool) -> None:
def setInitializeLayouts(self, val: bool) -> None:
def setIsHomogeneous(self, val: bool) -> None:
def setIsSheetSet(self, val: bool) -> None:
def setLineMerge(self, val: bool) -> None:
def setLogFilePath(self, val: str) -> None:
def setMajorVersion(self, val: int) -> None:
def setMinorVersion(self, val: int) -> None:
def setNoOfCopies(self, val: int) -> None:
def setPassword(self, val: str) -> None:
def setPlotStampOn(self, val: bool) -> None:
def setPrecisionEntries(self, val: list[PyPl.PrecisionEntry]) -> None:
def setProjectPath(self, path: str) -> None:
def setPromptForDwfName(self, val: bool) -> None:
def setPromptForPassword(self, val: bool) -> None:
def setPwdProtectPublishedDWF(self, val: bool) -> None:
def setSelectionSetName(self, val: str) -> None:
def setSheetSetName(self, val: str) -> None:
def setSheetType(self, val: PyPl.SheetType) -> None:
def setUnrecognizedData(self, sectionName: str, sectionData: str) -> None:
def setViewFile(self, val: bool) -> None:
def sheetSetName(self) -> str:
def sheetType(self) -> SheetType:
def viewFile(self) -> bool:
class DSDEntry Class
def NPS(self) -> str:
def NPSSourceDWG(self) -> str:
def __init__(self) -> None:
This container class holds information specific to a sheet (in a sheet set). AcPlDSDData
holds a collection of AcPlDSDEntry objects to configure a publish job.
def __reduce__(self) -> Any:
def className() -> str:
def desc() -> PyRx.RxClass:
Returns a pointer to the AcRxClass object representing the specific class, or most recent
parent class explicitly registered with ObjectARX of either the pointer type used to invoke
it or the class qualifier used with it. (Remember that when a static member function is
invoked via a pointer, the pointer type, not the object type, determines which
implementation of the function is invoked.) When working with a pointer to an object and
the proper AcRxClass object for the class of the object pointed to is desired, the
AcRxObject::isA() function should be used, since it is a virtual non-static method and is
therefore not pointer type dependent. Caching the value of the pointer returned by this
method is acceptable, provided the application knows that the AcRxClass object pointed to
by the returned pointer was created by an ObjectARX application that will not be unloaded.
def dwgName(self) -> str:
def has3dDwfSetup(self) -> bool:
def layout(self) -> str:
def orgSheetPath(self) -> str:
def setDwgName(self, val: str) -> None:
def setHas3dDwfSetup(self, val: bool) -> None:
def setLayout(self, val: str) -> None:
def setNPS(self, val: str) -> None:
def setNPSSourceDWG(self, val: str) -> None:
def setSetupType(self, val: PyPl.SetupType) -> None:
def setTitle(self, val: str) -> None:
def setTraceSession(self, val: str) -> None:
def setupType(self) -> SetupType:
def title(self) -> str:
def traceSession(self) -> str:
class DeviceType Class
kSystemPrinter: ClassVar[Self]
kPC3File: ClassVar[Self]
kOneOffConfig: ClassVar[Self]
kUninitialized: ClassVar[Self]
class MatchingPolicy Class
kMatchDisabled: ClassVar[Self]
kMatchEnabled: ClassVar[Self]
kMatchEnabledCustom: ClassVar[Self]
kMatchEnabledTmpCustom: ClassVar[Self]
class PlObject Class
def __init__() -> None:
Raises an exception.
This class cannot be instantiated from Python.
def __reduce__(self) -> Any:
def className() -> str:
class PlotCancelStatus Class
kPlotContinue: ClassVar[Self]
kPlotCanceledByCaller: ClassVar[Self]
kPlotCanceledByCancelAllButton: ClassVar[Self]
kPlotCancelStatusCount: ClassVar[Self]
class PlotConfig Class
def __init__() -> None:
Raises an exception.
This class cannot be instantiated from Python.
def __reduce__(self) -> Any:
def className() -> str:
def desc() -> PyRx.RxClass:
Returns a pointer to the AcRxClass object representing the specific class, or most recent
parent class explicitly registered with ObjectARX of either the pointer type used to invoke
it or the class qualifier used with it. (Remember that when a static member function is
invoked via a pointer, the pointer type, not the object type, determines which
implementation of the function is invoked.) When working with a pointer to an object and
the proper AcRxClass object for the class of the object pointed to is desired, the
AcRxObject::isA() function should be used, since it is a virtual non-static method and is
therefore not pointer type dependent. Caching the value of the pointer returned by this
method is acceptable, provided the application knows that the AcRxClass object pointed to
by the returned pointer was created by an ObjectARX application that will not be unloaded.
def deviceName(self) -> str:
def deviceType(self) -> int:
def fullPath(self) -> str:
def getCanonicalMediaNameList(self) -> list[str]:
def getDefaultFileExtension(self) -> str:
def getDescriptionFields(self) -> tuple[str, ...]:
def getLocalMediaName(self, canonicalMediaName: str) -> str:
def getMediaBounds(self, canonicalMediaName: str) -> tuple:
def isPlotToFile(self) -> bool:
def maxDeviceDPI(self) -> int:
def plotToFileCapability(self) -> PlotToFileCapability:
def refreshMediaNameList(self) -> None:
def saveToPC3(self, val: str) -> bool:
def setPlotToFile(self, val: bool) -> None:
class PlotConfigInfo Class
def __init__(self) -> None:
def __reduce__(self) -> Any:
def className() -> str:
def desc() -> PyRx.RxClass:
Returns a pointer to the AcRxClass object representing the specific class, or most recent
parent class explicitly registered with ObjectARX of either the pointer type used to invoke
it or the class qualifier used with it. (Remember that when a static member function is
invoked via a pointer, the pointer type, not the object type, determines which
implementation of the function is invoked.) When working with a pointer to an object and
the proper AcRxClass object for the class of the object pointed to is desired, the
AcRxObject::isA() function should be used, since it is a virtual non-static method and is
therefore not pointer type dependent. Caching the value of the pointer returned by this
method is acceptable, provided the application knows that the AcRxClass object pointed to
by the returned pointer was created by an ObjectARX application that will not be unloaded.
def deviceId(self) -> str:
def deviceName(self) -> str:
def deviceType(self) -> DeviceType:
def fullPath(self) -> str:
def setDeviceId(self, val: type) -> None:
def setDeviceName(self, val: str) -> None:
def setDeviceType(self, val: PyPl.DeviceType) -> None:
def setFullPath(self, val: str) -> None:
class PlotConfigManager Class
def __init__(self) -> None:
def __reduce__(self) -> Any:
def className() -> str:
def getCurrentConfig(self) -> PlotConfig:
def getDevicesList(self) -> list[PyPl.PlotConfigInfo]:
def getStdConfigName(self) -> str:
def getStyleList(self) -> list[str]:
def refreshList(self, refreshCode: PyPl.RefreshCode) -> None:
def setCurrentConfig(self, deviceName: str) -> PlotConfig:
class PlotEngine Class
def __init__() -> None:
Raises an exception.
This class cannot be instantiated from Python.
def __reduce__(self) -> Any:
def beginDocument(self, plotInfo: PyPl.PlotInfo, docName: str, plotToFile: bool, fileName: str) -> None:
def beginGenerateGraphics(self) -> None:
def beginPage(self, pageInfo: PyPl.PlotPageInfo, plotInfo: PyPl.PlotInfo, lastPage: bool) -> None:
def beginPlot(self, dlgRef: PyPl.PlotProgressDialog) -> None:
def className() -> str:
def destroy(self) -> None:
def endDocument(self) -> None:
def endGenerateGraphics(self) -> None:
def endPage(self) -> None:
def endPlot(self) -> None:
def isBackgroundPackaging(self) -> bool:
class PlotFactory Class
def __init__() -> None:
Raises an exception.
This class cannot be instantiated from Python.
def __reduce__(self) -> Any:
def className() -> str:
def createPreviewEngine(flags: int) -> PlotEngine:
def createPublishEngine() -> PlotEngine:
def processPlotState() -> ProcessPlotState:
class PlotInfo Class
def OrgFilePath(self) -> str:
def __init__(self) -> None:
AcPlPlotInfo is a utility class that provides methods for building information about how
and what to plot and, ultimately, acts as a vehicle to transport this information to the
plotting pipeline. Applications must provide the object ID of the layout to be plotted to
this object before passing it to an AcPlPlotEngine object for processing. Applications can
provide overrides, in the form of an AcDbPlotSettings object, to be used for plotting the
layout in place of the settings on the layout itself. Applications can also override the
output device by providing an AcPlPlotConfig object designating the device to plot to. If a
device override is applied, it supercedes the device in the layout and the device in the
AcDbPlotSettings overrides object. AcPlPlotInfo objects must be validated using an
AcDbPlotInfoValidator before they can be processed by an AcPlPlotEngine. Validated
AcPlPlotInfo objects have non-null validated settings data and non-null validated
configurations, which will be used by the AcPlPlotEngine to plot the layout when it is
processed.
def __reduce__(self) -> Any:
def className() -> str:
def copyFrom(self, otherObject: PyRx.RxObject) -> None:
def desc() -> PyRx.RxClass:
Returns a pointer to the AcRxClass object representing the specific class, or most recent
parent class explicitly registered with ObjectARX of either the pointer type used to invoke
it or the class qualifier used with it. (Remember that when a static member function is
invoked via a pointer, the pointer type, not the object type, determines which
implementation of the function is invoked.) When working with a pointer to an object and
the proper AcRxClass object for the class of the object pointed to is desired, the
AcRxObject::isA() function should be used, since it is a virtual non-static method and is
therefore not pointer type dependent. Caching the value of the pointer returned by this
method is acceptable, provided the application knows that the AcRxClass object pointed to
by the returned pointer was created by an ObjectARX application that will not be unloaded.
def deviceOverride(self) -> PlotConfig:
def isCompatibleDocument(self, val: PyPl.PlotInfo) -> bool:
def isValidated(self) -> bool:
def layout(self) -> PyDb.ObjectId:
def mergeStatus(self) -> int:
def overrideSettings(self) -> PyDb.PlotSettings:
def setDeviceOverride(self, val: PyPl.PlotConfig) -> None:
def setLayout(self, id: PyDb.ObjectId) -> None:
def setOverrideSettings(self, val: PyDb.PlotSettings) -> None:
def setValidatedConfig(self, val: PyPl.PlotConfig) -> None:
def setValidatedSettings(self, val: PyDb.PlotSettings) -> None:
def validatedConfig(self) -> PlotConfig:
def validatedSettings(self) -> PyDb.PlotSettings:
class PlotInfoValidator Class
def __init__(self) -> None:
The AcPlPlotInfoValidator class merges plot settings from a layout object, an
AcDbPlotSettings object (settings overrides), and an output device override into a new plot
settings object. The validator returns a set of codes indicating any problems found during
the merge operation. The validator supports paper-matching policies in its validation
algorithmn. Depending on the setting of the policy, the validator may try to find a
matching paper size if the canonical paper name provided in the layout or overrides does
not exist on the device. The validator also has policies to create a custom paper size, if
possible, in case the matching algorithmn fails.
def __reduce__(self) -> Any:
def className() -> str:
def desc() -> PyRx.RxClass:
Returns a pointer to the AcRxClass object representing the specific class, or most recent
parent class explicitly registered with ObjectARX of either the pointer type used to invoke
it or the class qualifier used with it. (Remember that when a static member function is
invoked via a pointer, the pointer type, not the object type, determines which
implementation of the function is invoked.) When working with a pointer to an object and
the proper AcRxClass object for the class of the object pointed to is desired, the
AcRxObject::isA() function should be used, since it is a virtual non-static method and is
therefore not pointer type dependent. Caching the value of the pointer returned by this
method is acceptable, provided the application knows that the AcRxClass object pointed to
by the returned pointer was created by an ObjectARX application that will not be unloaded.
def dimensionalWeight(self) -> int:
def isCustomPossible(self, valByRef: PyPl.PlotInfo) -> CustomSizeResult:
def matchingPolicy(self) -> MatchingPolicy:
def mediaBoundsWeight(self, val: int) -> int:
def mediaGroupWeight(self) -> int:
def mediaMatchingThreshold(self) -> int:
def printableBoundsWeight(self) -> int:
def setDefDimensionalWeight(self) -> None:
def setDefMediaBoundsWeight(self) -> None:
def setDefMediaGroupWeight(self, val: int) -> None:
def setDefMediaMatchingThreshold(self) -> None:
def setDefPrintableBoundsWeight(self) -> None:
def setDefSheetDimensionalWeight(self) -> None:
def setDefSheetMediaGroupWeight(self) -> None:
def setDimensionalWeight(self, val: int) -> None:
def setMediaBoundsWeight(self, val: int) -> None:
def setMediaGroupWeight(self, val: int) -> None:
def setMediaMatchingPolicy(self, val: PyPl.MatchingPolicy) -> None:
def setMediaMatchingThreshold(self, val: int) -> None:
def setPrintableBoundsWeight(self, val: int) -> None:
def setSheetDimensionalWeight(self, val: int) -> None:
def setSheetMediaGroupWeight(self, val: int) -> None:
def sheetDimensionalWeight(self) -> int:
def sheetMediaGroupWeight(self) -> int:
def validate(self, valByRef: PyPl.PlotInfo) -> None:
class PlotMSGIndex Class
kDialogTitle: ClassVar[Self]
kSheetName: ClassVar[Self]
kSheetNameToolTip: ClassVar[Self]
kStatus: ClassVar[Self]
kSheetProgressCaption: ClassVar[Self]
kSheetSetProgressCaption: ClassVar[Self]
kMsgCancelling: ClassVar[Self]
kMsgCancellingCurrent: ClassVar[Self]
kCancelSheetBtnMsg: ClassVar[Self]
kCancelJobBtnMsg: ClassVar[Self]
kMsgCount: ClassVar[Self]
class PlotPageInfo Class
def __init__(self) -> None:
Returns information about the objects contained on a plotted page. Applications can use
this information as a starting point for estimating the time required to plot the page (or,
more precisely, to determine whether to warn the user that the page will take a long time
to plot). An object of this type is returned by the AcPlPlotEngine::startPage() method.
def __reduce__(self) -> Any:
def className() -> str:
def desc() -> PyRx.RxClass:
Returns a pointer to the AcRxClass object representing the specific class, or most recent
parent class explicitly registered with ObjectARX of either the pointer type used to invoke
it or the class qualifier used with it. (Remember that when a static member function is
invoked via a pointer, the pointer type, not the object type, determines which
implementation of the function is invoked.) When working with a pointer to an object and
the proper AcRxClass object for the class of the object pointed to is desired, the
AcRxObject::isA() function should be used, since it is a virtual non-static method and is
therefore not pointer type dependent. Caching the value of the pointer returned by this
method is acceptable, provided the application knows that the AcRxClass object pointed to
by the returned pointer was created by an ObjectARX application that will not be unloaded.
def entityCount() -> int:
def gradientCount() -> int:
def oleObjectCount() -> int:
def rasterCount() -> int:
def shadedViewportType() -> int:
class PlotProgressDialog Class
def __init__(self) -> None:
def __init__(self, bPreview: bool, nSheets: int, bShowCancelSheetButton: bool) -> None:
def __init__(self, hwnd: int, bPreview: bool, nSheets: int, bShowCancelSheetButton: bool) -> None:
def __init__(*args) -> None:
def __reduce__(self) -> Any:
def className() -> str:
def destroy(self) -> None:
def getPlotMsgString(self, index: PyPl.PlotMSGIndex) -> str:
def getPlotProgressRange(self) -> tuple[int, int]:
def getSheetProgressRange(self) -> tuple[int, int]:
def getStatusMsgString(self) -> str:
def heartbeat(self) -> None:
def isPlotCancelled(self) -> bool:
def isSheetCancelled(self) -> bool:
def isSingleSheetPlot(self) -> bool:
def isVisible(self) -> bool:
def onBeginPlot(self) -> bool:
def onBeginSheet(self) -> bool:
def onEndPlot(self) -> bool:
def onEndSheet(self) -> bool:
def plotCancelStatus(self) -> PlotCancelStatus:
def plotProgressPos(self) -> int:
def setIsVisible(self, val: bool) -> bool:
def setPlotCancelStatus(self, val: PyPl.PlotCancelStatus) -> None:
def setPlotMsgString(self, index: PyPl.PlotMSGIndex, val: str) -> bool:
def setPlotProgressPos(self, pos: int) -> None:
def setPlotProgressRange(self, lower: int, upper: int) -> None:
def setSheetCancelStatus(self, val: PyPl.SheetCancelStatus) -> None:
def setSheetProgressPos(self, pos: int) -> None:
def setSheetProgressRange(self, lower: int, upper: int) -> None:
def setStatusMsgString(self, val: str) -> bool:
def sheetCancelStatus(self) -> SheetCancelStatus:
def sheetProgressPos(self) -> int:
class PlotToFileCapability Class
kNoPlotToFile: ClassVar[Self]
kPlotToFileAllowed: ClassVar[Self]
kMustPlotToFile: ClassVar[Self]
class PrecisionEntry Class
def __init__(self) -> None:
def __reduce__(self) -> Any:
def className() -> str:
def colorResolution(self) -> int:
def desc() -> PyRx.RxClass:
Returns a pointer to the AcRxClass object representing the specific class, or most recent
parent class explicitly registered with ObjectARX of either the pointer type used to invoke
it or the class qualifier used with it. (Remember that when a static member function is
invoked via a pointer, the pointer type, not the object type, determines which
implementation of the function is invoked.) When working with a pointer to an object and
the proper AcRxClass object for the class of the object pointed to is desired, the
AcRxObject::isA() function should be used, since it is a virtual non-static method and is
therefore not pointer type dependent. Caching the value of the pointer returned by this
method is acceptable, provided the application knows that the AcRxClass object pointed to
by the returned pointer was created by an ObjectARX application that will not be unloaded.
def description(self) -> str:
def desiredPrecision(self) -> float:
def gradientResolution(self) -> int:
def monoResolution(self) -> int:
def setColorResolution(self, val: int) -> None:
def setDescription(self, val: str) -> None:
def setDesiredPrecision(self, val: float) -> None:
def setGradientResolution(self, val: int) -> None:
def setMonoResolution(self, val: type) -> None:
def setTitle(self, val: str) -> None:
def setUnitScale(self, val: str) -> None:
def setUnitType(self, val: str) -> None:
def title(self) -> str:
def unitScale(self) -> str:
def unitType(self) -> str:
class ProcessPlotState Class
kNotPlotting: ClassVar[Self]
kForegroundPlotting: ClassVar[Self]
kBackgroundPlotting: ClassVar[Self]
class RefreshCode Class
kAll: ClassVar[Self]
kRefreshDevicesList: ClassVar[Self]
kRefreshStyleList: ClassVar[Self]
kRefreshSystemDevicesList: ClassVar[Self]
kRefreshPC3DevicesList: ClassVar[Self]
class SetupType Class
kOriginalPS: ClassVar[Self]
kNPSSameDWG: ClassVar[Self]
kNPSOtherDWG: ClassVar[Self]
k3dDwf: ClassVar[Self]
kOverridePS: ClassVar[Self]
class SheetCancelStatus Class
kSheetContinue: ClassVar[Self]
kSheetCanceledByCancelButton: ClassVar[Self]
kSheetCanceledByCancelAllButton: ClassVar[Self]
kSheetCanceledByCaller: ClassVar[Self]
kSheetCancelStatusCount: ClassVar[Self]
class SheetType Class
kSingleDWF: ClassVar[Self]
kMultiDWF: ClassVar[Self]
kOriginalDevice: ClassVar[Self]
kSingleDWFx: ClassVar[Self]
kMultiDWFx: ClassVar[Self]
kSinglePDF: ClassVar[Self]
kMultiPDF: ClassVar[Self]
kSingleSVF: ClassVar[Self]
kMultiSVF: ClassVar[Self]
class StdConfigs Class
kNoneDevice: ClassVar[Self]
kDefaultWindowsSysPrinter: ClassVar[Self]
kDWF6ePlot: ClassVar[Self]
kDWFePlotOptForPlotting: ClassVar[Self]
kDWFePlotOptForViewing: ClassVar[Self]
kPublishToWebDWF: ClassVar[Self]
kPublishToWebJPG: ClassVar[Self]
kPublishToWebPNG: ClassVar[Self]
kDWFxePlot: ClassVar[Self]
kPublishToWebDWFx: ClassVar[Self]
kPDFePlot: ClassVar[Self]
kPDFePlotGeneralDocs: ClassVar[Self]
kPDFePlotHighQuality: ClassVar[Self]
kPDFePlotSmallerFile: ClassVar[Self]
kPDFePlotWebMobile: ClassVar[Self]
kSVFePlot: ClassVar[Self]
class StyTypes Class
kUndefined: ClassVar[Self]
kRegular: ClassVar[Self]
kTranslation: ClassVar[Self]
kColorDep: ClassVar[Self]
kAllTypes: ClassVar[Self]