Generated from JS stubs

JSplitter API Documentation

Static documentation generated directly from the component's JSDoc stubs, including inline examples and linked source samples.

1218 API items 15 documentation files 80 source examples

Namespaces

consoled2dFunctions for working with Direct2D graphics. Direct2D versions earlier than 1.1 are not supported in the WorkfbFunctions for controlling foobar2000 and accessing it's data.gdiDrawMode-aware graphics facade. With window.DrawMode == 0 its resource factories use GDI+; with window.DrawModperformanceHigh-resolution timing API implementing the JSplitter subset of the Web High Resolution Time, User Timing, andplmanFunctions for managing foobar2000 playlists.utilsVarious utility functions.windowFunctions for working with the current JSplitter panel and accessing it's properties.

Classes

ActiveXObjectLoad ActiveX object.BinaryReaderStreaming binary reader returned by utils.OpenBinaryReader.BinaryWriterStreaming binary writer returned by utils.OpenBinaryWriter.BroadcastChannelNamed asynchronous messaging channel shared by JSplitter panel and Worker realms. BroadcastChannel is the recoButtonObjectButton object returned by window.CreateButtonContextMenuManagerD2DBitmapD2DBrushObject used for drawing as alternative for simple colour. Can also be used to reuse brushes for drawing insteaD2DCompileInfoResult of d2d.CompileD2DEffectCreates Direct2D effect. Direct2D versions earlier than 1.1 are not supported. Minimum OS requirements: WindowD2DFontConstructor may fail if font is not present. Performance note: try caching and reusing D2DFont objects, since D2DGraphicsTypically used inside on_paint. Use on_paint(dgr) for D2DGraphics members hints in auto-completion list. Note:D2DStrokeStyleReusable Direct2D stroke style describing line caps, joins and dash behaviour. Create with d2d.StrokeStyle andDriveInfoObject returned by utils.GetDriveInfo. Property names and semantics follow the Microsoft Scripting Runtime DriDropTargetActionEnumeratorDeprecated: use for ... of loop instead.ErrorEventEvent carrying an uncaught Worker error. Trusted Worker error events dispatched by JSplitter are non-cancelablEventStandard-style event object used by the Worker event system.EventTargetBase event target used by Worker objects, Worker global scopes and BroadcastChannel objects.FbAudioChunkObject returned by fb.GetAudioChunkFbFileInfoObject returned by GetFileInfoFbMetadbHandleFbMetadbHandleListHandle list elements can be accessed with array accessor, e.g. handle_list[i]FbPlaybackQueueItemFbPlayingItemLocationFbPlaylistRecyclerA Recycle Bin for playlists.FbProfilerFbTitleFormatPerformance note: if you use the same query frequently, try caching FbTitleFormat object (by storing it somewhFbTooltipFbUiSelectionHolderThis is typically used to update the selection used by the default UI artwork panel or any other panel that maFbWindowControls the main foobar2000 application window. Global state: every JSplitter panel accesses the same native GdiBitmapGdiBrushObject used for drawing as alternative for simple colour. Can also be used to reuse brushes for drawing insteaGdiFontConstructor may fail if font is not present. Performance note: try caching and reusing GdiFont objects, since GdiGraphicsTypically used inside on_paint. Note: there are many different ways to get colours: window.GetColourDUI/windowGdiRawBitmapHtmlDocumentObject returned by utils.ParseHtml Lightweight DOM-like HTML document backed by the native HTML parser. Notes:HtmlNodeLightweight DOM-like HTML node. HtmlNode can represent an element node, text node, comment node, or another paMainMenuManagerMenuObjectMessageEventEvent carrying a structured-clone message payload. Used by direct Worker messaging and BroadcastChannel in botPanelObjectPanel object returned by window.GetPanel or window.GetPanelByIndexPerformanceObserverCreates a new observer for entries added to the JSplitter performance timeline. The callback is invoked asynchPerformanceObserverEntryListList of performance entries delivered to a PerformanceObserver callback. The entries in this list are ordered PromiseRejectionEventEvent used for unhandled and later-handled Worker Promise rejections.RunResultObject returned by utils.Run.SQLiteDatabaseSQLite database returned by utils.OpenDatabase. All operations are synchronous. Use a Worker for large importsSQLiteStatementPrepared SQLite statement returned by Prepare. A prepared statement is usable immediately after Prepare succeeTextReaderStreaming text reader returned by utils.OpenTextReader.TextWriterStreaming text writer returned by utils.OpenTextWriter.ThemeManagerWorkerRuns JavaScript in a separate JSplitter Worker realm and Worker thread. JSplitter Workers use a Web-Worker-insWorkerGlobalScopeGlobal object available inside every JSplitter Worker.

Modules

CallbacksCodepagesEffectsDirect2D effects Direct2D versions earlier than 1.1 are not supported. Minimum OS requirements: Windows 8+ or ESModulesECMAScript modules can be used as panel scripts by selecting an .mjs file in Script → File . A top-level .mjs FlagsHelpersMatrixMatrix helpersTitleFormattingJSplitter provides global Title Formatting fields for its statistics database and foobar2000 directories. ThesWebAssemblyJSplitter exposes the standard WebAssembly global in both panels and Workers. WebAssembly modules built from C

Other

GlobalsGlobal functions, callbacks and types.Documentation auditBroken source links, unresolved JSDoc links and other diagnostics.