Widgets

Widget > Add part list (flat)

The “Add part list (flat)” menu allows you to create a table in the PDF document. The flat part list is generated by parsing the model structure of the 3D parts.

Creation of a part list (flat)

This table is generated from the 3D data in the PDF document.

  1. Within the Tetra4D Enrich toolbar, choose Widget > Add part list (flat).

  2. Drag a rectangle to define the location and the size of the table.

  3. Use the frame controllers to resize the table.

  4. Drag the table border to reposition the table if required.

  5. Adjust the table properties to your specifications by selecting the options in the Edit panel in the right.

    Note

    Refer to Definition of the part list and table settings to have detailed explanations about how to customize the table presentation.

  6. Click on the green check “Validate the table modifications” icon to save the carousel, or

  7. Click on the red “X” “Cancel the table modifications” icon to discard the changes.

The flat part lists are generated according to the 3D model currently present in the PDF document. The flat part list only lists the components of the assembly and the total number of these components, independent of their position in the assembly hierarchy.

_images/page26_img1.png

“flat part list” table

Widget > Add part list (hierarchical)

The “Add part list (hierarchical)” menu allows you to create a table in the PDF document. The hierarchical part list is generated by parsing the model structure of the 3D parts.

Creation of a part list (hierarchical)

This table is generated from the 3D data in the PDF document.

  1. Within the Tetra4D Enrich toolbar, choose Widget > Add part list (hierarchical).

  2. Drag a rectangle to define the location and the size of the table.

  3. Use the frame controllers to resize the table.

  4. Drag the table border to reposition the table if required.

  5. Adjust the table properties to your specifications by selecting the options in the Edit panel in the right.

    Note

    Refer to Definition of the part list and table settings to have detailed explanations about how to customize the table presentation.

  6. Click on the green check “Validate the table modifications” icon to save the table, or

  7. Click on the red “X” “Cancel the table modifications” icon to discard the changes.

The hierarchical part lists are generated according to the 3D model currently present in the PDF document. The hierarchical part list reflects the hierarchy of the 3D information. Sub-assemblies are shown with indented part names and the components quantities are calculated locally, at the hierarchical level where they are found.

_images/page27_img1.png

A “hierarchical part list” table

Widget > Add table from CSV

The “Add a table from CSV” menu allows you to create a table in the PDF document from external data defined in a CSV.

Creation of a table from CSV

This table is generated from a chosen CSV file.

  1. Within the Tetra4D Enrich toolbar, choose Widget > Add table from CSV.

  2. Drag a rectangle to define the location and the size of the table.

  3. Use the frame controllers to resize the table if required.

  4. Drag the table border to reposition the table if required.

  5. Adjust the table properties to your specifications by selecting the options in the Edit panel in the right.

    Note

    Refer to Definition of the part list and table settings to have detailed explanations about how to customize the table presentation.

  6. Click on the green check “Validate the table modifications” icon to save the carousel, or

  7. Click on the red “X” “Cancel the table modifications” icon to discard the changes.

Table created from a CSV file has no link with the 3D parts of the 3D annotation. To map table rows with 3D parts, refer to “3D Attributes / 3D Mapping” section. To create actions triggered by a selection of a row of the table, refer to “On table row” section.

Note

CSV format

The CSV format expected by Tetra4D Enrich is shown below:

Column 1 title;Column 2 title;Column 3 title
C1 R1 value;C2 R1 value;C3 R1 value
C1 R2 value;C2 R2 value;C3 R2 value
C1 R3 value;C2 R3 value;C3 R3 value

The first line of the CSV file will be used to define the title of the columns in the table. The separator must be “;”.

_images/page28_img1.png

A “Table from CSV” table

Widget > Add table from clipboard

The “Add a table from clipboard” menu allows you to create a table in the PDF document from the system clipboard.

Creation of a table from clipboard

A table can be defined using data that is stored on the system clipboard. This is very similar to adding the table from a CSV file – the only difference is that instead of showing a dialog to select a CSV file, Tetra4 Enrich will grab the data automatically from the clipboard.

  1. Make sure the clipboard contains the table information. Then, within the Tetra4D Enrich toolbar, choose Widget > Add table from clipboard.

  2. Drag a rectangle to define the location and the size of the table.

  3. Use the frame controllers to resize the table.

  4. Drag the table border to reposition the table if required.

  5. Adjust the table properties to your specifications by selecting the options in the Edit panel in the right.

    Note

    Refer to Definition of the part list and table settings to have detailed explanations about how to customize the table presentation.

  6. Click on the green check “Validate the table modifications” icon to save the table, or

  7. Click on the red “X” “Cancel the table modifications” icon to discard the changes.

Tables created from the clipboard have no link with the 3D parts of the 3D annotation. To map table rows with 3D parts, refer to “3D Attributes / 3D Mapping”. To create actions triggered by a selection of a row of the table, refer to “On table row” section.

Note

Format of information copied in the clipboard

The contents of the clipboard must correspond to a table having multiple lines and rows. The column titles must be defined by the first row. Supported applications to copy the table information in the clipboard are Microsoft Excel and Google Sheets.

_images/page29_img1.png

Information in a spreadsheet (before being copied in the clipboard)

_images/page29_img2.png

Corresponding “Table from clipboard”

Definition of the part list and table settings

The Edit panel contains several settings to define the layout of the part list and table and to map its content with the 3D model if required.

Hover your mouse over any of the buttons to see the specific command.

  • Global settings: Defines the colors and the font information.

  • Emphasize: Defines how the selected part will be emphasized in the 3D annotation.

  • Column alignment: Defines the alignment of a selected column.

  • Add or remove columns: Enables you to add or remove a column.

  • 3D Attributes / 3D Mapping: Defines what information is displayed in a selected column and enables you to map the table with the 3D model if required.

    _images/page30_img1.png

    Edit panel for the table

Global settings subpanel

  • Font settings: Defines the font and the font size of all the information visible in the table.

  • Font color, Bold, Italic: Defines the color and text attributes of all the information visible in the table.

  • bg_color Background color: Defines the background color of the table.

Note: The background color applies to the full table.

  • header_bold Make header bold: set the header of the table to bold

Note: This setting enables to display header in bold while the table is displayed as non-bold.

  • border Add a border: Draws a frame around the table.

Note: The frame settings (color, thickness) are fixed and can’t be modified.

_images/page31_img4.png

Global settings area of the table edit panel

Emphasize subpanel

The Emphasize feature allows you to control how parts corresponding to the selected row in the table are emphasized in the 3D annotation.

There are three possibilities:

  • Emphasize with color and opacity: Parts are emphasized by a color change while all the other parts are displayed with opacity.

  • Emphasize with color: Parts are emphasized by a color change while all the other parts remain displayed without any change.

  • Emphasize with isolate: Parts are emphasized by an “isolate” operation (they remain visible and all the other parts are hidden). A “fit-all” operation is automatically performed in order

to zoom to the emphasized parts

Depending on the chosen emphasize mode, some additional settings are available:

  • color Emphasize color: Defines the color used to emphasize the search results.

  • Opacity slider: Defines the opacity value, when the “Emphasize with color and opacity” mode is selected.

  • Enable blinking: Activates blinking of the search results.
    Blinking is defined by two parameters: * Period: Defines the period time (in seconds) for every blink of the parts. * Number: Defines the number of blinking that occur for any highlight event.

Note: The “Enable blinking” option is not available with the “Emphasize by isolate” mode.

_images/page32_img2.png

Emphasize settings area of the Table panel

Column Alignment settings

_images/page33_img1.png

Column alignment settings area of the Table edit panel

  • align_left Align left: Align the selected column to left.

Note: This setting applies to the selected column. The selected column is the one in which the mouse cursor is placed.

  • align_center Align Center: Align the selected column to center.

Note: This setting applies to the selected column. The selected column is the one in which the mouse cursor is placed.

  • align_right Align right: Align the selected column to right.

Note: This setting applies to the selected column. The selected column is the one in which the mouse cursor is placed.

Add or remove columns settings

_images/page33_img5.png

Add or remove column settings area of the Table edit panel

  • insert_col_left Insert column to the left: Insert a new column to the left of the selected one.

Note: The selected column is the one in which the mouse cursor is placed.

  • insert_col_right Insert column to the right: Insert a new column to the right of the selected one.

Note: The selected column is the one in which the mouse cursor is placed.

  • delete_col Delete column: Delete the selected column.

Note: The selected column is the one in which the mouse cursor is placed.

3D Attributes / 3D Mapping subpanel

The 3D Attributes feature allows you to control which data is displayed in the columns of the table.

In case of a Part list (flat or hierarchical), the following information is listed in the table by default:

  • row number (title of column: #, name in the list of attributes: #Computed #),

  • part name (title of column: NAME, name in the list of attributes: #Computed NAME),

  • quantity (title of column: QTY, name in the list of attributes: #Computed QTY).

However, it is possible to display different information in one existing column, or in an added column.

The 3D Mapping feature allows you to map the information currently displayed in the table with the 3D model. This feature is meant to be used with tables created using the features Add table from CSV or Add table from clipboard.

_images/page34_img1.png

3D Attributes / 3D Mapping Settings area of the Table edit panel

  • fill_col_attr Fill column with attribute: Fill the selected column with attributes linked to the 3D model.

    1. Select the column you want to fill by selecting a cell in the column. There is no need to select the full column, just the top row of the column.

    2. Click on the Fill column with attributes icon.

    3. Select the attribute in the list of attributes from the dropdown.

    4. Check the result in the table.

The attributes that are listed in the list depend on the CAD model currently loaded in the PDF document, and on the additional attributes that may have been imported in the PDF document using the “ADD 3D attribute” feature. The default information that is listed in the table consists of:

  • Row number (title of column: #, name in the list of attributes: #Computed #),

  • Part name (title of column: NAME, name in the list of attributes: #Computed NAME),

  • Quantity (title of column: QTY, name in the list of attributes: #Computed QTY).

_images/page35_img1.png

List of attributes provided by the Fill column with attribute feature

  • gear : System information (default information displayed when the table is created).

  • download : Attributes that have been imported and linked to the 3D parts.

  • map_col: (no icon) Attribute defined in the CAD data (so that have been read while adding the 3D information in the PDF document.

  • map_col_3d Map selected column with 3D parts: Use the selected column to map the rows of the table with the 3D parts.

    1. Create the table using “Add table from CSV” or “Add table from clipboard” features.
      Note: See detailed explanations on “Add table from CSV” or “Add table from clipboard”.
    2. Select the column you want to use as a key for the mapping by selecting a cell in the column. Note: An example is provided next page.

    3. Click on the Map selected column with 3D parts icon.

    4. Check the result of the mapping in the dialog that pops-up.

    5. Click OK to close the dialog.

The “Map selected column with 3D parts” feature is available with tables created using the “Add table from CSV” or “Add table from clipboard” features. In the case of a table created using the Part list (flat or hierarchical) feature, this function will not be active, because these tables are already linked with the 3D data. Mapping the rows of the table with 3D parts enables a cross-highlight between the table and the 3D annotation, when selecting a row in the table or when selecting a part in the 3D annotation. The “mapping” means “correlate the values from this column to the corresponding 3D part”. The column title is important, because it is the key used to perform the mapping. For example, if the column title is “ItemNumber”, the mapping will work if the 3D parts contain an attribute named “ItemNumber”. Enrich will look for all the parts, and make the mapping between the table row and a particular part that matches ItemNumber.

Remark: Example of mapping between a CSV table and the 3D parts

The table below is mapped with the 3D parts based on the column ItemNumber (in this example, ItemNumber is an attribute which is defined in all the 3D parts). Once the table has been inserted in the document, the ItemNumber column must be selected and the feature “Map selected column with 3D parts” will execute the mapping based on this key. Afterwards, the mapping is managed by looking at all the values listed in the column of parts attributes. The table row and part become linked when the value of the key attribute for a 3D part matches with the value of the attribute present in the table. Below, the main housing part is linked to the highlighted table row because the ItemNumber values are the same: H7894561.

Mapping of the table rows with the 3D parts based on an attribute:

_images/page37_img1.png
_images/page37_img2.png
_images/page37_img3.png

The table below is mapped with the 3D parts based on the names of the parts. The names of the parts can be accessed using the key #Computed NAME. Consequently, the title of the column that contains the names of the parts must be #Computed NAME.

Mapping of the table rows with the 3D parts based on the names of the parts:

_images/page37_img4.png
_images/page37_img5.png
_images/page37_img7.png
_images/page37_img6.png

Widget > Add language selector

The “Add language selector” feature allows you to:

  • Define multiple languages within a single PDF document,

  • Create a widget that enable the document’s consumer to select the language to access to the localized information.

The information that can be localized are:

  • The meta-data linked to components,

  • The meta-data that have been imported and added to the components,

  • Text labels that are shown in text fields and buttons.

Note

The localized information are not supported by the Search widget and by the Table widget.

_images/page49_img1.png

A Language selector widget

_images/page49_img2.png

PDF document consumed using the English language

_images/page49_img3.png

PDF document consumed using the French language

Creation of a Language selector widget

  1. Within the Tetra4D Enrich toolbar, choose Widget > Add Language selector.

  2. Drag a rectangle to define the location and the size of the widget.
    The rectangle cannot overlap with other Tetra4D Enrich items.
    Once the rectangle is defined, the Language selector editor panel appears on the right.
  3. Use the frame controllers to resize the widget if needed.

  4. Adjust the widget properties to your specifications by selecting the commands in the Edit panel in the right.

  5. Rename the “Default Language” name in the Edit panel.

  6. Import languages files and define the languages names in the Edit panel.
    Note: The languages files are XML files encoded in UTF8.
    Refer to the “Export part list” feature for a description of the creation process for the XML files.
    Refer to “Localization of attributes and labels” XML file sample for a description of the file format for language definition.
  7. Click on the green check button “Validate the widget modifications” icon to save the language selector widget, or

  8. Click on the red “X” button “Cancel the Widget modifications” icon to discard the changes.

_images/page50_img1.png

Creation of a Language selector widget

Note

The import of the languages files is performed when the Language selector is saved. A dialog confirms the result of the import.

Definition of the Language selector layout

The Editor panel offers several settings to define the layout of the widget and to import languages files.

Hover your mouse over any of the buttons to see the specific command.

  • Global settings: Defines the colors and the font information for the widget.

  • Available languages: Imports additional languages files, sets the names of the languages and defines what languages are available in the widget.

_images/page51_img1.png

Edit panel for Language selector

Global settings subpanel

  • Font settings: Defines the font and the font size for used in the search widget.

  • Font color, Bold, Italic: Applies to the font used in the search widget.

  • Background color: Defines the background color of the Search widget.

_images/page52_img2.png

Global settings area of the Language selector edit panel

Available languages subpanel

The Available languages subpanel allows you to sequentially import files that define languages, and to set the names for the imported languages.

_images/page52_img3.png

Available languages settings area of the Language widget edit panel

  • Import a new language file: Browse to an existing language file (XML).

    1. Select the language file in the browser and click Apply to confirm the file selection
      Note: The selected language file appears in the language selector as a new row. The default name is the file’s name.
    2. To rename a language, double-click it and type-in a new value.
      Note: The names of the languages that appear in the selector widget are the names
      defined in the Available language list.
    3. To delete an imported language, use the delete icon.
      Note: It is not possible to update an already imported language. To modify a
      language, delete it first and then import again the language file and rename the language.
    4. To reorder the languages in the list, click a language row and drag and drop it to a new position.

    5. To define what languages will appear in the language selector widget, check the languages marks.

Example of creation of a multiple languages document

  • Initial document (title block labels and CAD meta-data are defined in English)

_images/page53_img1.png
  • XML file (partial): Language definition file sample (French).
    The list of the parts and labels has been exported with the Export Parts list feature
    The localized values have been added in this part list file (all Translation keys)
<attributes>
   <ATTRIBUTE key="ItemNumber" attribute_value="C1145783">
      <NEW_ATTRIB name="Description" value="CARBURETOR" translation="Carburateur" />
      <NEW_ATTRIB name="Material" value="Steel" translation="Acier" />
   </ATTRIBUTE> <labels>
   <NEW_LABEL name="Details_Label_1" value="Designation" translation="Désignation" />
   <NEW_LABEL name="Details_Label_2" value="Material" translation="Matière" />
   <NEW_LABEL name="Details_Label_3" value="Weight (g)" translation="Masse (g)" />
   <NEW_LABEL name="Details_Label_4" value="Revision" translation="Révision" />
   <NEW_LABEL name="Details_Label_5" value="Status" translation="Status" />
   <NEW_LABEL name="TB_01_Label" value="PART NUMBER" translation="Numéro de pièce" />
   <NEW_LABEL name="TB_02_Label" value="DESIGNATION" translation="Désignation" />
   <NEW_LABEL name="TB_03_Label" value="STATUS" translation="Status" />
   <NEW_LABEL name="TB_04_Label" value="REVISION" translation="Révision" />
  • Creation of the language selector widget:

    • Creation of the widget (position and size)

    _images/page54_img1.png
    • Import of language file

    _images/page54_img3.png

    Default language

    _images/page54_img2.png

    Selection of the French language file

    _images/page54_img4.png

    Renaming of the languages

    • Validation of the widget

_images/page54_img5.png
  • Resulting document

_images/page54_img7.png