Arelle iXBRL Viewer¶
Overview¶
The Arelle iXBRL Viewer is an interactive tool developed by the Arelle team for viewing Inline XBRL (iXBRL) reports in web browsers. It enables users to access and interact with XBRL data embedded in iXBRL reports. This viewer is designed with extensibility in mind, allowing users to adapt it to their needs.
Installation¶
The iXBRL Viewer is included in Arelle’s prepackaged distributions, so no additional installation steps are needed if you are using one of those.
If you installed Arelle from source or via pip, the iXBRL Viewer plugin is not included and must be installed separately:
pip install ixbrl-viewer
Key Features¶
Interactive Viewing: Experience interactive viewing of iXBRL reports in any web browser.
Data Accessibility: Easily access the XBRL data embedded within iXBRL reports.
Global Usage: Adapted and customized by various service providers and regulators.
Example Command Line Usage¶
For a comprehensive list of options, please refer to the project readme.
To create an ixbrl-viewer.htm viewer file, use the following command:
python arelleCmdLine.py --plugins iXBRLViewerPlugin --file filing-documents.zip --save-viewer ixbrl-viewer.htm
Example GUI Usage¶
The Arelle iXBRL Viewer can also be configured and utilized via the graphical user interface (GUI).
Simply navigate to Tools > iXBRL Viewer in the menu to get started.