API Documentation
References
MuPDF WebViewer has a reference list for typical objects you will need to access and have control over.
To access the keys for these objects use the
Object references for the print settings.
A sub-object of
Example
Object references for the scroll settings.
A sub-object of
Example
Object references for the viewer sizing settings.
A sub-object of
Example
Object references for the viewer mode setting.
Example
Object references for the viewer rotation.
Example
Object references for the dialog types.
A sub-object of
Example
Object references for the panel types.
You can open a specific panel type or close the left or right panel.
A sub-object of
A sub-object of
Example
Object references for the viewer theme.
Example
Object references for the viewer language.
Example
Object references for annotations.
A sub-object of
Example
Object references for redactions.
A sub-object of
Example
Object references for setting view visibility.
A sub-object of
Example
Object references for the dialog types.
A sub-object of
Example
Object references for icons.
Example
Object references for the event types.
A sub-object of
Example
mupdf.refs object.
mupdf.refs
print
Object references for the print settings.
type
A sub-object of print.
| Object references |
|---|
BROWSER |
PLUGIN |
mupdf.refs.print.type.BROWSER
scroll
Object references for the scroll settings.
type
A sub-object of scroll.
| Object references |
|---|
PAGE |
ANNOTATION |
mupdf.refs.scroll.type.PAGE
fit
Object references for the viewer sizing settings.
to
A sub-object of fit.
| Object references |
|---|
WIDTH |
HEIGHT |
PAGE |
READ |
mupdf.refs.fit.to.WIDTH
viewMode
Object references for the viewer mode setting.
| Object references |
|---|
SINGLE |
DOUBLE |
SINGLE_SCROLL |
DOUBLE_SCROLL |
EBOOK |
mupdf.refs.viewMode.DOUBLE
degree
Object references for the viewer rotation.
| Object references |
|---|
DEG_0 |
DEG_90 |
DEG_180 |
DEG_270 |
mupdf.refs.degree.DEG_90
dialog
Object references for the dialog types.
type
A sub-object of dialog.
| Object references |
|---|
PRINT |
SEARCH_TOOL |
mupdf.refs.dialog.type.PRINT
panel
Object references for the panel types.
You can open a specific panel type or close the left or right panel.
open
A sub-object of panel.
| Object references |
|---|
ANNOTATION |
ANNOTATION_PROPERTY |
BOOKMARK |
REDACTION |
TEXT_SEARCH |
THUMBNAIL |
close
A sub-object of panel.
| Object references |
|---|
LEFT |
RIGHT |
mupdf.refs.panel.open.BOOKMARK
mupdf.refs.panel.close.LEFT
theme
Object references for the viewer theme.
| Object references |
|---|
DARK_MODE |
LIGHT_MODE |
SYSTEM_SYNCHRONIZATION |
mupdf.refs.theme.DARK_MODE
language
Object references for the viewer language.
| Object references |
|---|
ENGLISH |
KOREAN |
JAPANESE |
mupdf.refs.language.ENGLISH
annotation
Object references for annotations.
tool
A sub-object of annotation.
| Object references |
|---|
BUTTON |
CHECK_BUTTON |
CIRCLE |
CLOUD |
COMBO_BOX |
ERASER |
HIGHLIGHT |
INK |
LINE |
LINE_DIMENSION |
LINK |
LIST_BOX |
POLYGON |
POLYGON_DIMENSION |
POLYLINE |
POLYLINE_DIMENSION |
RADIO_BUTTON |
SIGNATURE |
SQUARE |
STAMP |
STRIKE |
TEXT_CALLOUT |
TEXT_FIELD |
TEXT_FREE |
TEXT_POPUP |
UNDERLINE |
mupdf.refs.annotation.tool.STAMP
redaction
Object references for redactions.
textDataOption
A sub-object of redaction.
| Object references |
|---|
FULL |
NONE |
TEXT_ONLY |
mupdf.refs.redaction.textDataOption.FULL
visibility
Object references for setting view visibility.
view
A sub-object of visibility.
| Object references |
|---|
ANNOTATION_HIGHLIGHT |
ANNOTATION_PROPERTY_PANEL |
ANNOTATION_STAMP |
ANNOTATION_STRIKE |
ANNOTATION_UNDERLINE |
ANNOTATION_UNDO_REDO |
CONTEXT_MENU |
CONTEXT_MENU_COPY |
CONTEXT_MENU_HIGHLIGHT |
CONTEXT_MENU_SEARCH |
CONTEXT_MENU_STRIKEOUT |
CONTEXT_MENU_UNDERLINE |
FLOATING_NAV |
FLOATING_NAV_SEARCH |
INDICATOR |
INDICATOR_PAGE_NUMBER |
INDICATOR_SCALE |
SIDE_VIEW |
SIDE_VIEW_ANNOTATION |
SIDE_VIEW_BOOKMARK |
SIDE_VIEW_THUMBNAIL |
TOOLBAR |
TOOLBAR_ANNOTATION |
TOOLBAR_DOWNLOAD |
TOOLBAR_LEFT |
TOOLBAR_PRINT |
TOOLBAR_RIGHT |
TOOLBAR_ROTATE |
TOOLBAR_VIEW_MODE |
TOOLBAR_ZOOM |
mupdf.refs.visibility.view.TOOLBAR
text
Object references for the dialog types.
align
A sub-object of text.
| Object references |
|---|
CENTER |
LEFT |
RIGHT |
mupdf.refs.text.align.LEFT
icon
Object references for icons.
| Object references |
|---|
BIDIRECTIONAL_HORIZONTAL_ARROW |
BOOKMARK |
CALENDAR |
CASE_SENSITIVE |
CHECK_MARK |
CIRCLE |
CIRCLE_CHECK_MARK |
CIRCLE_HORIZONTAL_3DOT |
CLIP |
COLLAPSE |
COMMENT |
COPY |
CROSS |
DOUBLE_DICE |
DOWNLOAD |
DOWN_CHEVRON |
DOWN_CHEVRON2 |
DOWN_CHEVRON3 |
EDIT |
ENTER_FULLSCREEN |
EXIT_FULLSCREEN |
EXPAND |
FILLED_ROUND_SQUARE_CHECK_MARK |
FILLED_STAMP |
FIRST |
FUNNEL |
GEAR |
GRID |
HAND |
HORIZONTAL_3DOT |
HYPERLINK |
IMAGE |
INVISIBLE |
LAST |
LEFT_CHEVRON |
LEFT_CHEVRON2 |
LEFT_CHEVRON3 |
LIST |
LIST2 |
LOCKED |
MAIL |
MEDIA_FAST_FORWARD |
MEDIA_NEXT |
MEDIA_PAUSE |
MEDIA_PLAY |
MEDIA_PREVIOUS |
MEDIA_REWIND |
MEDIA_STOP |
MEMO |
MEMO2 |
MINUS |
MONITOR |
MP3_FILE |
NEXT |
NOTE |
OCR_FILE |
PAGE |
PAGE_HEIGHT |
PAGE_SEARCH |
PAGE_WIDTH |
PENCIL |
PHONE |
PLUS |
POINTER |
POLYGON |
PREVIOUS |
PRINT |
REDO |
REFRESH |
RIGHT_CHEVRON |
RIGHT_CHEVRON2 |
RIGHT_CHEVRON3 |
ROTATE_CLOCKWISE |
ROTATE_COUNTER_CLOCKWISE |
ROUND_SQUARE_CHECK_MARK |
SAVE |
SEARCH |
SEND |
SHARE |
SIGN_OUT |
SIGNATURE |
SQUARE |
SQUARE_CHECK_MARK |
SQUARE_NEXT |
SQUARE_PREVIOUS |
STAMP |
TEXT_BOX |
TEXT_CURSOR |
TEXT_HIGHLIGHT |
TEXT_STRIKEOUT |
TEXT_UNDERLINE |
TRASH_CAN |
TXT_FILE |
TWO_WAY_HORIZONTAL_ARROW |
TWO_WAY_VERTICAL_ARROW |
UNDO |
UNLOCKED |
UP_CHEVRON |
UP_CHEVRON2 |
UP_CHEVRON3 |
USER |
VISIBLE |
mupdf.refs.icon.REFRESH
event
Object references for the event types.
type
A sub-object of event.
| Object references |
|---|
ACTION_HISTORY_CHANGE |
ANNOTATION_CREATE |
ANNOTATION_MODIFY |
ANNOTATION_REMOVE |
ANNOTATION_SELECTION_CHANGE |
ANNOTATION_TOOL_CHANGE |
CURRENT_PAGE_INDEX_CHANGE |
CURRENT_READING_PAGE_CHANGE |
CUSTOM_CONTEXT_MENU_EXECUTE |
DOCUMENT_DOWNLOAD |
KEYDOWN |
KEYUP |
MOUSEDOWN |
MOUSEUP |
POINTERDOWN |
POINTERUP |
REDACTION_CREATE |
REDACTION_MODIFY |
REDACTION_REMOVE |
SCALE_CHANGE |
SCROLL_POSITION_CHANGE |
SIDE_VIEW_CLOSE |
SIDE_VIEW_OPEN |
TEXT_SEARCH_START |
TEXT_SELECTION_CHANGE |
mupdf.refs.event.type.KEYDOWN