Creating BOM Balloons
BOM balloons are circular callouts created in an assembly drawing. They shows the Bill of Materials information for each component. You can add the BOM balloons in the drawing using the functions described in this section.
Before you can add BOM balloons, you must create a table, add the repeat region, enter the desired report symbols, and designate the BOM balloon region. After this you can show BOM balloons on a selected assembly view.
Functions Introduced:
The function
ProDwgtableCellRegionGet() returns the ID of the repeat region. You must specify the name of the table, the column and row ID as input parameters.
The function
ProBomballoonCreate() creates the BOM balloons at the specified view. The input arguments are:
• pro_drawing—Specifies the name of the drawing.
• pro_table—Specifies the name of the table that contains the repeat region and the bill of material.
• region_id—Specifies the ID of the repeat region that contains the bill of material. If the ID of the repeat region in the table is -1, use the repeat region with ID as 0 in the table.
• pro_view—Specifies the view where the balloons must be added.
The function
ProBomballoonAllCreate() creates the BOM balloons to the first view of the drawing.
The function
ProBomballoonByComponentCreate() creates the balloons at the specified view and on the specified component. If the view is specified as
NULL, the balloons are added to the first view of the drawing. Specify the path to the component as
component_memb_id_tab.
The function
ProBomballoonByRecordCreate() creates the balloons for the specified record in the BOM table. The input arguments are:
• pro_drawing—Specifies the name of the drawing.
• pro_table—Specifies the name of the table that contains the repeat region and the bill of material.
• region_id—Specifies the ID of the repeat region that contains the bill of material.If the ID of the repeat region in the table is -1, use the repeat region with ID as 0 in the table.
• pro_view—Specifies the view where the balloons must be added. Specify this argument to create the balloons without a leader.
• table_record_index—Specifies the record in the BOM table. The balloons are created at the first component that matches the specified record.
• reference_memb_id_tab—Specifies the path to the component. This path is used as reference for the leader of the balloon.
• reference_id—Specifies the ID of the component. When the ID is set to K_NOT_USED, the balloons are attached without leaders.
• reference_type—Specifies the type of component using the enumerated data type ProType.
• attach_note_location—Specifies a ProArray of the attachment point for the balloons on the component.
The function
ProBomballoonClean() cleans up the location and display of BOM balloons in the specified view. The input arguments are:
• pro_drawing—Specifies the name of the drawing.
• pro_view—Specifies the view where BOM balloons have been added.
• clean_pos—Specifies a boolean value to indicate if the balloon must be cleaned.
• existing_snap_lines—Specifies a boolean value to indicate if the existing snap lines must be used for the clean up.
• offset_from_view_outline—Specifies the offset distance for the balloon placement from the view outline.
• stagger—Specifies a boolean value to indicate if the balloons must be staggered at different offset distance from the view outline.
• create_stagger_snap_lines—Specifies the incremental value for the stagger distance between the snap lines.
• interballoons_distance—Specifies the distance between the BOM balloons.
• attach_to_surface—Specifies if the leaders of the balloon must point to edges or surfaces. To attach the leader to a surface specify the value as PRO_B_TRUE.