KB173970053: ArtiosCAD - Canvas Layout Calculated Text Expressions

Question

What are the new calculated text expressions which can be used with Canvas Part/Job/Layout reports?

Answer

The new expressions have been added to the Calculated Text Table in ArtiosCAD Defaults under the Canvas/Part Information folder. A summary is also provided here.

Canvas Expressions

These functions return Canvas level information

• CANVASGETT(EXPRESSION) - returns the result of the expression evaluated against the canvas. A typical example would be to get the canvas filename: e.g. CANVASGETT("DBGET(DESIGN,NAME$)")
• CANVASGETR(1) - returns the total number of Parts on the Canvas
• CANVASGETR(2) - returns the total number of Jobs on the Canvas
• CANVASGETR(3) - returns the currently selected part number
• CANVASGETR(4) - returns the currently selected job index - 0 if not job selected
• CANVASGETR(5) - returns the currently selected layout index within the job - 0 if no layout selected

Part Expressions

These functions return Canvas level Part information. The first parameter (CANVAS_PART_INDEX) to these functions represents the 1-based canvas part index. If '0' is passed for this parameter, the currently selected part will be used.

e.g. PARTGETT(2,1) - returns the part name for the second part in the canvas.

e.g. PARTGETT(0,1) - returns the part name for the currently selected part in the canvas.

• PARTGETT(CANVAS_PART_INDEX,0,EXPRESSION) - (new for ArtiosCAD 16.1.1) returns the result of the text expression (EXPRESSION) evaluated against the part specified. A typical example would be to get the part filename for the currently selected part: e.g. PARTGETT(0,0,"DBGET(DESIGN,NAME$)")
• PARTGETT(CANVAS_PART_INDEX,1) - returns the part name for the part specified
• PARTGETT(CANVAS_PART_INDEX,2) - returns the board description for the part specified
• PARTGETT(CANVAS_PART_INDEX,3) - returns the board code for the part specified

• PARTGETR(CANVAS_PART_INDEX,0,EXPRESSION) - (new for ArtiosCAD 16.1.1) returns the result of the real expression (EXPRESSION) evaluated against the part specified. A typical example would be to get the rule length for the currently selected part: e.g. PARTGETT(0,0,"#LENRULE")
• PARTGETR(CANVAS_PART_INDEX,1) - returns the part type for the part specified.  The part types are defined as:
  
  • 0 - Not production
  • 1 - Production
  • 2 - Remainder
  • 3 - Output
  • 4 - Sheet
• PARTGETR(CANVAS_PART_INDEX,2) - returns the number of copies for the part specified
• PARTGETR(CANVAS_PART_INDEX,3) - returns the blank size(X) for the part specified
• PARTGETR(CANVAS_PART_INDEX,4) - returns the blank size(Y) for the part specified
• PARTGETR(CANVAS_PART_INDEX,5) - part area (sq mm or sq in) for the part specified
• PARTGETR(CANVAS_PART_INDEX,6) - (new for ArtiosCAD 16.1.1) part area minus holes (sq mm or sq in) for the part specified
• PARTGETR(CANVAS_PART_INDEX,7) - (new for ArtiosCAD 16.1.1) total rule length for the part specified

Job Expressions

These functions return Job level information. The first parameter (JOB_INDEX) to these functions represents the 1-based canvas job index. If '0' is passed for this parameter, the currently selected job will be used.

e.g. JOBGETT(2,1) - returns the job name for the second job in the canvas.

e.g. JOBGETT(0,1) - returns the job name for the currently selected job in the canvas.

• JOBGETT(JOB_INDEX,1) - returns the job name for the job specified
• JOBGETT(JOB_INDEX,2) - returns the board description for the job specified
• JOBGETT(JOB_INDEX,3) - returns the board code for the job specified
• JOBGETR(JOB_INDEX,1) - returns the number of different layouts in the job specified
• JOBGETR(JOB_INDEX,2) - returns the total number of sheets in the job specified
• JOBGETR(JOB_INDEX,3) - returns the job quantity or 0 when fill sheet
• JOBGETR(JOB_INDEX,4) - returns number of different parts in the job specified

• JOBPARTR(JOB_INDEX,JOB_PART_INDEX,1) - returns the canvas part index for the part specified in the job
• JOBPARTR(JOB_INDEX,JOB_PART_INDEX,2) - returns the number placed of this part in the job (yield)
• JOBPARTR(JOB_INDEX,JOB_PART_INDEX,3) - returns the number of ordered of this part included in the job

Layout Expressions

These functions return Layout level information.  The first parameter (JOB_INDEX) to these functions represents the 1-based canvas job index.  If '0' is passed for this parameter, the currently selected job will be used.  The second parameter (LAYOUT_INDEX) to these functions represents the 1-based layout index.  If '0' is passed for this parameter, the currently selected layout will be used.

• LAYPARTR(JOB_INDEX,LAYOUT_INDEX,LAYOUT_PART_INDEX,1) - returns the canvas part index for the part specified in the job
• LAYPARTR(JOB_INDEX,LAYOUT_INDEX,LAYOUT_PART_INDEX,2) - returns the number of copies of this part included in the layout