ixbrl-viewer 1.4.76__py3-none-any.whl → 1.4.77__py3-none-any.whl

iXBRLViewerPlugin/viewer/src/js/aspect.js

@@ -40,6 +40,17 @@ export class Aspect {
         return a !== undefined && this._aspect === a._aspect && this._value === a._value;
     }
 
+    /**
+     * Compares this Aspect to another
+     *
+     *
+     * @param {Aspect} b - The Aspect instance to compare against.
+     * @returns {number} - Negative if this < b, positive if this > b, zero if
+     * equal.
+     */
+    compareTo(b) {
+        return this._aspect.localeCompare(b._aspect);
+    }
 
     isTaxonomyDefined() {
         return this._aspect.includes(":");

iXBRLViewerPlugin/viewer/src/js/fact.js

@@ -215,10 +215,23 @@ export class Fact {
         return this.concept().isTextBlock();
     }
 
+    /**
+     * Get all defined Aspects (sorted by aspect name).
+     *
+     * @returns {Aspect[]} An array of instantiated Aspect objects.
+     */
     aspects() {
-        return Object.keys(this.f.a).map(k => this.aspect(k));
+        return Object.keys(this.f.a)
+            .map(k => this.aspect(k))
+            .sort((a, b) => a.compareTo(b));
     }
 
+    /**
+     * Retrieves or lazily creates an Aspect instance for the given aspect key.
+     *
+     * @param {string} a - The aspect key to retrieve or create.
+     * @returns {Aspect|undefined} The Aspect instance associated with the key, or undefined if not defined in `this.f.a`.
+     */
     aspect(a) {
         if (this._aspects === undefined) {
             this._aspects = {}

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

@@ -8,6 +8,8 @@ import { NAMESPACE_ISO4217 } from "./util";
 var testReportData = {
     "prefixes": {
         "eg": "http://www.example.com",
+        "aa": "http://www.example.com/aa",
+        "zz": "http://www.example.com/zz",
         "iso4217": NAMESPACE_ISO4217,
         "e": "http://example.com/entity",
     },
@@ -57,6 +59,30 @@ var testReportData = {
             },
             "d": "e"
         },
+        "eg:Dimension2": {
+            "labels": {
+                "std": {
+                    "en": "Dimension Two"
+                }
+            },
+            "d": "e"
+        },
+        "zz:Axis1": {
+            "labels": {
+                "std": {
+                    "en": "Axis One"
+                }
+            },
+            "d": "e"
+        },
+        "aa:Dimension3": {
+            "labels": {
+                "std": {
+                    "en": "Dimension Three"
+                }
+            },
+            "d": "e"
+        },
         "eg:Member1": {
             "labels": {
                 "std": {
@@ -71,6 +97,20 @@ var testReportData = {
                 }
             }
         },
+        "eg:Member3": {
+            "labels": {
+                "std": {
+                    "en": "Member Three"
+                }
+            }
+        },
+        "eg:Member4": {
+            "labels": {
+                "std": {
+                    "en": "Member Four"
+                }
+            }
+        },
         "eg:UnlabelledMember": {
             "labels": {
             }
@@ -720,6 +760,68 @@ describe("Aspect methods", () => {
     });
 });
 
+describe("Aspect sorting", () => {
+    var f = testFact({
+            "d": -3,
+            "v": 1000,
+            "a": {
+                "c": "eg:Concept1",
+                "u": "iso4217:USD",
+                "p": "2018-01-01/2019-01-01",
+                "eg:Dimension2": "eg:Member1",
+                "aa:Dimension3": "eg:Member2",
+                "zz:Axis1":      "eg:Member3",
+                "eg:Dimension1": "eg:Member4"
+            }});
+    test("Fact.aspects() is sorted", () => {
+        expect(f.aspects().length).toEqual(7);
+        expect(f.aspects().filter(a => a.isTaxonomyDefined()).length).toEqual(4);
+
+        expect(f.aspects().filter(a => a.isTaxonomyDefined())[0].name()).toEqual("aa:Dimension3");
+        expect(f.aspects().filter(a => a.isTaxonomyDefined())[0].label()).toEqual("Dimension Three");
+        expect(f.aspects().filter(a => a.isTaxonomyDefined())[0].value()).toEqual("eg:Member2");
+        expect(f.aspects().filter(a => a.isTaxonomyDefined())[0].valueLabel()).toEqual("Member Two");
+
+        expect(f.aspects().filter(a => a.isTaxonomyDefined()).at(-1).label()).toEqual("Axis One");
+        expect(f.aspects().filter(a => a.isTaxonomyDefined()).at(-1).valueLabel()).toEqual("Member Three");
+
+        expect(f.aspects().filter(a => a.isTaxonomyDefined()).map(k => k.name())).toEqual(["aa:Dimension3", "eg:Dimension1", "eg:Dimension2", "zz:Axis1"]);
+        expect(f.aspects().filter(a => !a.isTaxonomyDefined()).map(k => k.name())).toEqual(["c", "p", "u"]);
+    });
+});
+
+describe("Aspect sorting consistent between facts", () => {
+    var fact1 = testFact({
+            "d": -3,
+            "v": 1000,
+            "a": {
+                "c": "eg:Concept1",
+                "u": "iso4217:USD",
+                "p": "2018-01-01/2019-01-01",
+                "eg:Dimension2": "eg:Member1",
+                "aa:Dimension3": "eg:Member2",
+                "zz:Axis1":      "eg:Member3",
+                "eg:Dimension1": "eg:Member4"
+            }});
+    var fact2 = testFact({
+            "d": -3,
+            "v": 1001,
+            "a": {
+                "c": "eg:Concept2",
+                "u": "iso4217:USD",
+                "p": "2018-01-01/2019-01-01",
+                "zz:Axis1":      "eg:Member1",
+                "eg:Dimension2": "eg:Member2",
+                "aa:Dimension3": "eg:Member3",
+                "eg:Dimension1": "eg:Member4"
+            }});
+    test("fact1 dims are sorted as expected and in exactly the same order as fact2 dims", () => {
+        expect(fact1.aspects().filter(a => a.isTaxonomyDefined()).map(k => k.name())).toEqual(["aa:Dimension3", "eg:Dimension1", "eg:Dimension2", "zz:Axis1"]);
+        expect(fact1.aspects().filter(a => a.isTaxonomyDefined()).map(k => k.name())).toEqual(fact2.aspects().filter(a => a.isTaxonomyDefined()).map(k => k.name()));
+    });
+});
+
+
 describe("Fact errors", () => {
     test("iXBRL Invalid", () => {
         var f = testFact({

{ixbrl_viewer-1.4.76.dist-info → ixbrl_viewer-1.4.77.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ixbrl-viewer
-Version: 1.4.76
+Version: 1.4.77
 Summary: The Arelle iXBRL Viewer allows iXBRL reports to be viewed interactively in a web browser.
 Author-email: "arelle.org" <support@arelle.org>
 License-Expression: Apache-2.0

{ixbrl_viewer-1.4.76.dist-info → ixbrl_viewer-1.4.77.dist-info}/RECORD

@@ -1,5 +1,5 @@
 iXBRLViewerPlugin/__init__.py,sha256=263DtPKBXeTomSI-4SeE7gTX0ak16GiIB9DFOoxBK3k,16839
-iXBRLViewerPlugin/_version.py,sha256=edAo7jInhTS2oZ9vog5QWMHuPXvf-Ds8Km-y7KEmfbU,706
+iXBRLViewerPlugin/_version.py,sha256=8i4UboN7LyikKfY_6__GpilwC8bffYse-IldkSAZMkU,706
 iXBRLViewerPlugin/constants.py,sha256=DMyEKzoJZPN36vINiNF9wiP7PPofQg0ZLF0H2CP-ns4,3866
 iXBRLViewerPlugin/featureConfig.py,sha256=551aLjiGAkoxsgFDMBJT8s3nVaF787kgbRjFumTTsBE,255
 iXBRLViewerPlugin/iXBRLViewer.py,sha256=7IqbLuapCla5_c-lSM4KiKgSezbioKulJ5pa4ZEPejs,30643
@@ -12,7 +12,7 @@ iXBRLViewerPlugin/viewer/version.js,sha256=7b5si8UmaS7QqALQIP-wJ0I8onKFox8VyaAiU
 iXBRLViewerPlugin/viewer/webpack.common.js,sha256=hpXufjShXAESQh8Ds7ViJ_tbr8XSb7EdqQLRvyu_mQg,1691
 iXBRLViewerPlugin/viewer/webpack.dev.js,sha256=R9AwY_TBrg9otvXpDxT1UsGg5eMqi4aXW7C7EIsHzZk,551
 iXBRLViewerPlugin/viewer/webpack.prod.js,sha256=vfLowWC1EOty0zbq9P-usGaJ3w-JoERpJrYaE9MfoSE,499
-iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js,sha256=2rzjOlf9RJYEgCwAm-rS52y9dB7IjD32gFYVJfBi6BM,943084
+iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js,sha256=w-Q7gLIm5ejl5ajp62Ihve4Ipst3BcDOhVzru_KkedI,943170
 iXBRLViewerPlugin/viewer/dist/ixbrlviewer.js.LICENSE.txt,sha256=LtlhXpjEorsiefz-usoFDNTZC_le1KyOKPWgb3RWIq8,1832
 iXBRLViewerPlugin/viewer/src/data/utr.json,sha256=32ZuovUvTOiCiXnxQH1fyOlgLEbah8DhUInqxZNIjFc,20159
 iXBRLViewerPlugin/viewer/src/html/fact-details.html,sha256=r3cPuOzcosgBkYl0jfmRUGjYnLgv6Eu0IeTMmUHY4Ak,2863
@@ -122,7 +122,7 @@ iXBRLViewerPlugin/viewer/src/img/inline-viewer.svg,sha256=7gwas3nHxMunJIhb3clFbS
 iXBRLViewerPlugin/viewer/src/img/powered-by-workiva.png,sha256=4XE5yykXtKUxF2hytq9Uqjx64pa7AgOuidVuB5_04wU,10362
 iXBRLViewerPlugin/viewer/src/img/powered-by-workiva.svg,sha256=Zf2JArzszZCn7zCkHNVZiW8bhlDwPEdgIDJLJe86W30,7620
 iXBRLViewerPlugin/viewer/src/js/accordian.js,sha256=HLEwlBC6qh1bCnq79_r0eJd6sLgCcqjchXuOk4ZgVlY,1918
-iXBRLViewerPlugin/viewer/src/js/aspect.js,sha256=ufAwONyAkBae_QvRSv3N5ZsYxSl4rnSZTBO_HewNS2g,2462
+iXBRLViewerPlugin/viewer/src/js/aspect.js,sha256=BgMhxSAxnPq9RAtYV8WnyXocH2aYa8eSn9-iVH_g6j8,2770
 iXBRLViewerPlugin/viewer/src/js/aspect.test.js,sha256=2XGS_g7thB8UYSJ-lxHR-LmvM7N_cXPtCI1-7-rP4DQ,4271
 iXBRLViewerPlugin/viewer/src/js/balance.js,sha256=wOy4yTsvHkSW61pxGBQaCk-8mIBPbOpd3Jec0AcvA3c,323
 iXBRLViewerPlugin/viewer/src/js/calculation.js,sha256=tB5Tzr6aMrnERkBlLcPjJ0_SfGUT94FvXUbUR0id1iU,6778
@@ -136,8 +136,8 @@ iXBRLViewerPlugin/viewer/src/js/datatype.js,sha256=_hdRkZOZ-it8Jq4d10skIrQqKOcHL
 iXBRLViewerPlugin/viewer/src/js/datatype.test.js,sha256=A7rSgpvyPbhMpmt-dllaP1hwk4jDGBoi5eLi4TKqDWo,1738
 iXBRLViewerPlugin/viewer/src/js/dialog.js,sha256=Jr2RDS6wIJh8gtXoROCi-Xq9mz5QxdUPLYK9MmQTMYo,1131
 iXBRLViewerPlugin/viewer/src/js/docOrderIndex.js,sha256=rhNooqCDRU0f8Sb-adHnwqF7kq6vJA_rskGh6oPqdx8,674
-iXBRLViewerPlugin/viewer/src/js/fact.js,sha256=JczMGMw77NsdeKvjkJZ-mj7-zAX1TCfK7rSb0iNWF7U,12488
-iXBRLViewerPlugin/viewer/src/js/fact.test.js,sha256=Jkdd_khlu_nF1H0ojXNviqrYjQQRqS-vvT3MWjHXbWE,24320
+iXBRLViewerPlugin/viewer/src/js/fact.js,sha256=A1PfYzsWKryOcpzLTBqaIXKhcTjBb_Z4qbtFeLWSgac,12983
+iXBRLViewerPlugin/viewer/src/js/fact.test.js,sha256=gQoGD4SQFNgnJMN9ob-_3rg2j62ezUWpqHDoN_VkUO0,28087
 iXBRLViewerPlugin/viewer/src/js/factset.js,sha256=VwJSiIVra3IO5Zwz5LV4aQj5D_Q7tPAtlpQEPUioKU8,5120
 iXBRLViewerPlugin/viewer/src/js/factset.test.js,sha256=WNpm9EE1Eu3DkguUubN2nXnHWY9TIzQdJ6LuidRCHHY,8877
 iXBRLViewerPlugin/viewer/src/js/footnote.js,sha256=YPj7GQAdTC2KPSHAZSWF2z_gnJoJPQupusq3qcIwjhs,770
@@ -208,10 +208,10 @@ iXBRLViewerPlugin/viewer/src/less/text-mixins.less,sha256=pYeQjz6JptSyUTxoVwfNeb
 iXBRLViewerPlugin/viewer/src/less/validation-report.less,sha256=HWkYEWxny-_zAYrwPXwAXuNCbThMRyomhu6KteUAjEg,351
 iXBRLViewerPlugin/viewer/src/less/viewer.less,sha256=2Q_kms-bYCUHCX1sGUGzF3nQ6GGAy0y348wjybWchl8,5595
 iXBRLViewerPlugin/viewer/tools/build-font.js,sha256=Q-Uh0o6Uj2fkKd0zjS7rbVV2mkNydmEWGpkg0uWVir4,818
-ixbrl_viewer-1.4.76.dist-info/licenses/LICENSE.md,sha256=FOClHlBMDtwKei0tOJ7pv8WZ_HuQJMNYD1az3NpK73o,16647
-ixbrl_viewer-1.4.76.dist-info/licenses/NOTICE,sha256=-SHDY0OY7s4gm4Rdk5AB3nbnUsrdHEHPdJuGFR_vuM4,566
-ixbrl_viewer-1.4.76.dist-info/METADATA,sha256=PlzeEGfanhfX2Y1BkPfV72Ve5qdGvieY--gD4hG4CMc,18490
-ixbrl_viewer-1.4.76.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ixbrl_viewer-1.4.76.dist-info/entry_points.txt,sha256=2XUzP20WGwxdvnugdBybUBwAB3xf_zvrOR5W_smFz_4,65
-ixbrl_viewer-1.4.76.dist-info/top_level.txt,sha256=iQGm144gaJwCPqPDGQHi8umPFRQAvQShVKDk3JQv3JE,18
-ixbrl_viewer-1.4.76.dist-info/RECORD,,
+ixbrl_viewer-1.4.77.dist-info/licenses/LICENSE.md,sha256=FOClHlBMDtwKei0tOJ7pv8WZ_HuQJMNYD1az3NpK73o,16647
+ixbrl_viewer-1.4.77.dist-info/licenses/NOTICE,sha256=-SHDY0OY7s4gm4Rdk5AB3nbnUsrdHEHPdJuGFR_vuM4,566
+ixbrl_viewer-1.4.77.dist-info/METADATA,sha256=gUMgcmNkJ7sxPxlEWhOUBljanIGTxFfqnp80wL53Fq4,18490
+ixbrl_viewer-1.4.77.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ixbrl_viewer-1.4.77.dist-info/entry_points.txt,sha256=2XUzP20WGwxdvnugdBybUBwAB3xf_zvrOR5W_smFz_4,65
+ixbrl_viewer-1.4.77.dist-info/top_level.txt,sha256=iQGm144gaJwCPqPDGQHi8umPFRQAvQShVKDk3JQv3JE,18
+ixbrl_viewer-1.4.77.dist-info/RECORD,,