View on GitHub
NeeView
Image viewer that allows you to browse images in folders like a book.

Script Manual

Overview

Extend the command with a script. You can change the settings, execute multiple commands at once, or execute them as separate commands with changed command parameters.

Scripting is disabled by default. Set and enable on the Scripts page of Options.

You can qualify the command with the doc comments at the top of the file. The keys are not case sensitive.

KeySummary
@argsDefault arguments
@descriptionCommand description
@mouseGestureDefault mouse gestures
@nameCommand name
@shortCutKeyDefault shortcuts
@touchGestureDefault touch operation

Command script

If the script file is placed in the script folder, it can be used as a command. One file is one command.

Event script

A specially named script file will be executed automatically.

OnStartup.nvjsExecuted when the application is launched.
OnBookLoaded.nvjsExecutes when the book is opened.
OnPageChanged.nvjsExecutes when the page view is changed.
OnWindowStateChanged.nvjsExecuted when the window state is changed.

Console

A console for testing scripts. To open it, select "Options > Open console" from the menu.

Console-only command

clsClear screen (Ctrl+L)
exitClose console
help, ?Open this script help

Script reference

This section explains how to use NeeView-specific commands.

Methods

include(string)objectLoad and execute the script.

Parameters

pathstringScript path. Relative paths are relative to the current script location.

Returns

objectScript execution result

e.g.

// Load and run Sample.nvjs
include("Sample.nvjs")

log(object)voidPrint a message to the console. It only works when you run the script from the console. For script testing.

Parameters

logobjectOutput message

sleep(int)voidSuspends the script for the specified amount of time.

Parameters

millisecondintPause time (milliseconds)

system(string, string)voidRun the external app.

Parameters

filenamestringExecutable path. If you specify a URL or file path, the associated app will be executed.
argsstringApp arguments (optional)

[Root Instance] nv

Provides app-specific features.

Properties

ArgsdictionaryrCommand arguments are stored in this array.
BookBookAccessorrCurrent book accessor
BookmarkBookmarkPanelAccessorrBookmark panel accessor
BookshelfBookshelfPanelAccessorrBookshelf panel accessor
CommandCommandAccessor[]rAn associative array of command accessors. The commands are the same as those displayed under Options > Command Settings. For details, refer to Command list.

e.g.

// Execute "NextPage" command
nv.Command["NextPage"].Execute()
// As well
nv.Command.NextPage.Execute()

ConfigdictionaryrAn associative array of application settings. Refers to and changes the set value. For the types of set values, refer to Config list.

e.g.

// Change the theme color to dark
nv.Config.Theme.ThemeType = "Dark"

CurrentCommandCommandAccessorrCurrently running command
DestinationFolderCollectionDestinationFolderCollectionAccessorrDestination folder list accessor
EffectEffectPanelAccessorrEffects panel accessor
EnvironmentEnvironmentAccessorrEnvironment accessor
ExternalAppCollectionExternalAppCollectionAccessorrExternal app list accessor
HistoryHistoryPanelAccessorrHistory panel accessor
InformationInformationPanelAccessorrInformation panel accessor
NavigatorNavigatorPanelAccessorrNavigator panel accessor
PageListPageListPanelAccessorrPageList panel accessor
PlaylistPlaylistPanelAccessorrPlaylist panel accessor
ScriptPathstringrPath of currently running script file
SusiePluginCollectionSusiePluginCollectionAccessorrSusie plugin collection
ValuesdictionaryrAn associative array for storing values. The value saved in this object will be retained during app execution.

e.g.

// Store value
nv.Values["Test"] = "Hello!"
// As well
nv.Values.Test = "Hello!"

Methods

CopyFile(string, string)voidCopy a file or directory

Parameters

sourcestringPath of the copy source
destinationstringDestination path

DeleteFile(string)voidDelete a file or directory

Parameters

pathstringPath to be deleted

MoveFile(string, string)voidMove a file or directory

Parameters

sourcestringPath of the move source
destinationstringDestination path

ShowDialog(string, string, int)boolDisplay the dialog.

Parameters

titlestringMain text
messagestringMessage (optional)
commandsint0: OK / 1: OKCancel / 2: YesNo
Button types (optional)

Returns

boolReturns true if positive selection ("OK" or "Yes"), false otherwise.

e.g.

isYes = nv.ShowDialog("Is this a pen?", "I think it's a pen, really?", 2)
if (isYes) {
    nv.ShowDialog("Good.")
}

ShowInputDialog(string)stringDisplay the input dialog.

Parameters

titlestringMain text

Returns

stringInput text. Null when canceled

ShowInputDialog(string, string)stringDisplay the input dialog.

Parameters

titlestringMain text
textstringDefault text

Returns

stringInput text. Null when canceled

ShowInputDialog(string, string, string)stringDisplay the input dialog.

Parameters

titlestringMain text
messagestringMessage
textstringDefault text

Returns

stringInput text. Null when canceled

ShowMessage(string)voidDisplay a message on the screen.

Parameters

messagestringOutput message

ShowToast(string)voidDisplay the message as a toast.

Parameters

messagestringOutput message

[Class] BookAccessor

Book accessor

Properties

ConfigBookConfigAccessorrBook config
CreationTimeDaterCreation time
IsBookmarkedboolrwBookmarked or not
IsMediaboolrWhether the book is a video
IsNewboolrWhether the book is a newly opened book with no history
LastWriteTimeDaterLast write time
PagesPageAccessor[]rPages that make up the book
PathstringrBook path. Null if no book is open
SizeintrFile size. For directory, -1.
ViewPagesViewPageAccessor[]rDisplaying pages

Methods

Wait()voidWait for the view pages to finish loading

[Class] BookConfigAccessor

Book config accessor

Properties

AutoRotatestring (AutoRotateType)rwAutomatic rotation
BaseScaledoublerwBase scale
BookReadOrderstring (PageReadOrder)rwLeft Open / Right Open
IsRecursiveFolderboolrwLoad subfolders
IsSupportedDividePageboolrwDivide wide page
IsSupportedSingleFirstPageboolrwShow first page alone
IsSupportedSingleLastPageboolrwShow last page alone
IsSupportedWidePageboolrwConsider landscape pages as two pages
SortModestring (PageSortMode)rwSort order
ViewPageSizeintrwNumber of pages to display

[Class] BookmarkFolderNodeAccessor

Bookmark folder node accessor

This class inherits from NodeAccessor.

Properties

ChildrenNodeAccessor[]rChild nodes
IndexintrIndex number
IsDisposedboolr"true" if it is a destroyed node.
IsExpandedboolrw"true" if the node is in the expanded state
NamestringrNode name
ParentNodeAccessorrParent node
ValueBookmarkFolderNodeSourcerProperties of bookmark folder
ValueTypestringrNode value type

Methods

Add(dictionary)BookmarkFolderNodeAccessorCreate and add a new bookmark folder

Parameters

parameterdictionaryNew bookmark folder parameters (optional)
Parameter "Name" can be specified.

Returns

BookmarkFolderNodeAccessorNew bookmark folder

e.g.

// Create a bookmark folder by name
nv.Bookshelf.FolderTree.BookmarkNode.Add({Name:"AAA"})

Insert(int, dictionary)BookmarkFolderNodeAccessorCreate and insert a new bookmark folder

Parameters

indexintInvalid parameter
Note: This parameter is ignored because bookmark folders do not control their order.
parameterdictionaryNew bookmark folder parameters (optional)
Parameter "Name" can be specified.

Returns

BookmarkFolderNodeAccessorNew bookmark folder

Remove()boolDelete itself

Returns

boolReturns "true" if deletion succeeds

[Class] BookmarkFolderNodeSource

Properties of bookmark folder

Properties

NamestringrwName
PathstringrPath of bookmark folder

[Class] BookmarkFolderTreeAccessor

Bookmark folder tree accessor

Properties

BookmarkNodeBookmarkFolderNodeAccessorrRoot node of the bookmark folder tree
SelectedItemNodeAccessorrwSelected item

[Class] BookmarkItemAccessor

Bookmark item accessor

Properties

CreationTimeDaterCreation time
LastWriteTimeDaterLast write time
NamestringrName
PathstringrPath
SizeintrFile size. For directory, -1.

Methods

Open()voidOpen book
Open(bool)voidOpen book

Parameters

isRecursiveboolLoad subfolders

[Class] BookmarkPanelAccessor

Bookmark panel accessor

Properties

FolderOrderstring (FolderOrder)rwList item order
FolderTreeBookmarkFolderTreeAccessorrFolder tree in the Bookmark panel
IsFloatingboolrPanel is floating
IsSelectedboolrwPanel selected
IsVisibleboolrPanel visibility
ItemsBookmarkItemAccessor[]rList items
PathstringrwCurrent bookmark folder path
SearchWordstringrwSearch box text
SelectedItemsBookmarkItemAccessor[]rwSelected items
Stylestring (PanelListItemStyle)rwList item style

Methods

Close()voidClose panel
MoveToParent()voidUp
NewFolder(string)voidCreate a new bookmark folder

Parameters

namestringName

Open()voidOpen panel
OpenDock()voidOpen panel in docking mode
OpenFloat()voidOpen panel in floating mode

[Class] BookshelfFolderTreeAccessor

Bookshelf folder tree accessory

Properties

BookmarkNodeBookmarkFolderNodeAccessorrRoot node of the bookmark folder tree
DirectoryNodeDirectoryNodeAccessorrRoot node of the folder tree
QuickAccessNodeQuickAccessFolderNodeAccessorrQuick access root node
SelectedItemNodeAccessorrwSelected item

Methods

Expand(string)voidExpand to the specified folder

Parameters

pathstringFolder path

[Class] BookshelfItemAccessor

Bookshelf item accessor

Properties

CreationTimeDaterCreation time
LastWriteTimeDaterLast write time
NamestringrName
PathstringrPath
SizeintrFile size. For directory, -1.

Methods

Open()voidOpen book
Open(bool)voidOpen book

Parameters

isRecursiveboolLoad subfolders

[Class] BookshelfPanelAccessor

Bookshelf panel accessor

Properties

FolderOrderstring (FolderOrder)rwList item order
FolderTreeBookshelfFolderTreeAccessorrBookshelf folder tree
IsFloatingboolrPanel is floating
IsSelectedboolrwPanel selected
IsVisibleboolrPanel visibility
ItemsBookshelfItemAccessor[]rList items
NextHistorystring[]rLater history on the bookshelf
PathstringrwCurrent bookshelf path
PreviousHistorystring[]rPrevious history on bookshelf
SearchWordstringrwSearch box text
SelectedItemsBookshelfItemAccessor[]rwSelected items
Stylestring (PanelListItemStyle)rwList item style

Methods

Close()voidClose panel
MoveToNext()voidNext
MoveToParent()voidUp
MoveToPrevious()voidBack
Open()voidOpen panel
OpenDock()voidOpen panel in docking mode
OpenFloat()voidOpen panel in floating mode
Sync()voidMove to current book place
Wait()voidWait for display to complete

[Class] CommandAccessor

Command accessor

Properties

IsShowMessageboolrwDisplay a message when executing a command
MouseGesturestringrwMouse gestures

e.g.

// Set "↑←↓" to the mouse gesture of ViewRotateLeft command
nv.Command.ViewRotateLeft.MouseGesture = "ULD"

NamestringrCommand name
ParameterdictionaryrYou can get and set command parameters. The settings are permanent. The properties differ for each command. For details, see the command list below.

e.g.

// Change the rotation amount of "ViewRotateLeft" command to 45 degrees
nv.Command.ViewRotateLeft.Parameter.Angle = 45

ShortCutKeystringrwShortcut

e.g.

// Set "Ctrl+A" as shortcut for ViewRotateLeft command
nv.Command.ViewRotateLeft.ShortCutKey = "Ctrl+A"

TouchGesturestringrwTouch operation

e.g.

// Set "TouchCenter" for touch operation of ViewRotateLeft command
nv.Command.ViewRotateLeft.TouchGesture = "TouchCenter"

Methods

Execute(object[])boolExecute the command.
Some commands allow you to specify arguments. These can be used for the purpose of omitting the user's selection by specifying the argument in the command that normally displays the dialog.

Parameters

argsobject[]Command argument. The contents vary depending on the command. It is a variable length argument. (Optional)

Returns

boolSuccess or failure of command issuance. Commands may not be issued during loading. The success or failure of the command itself is not determined.

e.g.

// open C:\Foo\Bar.zip
nv.Command.LoadAs.Execute("C:\\Foo\\Bar.zip")

Patch(dictionary)CommandAccessorTemporarily change the command parameter.

Parameters

patchdictionarySpecify the command parameter to be overwritten temporarily in JSON format.

Returns

CommandAccessorReturns its own command accessors as is.

e.g.

// Rotate counterclockwise by specifying 5 degrees
nv.Command.ViewRotateLeft.Patch({"Angle": 5}).Execute()

[Class] DestinationFolderAccessor

Destination folder accessor

Properties

NamestringrwName
PathstringrwPath

Methods

Copy(string)voidCopy to destination folder

Parameters

pathstringFile to copy

Copy(string[])voidCopy to destination folder

Parameters

pathsstring[]List of files to copy

CopyPage(PageAccessor)voidCopy to destination folder

Parameters

pagePageAccessorPage to copy

CopyPage(PageAccessor[])voidCopy to destination folder

Parameters

pagesPageAccessor[]List of pages to copy

Move(string)voidMove to destination folder

Parameters

pathstringFile to move

Move(string[])voidMove to destination folder

Parameters

pathsstring[]List of files to move

MovePage(PageAccessor)voidMove to destination folder

Parameters

pagePageAccessorPage to move

MovePage(PageAccessor[])voidMove to destination folder

Parameters

pagesPageAccessor[]List of pages to move

[Class] DestinationFolderCollectionAccessor

Destination folder list accessor

Properties

ItemsDestinationFolderAccessor[]rDestination folders

Methods

CreateNew()DestinationFolderAccessorCreate a new destination folder

Returns

DestinationFolderAccessorNew destination folder

Remove(DestinationFolderAccessor)voidDelete destination folder

Parameters

itemDestinationFolderAccessorDestination folder to be deleted

[Class] DirectoryNodeAccessor

Folder node accessor

This class inherits from NodeAccessor.

Properties

ChildrenNodeAccessor[]rChild nodes
IndexintrIndex number
IsDisposedboolr"true" if it is a destroyed node.
IsExpandedboolrw"true" if the node is in the expanded state
NamestringrNode name
ParentNodeAccessorrParent node
ValueDirectoryNodeSourcerProperties of folder node
ValueTypestringrNode value type

[Class] DirectoryNodeSource

Properties of folder node

Properties

NamestringrName
PathstringrPath

[Class] EffectPanelAccessor

Effects panel accessor

Properties

IsFloatingboolrPanel is floating
IsSelectedboolrwPanel selected
IsVisibleboolrPanel visibility

Methods

Close()voidClose panel
Open()voidOpen panel
OpenDock()voidOpen panel in docking mode
OpenFloat()voidOpen panel in floating mode

[Class] EnvironmentAccessor

Environment accessor

Properties

DateVersionstringrDate version
NeeViewPathstringrNeeView executable file path
OSVersionstringrOS Version
PackageTypestringrPackage type
ProductVersionstringrProduct version
RevisionstringrGit revision
SelfContainedboolrSelf-contained package; framework-dependent if false
UserAgentstringrUser agent
UserSettingFilePathstringrSetting file path
VersionstringrVersion

[Class] ExternalAppAccessor

External app accessor

Properties

ArchivePolicystring (ArchivePolicy)rwCompressed file processing policy
CommandstringrwExternal app path
NamestringrwDisplay name
ParameterstringrwExternal app parameters
WorkingDirectorystringrwWorking folder

Methods

Execute(PageAccessor)voidRun external app

Parameters

pagePageAccessorPage to send

Execute(PageAccessor[])voidRun external app

Parameters

pagesPageAccessor[]List of pages to send

Execute(string)voidRun external app

Parameters

pathstringFile to send

Execute(string[])voidRun external app

Parameters

pathsstring[]List of files to send

[Class] ExternalAppCollectionAccessor

External app list accessor

Properties

ItemsExternalAppAccessor[]rExternal apps

Methods

CreateNew()ExternalAppAccessorCreate a new external app

Returns

ExternalAppAccessorNew external app

Remove(ExternalAppAccessor)voidDelete external app

Parameters

itemExternalAppAccessorExternal app to be deleted

[Class] HistoryItemAccessor

History item accessor

Properties

LastAccessTimeDaterLast access time
NamestringrItem name
PathstringrThe path corresponding to the item

Methods

Open()voidOpen book

[Class] HistoryPanelAccessor

History panel accessor

Properties

IsFloatingboolrPanel is floating
IsSelectedboolrwPanel selected
IsVisibleboolrPanel visibility
ItemsHistoryItemAccessor[]rList items
SearchWordstringrwSearch box text
SelectedItemsHistoryItemAccessor[]rwSelected items
Stylestring (PanelListItemStyle)rwList item style

Methods

Close()voidClose panel
Open()voidOpen panel
OpenDock()voidOpen panel in docking mode
OpenFloat()voidOpen panel in floating mode

[Class] InformationPanelAccessor

Information panel accessor

Properties

IsFloatingboolrPanel is floating
IsSelectedboolrwPanel selected
IsVisibleboolrPanel visibility

Methods

Close()voidClose panel
Open()voidOpen panel
OpenDock()voidOpen panel in docking mode
OpenFloat()voidOpen panel in floating mode

[Class] MediaPlayerAccessor

Media Player Accessor

Properties

AudioTrackTrackCollectionAccessorrAudio Track Management. If it does not exist, null
DurationdoublerMedia duration (seconds)
IsMutedboolrwMute mode ON/OFF
IsPlayingboolrwPlayback ON/OFF
IsRepeatboolrwRepeat mode ON/OFF
PositiondoublerwCurrent position (0.0-1.0)
SubtitleTrackCollectionAccessorrSubtitle Track Management. If it does not exist, null
VolumedoublerwVolume (0.0-1.0)

Navigator panel accessor

Properties

IsFloatingboolrPanel is floating
IsSelectedboolrwPanel selected
IsVisibleboolrPanel visibility

Methods

Close()voidClose panel
Open()voidOpen panel
OpenDock()voidOpen panel in docking mode
OpenFloat()voidOpen panel in floating mode

[Class] NodeAccessor

Node accessor

Properties

ChildrenNodeAccessor[]rChild nodes
IndexintrIndex number
IsDisposedboolr"true" if it is a destroyed node.
IsExpandedboolrw"true" if the node is in the expanded state
NamestringrNode name
ParentNodeAccessorrParent node
ValueobjectrNode Value
ValueTypestringrNode value type

Methods

Add(dictionary)NodeAccessorCreate and add a new item

Parameters

parameterdictionaryNew item parameters (optional)
Specify parameters as an associative array. Refer to the description of the derived class for details, as it depends on the type of item to be created.

Returns

NodeAccessorNew item

Insert(int, dictionary)NodeAccessorCreate and insert a new item

Parameters

indexintInsertion position
parameterdictionaryNew item parameters (optional)
Specify parameters as an associative array. Refer to the description of the derived class for details, as it depends on the type of item to be created.

Returns

NodeAccessorNew item

MoveTo(int)voidChange the index position

Parameters

newIndexintNew index number

Remove()boolDelete itself

Returns

boolReturns "true" if deletion succeeds

[Class] PageAccessor

Page accessor

Properties

CreationTimeDaterCreation time
IndexintrPage index. Numbers begin with 0.
IsBookboolrCan open as a book
LastWriteTimeDaterLast write time
PathstringrPage path
RawPathstringrRaw path
SizeintrFile size (Byte)

Methods

GetMetaValue(string)stringGet page meta information

Parameters

keystringMeta information item name. See the search options help for more information.

Returns

stringMeta information value

GetMetaValueMap()dictionaryGet a list of page meta information

Returns

dictionaryAssociative array of page meta information

Open()voidOpen page
OpenAsBook()voidOpen as book

[Class] PageListPanelAccessor

PageList panel accessor

Properties

Formatstring (PageNameFormat)rwItem name format
IsFloatingboolrPanel is floating
IsSelectedboolrwPanel selected
IsVisibleboolrPanel visibility
ItemsPageAccessor[]rList items
PathstringrCurrent book path
SearchWordstringrwSearch box text
SelectedItemsPageAccessor[]rwSelected items
SortModestring (PageSortMode)rwList item order
Stylestring (PanelListItemStyle)rwList item style

Methods

Close()voidClose panel
Open()voidOpen panel
OpenDock()voidOpen panel in docking mode
OpenFloat()voidOpen panel in floating mode

[Class] PlaylistItemAccessor

Playlist item accessor

Properties

NamestringrItem name
PathstringrThe path corresponding to the item

Methods

Open()voidOpen item

[Class] PlaylistPanelAccessor

Playlist panel accessor

Properties

IsFloatingboolrPanel is floating
IsSelectedboolrwPanel selected
IsVisibleboolrPanel visibility
ItemsPlaylistItemAccessor[]rList items
NamestringrwCurrent playlist name
PathstringrwCurrent playlist path
SelectedItemsPlaylistItemAccessor[]rwSelected items
Stylestring (PanelListItemStyle)rwList item style

Methods

Close()voidClose panel
Open()voidOpen panel
OpenDock()voidOpen panel in docking mode
OpenFloat()voidOpen panel in floating mode

[Class] QuickAccessFolderNodeAccessor

Quick access folder accessor

This class inherits from NodeAccessor.

Properties

ChildrenNodeAccessor[]rChild nodes
IndexintrIndex number
IsDisposedboolr"true" if it is a destroyed node.
IsExpandedboolrw"true" if the node is in the expanded state
NamestringrNode name
ParentNodeAccessorrParent node
ValueQuickAccessFolderNodeSourcerProperties of the quick access folder
ValueTypestringrNode value type

Methods

Add(dictionary)QuickAccessNodeAccessorCreate and add new quick access

Parameters

parameterdictionaryNew quick access parameters (optional)
Parameters "Name" and "Path" can be specified.

Returns

QuickAccessNodeAccessorNew quick access

e.g.

// Create quick access by specifying only path
nv.Bookshelf.FolderTree.QuickAccessNode.Add({Path:"C:\\FooBar"})

Insert(int, dictionary)QuickAccessNodeAccessorCreate and insert new quick access

Parameters

indexintInsertion position
parameterdictionaryNew quick access parameters (optional)
Parameters "Name" and "Path" can be specified.

Returns

QuickAccessNodeAccessorNew quick access

e.g.

// Create quick access with name and path
nv.Bookshelf.FolderTree.QuickAccessNode.Insert(0, {Name:"AAA", Path:"C:\\FooBar"})

[Class] QuickAccessFolderNodeSource

Properties of the quick access folder

Properties

NamestringrName

[Class] QuickAccessNodeAccessor

Quick access node accessor

This class inherits from NodeAccessor.

Properties

IndexintrIndex number
IsDisposedboolr"true" if it is a destroyed node.
NamestringrNode name
ParentNodeAccessorrParent node
ValueQuickAccessNodeSourcerProperties of the quick access
ValueTypestringrNode value type

Methods

MoveTo(int)voidChange the index position

Parameters

newIndexintNew index number

Remove()boolDelete itself

Returns

boolReturns "true" if deletion succeeds

[Class] QuickAccessNodeSource

Properties of the quick access

Properties

NamestringrwName
PathstringrwQuick access path

[Class] SusiePluginAccessor

Susie plugin accessor

Properties

ApiVersionstringrAPI version
DetailTextstringrDetailed text
ExtensionsstringrwExtensions. Multiple extensions can be specified by semicolon, initialized by null.
HasConfigDialogboolrConfiguration dialog exists
IsCacheEnabledboolrwCache plugin
IsEnabledboolrwEnable
IsPreExtractboolrwPre extract
NamestringrName
PathstringrPath
PluginTypestring (SusiePluginType)rSusie plugin type
PluginVersionstringrPlugin version

Methods

ShowConfigDialog()voidOpen the Configuration dialog

[Class] SusiePluginCollectionAccessor

Susie plugin collection accessor

Properties

AMPluginsSusiePluginAccessor[]rArchive plugins
INPluginsSusiePluginAccessor[]rImage plugins

[Class] TrackCollectionAccessor

Media player track accessor

Properties

SelectedIndexintrwSelected track number
Tracksstring[]rTrack list

[Class] ViewPageAccessor

ViewPage accessor

This class inherits from PageAccessor.

Properties

CreationTimeDaterCreation time
HeightdoublerPage height
IndexintrPage index. Numbers begin with 0.
IsBookboolrCan open as a book
LastWriteTimeDaterLast write time
PathstringrPage path
PlayerMediaPlayerAccessorrMedia player. If not media, null
RawPathstringrRaw path
SizeintrFile size (Byte)
WidthdoublerPage width

Methods

GetMetaValue(string)stringGet page meta information

Parameters

keystringMeta information item name. See the search options help for more information.

Returns

stringMeta information value

GetMetaValueMap()dictionaryGet a list of page meta information

Returns

dictionaryAssociative array of page meta information

GetPageAccessor()PageAccessorGet PageAccessor for this page

Returns

PageAccessorPage accessor

Open()voidOpen page
OpenAsBook()voidOpen as book

[Enum] ArchivePolicy

Compressed file processing policy

Fields

NoneDo not execute
SendArchiveFileCompressed file
SendArchivePathCompressed file + filename
SendExtractFileTemporary file

[Enum] AutoRotateType

Automatic rotation

Fields

NoneDefault
LeftAuto left rotate
RightAuto right rotate
ForcedLeftForced left rotate
ForcedRightForced right rotate

[Enum] FolderOrder

List item order

Fields

FileNameName↑
FileNameDescendingName↓
PathPath↑
PathDescendingPath↓
FileTypeType↑
FileTypeDescendingType↓
TimeStampDate↑
TimeStampDescendingDate↓
SizeSize↑
SizeDescendingSize↓
EntryTimeEntry↑
EntryTimeDescendingEntry↓
RandomShuffle

[Enum] PageNameFormat

Item name format in PageList

Fields

SmartSmart
NameOnlyName
RawRaw

[Enum] PageReadOrder

Page read order

Fields

RightToLeftRight to left
LeftToRightLeft to right

[Enum] PageSortMode

Page sort mode

Fields

FileNameName↑
FileNameDescendingName↓
TimeStampDate↑
TimeStampDescendingDate↓
SizeSize↑
SizeDescendingSize↓
EntryEntry↑
EntryDescendingEntry↓
RandomShuffle

[Enum] PanelListItemStyle

List item style

Fields

NormalText
ContentContent
BannerBanner
ThumbnailThumbnail

[Enum] SusiePluginType

Susie plugin type

Fields

NoneNone
ImageImage
ArchiveArchive

Config list

Name Type Summary
nv.Config.Archive.Media.IsEnabledboolOpen video as a book
nv.Config.Archive.Media.IsLibVlcEnabledboolPlay videos using libVLC

VLC media player is required. Many video formats are supported, and subtitles and audio channels can be selected.

nv.Config.Archive.Media.IsMediaPageEnabledboolOpen video as a page
nv.Config.Archive.Media.IsMutedboolMute video
nv.Config.Archive.Media.IsRepeatboolVideo repeat
nv.Config.Archive.Media.LibVlcPathstringlibVLC directory

Directory where the 64-bit version of libvlc.dll resides. This is usually the VLC media player installation folder.

nv.Config.Archive.Media.MediaStartDelaySecondsdoublePlay start delay (sec)

If 0 is specified, the contents may flicker.

nv.Config.Archive.Media.PageSecondsdoubleChange time in page movement (sec)
nv.Config.Archive.Media.SupportFileTypes".ex1;.ex2;.ex3"Video file extension

Probably what you can play with Windows Media Player is playable.

nv.Config.Archive.Media.VolumedoubleVideo volume
nv.Config.Archive.Pdf.IsEnabledboolUse PDF
nv.Config.Archive.Pdf.RenderSize"width,height"PDF page standard size

Normally we will render according to the display size, but the lower limit will be this standard size. If it becomes smaller, it is reduced and displayed.

nv.Config.Archive.Pdf.SupportFileTypes".ex1;.ex2;.ex3"PDF file extension
nv.Config.Archive.SevenZip.IsEnabledboolUse compressed file expansion with 7-Zip
nv.Config.Archive.SevenZip.SupportFileTypes".ex1;.ex2;.ex3"Compressed file extension
nv.Config.Archive.SevenZip.X64DllPathstringLocation of 7z.dll (64 bit)

Set this if you want to use another 7z.dll. You need to reopen the application.

nv.Config.Archive.SevenZip.X86DllPathstringLocation of 7z.dll (32bit)

Set this if you want to use another 7z.dll. You need to reopen the application.

nv.Config.Archive.Zip.Encoding
"Local"
Local
"UTF8"
UTF-8
"Auto"
Auto
Encoding for ZIP entry names

For ZIP files without the UTF-8 flag set.

nv.Config.Archive.Zip.IsEnabledboolUse ZIP compressed file expansion with standard function
nv.Config.Archive.Zip.IsFileWriteAccessEnabledboolZIP file editable

It will be possible to delete files in the ZIP. The "File management" setting must be enabled.

nv.Config.Archive.Zip.SupportFileTypes".ex1;.ex2;.ex3"Compressed file extension

Only ZIP format is supported.

nv.Config.AutoHide.AutoHideConflictBottomMargin
"Allow"
Allow
"AllowPixel"
Allow one pixel
"Deny"
Deny
Automatic display judgment of slider on side panel
nv.Config.AutoHide.AutoHideConflictTopMargin
"Allow"
Allow
"AllowPixel"
Allow one pixel
"Deny"
Deny
Automatic display judgment of menu bar on side panel
nv.Config.AutoHide.AutoHideDelayTimedoubleTime to hide auto-hide panel (sec)
nv.Config.AutoHide.AutoHideDelayVisibleTimedoubleTime to display auto-hide panel (sec)
nv.Config.AutoHide.AutoHideFocusLockMode
"None"
None
"LogicalFocusLock"
Panel
"LogicalTextBoxFocusLock"
TextBox
"FocusLock"
Window and Panel
"TextBoxFocusLock"
Window and TextBox
Auto-hide panel focus mode

It is not hidden when it has focus.

nv.Config.AutoHide.AutoHideHitTestHorizontalMargindoubleWidth for panel automatic display judgment (pixel)
nv.Config.AutoHide.AutoHideHitTestVerticalMargindoubleHeight for panel automatic display judgment (pixel)
nv.Config.AutoHide.IsAutoHideKeyDownDelayboolAuto-hide panel key input display continued

Postpone the action to hide when key input.

nv.Config.Background.BackgroundType
"Black"
Black background
"White"
White background
"Auto"
Image colored background
"Check"
White checkered background
"CheckDark"
Black checkered background
"Custom"
Custom Background
Background type
nv.Config.Background.CustomBackground.Color"#AARRGGBB"Custom background: Color
nv.Config.Background.CustomBackground.ImageFileNamestringCustom background: Image file
nv.Config.Background.CustomBackground.Type
"SolidColor"
Solid color
"ImageTile"
Image tile
"ImageFill"
Enlarge and display the image
"ImageUniform"
Fit image to window size
"ImageUniformToFill"
Extend the image to the full window
Custom background: Brush type
nv.Config.Background.IsPageBackgroundCheckerboolCheckered background transparent image

It will be a check pattern of "Transparent image background color".

nv.Config.Background.PageBackgroundColor"#AARRGGBB"Transparent image background color
nv.Config.Book.ContentsSpacedoubleDistance between pages in "Two pages" (pixels)

Sets the gap between page and page. Negative values ​​mean overlapping. Because each page is scaled, it is rare that there will be no gap just at 0.

nv.Config.Book.DividePageRatedoubleRate of divide page

Division rate when "Divide wide page".

nv.Config.Book.DummyPageColor"#AARRGGBB"Dummy page color
nv.Config.Book.Excludes"str1;str2;str3"Excluded folders
nv.Config.Book.FrameSpacedoubleDistance between pages in "Panorama" (pixels)

Sets the gap between page and page. Negative values ​​mean overlapping. Because each page is scaled, it is rare that there will be no gap just at 0.

nv.Config.Book.IsAutoRecursiveboolIf the subfolder is independent, read it without checking

Automatically loads subfolders if there are no pages and only one subfolder exists.

nv.Config.Book.IsConfirmRecursiveboolAsk if you want to load it when you only have a subfolder

If there is no page that can be displayed when the book is opened, and a subfolder exists, a dialog is displayed asking whether to load the subfolder.

nv.Config.Book.IsInsertDummyFirstPageboolAdd a dummy page to the first page
nv.Config.Book.IsInsertDummyLastPageboolAdd a dummy page to the last page
nv.Config.Book.IsInsertDummyPageboolInsert a dummy page for a double-page spread

When there are not enough pages at the two-page display, add a dummy page to align the spread.

nv.Config.Book.IsNotifyPageLoopboolNotify page loop
nv.Config.Book.IsPanoramaboolPanorama

Displays consecutive pages.

nv.Config.Book.IsPrioritizeBookMoveboolBook movement priority
nv.Config.Book.IsPrioritizePageMoveboolPage movement priority

Perform page movement without waiting for page display.

nv.Config.Book.IsReadyToPageMoveboolReady to page move

Switch display when page is ready. Not valid in "Panorama".

nv.Config.Book.IsSortFileFirstboolSort pages by file first

Arrange files before folders.

nv.Config.Book.IsStaticWidePageboolStatic two pages

The base page for the two pages display is determined by numbers only. Slider movement follows suit.

nv.Config.Book.Orientation
"Horizontal"
Horizontal
"Vertical"
Vertical
Page layout orientation
nv.Config.Book.PageEndAction
"None"
None
"NextBook"
Move to next book
"Loop"
Loop
"SeamlessLoop"
Seamless loop
"Dialog"
Select in dialog
Behavior when trying to move past the end of the page
nv.Config.Book.ResetPageWhenRandomSortboolReset page when shuffle
nv.Config.Book.TerminalSoundstringSound when not able to move
nv.Config.Book.WidePageStretch
"None"
None
"UniformHeight"
Uniform height
"UniformWidth"
Uniform width
How to align sizes in "Two pages"
nv.Config.Book.WidePageVerticalAlignment
"Top"
Top
"Center"
Center
"Bottom"
Bottom
Vertial alignment in "Two pages"
nv.Config.Book.WideRatiodoubleAspect ratio for determining horizontally long image (horizontal / vertical)

It is used in "Divide wide page".

nv.Config.Bookmark.BookmarkFilePathstringBookmark: Bookmark file location
nv.Config.Bookmark.BookmarkFolderOrder
"FileName"
Name↑
"FileNameDescending"
Name↓
"Path"
Path↑
"PathDescending"
Path↓
"FileType"
Type↑
"FileTypeDescending"
Type↓
"TimeStamp"
Date↑
"TimeStampDescending"
Date↓
"Size"
Size↑
"SizeDescending"
Size↓
"EntryTime"
Entry↑
"EntryTimeDescending"
Entry↓
"Random"
Shuffle
Bookmark: Default order of bookmarks
nv.Config.Bookmark.FolderTreeLayout
"Top"
Place to the top
"Left"
Place to the left
Bookmark: Folder tree layout
nv.Config.Bookmark.IsFolderTreeVisibleboolBookmark: Display folder tree
nv.Config.Bookmark.IsSaveBookmarkboolBookmark: Save bookmark file
nv.Config.Bookmark.IsSearchIncludeSubdirectoriesboolBookmark: Perform a search including subfolders
nv.Config.Bookmark.IsSyncBookshelfEnabledboolBookmark: Sync bookshelf when book is opened
nv.Config.Bookmark.PanelListItemStyle
"Normal"
Text
"Content"
Content
"Banner"
Banner
"Thumbnail"
Thumbnail
Bookmark: List item style
nv.Config.BookSetting.AutoRotate
"None"
Default
"Left"
Auto left rotate
"Right"
Auto right rotate
"ForcedLeft"
Forced left rotate
"ForcedRight"
Forced right rotate
Automatic rotation
nv.Config.BookSetting.BaseScaledoubleBase scale
nv.Config.BookSetting.BookReadOrder
"RightToLeft"
Right to left
"LeftToRight"
Left to right
Page read order
nv.Config.BookSetting.IsRecursiveFolderboolLoad subfolders

Since it searches everything under the folder to be opened, the load may be high depending on the location where it is opened.

nv.Config.BookSetting.IsSupportedDividePageboolDivide wide page
nv.Config.BookSetting.IsSupportedSingleFirstPageboolShow first page alone
nv.Config.BookSetting.IsSupportedSingleLastPageboolShow last page alone
nv.Config.BookSetting.IsSupportedWidePageboolConsider landscape pages as two pages
nv.Config.BookSetting.PageMode
"SinglePage"
One page
"WidePage"
Two pages
Page Size Mode
nv.Config.BookSetting.SortMode
"FileName"
Name↑
"FileNameDescending"
Name↓
"TimeStamp"
Date↑
"TimeStampDescending"
Date↓
"Size"
Size↑
"SizeDescending"
Size↓
"Entry"
Entry↑
"EntryDescending"
Entry↓
"Random"
Shuffle
Page sort mode
nv.Config.BookSettingDefault.AutoRotate
"None"
Default
"Left"
Auto left rotate
"Right"
Auto right rotate
"ForcedLeft"
Forced left rotate
"ForcedRight"
Forced right rotate
Automatic rotation
nv.Config.BookSettingDefault.BaseScaledoubleBase scale
nv.Config.BookSettingDefault.BookReadOrder
"RightToLeft"
Right to left
"LeftToRight"
Left to right
Page read order
nv.Config.BookSettingDefault.IsRecursiveFolderboolLoad subfolders

Since it searches everything under the folder to be opened, the load may be high depending on the location where it is opened.

nv.Config.BookSettingDefault.IsSupportedDividePageboolDivide wide page
nv.Config.BookSettingDefault.IsSupportedSingleFirstPageboolShow first page alone
nv.Config.BookSettingDefault.IsSupportedSingleLastPageboolShow last page alone
nv.Config.BookSettingDefault.IsSupportedWidePageboolConsider landscape pages as two pages
nv.Config.BookSettingDefault.PageMode
"SinglePage"
One page
"WidePage"
Two pages
Page Size Mode
nv.Config.BookSettingDefault.SortMode
"FileName"
Name↑
"FileNameDescending"
Name↓
"TimeStamp"
Date↑
"TimeStampDescending"
Date↓
"Size"
Size↑
"SizeDescending"
Size↓
"Entry"
Entry↑
"EntryDescending"
Entry↓
"Random"
Shuffle
Page sort mode
nv.Config.BookSettingPolicy.AutoRotate
"Default"
Default
"Continue"
Continue
"RestoreOrDefault"
Restore, else default
"RestoreOrContinue"
Restore, else continue
Automatic rotation
nv.Config.BookSettingPolicy.BaseScale
"Default"
Default
"Continue"
Continue
"RestoreOrDefault"
Restore, else default
"RestoreOrContinue"
Restore, else continue
Base scale
nv.Config.BookSettingPolicy.BookReadOrder
"Default"
Default
"Continue"
Continue
"RestoreOrDefault"
Restore, else default
"RestoreOrContinue"
Restore, else continue
Setting policy of "Page read order" when opening a book
nv.Config.BookSettingPolicy.IsRecursiveFolder
"Default"
Default
"Continue"
Continue
"RestoreOrDefault"
Restore, else default
"RestoreOrContinue"
Restore, else continue
Setting policy of "Load subfolders" when opening a book
nv.Config.BookSettingPolicy.IsSupportedDividePage
"Default"
Default
"Continue"
Continue
"RestoreOrDefault"
Restore, else default
"RestoreOrContinue"
Restore, else continue
Setting policy of "Divide wide page" when opening a book
nv.Config.BookSettingPolicy.IsSupportedSingleFirstPage
"Default"
Default
"Continue"
Continue
"RestoreOrDefault"
Restore, else default
"RestoreOrContinue"
Restore, else continue
Setting policy of "Show first page alone" when opening a book
nv.Config.BookSettingPolicy.IsSupportedSingleLastPage
"Default"
Default
"Continue"
Continue
"RestoreOrDefault"
Restore, else default
"RestoreOrContinue"
Restore, else continue
Setting policy of "Show last page alone" when opening a book
nv.Config.BookSettingPolicy.IsSupportedWidePage
"Default"
Default
"Continue"
Continue
"RestoreOrDefault"
Restore, else default
"RestoreOrContinue"
Restore, else continue
Setting policy of "Consider landscape pages as two pages" when opening a book
nv.Config.BookSettingPolicy.Page
"Default"
Default
"RestoreOrDefault"
Restore, else default
"RestoreOrDefaultReset"
Restore, else default, clear last page
Setting policy of "Page position" when opening a book
nv.Config.BookSettingPolicy.PageMode
"Default"
Default
"Continue"
Continue
"RestoreOrDefault"
Restore, else default
"RestoreOrContinue"
Restore, else continue
Setting policy of "Page Size Mode" when opening a book
nv.Config.BookSettingPolicy.SortMode
"Default"
Default
"Continue"
Continue
"RestoreOrDefault"
Restore, else default
"RestoreOrContinue"
Restore, else continue
Setting policy of "Page sort mode" when opening a book
nv.Config.Bookshelf.DefaultFolderOrder
"FileName"
Name↑
"FileNameDescending"
Name↓
"Path"
Path↑
"PathDescending"
Path↓
"FileType"
Type↑
"FileTypeDescending"
Type↓
"TimeStamp"
Date↑
"TimeStampDescending"
Date↓
"Size"
Size↑
"SizeDescending"
Size↓
"EntryTime"
Entry↑
"EntryTimeDescending"
Entry↓
"Random"
Shuffle
Bookshelf: Standard default order
nv.Config.Bookshelf.ExcludePatternstringBookshelf: Filename pattern to exclude from display

It is specified with .NET regular expression. Capital letters and lower case letters are not distinguished.

nv.Config.Bookshelf.FolderTreeLayout
"Top"
Place to the top
"Left"
Place to the left
Bookshelf: Folder tree layout
nv.Config.Bookshelf.HomestringBookshelf: Home location
nv.Config.Bookshelf.IsCloseBookWhenMoveboolBookshelf: Close the book when changing the location
nv.Config.Bookshelf.IsCruiseboolBookshelf: Enable Folder Cruise

Move the folder including the parent and child of the folder. It does not apply when the bookshelf is a search result.

nv.Config.Bookshelf.IsFolderTreeVisibleboolBookshelf: Display folder tree
nv.Config.Bookshelf.IsInsertItemboolBookshelf: Insert additional file at sort position

The bookshelf reflects information in real time. If this setting is on, inserts the added file in the current sort order position. When turned off, it is added to the end of the list.

nv.Config.Bookshelf.IsMultipleRarFilterEnabledboolBookshelf: Filter RAR split files from display

For an RAR split file called ".part[number].rar", only the file with the smallest number is displayed in the list.

nv.Config.Bookshelf.IsOpenNextBookWhenRemoveboolBookshelf: After deleting the viewing book, open the next book
nv.Config.Bookshelf.IsOrderWithoutFileTypeboolBookshelf: Sort without file type
nv.Config.Bookshelf.IsSearchIncludeSubdirectoriesboolBookshelf: Perform a search including subfolders
nv.Config.Bookshelf.IsSyncFolderTreeboolBookshelf: Synchronize Folders tree with sync button
nv.Config.Bookshelf.IsVisibleBookmarkMarkboolBookshelf: Display bookmark symbols

★ mark is displayed in the bookmarked book.

nv.Config.Bookshelf.IsVisibleHistoryMarkboolBookshelf: Display history symbol

A check mark is displayed in the book remaining in the history.

nv.Config.Bookshelf.PanelListItemStyle
"Normal"
Text
"Content"
Content
"Banner"
Banner
"Thumbnail"
Thumbnail
Bookshelf: List item style
nv.Config.Bookshelf.PlaylistFolderOrder
"FileName"
Name↑
"FileNameDescending"
Name↓
"Path"
Path↑
"PathDescending"
Path↓
"FileType"
Type↑
"FileTypeDescending"
Type↓
"TimeStamp"
Date↑
"TimeStampDescending"
Date↓
"Size"
Size↑
"SizeDescending"
Size↓
"EntryTime"
Entry↑
"EntryTimeDescending"
Entry↓
"Random"
Shuffle
Bookshelf: Default order of playlists
nv.Config.Command.IsAccessKeyEnabledboolAllow access key

When turned off, system operation with the Alt key is disabled, eliminating malfunctions with command shortcuts. However Alt+F4 is always active.

nv.Config.Command.IsHorizontalWheelLimitedOnceboolLimit tilt wheel operation to one time

Tilt wheel Executes one command with one operation. If you are using a stepless mouse, turn it off.

nv.Config.Command.IsReversePageMoveboolSwap movement direction of page movement command according to slider direction

When the slider is from left to right, reverse the page moving direction. The setting of the command to work is set by "Enable operation swap by slider direction" of the command parameter.

nv.Config.Command.IsReversePageMoveHorizontalWheelboolReplace when operating tilt wheel

You can select correspondence only for tilt wheel operation.

nv.Config.Command.IsReversePageMoveWheelboolReplace when operating wheel

You can select correspondence only for wheel operation.

nv.Config.Control.IsSelectedboolPanel selected
nv.Config.Control.IsVisibleboolPanel visibility (Read only)
nv.Config.FilmStrip.ImageWidthdoublePage thumbnail size
nv.Config.FilmStrip.IsEnabledboolShow filmstrip
nv.Config.FilmStrip.IsHideFilmStripboolAutomatically hide filmstrip
nv.Config.FilmStrip.IsManipulationBoundaryFeedbackEnabledboolTouch scroll termination bound on filmstrip
nv.Config.FilmStrip.IsSelectedCenterboolScroll so that the selected item appears in the center
nv.Config.FilmStrip.IsVisibleNumberboolDisplay page number
nv.Config.FilmStrip.IsVisiblePlaylistMarkboolDisplay playlisted mark
nv.Config.FilmStrip.IsWheelMovePageboolMove pages by wheel operation
nv.Config.Fonts.FolderTreeFontScaledoubleFolder tree font scale
nv.Config.Fonts.FontNamestringFont
nv.Config.Fonts.FontScaledoubleFont scale
nv.Config.Fonts.IsClearTypeEnabledboolEnable ClearType
nv.Config.Fonts.MenuFontScaledoubleMenu font scale
nv.Config.Fonts.PanelFontScaledoubleList item font scale
nv.Config.History.HistoryEntryPageCountintNumber of page operations to start history registration

The history is recorded when the page is moved more than the set number of times or the last page is displayed.

nv.Config.History.HistoryFilePathstringHistory file location
nv.Config.History.IsAutoCleanupEnabledboolAutomatically delete invalid history at startup
nv.Config.History.IsCurrentFolderboolCurrent folder only

Shows the history of only the folders of the currently open book.

nv.Config.History.IsForceUpdateHistoryboolEven if you open a book from history, it updates the last browsing date
nv.Config.History.IsInnerArchiveHistoryEnabledboolSave recursive compressed file in history
nv.Config.History.IsKeepFolderStatusboolSave folder state
nv.Config.History.IsKeepSearchHistoryboolSave search history
nv.Config.History.IsSaveHistoryboolSave history file
nv.Config.History.IsUncHistoryEnabledboolSave UNC path in history

Save the path on the network like "\\computer\~" in the history.

nv.Config.History.LimitSizeintSize limit
nv.Config.History.LimitSpanSystem.TimeSpanRetention period
nv.Config.History.PanelListItemStyle
"Normal"
Text
"Content"
Content
"Banner"
Banner
"Thumbnail"
Thumbnail
History item style
nv.Config.Image.IsMediaRepeatboolVideo page repeat
nv.Config.Image.Standard.IsAllFileSupportedboolA file whose extension is unknown is regarded as an image file

This function works when "File type to be used as page" is "All files".

nv.Config.Image.Standard.IsAnimatedGifEnabledboolPlay animated GIF

Perform animated GIF playback. Memory consumption problems may occur with long GIFs.

nv.Config.Image.Standard.IsAnimatedPngEnabledboolPlay animated PNG

Perform animated PNG playback. Memory consumption problems may occur with long PNGs.

nv.Config.Image.Standard.IsAspectRatioEnabledboolApply image resolution information

Display according to the dpi and aspect ratio set in the image file.

nv.Config.Image.Standard.SupportFileTypes".ex1;.ex2;.ex3"Image file extensions
nv.Config.Image.Standard.UseWicInformationboolUse WIC information

Obtains the image file extension from WIC. If off, only the default extension is available.

nv.Config.Image.Svg.IsEnabledboolEnable SVG file

Open an SVG file as a page.

nv.Config.Image.Svg.SupportFileTypes".ex1;.ex2;.ex3"SVG file extensions
nv.Config.ImageCustomSize.ApplicabilityRatedoubleCustom Size: Applicability rate
nv.Config.ImageCustomSize.AspectRatio
"None"
Free
"Origin"
Keep the original aspect ratio
"Ratio_1_1"
1:1
"Ratio_2_3"
2:3
"Ratio_4_3"
4:3
"Ratio_8_9"
8:9
"Ratio_16_9"
16:9
"HalfView"
Half view aspect ratio
"View"
View aspect ratio
Custom Size: Aspect ratio
nv.Config.ImageCustomSize.IsAlignLongSideboolCustom Size: Align long side

Swap the vertical and horizontal as needed.

nv.Config.ImageCustomSize.IsEnabledboolCustom Size: Enable custom image size
nv.Config.ImageCustomSize.Size"width,height"Custom Size: Custom image size
nv.Config.ImageDotKeep.IsEnabledboolKeep dot
nv.Config.ImageDotKeep.ThresholddoubleScale threshold for "Keep dot"

It will be applied when it becomes larger than the set magnification.

nv.Config.ImageEffect.BloomEffect.BaseIntensitydoubleBloom: Base intensity
nv.Config.ImageEffect.BloomEffect.BaseSaturationdoubleBloom: Base saturation
nv.Config.ImageEffect.BloomEffect.BloomIntensitydoubleBloom: Bloom intensity
nv.Config.ImageEffect.BloomEffect.BloomSaturationdoubleBloom: Bloom saturation
nv.Config.ImageEffect.BloomEffect.ThresholddoubleBloom: Threshold
nv.Config.ImageEffect.BlurEffect.RadiusdoubleBlur: Radius
nv.Config.ImageEffect.ColorSelectEffect.CurvedoubleColor select: Curve
nv.Config.ImageEffect.ColorSelectEffect.HuedoubleColor select: Hue
nv.Config.ImageEffect.ColorSelectEffect.RangedoubleColor select: Range
nv.Config.ImageEffect.ColorToneEffect.DarkColor"#AARRGGBB"Color tone: Dark color
nv.Config.ImageEffect.ColorToneEffect.DesaturationdoubleColor tone: Desaturation
nv.Config.ImageEffect.ColorToneEffect.LightColor"#AARRGGBB"Color tone: Light color
nv.Config.ImageEffect.ColorToneEffect.ToneAmountdoubleColor tone: Tone amount
nv.Config.ImageEffect.EffectType
"None"
None
"Level"
Level
"Hsv"
HSV
"ColorSelect"
Color select
"Blur"
Blur
"Bloom"
Bloom
"Monochrome"
Monochrome
"ColorTone"
Color tone
"Sharpen"
Sharpen
"Embossed"
Embossed
"Pixelate"
Pixelate
"Magnify"
Magnify
"Ripple"
Ripple
"Swirl"
Swirl
Image effect type
nv.Config.ImageEffect.EmbossedEffect.AmountdoubleEmbossed: Amount
nv.Config.ImageEffect.EmbossedEffect.Color"#AARRGGBB"Embossed: Color
nv.Config.ImageEffect.EmbossedEffect.HeightdoubleEmbossed: Height
nv.Config.ImageEffect.HsvEffect.HuedoubleHSV: Hue
nv.Config.ImageEffect.HsvEffect.SaturationdoubleHSV: Saturation
nv.Config.ImageEffect.HsvEffect.ValuedoubleHSV: Brightness
nv.Config.ImageEffect.IsEnabledboolEnable image effect
nv.Config.ImageEffect.IsHsvModeboolPerform color setting with HSV

Sets color parameters in HSV (Hue, Saturation, Brightness). Turning it off sets the color parameters in RGB.

nv.Config.ImageEffect.LevelEffect.BlackdoubleLevel: Black
nv.Config.ImageEffect.LevelEffect.CenterdoubleLevel: Center
nv.Config.ImageEffect.LevelEffect.MaximumdoubleLevel: Max
nv.Config.ImageEffect.LevelEffect.MinimumdoubleLevel: Min
nv.Config.ImageEffect.LevelEffect.WhitedoubleLevel: White
nv.Config.ImageEffect.MagnifyEffect.AmountdoubleMagnify: Amount
nv.Config.ImageEffect.MagnifyEffect.Center"x,y"Magnify: Center
nv.Config.ImageEffect.MagnifyEffect.InnerRadiusdoubleMagnify: Inner radius
nv.Config.ImageEffect.MagnifyEffect.OuterRadiusdoubleMagnify: Outer radius
nv.Config.ImageEffect.MonochromeEffect.Color"#AARRGGBB"Monochrome: Color
nv.Config.ImageEffect.PixelateEffect.PixelationdoublePixelate: Pixelation
nv.Config.ImageEffect.RippleEffect.Center"x,y"Ripple: Center
nv.Config.ImageEffect.RippleEffect.FrequencydoubleRipple: Frequency
nv.Config.ImageEffect.RippleEffect.MagnitudedoubleRipple: Magnitude
nv.Config.ImageEffect.RippleEffect.PhasedoubleRipple: Phase
nv.Config.ImageEffect.SharpenEffect.AmountdoubleSharpen: Amount
nv.Config.ImageEffect.SharpenEffect.HeightdoubleSharpen: Height
nv.Config.ImageEffect.SwirlEffect.Center"x,y"Swirl: Center
nv.Config.ImageEffect.SwirlEffect.TwistAmountdoubleSwirl: Twist amount
nv.Config.ImageGrid.Color"#AARRGGBB"Grid: Color
nv.Config.ImageGrid.DivXintGrid: Column
nv.Config.ImageGrid.DivYintGrid: Row
nv.Config.ImageGrid.IsEnabledboolGrid: Show grid
nv.Config.ImageGrid.IsSquareboolGrid: Square
nv.Config.ImageGrid.Target
"Image"
Image
"Screen"
Screen
Grid: Target
nv.Config.ImageResizeFilter.IsEnabledboolEnable resize filter
nv.Config.ImageResizeFilter.IsUnsharpMaskEnabledboolEnable unsharp mask when resizing
nv.Config.ImageResizeFilter.ResizeInterpolation
"NearestNeighbor"
NearestNeighbor
"Average"
Average
"Linear"
Linear
"Quadratic"
Quadratic
"Hermite"
Hermite
"Mitchell"
Mitchell
"CatmullRom"
CatmullRom
"Cubic"
Cubic
"CubicSmoother"
CubicSmoother
"Lanczos"
Lanczos
"Spline36"
Spline36
Resize interpolation method
nv.Config.ImageResizeFilter.UnsharpMask.AmountintUnsharp mask: Amount
nv.Config.ImageResizeFilter.UnsharpMask.RadiusdoubleUnsharp mask: Radius
nv.Config.ImageResizeFilter.UnsharpMask.ThresholdintUnsharp mask: Threshold
nv.Config.ImageTrim.BottomdoubleTrim: Bottom
nv.Config.ImageTrim.IsEnabledboolTrim: Enable trim
nv.Config.ImageTrim.LeftdoubleTrim: Left
nv.Config.ImageTrim.RightdoubleTrim: Right
nv.Config.ImageTrim.TopdoubleTrim: Top
nv.Config.Information.DateTimeFormatstringInformation: Date time format

Specifies the .NET custom datetime format string.

nv.Config.Information.IsVisibleAdvancedPhotoboolInformation: View advanced photo section
nv.Config.Information.IsVisibleCameraboolInformation: View camera section
nv.Config.Information.IsVisibleDescriptionboolInformation: View description section
nv.Config.Information.IsVisibleExtrasboolInformation: View extras section
nv.Config.Information.IsVisibleFileboolInformation: View file section
nv.Config.Information.IsVisibleGpsboolInformation: View GPS section
nv.Config.Information.IsVisibleImageboolInformation: View image section
nv.Config.Information.IsVisibleOriginboolInformation: View origin section
nv.Config.Information.MapProgramFormatstringInformation: Map program

$Lat: Latitude, $LatDeg: Latitude(DEG), $Lon: Longitude, $LonDeg: Longitude(DEG)

nv.Config.Loupe.DefaultScaledoubleLoupe standard magnification
nv.Config.Loupe.IsEscapeKeyEnabledboolUse the Esc key to release the loupe
nv.Config.Loupe.IsLoupeCenterboolSet the cursor position at the start of the loupe to the center of the screen
nv.Config.Loupe.IsResetByPageChangedboolRelease the loupe after moving the page
nv.Config.Loupe.IsResetByRestartboolStart loupe at standard magnification

When turned off, it retains the magnification of the last use of the loupe. The standard magnification can be set arbitrarily.

nv.Config.Loupe.IsVisibleLoupeInfoboolDisplay the magnification of loupe

When using the loupe, the magnification is displayed in the upper right.

nv.Config.Loupe.IsWheelScalingEnabledboolChange the loupe magnification by operating the wheel when using the loupe

Commands to which wheel operation is assigned are invalid.

nv.Config.Loupe.MaximumScaledoubleLoupe maximum magnification
nv.Config.Loupe.MinimumScaledoubleLoupe minimum magnification
nv.Config.Loupe.ScaleStepdoubleLoupe magnification change unit
nv.Config.Loupe.SpeeddoubleLoupe Speed
nv.Config.MainView.AlternativeContent
"Blank"
Blank
"PageList"
PageList
Alternative content for main view

Content to display instead when the MainView window is displayed.

nv.Config.MainView.IsAutoHideboolMainView window auto close

Minimizes the MainView window when the book is closed.

nv.Config.MainView.IsAutoShowboolMainView window auto show

When the MainView window is minimized and the view pages are refreshed, the window is automatically restored.

nv.Config.MainView.IsAutoStretchboolMainView window auto stretch

Adjust the window size to the image size.

nv.Config.MainView.IsFloatingboolMainView floating
nv.Config.MainView.IsFloatingEndWhenClosedboolDeactivate the mode when the MainView window is closed
nv.Config.MainView.IsHideTitleBarboolAutomatically hide MainView window title bar
nv.Config.MainView.IsTopmostboolMainView window is topmost
nv.Config.MenuBar.IsAddressBarEnabledboolShow address bar
nv.Config.MenuBar.IsHamburgerMenuboolUse the hamburger menu

Instead of the menu bar, it displays an icon that brings together the menus.

nv.Config.MenuBar.IsHideMenuboolHide menu automatically
nv.Config.MenuBar.IsHideMenuInAutoHideModeboolAutomatically hide the menu when it is auto-hide mode
nv.Config.MenuBar.IsVisibleboolMenu visibility (Read only)
nv.Config.Mouse.CursorHideReleaseDistancedoubleMove distance to redisplay (pixel)
nv.Config.Mouse.CursorHideTimedoubleHide time (sec)
nv.Config.Mouse.GestureMinimumDistancedoubleMouse gesture stroke (pixel)

By moving this distance, it is judged as a gesture stroke.

nv.Config.Mouse.HoverScrollDurationdoubleHover scroll time (sec)

The longer the time, the smoother the scroll.

nv.Config.Mouse.InertiaSensitivitydoubleInertia sensitivity
nv.Config.Mouse.IsCursorHideEnabledboolHide the cursor with no mouse operation

Hide the cursor if the mouse is not operated for the set time.

nv.Config.Mouse.IsCursorHideReleaseActionboolRedisplay with mouse button operation
nv.Config.Mouse.IsDragEnabledboolUse mouse drag
nv.Config.Mouse.IsGestureEnabledboolUse mouse gesture
nv.Config.Mouse.IsHoverScrollboolHover scroll mode
nv.Config.Mouse.LongButtonDownMode
"None"
None
"Loupe"
Loupe
"AutoScroll"
Auto scroll
"Repeat"
Repeat input
Long press mode
nv.Config.Mouse.LongButtonDownTimedoubleLong press decision time (sec)

It is time to be judged to be long pressed.

nv.Config.Mouse.LongButtonMask
"Left"
Left button
"Right"
Right button
"All"
All buttons
Long press button
nv.Config.Mouse.LongButtonRepeatTimedoubleRepeat interval (sec)

Repeat time with repeat input.

nv.Config.Mouse.MinimumDragDistancedoubleDrag starting distance (pixel)

First moving distance to become a drag or gesture

nv.Config.Navigator.IsVisibleControlBarboolControl bar in the navigator panel
nv.Config.Navigator.IsVisibleThumbnailboolShow thumbnail
nv.Config.Navigator.ThumbnailHeightdoubleThumbnail area height
nv.Config.Notice.BookNameShowMessageStyle
"None"
None
"Normal"
Visible
"Tiny"
Tiny
Show open book name
nv.Config.Notice.CommandShowMessageStyle
"None"
None
"Normal"
Visible
"Tiny"
Tiny
Show command execution message
nv.Config.Notice.GestureShowMessageStyle
"None"
None
"Normal"
Visible
"Tiny"
Tiny
Show gesture status
nv.Config.Notice.IsBusyMarkEnabledboolThe image reading processing in progress mark is displayed on the upper left of the screen
nv.Config.Notice.IsEmptyMessageEnabledboolShow message when there are no pages in the book
nv.Config.Notice.IsOriginalScaleShowMessageboolMake the scale display of the view operation the original image size standard

In case of 2 page display, we refer to the page with the smaller number.

nv.Config.Notice.NoticeShowMessageStyle
"None"
None
"Normal"
Visible
"Tiny"
Tiny
General information
nv.Config.Notice.NowLoadingShowMessageStyle
"None"
None
"Normal"
Visible
"Tiny"
Tiny
Show Now Loading
nv.Config.Notice.ViewTransformShowMessageStyle
"None"
None
"Normal"
Visible
"Tiny"
Tiny
Show status change by drag operation
nv.Config.PageList.FocusMainViewboolFocus to main view

After selecting a page, move the focus to the main view.

nv.Config.PageList.Format
"Smart"
Smart
"NameOnly"
Name
"Raw"
Raw
Page name display format of PageList
nv.Config.PageList.PanelListItemStyle
"Normal"
Text
"Content"
Content
"Banner"
Banner
"Thumbnail"
Thumbnail
PageList item style
nv.Config.PageList.ShowBookTitleboolShow book title
nv.Config.PageTitle.IsEnabledboolPage title: Show page title

Appears when the cursor is over a slider or filmstrip.

nv.Config.PageTitle.PageTitleFormat1stringPage title: For 1 page
nv.Config.PageTitle.PageTitleFormat2stringPage title: For 2 page
nv.Config.PageTitle.PageTitleFormatMediastringPage title: For video
nv.Config.PageViewRecorder.IsSavePageViewRecordboolSave page view records
nv.Config.PageViewRecorder.PageViewRecordFilePathstringPage view recording path
nv.Config.Panels.BannerItemProfile.ImageShape
"Original"
Original
"Square"
Square
"BookShape"
Book shape
"Banner"
Banner
Banner style: Shape of Icon
nv.Config.Panels.BannerItemProfile.ImageWidthintBanner style: Icon size

The width of the icon image. The aspect ratio depends on the shape of the icon. If the thumbnail image resolution is exceeded, the image will be grainy.

nv.Config.Panels.BannerItemProfile.IsImagePopupEnabledboolBanner style: Icon popup

When placing the cursor on the icon, a large image will be displayed in the popup.

nv.Config.Panels.BannerItemProfile.IsTextVisibleboolBanner style: Display the name
nv.Config.Panels.BannerItemProfile.IsTextWrappedboolBanner style: Wrap name
nv.Config.Panels.ContentItemProfile.ImageShape
"Original"
Original
"Square"
Square
"BookShape"
Book shape
"Banner"
Banner
Content style: Shape of Icon
nv.Config.Panels.ContentItemProfile.ImageWidthintContent style: Icon size

The width of the icon image. The aspect ratio depends on the shape of the icon. If the thumbnail image resolution is exceeded, the image will be grainy.

nv.Config.Panels.ContentItemProfile.IsImagePopupEnabledboolContent style: Icon popup

When placing the cursor on the icon, a large image will be displayed in the popup.

nv.Config.Panels.ContentItemProfile.IsTextVisibleboolContent style: Display the name
nv.Config.Panels.ContentItemProfile.IsTextWrappedboolContent style: Wrap name
nv.Config.Panels.IsDecoratePlaceboolFormat path display of supplemental text

Format as "AAA (C:\BBB\CCC)".

nv.Config.Panels.IsHidePanelboolHide side panels automatically
nv.Config.Panels.IsHidePanelInAutoHideModeboolAutomatically hide the side panel when it is auto-hide mode
nv.Config.Panels.IsLeftRightKeyEnabledboolThe left and right key input of the side panel is valid

Activate left / right key operation on the side panel. In the bookshelf, move the folder hierarchically.

nv.Config.Panels.IsLimitPanelWidthboolLimit panel width

Limit the width of the panel to fit in the window

nv.Config.Panels.IsManipulationBoundaryFeedbackEnabledboolTouch scroll termination bound on side panel
nv.Config.Panels.IsSideBarEnabledboolShow side bars
nv.Config.Panels.IsVisibleItemsCountboolShow number of items
nv.Config.Panels.MouseWheelSpeedRatedoubleMouse wheel scroll speed rate in thumbnail view
nv.Config.Panels.OpacitydoublePanel opacity

It is effective in auto-hide mode.

nv.Config.Panels.OpenWithDoubleClickboolDouble click to open book

Effective on bookshelf, bookmark panel, and history panel.

nv.Config.Panels.ThumbnailItemProfile.ImageShape
"Original"
Original
"Square"
Square
"BookShape"
Book shape
"Banner"
Banner
Thumbnail style: Shape of Icon
nv.Config.Panels.ThumbnailItemProfile.ImageWidthintThumbnail style: Icon size

The width of the icon image. The aspect ratio depends on the shape of the icon. If the thumbnail image resolution is exceeded, the image will be grainy.

nv.Config.Panels.ThumbnailItemProfile.IsImagePopupEnabledboolThumbnail style: Icon popup

When placing the cursor on the icon, a large image will be displayed in the popup.

nv.Config.Panels.ThumbnailItemProfile.IsTextVisibleboolThumbnail style: Display the name
nv.Config.Panels.ThumbnailItemProfile.IsTextWrappedboolThumbnail style: Wrap name
nv.Config.Performance.CacheMemorySizeintBook cache memory size (MB)

Once the page has been read, it is stored in memory to speed up redisplay. This value is a guideline, and memory may be used beyond this value. Note that too large a value can make the system unstable.

nv.Config.Performance.IsLimitSourceSizeboolLoad image size limit

Reduce the imported image with "Maximum image size" as the upper limit. It is setting for speed and memory saving. When this restriction is applied, "*" will be displayed in the size field of the information if it is the loaded image.

nv.Config.Performance.IsLoadingPageVisibleboolDisplay the current page until the next page loads

You can save memory by turning it off.

nv.Config.Performance.JobWorkerSizeintNumber of threads used for image loading

The recommended value is 2 to 4

nv.Config.Performance.MaximumSize"width,height"Maximum image size

This is the maximum image size enlarged by the resize filter.

nv.Config.Performance.PreExtractSolidSizeintMemory size used to pre-decompress solid compressed files (MB)

If not enough, extract to a temporary file.

nv.Config.Performance.PreLoadSizeintRead ahead page size

Read ahead within the cache memory size.

nv.Config.Playlist.CurrentPlayliststringCurrent playlist
nv.Config.Playlist.IsCurrentBookFilterEnabledboolShow only open book pages
nv.Config.Playlist.IsFirstInboolAdd to the top of the list

This is the insertion position for additional commands. If it is turned off, it will be added at the end.

nv.Config.Playlist.IsGroupByboolGroup and display by folder
nv.Config.Playlist.PanelListItemStyle
"Normal"
Text
"Content"
Content
"Banner"
Banner
"Thumbnail"
Thumbnail
List item style
nv.Config.Playlist.PlaylistFolderstringPlaylist file storage location

Playlist files in this folder are managed.

nv.Config.Script.ErrorLevel
"Info"
Lv1: Info
"Warning"
Lv2: Warning
"Error"
Lv3: Error
Obsolete member access error level

This is a debug setting. Select the error handling of member access that can no longer be used due to version upgrade.

nv.Config.Script.IsScriptFolderEnabledboolUse scripts
nv.Config.Script.IsSQLiteEnabledboolEnable SQLite API

Enables access to the System.Data.SQLite namespace in .NET

nv.Config.Script.OnBookLoadedWhenRenamedboolOnBookLoaded.nvjs is also called when a book is renamed
nv.Config.Script.ScriptFolderstringScripts folder

Use the scripts in this folder.

nv.Config.Slider.IsEnabledboolSlider: Show slider
nv.Config.Slider.IsHidePageSliderboolSlider: Hide slider automatically
nv.Config.Slider.IsHidePageSliderInAutoHideModeboolSlider: Automatically hide the slider when it is auto-hide mode
nv.Config.Slider.IsSliderLinkedFilmStripboolSlider: Real time change with slider applies only to film strip

Switch pages when decided.

nv.Config.Slider.IsSyncPageModeboolSlider: Synchronize the amount of change to the number of displayed pages
nv.Config.Slider.IsVisibleboolSlider: Slider visibility (Read only)
nv.Config.Slider.IsVisiblePlaylistMarkboolSlider: Display playlisted mark
nv.Config.Slider.OpacitydoubleSlider: Slider opacity

It is applied when "Hide slider automatically" is enabled.

nv.Config.Slider.SliderDirection
"LeftToRight"
Left to right
"RightToLeft"
Right to left
"SyncBookReadDirection"
Depends on the book orientation
Slider: Slider Direction
nv.Config.Slider.SliderIndexLayout
"None"
None
"Left"
Left
"Right"
Right
Slider: Page number display position
nv.Config.Slider.ThicknessdoubleSlider: Slider thickness (pixel)
nv.Config.SlideShow.IsCancelSlideByMouseMoveboolSlideshow: Reset display interval with mouse move

When turned off, it is reset only by an explicit action, such as a click.

nv.Config.SlideShow.IsSlideShowByLoopboolSlideshow: Loop play

After playing to the last page, it will return to the first page.

nv.Config.SlideShow.IsTimerVisibleboolSlideshow: Show timer
nv.Config.SlideShow.SlideShowIntervaldoubleSlideshow: Display interval (sec)
nv.Config.StartUp.IsAutoPlaySlideShowboolStart playing slideshow
nv.Config.StartUp.IsMultiBootEnabledboolAllow multiple activations
nv.Config.StartUp.IsOpenLastBookboolRestore an open book
nv.Config.StartUp.IsOpenLastFolderboolRestore bookshelf location

The location of the bookshelf if you do not open the book at startup.

nv.Config.StartUp.IsRestoreFullScreenboolRestore full screen state
nv.Config.StartUp.IsRestoreSecondWindowPlacementboolRestore the second window coordinates

Restores window coordinates even after duplicate launches. If turned off, the window will be displayed with the initial coordinates.

nv.Config.StartUp.IsRestoreWindowPlacementboolRestore window coordinates
nv.Config.StartUp.IsSplashScreenEnabledboolSplash screen
nv.Config.Susie.IsEnabledboolUse Susie plugins
nv.Config.Susie.IsFirstOrderSusieArchiveboolPrioritize Susie plugin in compressed file expansion
nv.Config.Susie.IsFirstOrderSusieImageboolPrioritize Susie plugin in image display
nv.Config.Susie.SusiePluginPathstringPlugins folder
nv.Config.System.ArchiveCopyPolicy
"None"
Do not execute
"SendArchiveFile"
Compressed file
"SendArchivePath"
Compressed file + filename
"SendExtractFile"
Temporary file
For compressed files
nv.Config.System.ArchiveRecursiveMode
"CurrentDirectory"
Expand for each directory
"IncludeSubDirectories"
Expand by compressed file unit
"IncludeSubArchives"
Expand all
Compressed file handling

Extended range when opening compressed file

nv.Config.System.BookPageCollectMode
"Image"
Image files
"ImageAndBook"
Image files and folders
"All"
All files
File type to be used as page

If you make a folder a page, you can open the folder from that page.

nv.Config.System.DateTimeFormatstringDate time format
nv.Config.System.DownloadPathstringDownload folder

It is a storage place of the image dropped by the browser etc. If not specified, temporary folder is used.

nv.Config.System.FileManagerstringFile Manager

If not set, use Explorer.

nv.Config.System.FileManagerFileArgsstringFile Type Arguments

Arguments for displaying file as selections in the parent folder in File Manager. $File is replaced by the file path.

nv.Config.System.FileManagerFolderArgsstringFolder Type Arguments

Arguments for opening a folder in File Manager. $File is replaced by the file path.

nv.Config.System.IsFileWriteAccessEnabledboolFile management

You will be able to delete and rename files.

nv.Config.System.IsHiddenFileVisibleboolShow hidden files
nv.Config.System.IsIgnoreImageDpiboolDot-by-dot display of image

When displaying at the original size, it matches the pixels of the display independently of the display scale of the display.

nv.Config.System.IsIncrementalSearchEnabledboolIncremental search enabled
nv.Config.System.IsInputMethodEnabledboolEnable IME outside the text box

* It is applied from the next startup. Always valid for text boxes.

nv.Config.System.IsNaturalSortEnabledboolUse natural sort

Makes sorting by name, such as numbers separated by periods, kanji numbers, etc. more natural. When off, same as Explorer.

nv.Config.System.IsNetworkEnabledboolAllow network access

When turned off, the version update confirmation from the "About" dialog is stopped and a confirmation dialog is displayed before connecting to the Internet with a web browser.

nv.Config.System.IsOpenBookAtCurrentPlaceboolMake the start position of the file selection dialog in "Open file" the location of the currently opened book
nv.Config.System.IsRemoveConfirmedboolShow confirmation dialog when deleting files
nv.Config.System.IsRemoveWantNukeWarningboolShow confirmation dialog when deleting files that don't fit in the Recycle Bin
nv.Config.System.IsSettingBackupboolMake a backup of the setting file

Make a backup of the configuration file and load it instead if the normal configuration file can not be read. The file name is "UserSetting.json.bak". The update timing is when you close the options window and when you exit the application.

nv.Config.System.IsSyncUserSettingboolSynchronize settings

When multi-booting, all NeeView settings are updated when closing the options window.

nv.Config.System.LanguagestringLanguage

* It is applied from the next startup.

nv.Config.System.SearchHistorySizeintSearch history size
nv.Config.System.TemporaryDirectorystringTemporary location

It is used for pre-extraction and recursive compression files.

nv.Config.System.TextCopyPolicy
"None"
None
"CopyFilePath"
Temporary file path
"OriginalPath"
Original path
Text copy

If "Original path" is set, the text for temporary files will be the pathname of the original file.

nv.Config.System.TextEditorstringText editor

If not set, use Notepad.

nv.Config.System.WebBrowserstringWeb browser

If not set, use default web browser.

nv.Config.System.IsExplorerContextMenuEnabledboolRegister in the Explorer context menu.

Add "Open in NeeView" to the Explorer context menu. This feature uses the registry.

nv.Config.Theme.CustomThemeFolderstringCustom theme folder
nv.Config.Theme.ThemeTypestringTheme type
nv.Config.Thumbnail.CacheLimitSpanSystem.TimeSpanThumbnail cache retention period
nv.Config.Thumbnail.Format
"Jpeg"
JPEG
"Png"
PNG
Thumbnail image format

PNG is high quality, but the data size is larger than JPEG.

nv.Config.Thumbnail.ImageWidthintThumbnail image resolution

The higher the value, the higher the resolution but the larger the data size.

nv.Config.Thumbnail.IsCacheEnabledboolUse thumbnail cache

Cache the book thumbnail.

nv.Config.Thumbnail.QualityintThumbnail quality

Quality when the thumbnail image format is JPEG.

nv.Config.Thumbnail.ThumbnailBookCapacityintBook Thumbnail Capacity

The number of book thumbnails held in memory.

nv.Config.Thumbnail.ThumbnailCacheFilePathstringThumbnail cache file location
nv.Config.Thumbnail.ThumbnailPageCapacityintPage Thumbnail Capacity

The number of page thumbnails held in memory. When the book is closed everything is destroyed.

nv.Config.Touch.DragAction
"None"
None
"Drag"
Touch view operation
"MouseDrag"
Mouse drag operation
"Gesture"
Gesture
"Loupe"
Loupe
Single touch drag operation
nv.Config.Touch.GestureMinimumDistancedoubleMinimum movement distance for touch drag judgment (pixel)

Dragging is judged to start for the first time by moving this distance.

nv.Config.Touch.HoldAction
"None"
None
"Drag"
Touch view operation
"MouseDrag"
Mouse drag operation
"Gesture"
Gesture
"Loupe"
Loupe
Long press Touch drag operation
nv.Config.Touch.InertiaSensitivitydoubleInertia sensitivity
nv.Config.Touch.IsAngleEnabledboolEnable rotation operation with multi-touch
nv.Config.Touch.IsEnabledboolUse the touch function

When turned off, it is recognized as a standard mouse operation.

nv.Config.Touch.IsScaleEnabledboolEnable sizing operation with pinch in and pinch out
nv.Config.Touch.MinimumManipulationDistancedoubleTouch operation pinch minimum change distance (pixel)

This is the minimum operating distance at which rotation and enlargement / reduction by touch operation are effective.

nv.Config.Touch.MinimumManipulationRadiusdoubleTouch operation pinch minimum determination distance (pixel)

It is the distance between the minimum of 2 touches judged as rotation by touch operation, enlargement / reduction.

nv.Config.View.AllowFileContentAutoRotatebool
nv.Config.View.AllowStretchScaleDownboolAllow scale down on stretch
nv.Config.View.AllowStretchScaleUpboolAllow scale up on stretch
nv.Config.View.AngleFrequencydoubleRotating Snap
nv.Config.View.FlipCenter
"View"
View center
"Target"
Image center
"Cursor"
Cursor position
Center of flip
nv.Config.View.IsBaseScaleEnabledboolEnable base scale

Enable base scale.

nv.Config.View.IsKeepAngleboolMaintain the angle even when changing pages

This setting does not work when automatic rotation is enabled.

nv.Config.View.IsKeepAngleBooksboolMaintain the angle even when changing books

Works when "Maintain the angle even when changing pages" is enabled.

nv.Config.View.IsKeepFlipboolMaintain reversal even when changing pages
nv.Config.View.IsKeepFlipBooksboolMaintain scaling even when changing books
nv.Config.View.IsKeepPageTransformboolKeep view transform

Keep page-by-page rotation, scaling, and flip.

nv.Config.View.IsKeepScaleboolMaintain scaling even when changing pages
nv.Config.View.IsKeepScaleBooksboolMaintain reversal even when changing books
nv.Config.View.IsLimitMoveboolLimit movement to within a window
nv.Config.View.IsRotateStretchEnabledboolApply stretch to navigator rotation buttons
nv.Config.View.IsScaleStretchTrackingboolStretch tracking

Adjusts the scale according to the stretch mode when rotating.

nv.Config.View.MainViewMargindoubleMain view margin (pixel)
nv.Config.View.PageMoveDurationdoublePage move time (sec)

Effective when "Panorama" is off.

nv.Config.View.RotateCenter
"View"
View center
"Target"
Image center
"Cursor"
Cursor position
Center of rotation
nv.Config.View.ScaleCenter
"View"
View center
"Target"
Image center
"Cursor"
Cursor position
Center of scaling
nv.Config.View.ScrollDurationdoubleScroll time (sec)
nv.Config.View.StretchMode
"None"
Original size
"Uniform"
Fit to window size
"UniformToFill"
Extend it to fill the window
"UniformToSize"
Fit the area size to the window
"UniformToVertical"
Fit height to window
"UniformToHorizontal"
Fit width to window
Stretch mode
nv.Config.View.ViewHorizontalOrigin
"Center"
Center
"Left"
Left alignment
"Right"
Right alignment
"DirectionDependent"
Direction dependent
"CenterOrLeft"
Center. Left alignment if larger than display area
"CenterOrRight"
Center. Right alignment if larger than display area
"CenterOrDirectionDependent"
Center. Direction dependent if larger than display area
Horizontal alignment at start
nv.Config.View.ViewVerticalOrigin
"Center"
Center
"Top"
Top alignment
"Bottom"
Bottom alignment
"DirectionDependent"
Direction dependent
"CenterOrTop"
Center. Top alignment if larger than display area
"CenterOrBottom"
Center. Bottom alignment if larger than display area
"CenterOrDirectionDependent"
Center. Direction dependent if larger than display area
Vertical alignment at start
nv.Config.Window.IsAutoHideInFullScreenboolApply auto-hide mode in full screen
nv.Config.Window.IsAutoHideInMaximizedboolApply auto-hide mode in maximized window
nv.Config.Window.IsAutoHideInNormalboolApply auto-hide mode in normal window
nv.Config.Window.IsCaptionEmulateInFullScreenboolTitle bar operation at full screen

Accepts double-click and drag operations in the title bar during full screen.

nv.Config.Window.IsRestoreAeroSnapPlacementboolRestore Aero Snap window placement
nv.Config.Window.IsTopmostboolWindow topmost
nv.Config.Window.MouseActivateAndEatboolDisable mouse data when activating window with mouse
nv.Config.Window.State
"None"
None
"Normal"
Normal
"Minimized"
Minimized
"Maximized"
Maximized
"FullScreen"
Full screen
Window state
nv.Config.WindowTitle.WindowTitleFormat1stringWindow title: For 1 page
nv.Config.WindowTitle.WindowTitleFormat2stringWindow title: For 2 page
nv.Config.WindowTitle.WindowTitleFormatMediastringWindow title: For video

Command list

File

Command name Argument Command parameter Summary
LoadAs
path: string
File or folder path
Open file

Select and open the compressed file or image file.

ReLoad Reload

Reload the book

Unload Close

Close the open workbook.

OpenExternalApp
Command: string
Program. If not specified, launch the application associated with the extension.
Parameter: string
Parameters. $File will be replaced with the file path. $Uri is replaced with the URI escaped file path.
WorkingDirectory: string
Working directory.
MultiPagePolicy: enum
"Once": Run only one page / "All": Run all pages / "AllLeftToRight": Run all pages (Left to right)
For 2 pages.
ArchivePolicy: enum
"None": Do not execute / "SendArchiveFile": Compressed file / "SendArchivePath": Compressed file + filename / "SendExtractFile": Temporary file
Compressed file policy.
External app (simple)

Open the displayed image with an external application.

OpenExternalAppAs
MultiPagePolicy: enum
"Once": Run only one page / "All": Run all pages / "AllLeftToRight": Run all pages (Left to right)
For 2 pages.
Index: int
Selected index. Directly executes the selection number.
External app

Select an external application to open the displayed images.

OpenExplorer Open in explorer

Open the file of the page you are viewing in Explorer.

ExportImageAs
ExportFolder: string
Default output folder. Output folder at startup. During startup, it follows the changed storage location.
QualityLevel: int
JPEG quality. It is used only when conversion is required.
Save as

Save the image to a file.

ExportImage
Mode: enum
"Original": Save as original file / "View": Save view
Output image type.
HasBackground: bool
Include background.
IsOriginalSize: bool
Output in original size.
IsDotKeep: bool
Keep dot.
ExportFolder: string
Output folder.
FileNameMode: enum
"Original": Original file name / "BookPageNumber": Book name + page number
Output file name.
FileFormat: enum
"Png": PNG / "Jpeg": JPEG
Output file format. Used when "Output image type" is "Save view".
QualityLevel: int
JPEG quality. It is used only when conversion is required.
IsShowToast: bool
Toast notification.
Save

Save the image to a file. The storage folder is specified by a command parameter.

Print Print

Print the image.

DeleteFile Delete file

Delete the file. Compressed files can not be deleted.

DeleteBook Delete book

Delete the currently viewed folder or compressed file.

CopyFile
MultiPagePolicy: enum
"Once": Run only one page / "All": Run all pages / "AllLeftToRight": Run all pages (Left to right)
For 2 pages.
Copy file

Copy the file to the clipboard.

CopyImage Copy image

Copy the image to the clipboard. For 2 page display, copy only the main page.

Paste Paste

Paste clipboard files and images.

CopyToFolderAs
MultiPagePolicy: enum
"Once": Run only one page / "All": Run all pages / "AllLeftToRight": Run all pages (Left to right)
For 2 pages.
Index: int
Selected index. Directly executes the selection number.
Copy to folder

Select the folder where you want to copy the displayed images.

MoveToFolderAs
MultiPagePolicy: enum
"Once": Run only one page / "All": Run all pages / "AllLeftToRight": Run all pages (Left to right)
For 2 pages.
Index: int
Selected index. Directly executes the selection number.
Move to folder

Select the folder where you want to move the displayed images.

ClearHistory Clear history

Delete all history.

ClearHistoryInPlace Delete history in place

Delete all history in the current location of the bookshelf.

RemoveUnlinkedHistory Delete invalid history items

Delete history items that do not exist.

Stretch

Command name Argument Command parameter Summary
ToggleStretchMode
IsLoop: bool
Loop setting / Loop.
IsEnableNone: bool
Switchable mode / Original size.
IsEnableUniform: bool
Switchable mode / Fit to window size.
IsEnableUniformToFill: bool
Switchable mode / Extend it to fill the window.
IsEnableUniformToSize: bool
Switchable mode / Fit the area size to the window.
IsEnableUniformToVertical: bool
Switchable mode / Fit height to window.
IsEnableUniformToHorizontal: bool
Switchable mode / Fit width to window.
Switch stretch

Switch the stretch in sequence.

ToggleStretchModeReverse

Parameters to share with "ToggleStretchMode"

IsLoop: bool
Loop setting / Loop.
IsEnableNone: bool
Switchable mode / Original size.
IsEnableUniform: bool
Switchable mode / Fit to window size.
IsEnableUniformToFill: bool
Switchable mode / Extend it to fill the window.
IsEnableUniformToSize: bool
Switchable mode / Fit the area size to the window.
IsEnableUniformToVertical: bool
Switchable mode / Fit height to window.
IsEnableUniformToHorizontal: bool
Switchable mode / Fit width to window.
Switch stretch (reverse)

Switch the stretch in sequence. (reverse)

SetStretchModeNone Original size

Display the image as it is.

SetStretchModeUniform
IsToggle: bool
Switching to original size. If the stretch mode is already specified, it will be the original size
Fit to window size

Scales the image to fit the window size.

SetStretchModeUniformToFill

Parameters to share with "SetStretchModeUniform"

IsToggle: bool
Switching to original size. If the stretch mode is already specified, it will be the original size
Extend it to fill the window

Scale up or down to fit the window size either vertically or horizontally. The image will be larger than the window size.

SetStretchModeUniformToSize

Parameters to share with "SetStretchModeUniform"

IsToggle: bool
Switching to original size. If the stretch mode is already specified, it will be the original size
Fit the area size to the window

Scales the image so that it is equal to the area size of ​​the window.

SetStretchModeUniformToVertical

Parameters to share with "SetStretchModeUniform"

IsToggle: bool
Switching to original size. If the stretch mode is already specified, it will be the original size
Fit height to window

Scales to fit the height of the image to the height of the window.

SetStretchModeUniformToHorizontal

Parameters to share with "SetStretchModeUniform"

IsToggle: bool
Switching to original size. If the stretch mode is already specified, it will be the original size
Fit width to window

Scales to fit the width of the image to the width of the window.

ToggleStretchAllowScaleUp
switch: bool
ON / OFF. Toggle if omitted.
Allow stretch scale up

Allow scale up on stretch.

ToggleStretchAllowScaleDown
switch: bool
ON / OFF. Toggle if omitted.
Allow stretch scale down

Allow scale down on stretch.

ToggleCustomSize
switch: bool
ON / OFF. Toggle if omitted.
Toggle custom size

Toggles enabling / disabling of size specification applied to original size.

Effect

Command name Argument Command parameter Summary
ToggleNearestNeighbor
switch: bool
ON / OFF. Toggle if omitted.
Toggle keep dot

Enlarges the image while maintaining the dots. When turned off, the scale conversion process (Fant) is performed.

ToggleBackground Switch background

Switch the background sequentially.

SetBackgroundBlack Black background

Make the background black.

SetBackgroundWhite White background

Make the background white.

SetBackgroundAuto Image colored background

Set the background color from the image. Specifically, the color of the upper left pixel of the image is used.

SetBackgroundCheck White checkered background

Make the background a white checkered pattern.

SetBackgroundCheckDark Black checkered background

Make the background a black checkered pattern.

SetBackgroundCustom Custom Background

Make the background a custom background.

ToggleResizeFilter
switch: bool
ON / OFF. Toggle if omitted.
Toggle resize filter

Toggle resize filter ON / OFF.

ToggleGrid
switch: bool
ON / OFF. Toggle if omitted.
Grid

Toggle visible / hide of grid.

ToggleEffect
switch: bool
ON / OFF. Toggle if omitted.
Toggle effect

Toggle effect ON / OFF.

Window

Command name Argument Command parameter Summary
ToggleTopmost Toggle topmost

Always display the window in front.

ToggleVisibleAddressBar Toggle address bar

Toggle visible / hide of the address bar.

ToggleHideMenu Toggle auto hide menu

Hide the menu. It is displayed by moving the cursor to the upper end of the window.

ToggleVisibleSideBar Toggle side bars

Toggle visible / hide of side bars.

ToggleHidePanel Toggle auto hide panels

Automatically hide the left and right panels. It is displayed by moving the cursor to the left and right edges of the window.

ToggleVisiblePageSlider
switch: bool
ON / OFF. Toggle if omitted.
Toggle slider

Toggle visible / hide of the slider.

ToggleHidePageSlider Toggle auto hide slider

Hide the slider. It is displayed by moving the cursor to the lower end of the window.

ToggleFullScreen Toggle full screen

Switch the full screen state.

SetFullScreen Full screen

Make it full screen.

CancelFullScreen Full screen OFF

Turn off full screen.

ToggleWindowMinimize Minimize window

Minimize the window. If it has already been minimized, restore it to its original size.

ToggleWindowMaximize Maximize window

Maximize the window. If it has already been maximized, restore it to its original size.

ShowHiddenPanels Show panels

The panel which is hidden automatically is displayed once. It will be canceled by some operation.

FocusPrevApp Switch prev NeeView

Switch to previous NeeView window.

FocusNextApp Switch next NeeView

Switch to next NeeView window.

StretchWindow Stretch window

Fit the window to the MainView content size.

Panel

Command name Argument Command parameter Summary
ToggleVisibleBookshelf
switch: bool
ON / OFF. Toggle if omitted.
Toggle bookshelf

Toggle visible / hide of the bookshelf panel.

ToggleVisiblePageList
switch: bool
ON / OFF. Toggle if omitted.
Toggle PageList panel

Toggle visible / hide of the PageList panel.

ToggleVisibleBookmarkList
switch: bool
ON / OFF. Toggle if omitted.
Toggle bookmark panel

Toggle visible / hide of the bookmark panel.

ToggleVisiblePlaylist
switch: bool
ON / OFF. Toggle if omitted.
Toggle playlist panel

Toggle visible / hide of the playlist panel.

ToggleVisibleHistoryList
switch: bool
ON / OFF. Toggle if omitted.
Toggle history panel

Toggle visible / hide of the history panel.

ToggleVisibleFileInfo
switch: bool
ON / OFF. Toggle if omitted.
Toggle information panel

Toggle visible / hide of the information panel.

ToggleVisibleNavigator
switch: bool
ON / OFF. Toggle if omitted.
Toggle navigator

Toggle visible / hide of the navigator panel.

ToggleVisibleEffectInfo
switch: bool
ON / OFF. Toggle if omitted.
Toggle effects panel

Toggle visible / hide of the effects panel.

ToggleVisibleFoldersTree
switch: bool
ON / OFF. Toggle if omitted.
Toggle Folders tree

Toggle visible / hide of the Folders tree. The bookshelf is displayed.

FocusFolderSearchBox Focus on bookshelf search box

Focus on the bookshelf search box. The Bookshelf panel will be in the display state.

FocusBookmarkSearchBox Focus on bookmark search box

Focus on the bookmark search box. The Bookmark panel will be in the display state.

FocusPageListSearchBox Focus on PageList search box

Focus on the PageList search box. The PageList panel will be in the display state.

FocusHistorySearchBox Focus on history search box

Focus on the history search box. The History panel will be in the display state.

FocusBookmarkList Display bookmark list

Display bookmark folder of the bookshelf.

FocusMainView
NeedClosePanels: bool
Close all panels.
Focus on main view

Move focus to the main view.

ToggleMainViewFloating Toggle MainView window

Make the MainView a window.

Filmstrip

Command name Argument Command parameter Summary
ToggleVisibleThumbnailList
switch: bool
ON / OFF. Toggle if omitted.
Toggle filmstrip

Toggle visible / hide of the filmstrip.

ToggleHideThumbnailList
switch: bool
ON / OFF. Toggle if omitted.
Toggle auto hide filmstrip

Display the film strip only when using the slider.

View operation

Command name Argument Command parameter Summary
ToggleSlideShow
switch: bool
ON / OFF. Toggle if omitted.
Toggle slideshow

Toggle play / stop of the slideshow.

ToggleHoverScroll
switch: bool
ON / OFF. Toggle if omitted.
Toggle hover scroll

Scrolls according to the position of the cursor.

ViewScrollNTypeUp
ScrollType: enum
"NType": N-type scroll / "ZType": Z-type scroll / "Diagonal": Diagonal scroll
Scroll type.
Scroll: double
Amount of movement. The ratio to the screen to scroll in one operation.
LineBreakStopTime: double
Line break stop (sec). This is the waiting time to prevent a line break immediately.
PagesAsOne: bool
In panorama mode, all pages are considered as one page.
IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
N-type scroll ↑

If you can scroll vertically and horizontally, scroll to draw N characters.

ViewScrollNTypeDown

Parameters to share with "ViewScrollNTypeUp"

ScrollType: enum
"NType": N-type scroll / "ZType": Z-type scroll / "Diagonal": Diagonal scroll
Scroll type.
Scroll: double
Amount of movement. The ratio to the screen to scroll in one operation.
LineBreakStopTime: double
Line break stop (sec). This is the waiting time to prevent a line break immediately.
PagesAsOne: bool
In panorama mode, all pages are considered as one page.
IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
N-type scroll ↓

If you can scroll vertically and horizontally, scroll to draw N characters.

ViewScrollUp
Scroll: double
Amount of movement. The ratio to the screen to scroll in one operation.
AllowCrossScroll: bool
Allow vertical scroll. If you can not scroll in the axial direction, sucrose in the direction perpendicular to the axis.
Scroll ↑

Roll the image upwards. When it is not possible to scroll vertically, side scrolling will occur.

ViewScrollDown

Parameters to share with "ViewScrollUp"

Scroll: double
Amount of movement. The ratio to the screen to scroll in one operation.
AllowCrossScroll: bool
Allow vertical scroll. If you can not scroll in the axial direction, sucrose in the direction perpendicular to the axis.
Scroll ↓

Roll the image downwards. When it is not possible to scroll vertically, side scrolling will occur.

ViewScrollLeft

Parameters to share with "ViewScrollUp"

Scroll: double
Amount of movement. The ratio to the screen to scroll in one operation.
AllowCrossScroll: bool
Allow vertical scroll. If you can not scroll in the axial direction, sucrose in the direction perpendicular to the axis.
Scroll ←

Roll the image to the left. If horizontal scrolling is not possible, vertical scrolling will occur.

ViewScrollRight

Parameters to share with "ViewScrollUp"

Scroll: double
Amount of movement. The ratio to the screen to scroll in one operation.
AllowCrossScroll: bool
Allow vertical scroll. If you can not scroll in the axial direction, sucrose in the direction perpendicular to the axis.
Scroll →

Roll the image to the right. If horizontal scrolling is not possible, vertical scrolling will occur.

ViewScaleUp
Scale: double
Scale rate. It is the rate of change by one operation.
IsSnapDefaultScale: bool
100% snap. Make sure to zoom in and out by 100%.
Zoom in

Enlarge the image.

ViewScaleDown

Parameters to share with "ViewScaleUp"

Scale: double
Scale rate. It is the rate of change by one operation.
IsSnapDefaultScale: bool
100% snap. Make sure to zoom in and out by 100%.
Zoom out

Reduce the image.

ViewScaleStretch Stretch

Apply stretch to scale.

ViewBaseScaleUp
Scale: double
Scale rate. It is the rate of change by one operation.
IsSnapDefaultScale: bool
100% snap. Make sure to zoom in and out by 100%.
Base scale zoom in

Enlarge the base scale.

ViewBaseScaleDown

Parameters to share with "ViewBaseScaleUp"

Scale: double
Scale rate. It is the rate of change by one operation.
IsSnapDefaultScale: bool
100% snap. Make sure to zoom in and out by 100%.
Base scale zoom out

Reduces the base scale.

ViewRotateLeft
Angle: int
Rotation angle. It is the angle of rotation in one operation. (0-180)
IsStretch: bool
Apply image stretch. Re-apply image stretch after rotation.
Left rotate

Rotate the image to the left.

ViewRotateRight

Parameters to share with "ViewRotateLeft"

Angle: int
Rotation angle. It is the angle of rotation in one operation. (0-180)
IsStretch: bool
Apply image stretch. Re-apply image stretch after rotation.
Right rotate

Rotate the image to the right.

ToggleIsAutoRotateLeft
switch: bool
ON / OFF. Toggle if omitted.
Toggle auto left rotation

When displaying the page, left rotate the portrait image 90 degrees. If the window is portrait, rotate horizontally long image by 90 degrees.

ToggleIsAutoRotateRight
switch: bool
ON / OFF. Toggle if omitted.
Toggle auto right rotation

When displaying the page, right rotate the portrait image 90 degrees. If the window is portrait, rotate horizontally long image by 90 degrees.

ToggleIsAutoRotateForcedLeft
switch: bool
ON / OFF. Toggle if omitted.
Toggle forced left rotation

Rotate 90 degrees to the left regardless of image size.

ToggleIsAutoRotateForcedRight
switch: bool
ON / OFF. Toggle if omitted.
Toggle forced right rotation

Rotate 90 degrees to the right regardless of image size.

ToggleViewFlipHorizontal
switch: bool
ON / OFF. Toggle if omitted.
Flip horizontal

Flip the image left and right.

ViewFlipHorizontalOn Flip horizontal

Flip the image left and right.

ViewFlipHorizontalOff Flip horizontal OFF

Cancel flip.

ToggleViewFlipVertical
switch: bool
ON / OFF. Toggle if omitted.
Flip vertical

Flip the image upside down.

ViewFlipVerticalOn Flip vertical

Turn it upside down.

ViewFlipVerticalOff Flip vertical OFF

Cancel flip.

ViewReset View reset

Reset rotation, scaling, movement, and flip by manipulating the view.

ToggleIsLoupe
switch: bool
ON / OFF. Toggle if omitted.
Toggle loupe

Loupe ON / OFF.

LoupeOn Loupe

Make the loupe mode.

LoupeOff Loupe OFF

Release the loupe mode.

LoupeScaleUp Loupe zoom in

Expands the magnifying power of the loupe. It functions only when using a loupe.

LoupeScaleDown Loupe zoom out

Reduce the loupe magnification. It functions only when using a loupe.

AutoScrollOn Auto scroll

Change to auto scroll mode.

Page move

Command name Argument Command parameter Summary
PrevPage
IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
Prev

Move to the previous page. If it is 2 pages display, it moves by 2 pages.

NextPage

Parameters to share with "PrevPage"

IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
Next

Move to next page direction. If it is 2 page display, it moves by 2 pages.

PrevOnePage
IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
Prev One

Move previous one page only.

NextOnePage

Parameters to share with "PrevOnePage"

IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
Next One

Only one page will move in the next direction.

PrevScrollPage
ScrollType: enum
"NType": N-type scroll / "ZType": Z-type scroll / "Diagonal": Diagonal scroll
Scroll type.
Scroll: double
Amount of movement. The ratio to the screen to scroll in one operation.
EndMargin: double
Scroll end margin. If the scroll distance is less than this, line movement is prioritized.
LineBreakStopTime: double
Line break stop (sec). This is the waiting time to prevent a line break immediately.
LineBreakStopMode: enum
"Line": Line / "Page": Page
Line break stop mode. Line by line or page by page.
PagesAsOne: bool
In panorama mode, all pages are considered as one page.
IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
Scroll + Prev

Scroll the image backward in the page. If it is not possible to scroll, it will move to the previous page. When using a loupe, only move pages.

NextScrollPage

Parameters to share with "PrevScrollPage"

ScrollType: enum
"NType": N-type scroll / "ZType": Z-type scroll / "Diagonal": Diagonal scroll
Scroll type.
Scroll: double
Amount of movement. The ratio to the screen to scroll in one operation.
EndMargin: double
Scroll end margin. If the scroll distance is less than this, line movement is prioritized.
LineBreakStopTime: double
Line break stop (sec). This is the waiting time to prevent a line break immediately.
LineBreakStopMode: enum
"Line": Line / "Page": Page
Line break stop mode. Line by line or page by page.
PagesAsOne: bool
In panorama mode, all pages are considered as one page.
IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
Scroll + Next

Page Scrolls the image in the next direction. If it is not possible to scroll, it will move to the next page. When using a loupe, only move pages.

JumpPage
number: int
Page number
Jump page

Enter the page number and move.

JumpRandomPage Random page

Jump to a random page.

PrevSizePage
Size: int
Number of moved pages.
IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
Prev x pages

Move previous by a set number of pages.

NextSizePage

Parameters to share with "PrevSizePage"

Size: int
Number of moved pages.
IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
Next x pages

Move to the next direction by the set number of pages.

PrevFolderPage
IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
Prev folder

Move to the first page of the previous folder of the book. Valid only in name order.

NextFolderPage

Parameters to share with "PrevFolderPage"

IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
Next folder

Move to the first page of the next folder of the book. Valid only in name order.

FirstPage
IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
First page

Move to the first page.

LastPage

Parameters to share with "FirstPage"

IsReverse: bool
Enable operation swap by slider direction. Allows the operation replacement by changing the slider direction.
Last page

Move to the last page.

PrevHistoryPage Go back view page

Move to previous view page.

NextHistoryPage Go next view page

Move to next view page.

Book move

Command name Argument Command parameter Summary
ToggleBookLock
switch: bool
ON / OFF. Toggle if omitted.
Toggle book lock

Prohibits book switching.

PrevBook Prev Book

Open previous book on the bookshelf.

NextBook Next Book

Open next book on the bookshelf.

RandomBook Random Book

Load the random book on the bookshelf.

PrevHistory Prev History

Open previous book on the history panel.

NextHistory Next History

Open next book on the history panel.

PrevBookHistory Go back

Open previous book in history.

NextBookHistory Go next

Open next book in history.

MoveToParentBook Go to parent

Open the upper hierarchy as a book.

MoveToChildBook Go to child

If possible, open the page as a book.

Video

Command name Argument Command parameter Summary
ToggleMediaPlay Play/Stop

Toggle between playing and stopping the movie.

Book order

Command name Argument Command parameter Summary
ToggleBookOrder Switch book order

Switch the order of books in sequence.

SetBookOrderByFileNameA Book Name Ascending

Set the order of books in ascending order by name.

SetBookOrderByFileNameD Book Name Descending

Set the order of books in descending order by name.

SetBookOrderByPathA Book Path Ascending

Set the order of books in ascending order by full path.

SetBookOrderByPathD Book Path Descending

Set the order of books in descending order by full path.

SetBookOrderByFileTypeA Book FileType Ascending

Set the order of books in ascending order by file type.

SetBookOrderByFileTypeD Book FileType Descending

Set the order of books in descending order by file type.

SetBookOrderByTimeStampA Book Date Ascending

Set the order of books in ascending order by date.

SetBookOrderByTimeStampD Book Date Descending

Set the order of books in descending order by date.

SetBookOrderByEntryTimeA Book EntryTime Ascending

Set the order of books in ascending order by entry time.

SetBookOrderByEntryTimeD Book EntryTime Descending

Set the order of books in descending order by entry time.

SetBookOrderBySizeA Book Size Ascending

Set the order of books in ascending order by size.

SetBookOrderBySizeD Book Size Descending

Set the order of books in descending order by size.

SetBookOrderByRandom Book Shuffle

Set the order of books randomly.

Page setting

Command name Argument Command parameter Summary
TogglePageMode
IsLoop: bool
Loop.
Toggle page mode

Toggle page mode in sequance

TogglePageModeReverse

Parameters to share with "TogglePageMode"

IsLoop: bool
Loop.
Toggle page mode (reverse)

Toggle page mode in sequence (reverse)

SetPageModeOne One page

Make it 1 page display.

SetPageModeTwo Two pages

It makes 2 page display.

ToggleIsPanorama Panorama

Displays consecutive pages.

TogglePageOrientation Toggle pages orientation

Switch between horizontal and vertical orientation.

SetPageOrientationHorizontal Horizontal page layout

Align pages horizontally

SetPageOrientationVertical Vertical page layout

Align pages vertically

ToggleBookReadOrder Book orientation

Toggle right and left open.

SetBookReadOrderRight Right to left

Right forward from right to left. Previous page is on the right when 2 pages are displayed.

SetBookReadOrderLeft Left to right

Left forward from left to right. Previous page is on the left when 2 pages are displayed.

ToggleIsSupportedDividePage
switch: bool
ON / OFF. Toggle if omitted.
Divide wide page

When one page is displayed, divide the landscape page into pages.

ToggleIsSupportedWidePage
switch: bool
ON / OFF. Toggle if omitted.
Consider landscape pages as two pages

When two pages are displayed, the horizontally long image is regarded as two pages and is displayed independently.

ToggleIsSupportedSingleFirstPage
switch: bool
ON / OFF. Toggle if omitted.
Show first page alone

Even on 2 page display, the first page is displayed as 1 page.

ToggleIsSupportedSingleLastPage
switch: bool
ON / OFF. Toggle if omitted.
Show last page alone

Even on 2 page display, the last page is displayed on 1 page.

ToggleIsRecursiveFolder
switch: bool
ON / OFF. Toggle if omitted.
Load subfolders

When loading images from folders, subfolders or compressed files are also loaded at the same time.

SetDefaultPageSetting Reset page setting

Restore the default page setting.

Page order

Command name Argument Command parameter Summary
ToggleSortMode Switch pages order

Switch the order of the pages in sequence.

SetSortModeFileName Name Ascending

Sort the order of the pages in ascending order by filename.

SetSortModeFileNameDescending Name Descending

Sort the order of the pages in descending order by file name.

SetSortModeTimeStamp Date Ascending

Sort the order of pages by file date ascending order.

SetSortModeTimeStampDescending Date Descending

Sort the order of pages by file date descending order.

SetSortModeSize Size Ascending

Set the order of pages in ascending order by file size.

SetSortModeSizeDescending Size Descending

Set the order of pages in descending order by file size.

SetSortModeEntry Entry Ascending

Set the order of pages in ascending order by entry.

SetSortModeEntryDescending Entry Descending

Set the order of pages in descending order by entry.

SetSortModeRandom Shuffle

Shuffle the order of pages.

Bookmark

Command name Argument Command parameter Summary
ToggleBookmark
switch: bool
ON / OFF. Toggle if omitted.
Toggle bookmark

Toggle bookmark for currently open book.

Playlist

Command name Argument Command parameter Summary
TogglePlaylistItem
switch: bool
ON / OFF. Toggle if omitted.
Toggle playlist item

Add or delete the current page to the playlist.

PrevPlaylistItem Prev playlist item

Go to the previous page mark.

NextPlaylistItem Next playlist item

Go to the next page mark.

PrevPlaylistItemInBook
IsLoop: bool
Loop.
IsIncludeTerminal: bool
Include the first and last pages.
Prev playlist item in book

Move to the previous page mark in the current book.

NextPlaylistItemInBook

Parameters to share with "PrevPlaylistItemInBook"

IsLoop: bool
Loop.
IsIncludeTerminal: bool
Include the first and last pages.
Next playlist item in book

Move to the next page mark in the current book.

Script

Command name Argument Command parameter Summary
CancelScript Cancel script

Stops a running script that has a "sleep" instruction.

Other

Command name Argument Command parameter Summary
OpenOptionsWindow Open settings window

Open the settings window.

OpenSettingFilesFolder Open setting folder

Open the folder where the configuration file setting file is saved.

OpenScriptsFolder Open scripts folder

Open the scripts folder with Explorer.

OpenVersionWindow Display version information

Display version information.

CloseApplication Quit application

Quit this application.

TogglePermitFile
switch: bool
ON / OFF. Toggle if omitted.
Toggle file management

Toggle enable / disable of file management command.

HelpCommandList Command help

Displays help of all commands in the browser.

HelpScript Script Help

Displays the script manual in the browser.

HelpMainMenu Main menu help

Display the main menu help on the browser.

HelpSearchOption Search options help

Display the search options help on the browser.

OpenContextMenu Open context menu

Open the context menu.

ExportBackup
FileName: string
Backup file path.
Export settings

Create backups of settings, history, bookmarks. The thumbnail cache is not backed up.

ImportBackup
FileName: string
Backup file path.
UserSetting: enum
"Undefined": Undefined / "Skip": Skip / "Import": Import
Settings.
History: enum
"Undefined": Undefined / "Skip": Skip / "Import": Import
History.
Bookmark: enum
"Undefined": Undefined / "Skip": Skip / "Import": Import
Bookmark.
Playlists: enum
"Undefined": Undefined / "Skip": Skip / "Import": Import
Playlist.
Themes: enum
"Undefined": Undefined / "Skip": Skip / "Import": Import
Custom themes.
Scripts: enum
"Undefined": Undefined / "Skip": Skip / "Import": Import
Scripts.
Import settings

Select the restored item from the backup file and restore it. If all parameters are defined, the dialog will not be displayed.

ReloadSetting Reload settings

Reload the settings.

SaveSetting Save settings

Performs saving the current settings.

TouchEmulate Touch emulate

Execute the touch command at the cursor position.

OpenConsole Open script console

Open the script console.

Breaking changes by version

Severity

ErrorThis change is fatal and causes errors.
WarningThis effect is disabled and does not work.
InfoCompatible and works the same. Spelling errors corrected, etc.

Version 42.0

Severity Name Category Alternative
Error HistoryItemAccessor.LastAccessTime Changed Type changed from string to Date.
Error PageAccessor.LastWriteTime Changed Type changed from string to Date.
Error PageAccessor.Path Changed The path is now the path of the page entity. In the case of a shortcut file, it is the path to its entity. See RawPath for paths in previous versions.
Error ViewPageAccessor.LastWriteTime Changed Type changed from string to Date.
Error ViewPageAccessor.Path Changed The path is now the path of the page entity. In the case of a shortcut file, it is the path to its entity. See RawPath for paths in previous versions.
Warning nv.Command.CopyFile.Parameter.ArchivePolicy Obsolete nv.Config.System.ArchiveCopyPolicy
Warning nv.Command.CopyFile.Parameter.TextCopyPolicy Obsolete nv.Config.System.TextCopyPolicy
Warning nv.Config.View.ViewOrigin Obsolete nv.Config.View.ViewHorizontalOrigin, ViewVerticalOrigin
Info nv.Config.Window.IsAutoHidInMaximized Obsolete nv.Config.Window.IsAutoHideInMaximized

Version 41.0

Severity Name Category Alternative
Warning nv.Config.Performance.IsPreExtractToMemory Obsolete x
Info nv.Config.AutoHide.AutoHideConfrictBottomMargin Obsolete nv.Config.AutoHide.AutoHideConflictBottomMargin
Info nv.Config.AutoHide.AutoHideConfrictTopMargin Obsolete nv.Config.AutoHide.AutoHideConflictTopMargin
Info nv.Config.System.IsHiddenFileVisibled Obsolete nv.Config.System.IsHiddenFileVisible
Info nv.Config.System.IsOpenbookAtCurrentPlace Obsolete nv.Config.System.IsOpenBookAtCurrentPlace

Version 40.0

Severity Name Category Alternative
Warning nv.Command.NextScrollPage.Parameter.ScrollDuration Obsolete nv.Config.View.ScrollDuration
Warning nv.Command.PrevScrollPage.Parameter.ScrollDuration Obsolete nv.Config.View.ScrollDuration
Warning nv.Command.ViewScrollDown.Parameter.ScrollDuration Obsolete nv.Config.View.ScrollDuration
Warning nv.Command.ViewScrollLeft.Parameter.ScrollDuration Obsolete nv.Config.View.ScrollDuration
Warning nv.Command.ViewScrollNTypeDown.Parameter.ScrollDuration Obsolete nv.Config.View.ScrollDuration
Warning nv.Command.ViewScrollNTypeUp.Parameter.ScrollDuration Obsolete nv.Config.View.ScrollDuration
Warning nv.Command.ViewScrollRight.Parameter.ScrollDuration Obsolete nv.Config.View.ScrollDuration
Warning nv.Command.ViewScrollUp.Parameter.ScrollDuration Obsolete nv.Config.View.ScrollDuration
Warning nv.Config.Book.BookPageSize Obsolete x
Warning nv.Config.Book.IsMultiplePageMove Obsolete x
Warning nv.Config.Bookshelf.IsIncrementalSearchEnabled Obsolete nv.Config.System.IsIncrementalSearchEnabled
Warning nv.Config.Bookshelf.IsVisibleItemsCount Obsolete nv.Config.Panels.IsVisibleItemsCount
Warning nv.Config.View.IsViewStartPositionCenter Obsolete nv.Config.View.ViewHorizontalOrigin,ViewVerticalOrigin
Warning nv.Config.Window.MaximizeWindowGapWidth Obsolete x
Info nv.Config.View.AutoRotate Obsolete nv.Config.BookSetting.AutoRotate
Info nv.Config.View.BaseScale Obsolete nv.Config.BookSetting.BaseScale
Info nv.Config.View.MainViewMergin Obsolete nv.Config.View.MainViewMargin

Script examples

Here are some example scripts. For other samples, refer to NeeView Sample Scripts.

Execute "External app" command by temporarily changing the executable file and arguments

OpenMsPaint.nvjs

// @name MS Paint
// @description Open the file in MS Paint.

param = {
    "Command": "mspaint.exe",
    "Parameter": "\"$File\""
}
nv.Command.OpenExternalApp.Patch(param).Execute()

Open display page in new NeeView

OpenNeeView.nvjs

// @name Open in NeeView
// @description Open the display page in a new NeeView.

nv.Command.SaveSetting.Execute() // Perform a save to keep settings the same

param = {
    "Command": "$NeeView", // Special way of writing to indicate the path of NeeView itself
    "Parameter": "-n \"$File\"",
    "MultiPagePolicy": "Once",
    "ArchivePolicy": "SendArchivePath"
}
nv.Command.OpenExternalApp.Patch(param).Execute()

ON / OFF of unsharp mask

ToggleUnsharpMask.nvjs

// @name Unsharp Mask ON/OFF
// @description Unsharp Mask toggle. Displays a warning when the resize filter is not effective.

if (nv.Config.ImageResizeFilter.IsEnabled) {
    nv.Config.ImageResizeFilter.IsUnsharpMaskEnabled = !nv.Config.ImageResizeFilter.IsUnsharpMaskEnabled
    if (nv.Config.ImageResizeFilter.IsUnsharpMaskEnabled) {
        nv.ShowMessage("UnsharpMask ON")
    }
    else {
        nv.ShowMessage("UnsharpMask OFF")
    }
}
else {
    nv.ShowMessage("ResizeFilter is not active")
}

If the path of the newly opened book contains "English", open it to the left, otherwise open it to the right

OnBookLoaded.nvjs

// @name Book start action
// @description Events when a book is opened

if (nv.Book.IsNew) {
    if (nv.Book.Path.match(/English/) != null) {
        nv.Book.Config.BookReadOrder = "LeftToRight"
    }
    else {
        nv.Book.Config.BookReadOrder = "RightToLeft"
    }
}

Change the way video files are manipulated

OnBookLoaded.nvjs

// @name Book start action
// @description Events when a book is opened

if (nv.Book.IsMedia) {
    // Video: click to play/stop, double-click to toggle full screen
    nv.Command.ToggleMediaPlay.ShortCutKey = "LeftClick"
    nv.Command.Script_ToggleFullScreenAndMediaPlay.ShortCutKey = "LeftDoubleClick"
    nv.Command.NextPage.ShortCutKey = "Left"
}
else {
    // Normal: Standard setting
    nv.Command.ToggleMediaPlay.ShortCutKey = null
    nv.Command.Script_ToggleFullScreenAndMediaPlay.ShortCutKey = null
    nv.Command.NextPage.ShortCutKey = "Left,LeftClick"
}

ToggleFullScreenAndMediaPlay.nvjs

// @name Full screen & video playback
// @description Switch between full screen and video playback at the same time

nv.Command.ToggleFullScreen.Execute()
nv.Command.ToggleMediaPlay.Execute()