ixbrl-viewer 1.4.9__py3-none-any.whl → 1.4.11__py3-none-any.whl

iXBRLViewerPlugin/viewer/src/html/inspector.html

@@ -169,8 +169,8 @@ See COPYRIGHT.md for copyright information
           </div>
 
           <div class="filter-info">
-            <span id="matching-concepts-count">?</span>
-            <span data-i18n="inspector.matchingConcepts"> matching concept(s)</span>
+            <span id="matching-facts-count">?</span>
+            <span data-i18n="inspector.matchingFacts"> matching facts(s)</span>
           </div>
         </div>
       </div>

iXBRLViewerPlugin/viewer/src/i18n/en/translation.json

@@ -47,7 +47,7 @@
     "highlight": "Highlight",
     "initializing": "Initializing",
     "loadingViewer": "Loading iXBRL Viewer",
-    "matchingConcepts": " matching concept(s)",
+    "matchingFacts": " matching facts(s)",
     "namespaces": "Namespaces",
     "narrowerAnchor": "Narrower anchors",
     "negative": "Negative",

iXBRLViewerPlugin/viewer/src/i18n/es/translation.json

@@ -47,7 +47,7 @@
     "highlight": "Destacar",
     "initializing": "",
     "loadingViewer": "Preparando el visor iXBRL",
-    "matchingConcepts": "",
+    "matchingFacts": "",
     "namespaces": "",
     "narrowerAnchor": "Anclaje angosto",
     "negative": "",

iXBRLViewerPlugin/viewer/src/js/aspect.js

@@ -56,7 +56,7 @@ export class Aspect {
             return this._report.getLabel(this._value, rolePrefix) || this._value;
         }
         else if (this._aspect === 'u') {
-            return this._report.reportSet.getUnit(this._value).measureLabel();
+            return this._report.reportSet.getUnit(this._value).label();
         }
         else if (this._aspect === 'p') {
             const p = new Period(this._value);

iXBRLViewerPlugin/viewer/src/js/aspect.test.js

@@ -3,11 +3,12 @@
 import { Aspect, AspectSet } from "./aspect.js";
 import { ReportSet } from "./reportset.js";
 import { TestInspector } from "./test-utils.js";
+import { NAMESPACE_ISO4217 } from "./util";
 
 const testReportData = {
     "prefixes": {
         "eg": "http://www.example.com",
-        "iso4217": "http://www.xbrl.org/2003/iso4217"
+        "iso4217": NAMESPACE_ISO4217
     },
     "facts" : {},
     "concepts": {

iXBRLViewerPlugin/viewer/src/js/chart.js

@@ -97,7 +97,7 @@ export class IXBRLChart extends Dialog {
         const uv2 = set2av.uniqueValues();
 
         const scale = this._chooseMultiplier(facts);
-        const yLabel = fact.measureLabel() + " " + this._multiplierDescription(scale);
+        const yLabel = fact.unitLabel() + " " + this._multiplierDescription(scale);
         const labels = [];
         
         const dataSets = [];

iXBRLViewerPlugin/viewer/src/js/chart.test.js

@@ -1,14 +1,14 @@
 // See COPYRIGHT.md for copyright information
 
-import { Fact } from "./fact.js";
 import { IXBRLChart } from "./chart.js";
 import { ReportSet } from "./reportset.js";
 import { TestInspector } from "./test-utils.js";
+import { NAMESPACE_ISO4217 } from "./util";
 
 var testReportData = {
     "prefixes": {
         "eg": "http://www.example.com",
-        "iso4217": "http://www.xbrl.org/2003/iso4217",
+        "iso4217": NAMESPACE_ISO4217,
         "e": "http://example.com/entity",
     },
     "concepts": {

iXBRLViewerPlugin/viewer/src/js/concept.test.js

@@ -1,12 +1,12 @@
 // See COPYRIGHT.md for copyright information
 
-import { XBRLReport } from "./report.js";
 import { ReportSet } from "./reportset.js";
+import { NAMESPACE_ISO4217 } from "./util";
 
 const testReportData = {
     "prefixes": {
         "eg": "http://www.example.com",
-        "iso4217": "http://www.xbrl.org/2003/iso4217",
+        "iso4217": NAMESPACE_ISO4217,
         "e": "http://example.com/entity",
     },
     "concepts": {

iXBRLViewerPlugin/viewer/src/js/fact.js

@@ -78,10 +78,10 @@ export class Fact {
                 formattedNumber = formatNumber(v, d);
             }
             if (this.isMonetaryValue()) {
-                v = this.measureLabel() + " " + formattedNumber;
+                v = this.unitLabel() + " " + formattedNumber;
             }
             else {
-                v = formattedNumber + " " + this.measureLabel();
+                v = formattedNumber + " " + this.unitLabel();
             }
         }
         else if (this.isNil()) {
@@ -108,22 +108,6 @@ export class Fact {
         return v;
     }
 
-    /**
-     * Returns the qname of the first numerator in the fact's unit
-     * @return {String} QName string of a measure
-     */
-    measure() {
-        return this.unit()?.measure();
-    }
-
-    /**
-     * Returns a readable label representing the first numerator in the fact's unit
-     * @return {String} Label representing measure
-     */
-    measureLabel() {
-        return this.unit()?.measureLabel() ?? i18next.t("factDetails.noUnit");
-    }
-
     /**
      * Returns details about this fact's unit
      * @return {Unit} Unit instance
@@ -139,6 +123,14 @@ export class Fact {
         return this._unit;
     }
 
+    /**
+     * Returns a readable label representing the fact's unit
+     * @return {String} Label representing unit
+     */
+    unitLabel() {
+        return this.unit()?.label() ?? i18next.t("factDetails.noUnit");
+    }
+
     getConceptPrefix() {
         return this.conceptName().split(':')[0];
     }
@@ -264,17 +256,12 @@ export class Fact {
     }
 
     getScaleLabel(value, isAccuracy=false) {
-        let measure = this.measure() ?? '';
-        if (measure) {
-            measure = this.report.qname(measure).localname;
-        }
         return this.report.getScaleLabel(
                 // We use the same table of labels for scale and accuracy,
                 // but decimals means "accurate to 10^-N" whereas scale means 10^N,
                 // so invert N for accuracy.
                 isAccuracy ? -value : value,
-                this.isMonetaryValue(),
-                measure
+                this.unit()
         );
     }
 

iXBRLViewerPlugin/viewer/src/js/fact.test.js

@@ -3,11 +3,12 @@
 import { Fact } from "./fact.js";
 import { ReportSet } from "./reportset.js";
 import { TestInspector } from "./test-utils.js";
+import { NAMESPACE_ISO4217 } from "./util";
 
 var testReportData = {
     "prefixes": {
         "eg": "http://www.example.com",
-        "iso4217": "http://www.xbrl.org/2003/iso4217",
+        "iso4217": NAMESPACE_ISO4217,
         "e": "http://example.com/entity",
     },
     "concepts": {
@@ -108,7 +109,6 @@ describe("Simple fact properties", () => {
         expect(f.isMonetaryValue()).toBeTruthy();
         expect(f.readableValue()).toEqual("US $ 1,000");
         expect(f.unit().value()).toEqual("iso4217:USD");
-        expect(f.measure()).toEqual("iso4217:USD");
         expect(f.conceptQName().prefix).toEqual("eg");
         expect(f.conceptQName().localname).toEqual("Concept1");
         expect(f.conceptQName().namespace).toEqual("http://www.example.com");
@@ -128,9 +128,8 @@ describe("Simple fact properties", () => {
         expect(f.isNumeric()).toBeTruthy();
         expect(f.decimals()).toEqual(-3);
         expect(f.isMonetaryValue()).toBeFalsy();
-        expect(f.readableValue()).toEqual("1,000 eg:USD");
+        expect(f.readableValue()).toEqual("1,000 USD");
         expect(f.unit().value()).toEqual("eg:USD");
-        expect(f.measure()).toEqual("eg:USD");
         expect(f.conceptQName().prefix).toEqual("eg");
         expect(f.conceptQName().localname).toEqual("Concept1");
         expect(f.conceptQName().namespace).toEqual("http://www.example.com");
@@ -149,9 +148,8 @@ describe("Simple fact properties", () => {
         expect(f.decimals()).toBeUndefined();
         expect(f.isNumeric()).toBeTruthy();
         expect(f.isMonetaryValue()).toBeFalsy();
-        expect(f.readableValue()).toEqual("1,000,000.0125 eg:USD");
+        expect(f.readableValue()).toEqual("1,000,000.0125 USD");
         expect(f.unit().value()).toEqual("eg:USD");
-        expect(f.measure()).toEqual("eg:USD");
         expect(f.conceptQName().prefix).toEqual("eg");
         expect(f.conceptQName().localname).toEqual("Concept1");
         expect(f.conceptQName().namespace).toEqual("http://www.example.com");
@@ -539,7 +537,7 @@ describe("Readable value", () => {
     test("Other numeric", () => {
 
         expect(testFact({ "v": "10", d: -2, a: { u: "xbrli:foo" } }).readableValue())
-            .toBe("10 xbrli:foo");
+            .toBe("10 foo");
 
     });
 
@@ -635,8 +633,7 @@ describe("Unit aspect handling", () => {
         expect(f.isNumeric()).toBeTruthy();
         expect(f.isMonetaryValue()).toBeFalsy();
         expect(f.unit()).toBeUndefined();
-        expect(f.measure()).toBeUndefined();
-        expect(f.measureLabel()).toBe("<NOUNIT>");
+        expect(f.unitLabel()).toBe("<NOUNIT>");
     });
 
     test("Non-numeric, no unit", () => {    
@@ -647,7 +644,6 @@ describe("Unit aspect handling", () => {
         });
         expect(f.isNumeric()).toBeFalsy();
         expect(f.unit()).toBeUndefined();
-        expect(f.measure()).toBeUndefined();
     });
 });
 
@@ -707,7 +703,6 @@ describe("Fact errors", () => {
         expect(f.isMonetaryValue()).toBeTruthy();
         expect(f.readableValue()).toEqual("Invalid value");
         expect(f.unit().value()).toEqual("iso4217:USD");
-        expect(f.measure()).toEqual("iso4217:USD");
         expect(f.conceptQName().prefix).toEqual("eg");
         expect(f.conceptQName().localname).toEqual("Concept1");
         expect(f.conceptQName().namespace).toEqual("http://www.example.com");

iXBRLViewerPlugin/viewer/src/js/factset.test.js

@@ -1,9 +1,7 @@
 // See COPYRIGHT.md for copyright information
 
-import { Fact } from "./fact.js";
 import { FactSet } from "./factset.js";
-import { viewerUniqueId } from "./util.js";
-import { XBRLReport } from "./report.js";
+import { NAMESPACE_ISO4217, viewerUniqueId } from "./util.js";
 import { ReportSet } from "./reportset.js";
 
 var i = 0;
@@ -11,7 +9,7 @@ var i = 0;
 var testReportData = {
     "prefixes": {
         "eg": "http://www.example.com",
-        "iso4217": "http://www.xbrl.org/2003/iso4217",
+        "iso4217": NAMESPACE_ISO4217,
         "e": "http://example.com/entity",
     },
     "concepts": {

iXBRLViewerPlugin/viewer/src/js/inspector.js

@@ -1,7 +1,7 @@
 // See COPYRIGHT.md for copyright information
 
 import $ from 'jquery'
-import { formatNumber, wrapLabel, truncateLabel, runGenerator, SHOW_FACT, viewerUniqueId } from "./util.js";
+import { formatNumber, wrapLabel, truncateLabel, runGenerator, SHOW_FACT, HIGHLIGHT_COLORS, viewerUniqueId } from "./util.js";
 import { ReportSearch } from "./search.js";
 import { Calculation } from "./calculations.js";
 import { IXBRLChart } from './chart.js';
@@ -256,7 +256,7 @@ export class Inspector {
         for (const [i, name] of key.entries()) {
             $("<div>")
                 .addClass("item")
-                .append($("<span></span>").addClass("sample").addClass("sample-" + i))
+                .append($("<span></span>").addClass("sample").addClass("sample-" + (i % HIGHLIGHT_COLORS)))
                 .append($("<span></span>").text(name))
                 .appendTo($(".highlight-key .items"));
         }
@@ -436,7 +436,7 @@ export class Inspector {
             $(".text", overlay).text(i18next.t("search.tryAgainDifferentKeywords"));
             overlay.show();
         }
-        $("#matching-concepts-count").text(results.length);
+        $("#matching-facts-count").text(results.length);
         /* Don't highlight search results if there's no search string */
         if (spec.searchString != "") {
             this._viewer.highlightRelatedFacts(results.map(r => r.fact));

iXBRLViewerPlugin/viewer/src/js/inspector.test.js

@@ -1,15 +1,14 @@
 // See COPYRIGHT.md for copyright information
 
-import { Fact } from "./fact.js";
 import { ReportSet } from "./reportset.js";
 import { TestInspector } from "./test-utils.js";
-import { SHOW_FACT, viewerUniqueId } from "./util.js";
+import { NAMESPACE_ISO4217, SHOW_FACT, viewerUniqueId } from "./util.js";
 
 
 const testReportData = {
     "prefixes": {
         "eg": "http://www.example.com",
-        "iso4217": "http://www.xbrl.org/2003/iso4217",
+        "iso4217": NAMESPACE_ISO4217,
         "e": "http://example.com/entity",
     },
     "concepts": {

iXBRLViewerPlugin/viewer/src/js/outline.test.js

@@ -2,14 +2,14 @@
 
 import $ from 'jquery'
 import { ReportSet } from "./reportset.js";
-import { ReportSetOutline, DocumentOutline } from "./outline.js";
+import { DocumentOutline } from "./outline.js";
 import { IXNode } from "./ixnode.js";
-import { viewerUniqueId } from "./util.js";
+import { NAMESPACE_ISO4217, viewerUniqueId } from "./util.js";
 
 const testReportData = {
     prefixes: {
         eg: "http://www.example.com",
-        iso4217: "http://www.xbrl.org/2003/iso4217",
+        iso4217: NAMESPACE_ISO4217,
         e: "http://example.com/entity",
     },
     roles: {

iXBRLViewerPlugin/viewer/src/js/report.js

@@ -179,10 +179,14 @@ export class XBRLReport {
         return this.reportSet.qname(v);
     }
 
-    getScaleLabel(scale, isMonetaryValue, currency=null) {
+    getScaleLabel(scale, unit) {
         let label = i18next.t(`scale.${scale}`, {defaultValue:"noName"});
-        if (isMonetaryValue && scale === -2) {
-            label = i18next.t(`currencies:cents${currency}`, {defaultValue: label});
+        if (unit && unit.isMonetary() && scale === -2) {
+            let measure = unit.value() ?? '';
+            if (measure) {
+                measure = this.qname(measure).localname;
+            }
+            label = i18next.t(`currencies:cents${measure}`, {defaultValue: label});
         }
         if (label === "noName") {
             return null;

iXBRLViewerPlugin/viewer/src/js/report.test.js

@@ -2,6 +2,7 @@
 
 import { ReportSet } from "./reportset.js";
 import { ViewerOptions } from "./viewerOptions.js";
+import { NAMESPACE_ISO4217 } from "./util";
 
 var testReportData = {
     "languages": {
@@ -10,7 +11,7 @@ var testReportData = {
     },
     "prefixes": {
         "eg": "http://www.example.com",
-        "iso4217": "http://www.xbrl.org/2003/iso4217"
+        "iso4217": NAMESPACE_ISO4217
     },
     "roles": {
         "role1": "https://www.example.com/role1",

iXBRLViewerPlugin/viewer/src/js/reportset.test.js

@@ -2,7 +2,7 @@
 
 import { ReportSet } from "./reportset.js";
 import { ViewerOptions } from "./viewerOptions.js";
-import { viewerUniqueId } from "./util.js";
+import { NAMESPACE_ISO4217, viewerUniqueId } from "./util.js";
 import { createNumericFact } from "./test-utils.js";
 
 function anchoringRelationShips(include) {
@@ -28,7 +28,7 @@ function multiReportTestData(withAnchoring) {
         },
         "prefixes": {
             "eg": "http://www.example.com",
-            "iso4217": "http://www.xbrl.org/2003/iso4217"
+            "iso4217": NAMESPACE_ISO4217
         },
         "roles": {
             "role1": "https://www.example.com/role1",
@@ -131,7 +131,7 @@ function singleReportTestData() {
         },
         "prefixes": {
             "eg": "http://www.example.com",
-            "iso4217": "http://www.xbrl.org/2003/iso4217"
+            "iso4217": NAMESPACE_ISO4217
         },
         "roles": {
             "role1": "https://www.example.com/role1",

iXBRLViewerPlugin/viewer/src/js/unit.js

@@ -1,29 +1,32 @@
 // See COPYRIGHT.md for copyright information
 
-import i18next from "i18next";
-import {titleCase} from "./util";
+import { measureLabel, NAMESPACE_ISO4217 } from "./util";
 
 export class Unit {
     
-    constructor(report, unitKey) {
-        this._report = report;
+    constructor(reportSet, unitKey) {
+        this._reportSet = reportSet;
         this._value = unitKey;
         const split = unitKey
                 .split(/[()]/ig).join('') // TODO: replace with .replaceAll(/[()]/ig,'') when no longer supporting node 14
                 .split('/');
         this._numerators = split[0].split('*');
         this._denominators = split.length > 1 ? split[1].split('*') : [];
-        this._isMonetary = Boolean(this._numerators.find(n => this._report.qname(n).namespace === "http://www.xbrl.org/2003/iso4217"));
-        this._label = split.map(x => {
-                const part = x.split('*').map(y => {
-                    return titleCase(y.split(':')[1]);
-                }).join('*');
+        this._isMonetary =
+                this._denominators.length === 0 &&
+                this._numerators.length === 1 &&
+                this._reportSet.qname(this._numerators[0]).namespace === NAMESPACE_ISO4217;
+        this._label = split
+            .map(measure => {
+                const part = measure
+                    .split('*')
+                    .map(x => measureLabel(this._reportSet, x))
+                    .join('*');
                 return part.includes('*') ? `(${part})` : part;
-            }).join('/');
-        this._measure = this._numerators[0];
+            })
+            .join('/');
     }
 
-
     /**
      * Returns whether any of the numerators are an iso4217 monetary measure.
      * @return {Boolean}
@@ -40,27 +43,6 @@ export class Unit {
         return this._label;
     }
 
-    /**
-     * Returns the qname of the first numerator in the unit
-     * @return {String} QName string of a measure
-     */
-    measure() {
-        return this._measure;
-    }
-
-    /**
-     * Returns a readable label representing the first numerator in the unit
-     * @return {String} Label representing measure
-     */
-    measureLabel() {
-        const measure = this.measure();
-        const qname = this._report.qname(measure);
-        if (qname.namespace === "http://www.xbrl.org/2003/iso4217") {
-            return i18next.t(`currencies:unitFormat${qname.localname}`, {defaultValue: qname.localname});
-        }
-        return measure;
-    }
-
     /**
      * Returns the OIM format string representing the unit
      * @return {String} OIM format unit string

iXBRLViewerPlugin/viewer/src/js/unit.test.js

@@ -3,11 +3,12 @@
 import { Unit } from "./unit.js";
 import { ReportSet } from "./reportset.js";
 import { TestInspector } from "./test-utils.js";
+import { NAMESPACE_ISO4217 } from "./util";
 
 var testReportData = {
     "prefixes": {
         "eg": "http://www.example.com",
-        "iso4217": "http://www.xbrl.org/2003/iso4217",
+        "iso4217": NAMESPACE_ISO4217,
         "e": "http://example.com/entity",
     },
     "facts": {}
@@ -29,51 +30,39 @@ beforeAll(() => {
 describe("Unit label", () => {
     test("Unit label for simple unit", () => {
         var unit = new Unit(testReport(), 'iso4217:USD');
-        expect(unit.label()).toEqual('USD');
+        expect(unit.label()).toEqual('US $');
     });
 
     test("Unit label for complex unit", () => {
         var unit = new Unit(testReport(), 'iso4217:USD/eg:share');
-        expect(unit.label()).toEqual('USD/Share');
+        expect(unit.label()).toEqual('US $/share');
     });
 
     test("Unit label for complex unit with numerator parentheses", () => {
         var unit = new Unit(testReport(), '(iso4217:USD*eg:share)/eg:shareholder');
-        expect(unit.label()).toEqual('(USD*Share)/Shareholder');
+        expect(unit.label()).toEqual('(US $*share)/shareholder');
     });
 
     test("Unit label for complex unit with denominator parentheses", () => {
         var unit = new Unit(testReport(), 'iso4217:USD/(eg:share*eg:shareholder)');
-        expect(unit.label()).toEqual('USD/(Share*Shareholder)');
+        expect(unit.label()).toEqual('US $/(share*shareholder)');
     });
 });
 
-describe("Unit measure", () => {
-    test("Unit measure is simple unit", () => {
-        var unit = new Unit(testReport(), 'iso4217:USD');
-        expect(unit.measure()).toEqual('iso4217:USD');
-    });
-
-    test("Unit measure is first numerator of complex unit", () => {
-        var unit = new Unit(testReport(), '(iso4217:USD*eg:share)/eg:shareholder');
-        expect(unit.measure()).toEqual('iso4217:USD');
-    });
-});
-
-describe("Unit measure label", () => {
-    test("Unit measure label - known currency", () => {
+describe("Unit label", () => {
+    test("Unit label - known currency", () => {
         var unit = new Unit(testReport(), 'eg:share');
-        expect(unit.measureLabel()).toEqual('eg:share');
+        expect(unit.label()).toEqual('share');
     });
 
-    test("Unit measure label - known currency", () => {
+    test("Unit label - known currency", () => {
         var unit = new Unit(testReport(), 'iso4217:USD');
-        expect(unit.measureLabel()).toEqual('US $');
+        expect(unit.label()).toEqual('US $');
     });
 
-    test("Unit measure label - unknown", () => {
+    test("Unit label - unknown", () => {
         var unit = new Unit(testReport(), 'iso4217:ZAR');
-        expect(unit.measureLabel()).toEqual('ZAR');
+        expect(unit.label()).toEqual('ZAR');
     });
 });
 
@@ -94,4 +83,8 @@ describe("Unit value", () => {
         var unit = new Unit(testReport(), '(iso4217:USD*eg:share)/eg:shareholder');
         expect(unit.value()).toEqual('(iso4217:USD*eg:share)/eg:shareholder');
     });
+    test("Unit value is simple unit", () => {
+        var unit = new Unit(testReport(), 'iso4217:USD');
+        expect(unit.value()).toEqual('iso4217:USD');
+    });
 });

iXBRLViewerPlugin/viewer/src/js/util.js

@@ -2,10 +2,16 @@
 
 import moment from "moment";
 import Decimal from "decimal.js";
+import i18next from "i18next";
 
 
 export const SHOW_FACT = 'SHOW_FACT';
 
+export const NAMESPACE_ISO4217 = 'http://www.xbrl.org/2003/iso4217';
+
+// The number of distinct highlight colors defined in inspector.less
+export const HIGHLIGHT_COLORS = 3;
+
 /* 
  * Takes a moment.js oject and converts it to a human readable date, or date
  * and time if the time component is not midnight.  Adjust specifies that a
@@ -207,3 +213,18 @@ export function getIXHiddenLinkStyle(domNode) {
     }
     return null;
 }
+
+/**
+ * Transforms measure qname into title case label (or currency symbol, if applicable).
+ * @return {String} Measure Label
+ */
+
+export function measureLabel(report, measure) {
+    const qname = report.qname(measure);
+    if (qname.namespace === NAMESPACE_ISO4217) {
+        measure = i18next.t(`currencies:unitFormat${qname.localname}`, {defaultValue: qname.localname});
+    } else if (measure.includes(':')) {
+        measure = measure.split(':')[1];
+    }
+    return measure;
+}