View only mode

[yauhen-karmyzau]

As an Application Administrator, I want the ability to configure Ketcher into a view-only mode so that I can control user interactions and limit modifications to the chemical structures. The view-only mode should be configurable from settings on load and by Ketcher API in runtime.

Acceptance Criteria:

1. An Application Administrator should be able to configure Ketcher into a view-only mode from settings before web app load.

2. The Application Administrator should also be able to switch Ketcher into and out of view-only mode in runtime using the Ketcher API.

3. In view-only mode, all editing tools should be disabled including hotkeys, preventing users from modifying the chemical structures.

4. The following tools and functions should be enabled:

   1. Open, Save, Copy group
      
   2. Hand and Selection tools
      
   3. Check Structure, Calculated Values, 3D Viewer
      
      

5. "Add to Canvas" button should be disabled in the "Open structure" dialog window and "Open as New Project" must be highlighted as default.
   

6. When the user is using Ketcher and has any tool selected, switching to View Only mode will automatically reset the selected tool to "Rectangle Selection."

7. To turn on/turn off option use this command in console with true and false flag: ketcher.editor.options({ viewOnlyMode: true })

8. Hotkeys whitelist:

Shortcut	Action
Mod+o	Open…
Mod+s	Save As…
Mod+c	Copy
Mod+Shift+f	Copy Image
Mod+m	Copy as MOL
Mod+Shift+k	Copy as KET
Mod+a	Select All
Mod+Shift+a	Deselect All
Alt+s	Check structure
Alt+c	Calculate values
Mod+h	Hand tool
Escape only switch to Selection	Rotate between by Shift+Tab: Lasso Selection, Rectangle Selection, Fragment Selection
Mod+_, Mod+-	Zoom Out
Mod+=, Mod++	Zoom In
Mod+Shift+0	Zoom 100%
?, &, Shift+/	Help

[daniil-sloboda]

• Right click on any element should not display context menu
• Selection tool should not allow to move or resize elements, only select them
• Whenever view mode is triggered tool should reset to selection
• Rotation is blocked
• Any edit is blocked

To turn view only mode on\off use the following api call (from code or web console)
window.ketcher.editor.setOptions(JSON.stringify({ viewOnlyMode: true })) to turn on and to turn off replace true with false

P.S. do not use options method because currently it leads to unexpected behavior

[Zhirnoff]

Tested.
Desktop:

• OS: Windows 11
• Browser Chrome
• Version 128.0.6613.120 (Official Build) (64-bit)

Ketcher version
[Version 2.25.0-rc.1]
Indigo version
[Version 1.24.0-rc.1]

1. Currently, there are issues with selecting structures using the Fragment tool (it’s not working).

2. Some hotkeys are not functioning (see screenshot). Mod+d Select descriptors not working also in prod version at all.
   I change description in ticket about Escape hotkey because we change it behaviour in Change esc behaviour logic for selection tool #2127
   

3. After disabling View Only mode, it’s impossible to select all structures and move them together to a new place on the canvas.

2024-09-11_16h27_25.mp4

4. Through 3D View, it’s possible to change the structure's position on the canvas (we need to decide whether to completely remove the 3D Viewer or block the Apply button in it).
5. Full screen, Help, and About buttons are blocked in View Only mode (is it necessary to block them?).
6. Also, after enabling View Only mode via API, the structure shifts to the center of the canvas. This requires further investigation (a bug will be logged).

[Zhirnoff]

Tested.

Desktop:

• OS: Windows 11
• Browser Chrome
• Version 128.0.6613.120 (Official Build) (64-bit)

Ketcher version
[Version 2.26.0-rc.1]
Indigo version
[Version 1.25.0-rc.1]