Images, Documents and Files

Images

Images can be uploaded to the BeeYard as Files or Images. By default, Images are displayed with Overlays, with the Overlay having the same name as the Image.

Add Image to Cell

  1. Click the Upload image button in the Cell.

    Upload image button
    Figure 1. Upload image button
  2. A popup window for uploading an image will appear.

    Upload image dialog
    Figure 2. Upload image dialog
  3. Click the Select file button to open the system dialog for selecting an image file.

  4. Select an image file and fill in the Filename. The selected image will be displayed.

    Upload new image window
    Figure 3. Upload new image window
  5. The uploaded Image will be displayed in the Editor view and selected in the list of Images.

    Image uploaded and displayed
    Figure 4. Image uploaded and displayed

Annotation panel

Since Images are displayed together with Shapes belonging to matching Overlays, Shapes can only be created when the Image is active. By default, when the Image and Overlay names match, the corresponding Overlay and Layer are automatically created when the first Shape is added to the Image. If a different Overlay and Layer are selected, the Shape will be added to the selected ones.

Annotation panel
Figure 5. Annotation panel

Shape tools

Shapes can be created using any of the Shape tools available in the Annotation Panel. The available tools include rectangle, oriented rectangle, cross, polygon, ellipse, path, mask, Ocr, and Smart tools. The Annotation Panel is only available in the Editor app.

Shape tools
Figure 6. Shape tools

Image tools

To move the Image, use the Pan tool, Zoom, or Reset the view. After creating or manipulating Shapes, the Undo and Redo functions are active. To save any changes, use the Save button. Image manipulation tools are available in both the Editor and Viewer apps, while tools related to Shapes are only available in the Editor app.

Image tools
Figure 7. Image tools

Filters

To enhance the Image itself, Filters can be applied. This function is available in both the Viewer and Editor apps, more information in the Editor app.

Filters tool
Figure 8. Filters tool

Details

  1. To view details about the Image, right-click on the Image name.

    Right click options
    Figure 9. Right click options
  2. Select Details to open a window with information about the File.

    Details
    Figure 10. Details

The details include basic information such as name or MIME type, Properties connected to the File, and its Tags. Both Properties and Tags can be edited in the Details window.

Note
On the right side, next to the annotation panel, are visible details of any selected item.

Rename

  1. To rename the Image, right-click on its name in the list of Images.

    Right click options
    Figure 11. Right click options
  2. Select Rename, and a pop-up window with an editable filename will appear.

    Filename pop up window
    Figure 12. Filename pop up window

Download

  1. To download the Image, right-click on its name in the list of Images.

    Right click options
    Figure 13. Right click options
  2. Select the Download option.

  3. The Image will be downloaded to your local disk.

Copy filename

  1. To copy the name of the Image, right-click on the Image name.

    Right click options
    Figure 14. Right click options
  2. Select the Copy filename option.

  3. The filename will be copied to the clipboard.

Delete

  1. To delete the Image, right-click on its name in the list of Images.

    Right click options
    Figure 15. Right click options
  2. Select the Delete option.

  3. The Image will be deleted from the Cell.

Documents

Documents are editable JSON files that can be processed in the BeeYard. For other data formats, use Files.

To open and edit Documents, use the Viewer app and the Editor app, respectively.

Add Document to Cell

In the Editor app, you can create a new empty Document or upload an existing Document from your local disk.

Create new Document

Note
The created Document will be empty.
  1. Click the Create new document button in the Documents section in the Cell.

    Create new document button
    Figure 16. Create new document button
  2. Enter the document name and choose if the Document will be Searchable or not.

    Enter document name
    Figure 17. Enter document name
  3. The saved Document will be displayed in the list of Documents in the Cell.

Upload Document from local disk

  1. Click the Upload document button in the Documents section of the Cell to upload an existing Document from your local disk.

    Upload document button
    Figure 18. Upload document button
  2. A popup window for uploading a document will appear.

    Upload new document
    Figure 19. Upload new document
  3. Click the Select file button to open a system dialog to select a JSON file.

  4. After selecting a file, set the Filename and Searchable option.

    Upload new document
    Figure 20. Upload new document, file selected
  5. The uploaded Document will be displayed in the list of Documents in the Cell.

    Document uploaded and displayed
    Figure 21. Document uploaded and displayed

Edit Document

  1. Select the Document you want to edit, and it will be displayed in the view.

  2. Click the Edit button on the right side of the view to enter editing mode.

    Details bar
    Figure 22. Details bar
  3. While the Edit button is selected, you can make changes to the data in the Document.

    Edit button selected
    Figure 23. Edit button selected
  4. Click the Save button next to the Edit button to save all the changes.

    Save button
    Figure 24. Save button
  5. The changes in the Document will be saved, and editing mode will be deactivated.

Details

  1. To view details about the Document, right-click on the Document name.

    Right click options
    Figure 25. Right click options
  2. Select Details to open a window with information about the Document.

    Details pop up window
    Figure 26. Details

The details include basic information such as name, mime type, Properties connected to the Document, and its Tags. Both Properties and Tags can be edited in the Details window.

Rename Document

  1. To rename the Document, right-click on the Document name.

    Right click options
    Figure 27. Right click options
  2. Select Rename to open a window with an editable filename.

    Filename pop up window
    Figure 28. Filename pop up window

Download Document

  1. To download the Document, right-click on the Document name.

    Right click options
    Figure 29. Right click options
  2. Select the Download option.

  3. The Document will be downloaded to your local disk.

Copy filename

  1. To copy the filename of the Document, right-click on the Document name.

    Right click options
    Figure 30. Right click options
  2. Select the Copy filename option.

  3. The filename will be copied to the clipboard.

Delete Document

  1. To delete the Document, right-click on the Document name.

    Right click options
    Figure 31. Right click options
  2. Select the Delete option.

  3. The Document will be deleted from the Cell.

Files

Any data type can be uploaded as a File. Only Files of certain MIME type can be displayed. Files are not editable or searchable, unlike Documents.

Upload File from local disk

  1. Click the Upload file button in the Files section of the Cell to upload a file from your local disk

    Upload file button
    Figure 32. Upload file button
  2. A popup window for uploading a file will appear.

    Upload new file
    Figure 33. Upload new file
  3. Click the Select file button to open a system dialog for selecting a file.

  4. After selecting a file, set the Filename and MIME type.

    Upload new file window
    Figure 34. Upload new file window
  5. The uploaded File will be displayed in the list of Files in the Cell.

    File uploaded and displayed
    Figure 35. File uploaded and displayed
Note
Only Files with matching MIME type can be displayed. It can be a text file, image, 3D model, video, and much more. Even if the Files are interactive, it is not possible to edit any. For example, the 3D models can be displayed with a mesh or just as a point cloud, videos can be viewed at different speeds, and text files can be read.
STL file displayed with a mesh and a point cloud.
Figure 36. STL file displayed with a mesh and a point cloud.

Details

  1. To view details about the File, right-click on the File name.

    Right click options
    Figure 37. Right click options
  2. Select Details to open a window with information about the File.

    Details
    Figure 38. Details

The details include basic information such as name, MIME type, Properties connected to the File, and its Tags. Both Properties and Tags can be edited in the Details window.

Rename File and change metadata

  1. To rename the File or change its metadata, right-click on the File name.

    Right click options
    Figure 39. Right click options
  2. Select Rename and change metadata to open a pop-up window with an editable filename and type.

    Filename pop up window
    Figure 40. Filename pop up window

Download File

  1. To download the File, right-click on the File name.

    Right click options
    Figure 41. Right click options
  2. Select the Download option.

  3. The File will be downloaded to your local disk.

Copy filename

  1. To copy the name of the File, right-click on the File name.

    Right click options
    Figure 42. Right click options
  2. Select the Copy filename option.

  3. The filename will be copied to the clipboard.

Delete File

  1. To delete the File, right-click on the File name.

    Right click options
    Figure 43. Right click options
  2. Select the Delete option.

  3. The File will be deleted from the Cell.