Home > PCB_Document

PCB_Document class

PCB & footprint / document operation class

Signature

class PCB_Document

Remarks

Operations performed on the design document as a whole

Methods

Method	Modifiers	Description
autoLayout()		(BETA) Auto layout
autoRouting(props)		(BETA) Auto routing
clearRouting(type)		(BETA) Clear routing
convertCanvasOriginToDataOrigin(x, y)		Input a canvas coordinate and return the data coordinate corresponding to that coordinate
convertDataOriginToCanvasOrigin(x, y)		Input a data coordinate and return the canvas coordinate corresponding to that coordinate
getCalculatingRatlineStatus()		Get the current ratline calculation function status
getCanvasOrigin()		Get the offset coordinate of the canvas origin relative to the data origin
getCanvasUpdateCalculationStatus()		(BETA) Query the current canvas update calculation status
getCurrentFilterConfiguration()		(BETA) Get Current canvas filter configuration
getPrimitiveAtPoint(x, y)		(BETA) Get The primitive at the coordinate point
getPrimitivesInRegion(left, right, top, bottom, leftToRight)		(BETA) Get All primitives in the region
importAutoLayoutJsonFile(autoLayoutFile)		(BETA) Import auto layout file (JSON)
importAutoRouteJsonFile(autoRouteFile)		(BETA) Import auto routing file (JSON)
importAutoRouteSesFile(autoRouteFile)		(BETA) Import auto routing file (SES)
importChanges(uuid)		Import changes from the schematic
navigateToCoordinates(x, y)		Locate to canvas coordinate
navigateToRegion(left, right, top, bottom)		(BETA) Locate to canvas region
save()		Save Document
setCanvasOrigin(offsetX, offsetY)		Set the offset coordinate of the canvas origin relative to the data origin
startCalculatingRatline()		Start the ratline calculation function
startCanvasUpdateCalculation()		(BETA) Start canvas update calculation
stopCalculatingRatline()		Stop the ratline calculation function
stopCanvasUpdateCalculation()		(BETA) Stop canvas update calculation
triggerCanvasUpdateCalculation()		(BETA) Trigger a canvas update calculation
zoomToBoardOutline()		(BETA) Zoom to the board outline (fit the board outline)