Message API/docs/components/navigation/api
API References
Technical reference for navigation toolControl actions.
The following action IDs are used within the `toolControl` message payload when the group is set to `navigation`.
- MAGNIFY: Activates the magnification loupe.
- ZOOM_IN / ZOOM_OUT: Incremental zoom changes.
- FIT_TO_WINDOW: Resets zoom to show the entire page.
- FIT_WIDTH / FIT_HEIGHT: Fits the page width or height to the viewport.
- ROTATE: Rotates the drawing view clockwise.
- SEARCH_TEXT: Opens the text search interface.
- SELECT_TEXT: Enables text selection mode.
All navigation controls use the specific `navigationToolControl` message type.
export interface NavigationControlMessage {
type: 'navigationToolControl';
payload: {
action:
| 'MAGNIFY' | 'ZOOM_IN' | 'ZOOM_OUT'
| 'FIT_TO_WINDOW' | 'FIT_WIDTH' | 'FIT_HEIGHT'
| 'ZOOM_WINDOW' | 'ROTATE'
| 'HIDE_MARKUPS' | 'BACKGROUND' | 'MONOCHROME'
| 'GRAYSCALE' | 'SEARCH_TEXT' | 'SELECT_TEXT'
| 'VECTORINFO' | 'BLOCKINFO';
enabled?: boolean;
searchText?: string; // Required for SEARCH_TEXT
searchCaseSensitive?: boolean; // Optional for SEARCH_TEXT
searchForward?: boolean; // Optional for SEARCH_TEXT
};
}Message Format
