`iXBRLViewerPlugin`¶

Submodules¶

Package Contents¶

Classes¶

iXBRLViewerLocalViewer

Functions¶

`iXBRLViewerCommandLineOptionExtender`
`pluginData`
`resetPluginData`
`processModel`
`generateViewer`	Generate and save an iXBRL viewer at the given destination (file, directory, or in-memory file) with the given viewer script URL. If copyScript is True the viewer script will be copied into the output destination.
`getFeaturesFromOptions`
`iXBRLViewerCommandLineXbrlRun`
`iXBRLViewerCommandLineFilingEnd`
`iXBRLViewerSaveCommand`
`iXBRLViewerSettingsCommand`
`iXBRLViewerToolsMenuExtender`
`toolsMenuExtender`
`commandLineOptionExtender`
`commandLineRun`
`commandLineFilingEnd`
`guiRun`	run iXBRL Viewer using GUI interactions for a single instance or testcases
`load_plugin_url`

Data¶

`_`
`PLUGIN_NAME`
`__pluginInfo__`

API¶

iXBRLViewerPlugin._: arelle.typing.TypeGetText¶: None

iXBRLViewerPlugin.PLUGIN_NAME¶: ‘ixbrl-viewer’

iXBRLViewerPlugin.iXBRLViewerCommandLineOptionExtender(parser: optparse.OptionParser, *args: Any, **kwargs: Any) → None¶

iXBRLViewerPlugin.pluginData(cntlr: arelle.Cntlr.Cntlr) → iXBRLViewerPlugin.plugin.IXBRLViewerPluginData¶

iXBRLViewerPlugin.resetPluginData(cntlr: arelle.Cntlr.Cntlr) → None¶

iXBRLViewerPlugin.processModel(cntlr: arelle.Cntlr.Cntlr, modelXbrl: arelle.ModelXbrl.ModelXbrl) → None¶

iXBRLViewerPlugin.generateViewer(cntlr: arelle.Cntlr.Cntlr, saveViewerDest: io.BytesIO | str | None, viewerURL: str | None = None, showValidationMessages: bool = False, zipViewerOutput: bool = False, packageDownloadURL: str | None = None, copyScript: bool = True) → None¶

Generate and save an iXBRL viewer at the given destination (file, directory, or in-memory file) with the given viewer script URL. If copyScript is True the viewer script will be copied into the output destination.

Parameters:

cntlr – The arelle controller that contains the model to be included in the viewer
saveViewerDest – The target that viewer data/files will be written to (path to file or directory, or a file object itself).
viewerURL – The filepath or URL location of the iXBRL Viewer JavaScript file.
showValidationMessages – True if validation messages should be shown in the viewer.
useStubViewer – True if the stub viewer should be used.
zipViewerOutput – True if the destination is a zip archive.
packageDownloadURL – Optional URL to use as the report package download URL.
copyScript – Controls if the script referenced by viewerURL is copied into the output directory, or directly set as the ‘src’ value of the script tag in the HTML iXBRL Viewer.

iXBRLViewerPlugin.getFeaturesFromOptions(options: argparse.Namespace | optparse.OptionParser) → dict[str, Any]¶

iXBRLViewerPlugin.iXBRLViewerCommandLineXbrlRun(cntlr: arelle.Cntlr.Cntlr, options: argparse.Namespace, modelXbrl: arelle.ModelXbrl.ModelXbrl, *args: Any, **kwargs: Any) → None¶

iXBRLViewerPlugin.iXBRLViewerCommandLineFilingEnd(cntlr: arelle.Cntlr.Cntlr, options: argparse.Namespace, *args: Any, **kwargs: Any) → None¶

iXBRLViewerPlugin.iXBRLViewerSaveCommand(cntlr: arelle.CntlrWinMain.CntlrWinMain) → None¶

iXBRLViewerPlugin.iXBRLViewerSettingsCommand(cntlr: arelle.CntlrWinMain.CntlrWinMain) → None¶

iXBRLViewerPlugin.iXBRLViewerToolsMenuExtender(cntlr: arelle.CntlrWinMain.CntlrWinMain, menu: tkinter.Menu, *args: Any, **kwargs: Any) → None¶

iXBRLViewerPlugin.toolsMenuExtender(cntlr: arelle.CntlrWinMain.CntlrWinMain, menu: tkinter.Menu, *args: Any, **kwargs: Any) → None¶

iXBRLViewerPlugin.commandLineOptionExtender(*args: Any, **kwargs: Any) → None¶

iXBRLViewerPlugin.commandLineRun(cntlr: arelle.Cntlr.Cntlr, options: argparse.Namespace, modelXbrl: arelle.ModelXbrl.ModelXbrl, *args: Any, **kwargs: Any) → None¶

iXBRLViewerPlugin.commandLineFilingEnd(*args: Any, **kwargs: Any) → None¶

class iXBRLViewerPlugin.iXBRLViewerLocalViewer¶

Bases: arelle.LocalViewer.LocalViewer

getLocalFile(file: str, relpath: str, request: Any) → Any¶

iXBRLViewerPlugin.guiRun(cntlr: arelle.CntlrWinMain.CntlrWinMain, modelXbrl: arelle.ModelXbrl.ModelXbrl, attach: Any, *args: Any, **kwargs: Any) → None¶: run iXBRL Viewer using GUI interactions for a single instance or testcases

iXBRLViewerPlugin.load_plugin_url() → str¶

iXBRLViewerPlugin.__pluginInfo__¶: None

iXBRLViewerPlugin¶