Skip to main content
Skip table of contents

Canvas UI - Annotation

The ICE Annotation system provides a way to annotate directly on the ICE Canvas. It can be accessed from the canvas toolbar.

Accessing Annotation System

To Show/Hide Annotations: On the canvas toolbar, click the Annotation Button. This action toggles the visibility of the annotation system on the canvas.

image-20240109-093416.png

Available Annotation Tools

The following tools are available in the annotation system:

  1. Pen: For freehand drawing and writing on the canvas.

  2. Text: To add text annotations.

  3. Shapes: Insert various geometric shapes.

  4. Lines: Draw straight lines.

  5. Undo: Reverse the last action.

  6. Redo: Reapply an action that was undone.

image-20240109-093636.png

Important Notes

  • Going Home: Navigating to the home screen in ICE will clear any current annotations.

  • New Session: Loading a new session will also clear existing annotations.

Configuration

The annotation tool can be tailored to specific preferences. This customisation is achieved by modifying the config.json file located in C:\\igloo\\igloo-core-service. Below is a guide on how to configure these settings.

Accessing the Configuration File

  1. Locate the File: Navigate to C:\\igloo\\igloo-core-service on your system.

  2. Open config.json

Customization Options

The annotation section of the config.json file contains several parameters that you can customize:

  • "defaultColour": Sets the default colour for the pen and shapes. For example, "white" sets the default color to white. You can change this to any valid color name or hexadecimal colour code e.g. “#ff0000” for red.

  • "defaultFontSize": Adjusts the default font size for text annotations.

  • "defaultStrokeWidth": Defines the default stroke width for the pen and shapes.

  • Position Settings: These settings define the positions of various elements in the annotation interface. Each position is determined by x (horizontal) and y (vertical) coordinates:

    • "eraserMenuPos": Position of the eraser menu.

    • "sidebarPos": Position of the sidebar.

    • "toolMenuPos": Position of the tool menu.

    • "clearAllPos": Position of the 'Clear All' option.

    For example, "x": 0, "y": 0 places the element at the top-left corner of the canvas and "x": 50, "y": 50 places the element in the middle of the canvas top-left aligned.

Applying Changes

  1. Edit the Values: Change the values in the annotation section as per your requirements.

  2. Save the File: After making the changes, save the config.json file.

  3. Refresh the annotation page

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.