@mat3ra/made 2025.5.13-1 → 2025.6.10-0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/dist/js/made.d.ts +7 -1283
  2. package/dist/js/made.js +0 -1
  3. package/dist/js/material.d.ts +14 -633
  4. package/dist/js/material.js +10 -347
  5. package/dist/js/materialMixin.d.ts +164 -0
  6. package/dist/js/materialMixin.js +356 -0
  7. package/dist/js/tools/index.d.ts +4 -976
  8. package/package.json +3 -3
  9. package/pyproject.toml +2 -2
  10. package/src/js/made.ts +1 -2
  11. package/src/js/material.ts +14 -436
  12. package/src/js/materialMixin.ts +445 -0
  13. package/src/py/mat3ra/made/tools/build/__init__.py +4 -4
  14. package/src/py/mat3ra/made/tools/build/slab/builders.py +9 -7
  15. package/tests/js/tools/surface.ts +2 -1
package/dist/js/made.d.ts CHANGED
@@ -2,7 +2,7 @@ import { Basis } from "./basis/basis";
2
2
  import { AtomicConstraints } from "./constraints/constraints";
3
3
  import { Lattice } from "./lattice/lattice";
4
4
  import { ReciprocalLattice } from "./lattice/reciprocal/lattice_reciprocal";
5
- import { MaterialMixin } from "./material";
5
+ import { Material } from "./material";
6
6
  export declare const Made: {
7
7
  coefficients: {
8
8
  EV_TO_RY: number;
@@ -484,312 +484,8 @@ export declare const Made: {
484
484
  typeof(x: any): string;
485
485
  import(object: import("mathjs").ImportObject | import("mathjs").ImportObject[], options: import("mathjs").ImportOptions): void;
486
486
  };
487
- Material: {
488
- new (...config: any[]): {
489
- _json: import("./material").MaterialSchemaJSON;
490
- toJSON(): import("./types").MaterialJSON;
491
- src: import("@mat3ra/esse/dist/js/types").FileSourceSchema | undefined;
492
- updateFormula(): void;
493
- isNonPeriodic: boolean;
494
- getDerivedPropertyByName(name: string): {
495
- name?: "volume" | undefined;
496
- units?: "angstrom^3" | undefined;
497
- value: number;
498
- } | {
499
- name?: "density" | undefined;
500
- units?: "g/cm^3" | undefined;
501
- value: number;
502
- } | {
503
- pointGroupSymbol?: string | undefined;
504
- spaceGroupSymbol?: string | undefined;
505
- tolerance?: {
506
- units?: "angstrom" | undefined;
507
- value: number;
508
- } | undefined;
509
- name?: "symmetry" | undefined;
510
- } | {
511
- name?: "elemental_ratio" | undefined;
512
- value: number;
513
- element?: string | undefined;
514
- } | {
515
- name?: "p-norm" | undefined;
516
- degree?: number | undefined;
517
- value: number;
518
- } | {
519
- name?: "inchi" | undefined;
520
- value: string;
521
- } | {
522
- name?: "inchi_key" | undefined;
523
- value: string;
524
- } | undefined;
525
- getDerivedProperties(): import("@mat3ra/esse/dist/js/types").DerivedPropertiesSchema;
526
- readonly formula: string;
527
- readonly unitCellFormula: string;
528
- unsetFileProps(): void;
529
- setBasis(textOrObject: string | import("./basis/basis").BasisConfig, format?: string | undefined, unitz?: string | undefined): void;
530
- setBasisConstraints(constraints: import("./constraints/constraints").Constraint[]): void;
531
- setBasisConstraintsFromArrayOfObjects(constraints: import("@mat3ra/esse/dist/js/types").AtomicConstraintsSchema): void;
532
- readonly basis: import("./material").OptionallyConstrainedBasisConfig;
533
- readonly Basis: import("./basis/constrained_basis").ConstrainedBasis;
534
- readonly uniqueElements: string[];
535
- lattice: import("@mat3ra/esse/dist/js/types").LatticeSchema;
536
- readonly Lattice: Lattice;
537
- getInchiStringForHash(): string;
538
- calculateHash(salt?: string, isScaled?: boolean, bypassNonPeriodicCheck?: boolean): string;
539
- hash: string;
540
- readonly scaledHash: string;
541
- toCrystal(): void;
542
- toCartesian(): void;
543
- getBasisAsXyz(fractional?: boolean): string;
544
- getAsQEFormat(): string;
545
- getAsPOSCAR(ignoreOriginal?: boolean, omitConstraints?: boolean): string;
546
- getACopyWithConventionalCell(): any;
547
- getConsistencyChecks(): import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
548
- getBasisConsistencyChecks(): import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
549
- consistencyChecks: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
550
- addConsistencyChecks(array: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[]): void;
551
- prop: {
552
- <T = undefined>(name: string, defaultValue: T): T;
553
- <T_1 = undefined>(name: string): T_1 | undefined;
554
- } & {
555
- <T_2 = undefined>(name: string, defaultValue: T_2): T_2;
556
- <T_3 = undefined>(name: string): T_3 | undefined;
557
- } & {
558
- <T_4 = undefined>(name: string, defaultValue: T_4): T_4;
559
- <T_5 = undefined>(name: string): T_5 | undefined;
560
- } & {
561
- <T_6 = undefined>(name: string, defaultValue: T_6): T_6;
562
- <T_7 = undefined>(name: string): T_7 | undefined;
563
- } & {
564
- <T_8 = undefined>(name: string, defaultValue: T_8): T_8;
565
- <T_9 = undefined>(name: string): T_9 | undefined;
566
- };
567
- setProp: ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void);
568
- unsetProp: ((name: string) => void) & ((name: string) => void) & ((name: string) => void) & ((name: string) => void) & ((name: string) => void);
569
- setProps: ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any);
570
- toJSONSafe: ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
571
- toJSONQuick: ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
572
- clone: ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any);
573
- validate: (() => void) & (() => void) & (() => void) & (() => void) & (() => void);
574
- clean: ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
575
- isValid: (() => boolean) & (() => boolean) & (() => boolean) & (() => boolean) & (() => boolean);
576
- readonly cls: string;
577
- getClsName: (() => string) & (() => string) & (() => string) & (() => string) & (() => string);
578
- getAsEntityReference: {
579
- (byIdOnly: true): {
580
- _id: string;
581
- };
582
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
583
- } & {
584
- (byIdOnly: true): {
585
- _id: string;
586
- };
587
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
588
- } & {
589
- (byIdOnly: true): {
590
- _id: string;
591
- };
592
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
593
- } & {
594
- (byIdOnly: true): {
595
- _id: string;
596
- };
597
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
598
- } & {
599
- (byIdOnly: true): {
600
- _id: string;
601
- };
602
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
603
- };
604
- getEntityByName: ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity);
605
- id: string;
606
- _id: string;
607
- schemaVersion: string;
608
- systemName: string;
609
- readonly slug: string;
610
- readonly isSystemEntity: boolean;
611
- metadata: object;
612
- updateMetadata(object: object): void;
613
- name: string;
614
- setName(name: string): void;
615
- readonly isDefault: boolean;
616
- };
617
- readonly defaultConfig: {
618
- name: string;
619
- basis: {
620
- elements: {
621
- id: number;
622
- value: string;
623
- }[];
624
- coordinates: {
625
- id: number;
626
- value: number[];
627
- }[];
628
- units: string;
629
- };
630
- lattice: {
631
- type: string;
632
- a: number;
633
- b: number;
634
- c: number;
635
- alpha: number;
636
- beta: number;
637
- gamma: number;
638
- units: {
639
- length: string;
640
- angle: string;
641
- };
642
- };
643
- };
644
- constructMaterialFileSource(fileName: string, fileContent: string, fileExtension: string): import("@mat3ra/esse/dist/js/types").FileSourceSchema;
645
- } & (new (...args: any[]) => {
646
- consistencyChecks: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
647
- addConsistencyChecks(array: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[]): void;
648
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
649
- prop<T = undefined>(name: string, defaultValue: T): T;
650
- prop<T_1 = undefined>(name: string): T_1 | undefined;
651
- setProp(name: string, value: unknown): void;
652
- unsetProp(name: string): void;
653
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
654
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
655
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
656
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
657
- clone(extraContext?: object | undefined): any;
658
- validate(): void;
659
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
660
- isValid(): boolean;
661
- readonly cls: string;
662
- getClsName(): string;
663
- getAsEntityReference(byIdOnly: true): {
664
- _id: string;
665
- };
666
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
667
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
668
- id: string;
669
- _id: string;
670
- schemaVersion: string;
671
- systemName: string;
672
- readonly slug: string;
673
- readonly isSystemEntity: boolean;
674
- }) & (new (...args: any[]) => {
675
- metadata: object;
676
- updateMetadata(object: object): void;
677
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
678
- prop<T_2 = undefined>(name: string, defaultValue: T_2): T_2;
679
- prop<T_3 = undefined>(name: string): T_3 | undefined;
680
- setProp(name: string, value: unknown): void;
681
- unsetProp(name: string): void;
682
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
683
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
684
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
685
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
686
- clone(extraContext?: object | undefined): any;
687
- validate(): void;
688
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
689
- isValid(): boolean;
690
- readonly cls: string;
691
- getClsName(): string;
692
- getAsEntityReference(byIdOnly: true): {
693
- _id: string;
694
- };
695
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
696
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
697
- id: string;
698
- _id: string;
699
- schemaVersion: string;
700
- systemName: string;
701
- readonly slug: string;
702
- readonly isSystemEntity: boolean;
703
- }) & (new (...args: any[]) => {
704
- name: string;
705
- setName(name: string): void;
706
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
707
- prop<T_4 = undefined>(name: string, defaultValue: T_4): T_4;
708
- prop<T_5 = undefined>(name: string): T_5 | undefined;
709
- setProp(name: string, value: unknown): void;
710
- unsetProp(name: string): void;
711
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
712
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
713
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
714
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
715
- clone(extraContext?: object | undefined): any;
716
- validate(): void;
717
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
718
- isValid(): boolean;
719
- readonly cls: string;
720
- getClsName(): string;
721
- getAsEntityReference(byIdOnly: true): {
722
- _id: string;
723
- };
724
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
725
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
726
- id: string;
727
- _id: string;
728
- schemaVersion: string;
729
- systemName: string;
730
- readonly slug: string;
731
- readonly isSystemEntity: boolean;
732
- }) & {
733
- new (...args: any[]): {
734
- readonly isDefault: boolean;
735
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
736
- prop<T_6 = undefined>(name: string, defaultValue: T_6): T_6;
737
- prop<T_7 = undefined>(name: string): T_7 | undefined;
738
- setProp(name: string, value: unknown): void;
739
- unsetProp(name: string): void;
740
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
741
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
742
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
743
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
744
- clone(extraContext?: object | undefined): any;
745
- validate(): void;
746
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
747
- isValid(): boolean;
748
- readonly cls: string;
749
- getClsName(): string;
750
- getAsEntityReference(byIdOnly: true): {
751
- _id: string;
752
- };
753
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
754
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
755
- id: string;
756
- _id: string;
757
- schemaVersion: string;
758
- systemName: string;
759
- readonly slug: string;
760
- readonly isSystemEntity: boolean;
761
- };
762
- readonly defaultConfig: object | null;
763
- createDefault(): any;
764
- } & typeof import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
765
- MaterialMixin: typeof MaterialMixin;
766
- defaultMaterialConfig: {
767
- name: string;
768
- basis: {
769
- elements: {
770
- id: number;
771
- value: string;
772
- }[];
773
- coordinates: {
774
- id: number;
775
- value: number[];
776
- }[];
777
- units: string;
778
- };
779
- lattice: {
780
- type: string;
781
- a: number;
782
- b: number;
783
- c: number;
784
- alpha: number;
785
- beta: number;
786
- gamma: number;
787
- units: {
788
- length: string;
789
- angle: string;
790
- };
791
- };
792
- };
487
+ Material: typeof Material;
488
+ defaultMaterialConfig: import("@mat3ra/esse/dist/js/types").MaterialSchema;
793
489
  Lattice: typeof Lattice;
794
490
  nonPeriodicLatticeScalingFactor: number;
795
491
  ReciprocalLattice: typeof ReciprocalLattice;
@@ -823,250 +519,7 @@ export declare const Made: {
823
519
  };
824
520
  tools: {
825
521
  surface: {
826
- generateConfig: (material: {
827
- _json: import("./material").MaterialSchemaJSON;
828
- toJSON(): import("./types").MaterialJSON;
829
- src: import("@mat3ra/esse/dist/js/types").FileSourceSchema | undefined;
830
- updateFormula(): void;
831
- isNonPeriodic: boolean;
832
- getDerivedPropertyByName(name: string): {
833
- name?: "volume" | undefined;
834
- units?: "angstrom^3" | undefined;
835
- value: number;
836
- } | {
837
- name?: "density" | undefined;
838
- units?: "g/cm^3" | undefined;
839
- value: number;
840
- } | {
841
- pointGroupSymbol?: string | undefined;
842
- spaceGroupSymbol?: string | undefined;
843
- tolerance?: {
844
- units?: "angstrom" | undefined;
845
- value: number;
846
- } | undefined;
847
- name?: "symmetry" | undefined;
848
- } | {
849
- name?: "elemental_ratio" | undefined;
850
- value: number;
851
- element?: string | undefined;
852
- } | {
853
- name?: "p-norm" | undefined;
854
- degree?: number | undefined;
855
- value: number;
856
- } | {
857
- name?: "inchi" | undefined;
858
- value: string;
859
- } | {
860
- name?: "inchi_key" | undefined;
861
- value: string;
862
- } | undefined;
863
- getDerivedProperties(): import("@mat3ra/esse/dist/js/types").DerivedPropertiesSchema;
864
- readonly formula: string;
865
- readonly unitCellFormula: string;
866
- unsetFileProps(): void;
867
- setBasis(textOrObject: string | import("./basis/basis").BasisConfig, format?: string | undefined, unitz?: string | undefined): void;
868
- setBasisConstraints(constraints: import("./constraints/constraints").Constraint[]): void;
869
- setBasisConstraintsFromArrayOfObjects(constraints: import("@mat3ra/esse/dist/js/types").AtomicConstraintsSchema): void;
870
- readonly basis: import("./material").OptionallyConstrainedBasisConfig;
871
- readonly Basis: import("./basis/constrained_basis").ConstrainedBasis;
872
- readonly uniqueElements: string[];
873
- lattice: import("@mat3ra/esse/dist/js/types").LatticeSchema;
874
- readonly Lattice: Lattice;
875
- getInchiStringForHash(): string;
876
- calculateHash(salt?: string, isScaled?: boolean, bypassNonPeriodicCheck?: boolean): string;
877
- hash: string;
878
- readonly scaledHash: string;
879
- toCrystal(): void;
880
- toCartesian(): void;
881
- getBasisAsXyz(fractional?: boolean): string;
882
- getAsQEFormat(): string;
883
- getAsPOSCAR(ignoreOriginal?: boolean, omitConstraints?: boolean): string;
884
- getACopyWithConventionalCell(): any;
885
- getConsistencyChecks(): import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
886
- getBasisConsistencyChecks(): import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
887
- consistencyChecks: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
888
- addConsistencyChecks(array: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[]): void;
889
- prop: {
890
- <T = undefined>(name: string, defaultValue: T): T;
891
- <T_1 = undefined>(name: string): T_1 | undefined;
892
- } & {
893
- <T_2 = undefined>(name: string, defaultValue: T_2): T_2;
894
- <T_3 = undefined>(name: string): T_3 | undefined;
895
- } & {
896
- <T_4 = undefined>(name: string, defaultValue: T_4): T_4;
897
- <T_5 = undefined>(name: string): T_5 | undefined;
898
- } & {
899
- <T_6 = undefined>(name: string, defaultValue: T_6): T_6;
900
- <T_7 = undefined>(name: string): T_7 | undefined;
901
- } & {
902
- <T_8 = undefined>(name: string, defaultValue: T_8): T_8;
903
- <T_9 = undefined>(name: string): T_9 | undefined;
904
- };
905
- setProp: ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void);
906
- unsetProp: ((name: string) => void) & ((name: string) => void) & ((name: string) => void) & ((name: string) => void) & ((name: string) => void);
907
- setProps: ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any);
908
- toJSONSafe: ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
909
- toJSONQuick: ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
910
- clone: ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any);
911
- validate: (() => void) & (() => void) & (() => void) & (() => void) & (() => void);
912
- clean: ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
913
- isValid: (() => boolean) & (() => boolean) & (() => boolean) & (() => boolean) & (() => boolean);
914
- readonly cls: string;
915
- getClsName: (() => string) & (() => string) & (() => string) & (() => string) & (() => string);
916
- getAsEntityReference: {
917
- (byIdOnly: true): {
918
- _id: string;
919
- };
920
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
921
- } & {
922
- (byIdOnly: true): {
923
- _id: string;
924
- };
925
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
926
- } & {
927
- (byIdOnly: true): {
928
- _id: string;
929
- };
930
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
931
- } & {
932
- (byIdOnly: true): {
933
- _id: string;
934
- };
935
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
936
- } & {
937
- (byIdOnly: true): {
938
- _id: string;
939
- };
940
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
941
- };
942
- getEntityByName: ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity);
943
- id: string;
944
- _id: string;
945
- schemaVersion: string;
946
- systemName: string;
947
- readonly slug: string;
948
- readonly isSystemEntity: boolean;
949
- metadata: object;
950
- updateMetadata(object: object): void;
951
- name: string;
952
- setName(name: string): void;
953
- readonly isDefault: boolean;
954
- } & {
955
- consistencyChecks: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
956
- addConsistencyChecks(array: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[]): void;
957
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
958
- prop<T = undefined>(name: string, defaultValue: T): T;
959
- prop<T_1 = undefined>(name: string): T_1 | undefined;
960
- setProp(name: string, value: unknown): void;
961
- unsetProp(name: string): void;
962
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
963
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
964
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
965
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
966
- clone(extraContext?: object | undefined): any;
967
- validate(): void;
968
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
969
- isValid(): boolean;
970
- readonly cls: string;
971
- getClsName(): string;
972
- getAsEntityReference(byIdOnly: true): {
973
- _id: string;
974
- };
975
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
976
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
977
- id: string;
978
- _id: string;
979
- schemaVersion: string;
980
- systemName: string;
981
- readonly slug: string;
982
- readonly isSystemEntity: boolean;
983
- } & {
984
- metadata: object;
985
- updateMetadata(object: object): void;
986
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
987
- prop<T_2 = undefined>(name: string, defaultValue: T_2): T_2;
988
- prop<T_3 = undefined>(name: string): T_3 | undefined;
989
- setProp(name: string, value: unknown): void;
990
- unsetProp(name: string): void;
991
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
992
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
993
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
994
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
995
- clone(extraContext?: object | undefined): any;
996
- validate(): void;
997
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
998
- isValid(): boolean;
999
- readonly cls: string;
1000
- getClsName(): string;
1001
- getAsEntityReference(byIdOnly: true): {
1002
- _id: string;
1003
- };
1004
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1005
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1006
- id: string;
1007
- _id: string;
1008
- schemaVersion: string;
1009
- systemName: string;
1010
- readonly slug: string;
1011
- readonly isSystemEntity: boolean;
1012
- } & {
1013
- name: string;
1014
- setName(name: string): void;
1015
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1016
- prop<T_4 = undefined>(name: string, defaultValue: T_4): T_4;
1017
- prop<T_5 = undefined>(name: string): T_5 | undefined;
1018
- setProp(name: string, value: unknown): void;
1019
- unsetProp(name: string): void;
1020
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1021
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1022
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1023
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1024
- clone(extraContext?: object | undefined): any;
1025
- validate(): void;
1026
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1027
- isValid(): boolean;
1028
- readonly cls: string;
1029
- getClsName(): string;
1030
- getAsEntityReference(byIdOnly: true): {
1031
- _id: string;
1032
- };
1033
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1034
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1035
- id: string;
1036
- _id: string;
1037
- schemaVersion: string;
1038
- systemName: string;
1039
- readonly slug: string;
1040
- readonly isSystemEntity: boolean;
1041
- } & {
1042
- readonly isDefault: boolean;
1043
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1044
- prop<T_6 = undefined>(name: string, defaultValue: T_6): T_6;
1045
- prop<T_7 = undefined>(name: string): T_7 | undefined;
1046
- setProp(name: string, value: unknown): void;
1047
- unsetProp(name: string): void;
1048
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1049
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1050
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1051
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1052
- clone(extraContext?: object | undefined): any;
1053
- validate(): void;
1054
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1055
- isValid(): boolean;
1056
- readonly cls: string;
1057
- getClsName(): string;
1058
- getAsEntityReference(byIdOnly: true): {
1059
- _id: string;
1060
- };
1061
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1062
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1063
- id: string;
1064
- _id: string;
1065
- schemaVersion: string;
1066
- systemName: string;
1067
- readonly slug: string;
1068
- readonly isSystemEntity: boolean;
1069
- } & import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity, millerIndices: import("@mat3ra/esse/dist/js/types").Coordinate3DSchema, numberOfLayers?: number, vx?: number, vy?: number) => import("./tools/surface").SlabConfigSchema;
522
+ generateConfig: (material: Material, millerIndices: import("@mat3ra/esse/dist/js/types").Coordinate3DSchema, numberOfLayers?: number, vx?: number, vy?: number) => import("./tools/surface").SlabConfigSchema;
1070
523
  };
1071
524
  supercell: {
1072
525
  generateConfig: (material: import("./types").MaterialInterface, supercellMatrix: import("@mat3ra/esse/dist/js/types").Matrix3X3Schema) => {
@@ -1077,738 +530,9 @@ export declare const Made: {
1077
530
  generateNewBasisWithinSupercell: (basis: Basis | import("./basis/constrained_basis").ConstrainedBasis, cell: import("./cell/cell").Cell, supercell: import("./cell/cell").Cell, supercellMatrix: import("@mat3ra/esse/dist/js/types").Matrix3X3Schema) => Basis;
1078
531
  };
1079
532
  material: {
1080
- scaleOneLatticeVector: (material: {
1081
- _json: import("./material").MaterialSchemaJSON;
1082
- toJSON(): import("./types").MaterialJSON;
1083
- src: import("@mat3ra/esse/dist/js/types").FileSourceSchema | undefined;
1084
- updateFormula(): void;
1085
- isNonPeriodic: boolean;
1086
- getDerivedPropertyByName(name: string): {
1087
- name?: "volume" | undefined;
1088
- units?: "angstrom^3" | undefined;
1089
- value: number;
1090
- } | {
1091
- name?: "density" | undefined;
1092
- units?: "g/cm^3" | undefined;
1093
- value: number;
1094
- } | {
1095
- pointGroupSymbol?: string | undefined;
1096
- spaceGroupSymbol?: string | undefined;
1097
- tolerance?: {
1098
- units?: "angstrom" | undefined;
1099
- value: number;
1100
- } | undefined;
1101
- name?: "symmetry" | undefined;
1102
- } | {
1103
- name?: "elemental_ratio" | undefined;
1104
- value: number;
1105
- element?: string | undefined;
1106
- } | {
1107
- name?: "p-norm" | undefined;
1108
- degree?: number | undefined;
1109
- value: number;
1110
- } | {
1111
- name?: "inchi" | undefined;
1112
- value: string;
1113
- } | {
1114
- name?: "inchi_key" | undefined;
1115
- value: string;
1116
- } | undefined;
1117
- getDerivedProperties(): import("@mat3ra/esse/dist/js/types").DerivedPropertiesSchema;
1118
- readonly formula: string;
1119
- readonly unitCellFormula: string;
1120
- unsetFileProps(): void;
1121
- setBasis(textOrObject: string | import("./basis/basis").BasisConfig, format?: string | undefined, unitz?: string | undefined): void;
1122
- setBasisConstraints(constraints: import("./constraints/constraints").Constraint[]): void;
1123
- setBasisConstraintsFromArrayOfObjects(constraints: import("@mat3ra/esse/dist/js/types").AtomicConstraintsSchema): void;
1124
- readonly basis: import("./material").OptionallyConstrainedBasisConfig;
1125
- readonly Basis: import("./basis/constrained_basis").ConstrainedBasis;
1126
- readonly uniqueElements: string[];
1127
- lattice: import("@mat3ra/esse/dist/js/types").LatticeSchema;
1128
- readonly Lattice: Lattice;
1129
- getInchiStringForHash(): string;
1130
- calculateHash(salt?: string, isScaled?: boolean, bypassNonPeriodicCheck?: boolean): string;
1131
- hash: string;
1132
- readonly scaledHash: string;
1133
- toCrystal(): void;
1134
- toCartesian(): void;
1135
- getBasisAsXyz(fractional?: boolean): string;
1136
- getAsQEFormat(): string;
1137
- getAsPOSCAR(ignoreOriginal?: boolean, omitConstraints?: boolean): string;
1138
- getACopyWithConventionalCell(): any;
1139
- getConsistencyChecks(): import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
1140
- getBasisConsistencyChecks(): import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
1141
- consistencyChecks: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
1142
- addConsistencyChecks(array: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[]): void;
1143
- prop: {
1144
- <T = undefined>(name: string, defaultValue: T): T;
1145
- <T_1 = undefined>(name: string): T_1 | undefined;
1146
- } & {
1147
- <T_2 = undefined>(name: string, defaultValue: T_2): T_2;
1148
- <T_3 = undefined>(name: string): T_3 | undefined;
1149
- } & {
1150
- <T_4 = undefined>(name: string, defaultValue: T_4): T_4;
1151
- <T_5 = undefined>(name: string): T_5 | undefined;
1152
- } & {
1153
- <T_6 = undefined>(name: string, defaultValue: T_6): T_6;
1154
- <T_7 = undefined>(name: string): T_7 | undefined;
1155
- } & {
1156
- <T_8 = undefined>(name: string, defaultValue: T_8): T_8;
1157
- <T_9 = undefined>(name: string): T_9 | undefined;
1158
- };
1159
- setProp: ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void);
1160
- unsetProp: ((name: string) => void) & ((name: string) => void) & ((name: string) => void) & ((name: string) => void) & ((name: string) => void);
1161
- setProps: ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any);
1162
- toJSONSafe: ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
1163
- toJSONQuick: ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
1164
- clone: ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any);
1165
- validate: (() => void) & (() => void) & (() => void) & (() => void) & (() => void);
1166
- clean: ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
1167
- isValid: (() => boolean) & (() => boolean) & (() => boolean) & (() => boolean) & (() => boolean);
1168
- readonly cls: string;
1169
- getClsName: (() => string) & (() => string) & (() => string) & (() => string) & (() => string);
1170
- getAsEntityReference: {
1171
- (byIdOnly: true): {
1172
- _id: string;
1173
- };
1174
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1175
- } & {
1176
- (byIdOnly: true): {
1177
- _id: string;
1178
- };
1179
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1180
- } & {
1181
- (byIdOnly: true): {
1182
- _id: string;
1183
- };
1184
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1185
- } & {
1186
- (byIdOnly: true): {
1187
- _id: string;
1188
- };
1189
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1190
- } & {
1191
- (byIdOnly: true): {
1192
- _id: string;
1193
- };
1194
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1195
- };
1196
- getEntityByName: ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity);
1197
- id: string;
1198
- _id: string;
1199
- schemaVersion: string;
1200
- systemName: string;
1201
- readonly slug: string;
1202
- readonly isSystemEntity: boolean;
1203
- metadata: object;
1204
- updateMetadata(object: object): void;
1205
- name: string;
1206
- setName(name: string): void;
1207
- readonly isDefault: boolean;
1208
- } & {
1209
- consistencyChecks: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
1210
- addConsistencyChecks(array: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[]): void;
1211
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1212
- prop<T = undefined>(name: string, defaultValue: T): T;
1213
- prop<T_1 = undefined>(name: string): T_1 | undefined;
1214
- setProp(name: string, value: unknown): void;
1215
- unsetProp(name: string): void;
1216
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1217
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1218
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1219
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1220
- clone(extraContext?: object | undefined): any;
1221
- validate(): void;
1222
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1223
- isValid(): boolean;
1224
- readonly cls: string;
1225
- getClsName(): string;
1226
- getAsEntityReference(byIdOnly: true): {
1227
- _id: string;
1228
- };
1229
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1230
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1231
- id: string;
1232
- _id: string;
1233
- schemaVersion: string;
1234
- systemName: string;
1235
- readonly slug: string;
1236
- readonly isSystemEntity: boolean;
1237
- } & {
1238
- metadata: object;
1239
- updateMetadata(object: object): void;
1240
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1241
- prop<T_2 = undefined>(name: string, defaultValue: T_2): T_2;
1242
- prop<T_3 = undefined>(name: string): T_3 | undefined;
1243
- setProp(name: string, value: unknown): void;
1244
- unsetProp(name: string): void;
1245
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1246
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1247
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1248
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1249
- clone(extraContext?: object | undefined): any;
1250
- validate(): void;
1251
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1252
- isValid(): boolean;
1253
- readonly cls: string;
1254
- getClsName(): string;
1255
- getAsEntityReference(byIdOnly: true): {
1256
- _id: string;
1257
- };
1258
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1259
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1260
- id: string;
1261
- _id: string;
1262
- schemaVersion: string;
1263
- systemName: string;
1264
- readonly slug: string;
1265
- readonly isSystemEntity: boolean;
1266
- } & {
1267
- name: string;
1268
- setName(name: string): void;
1269
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1270
- prop<T_4 = undefined>(name: string, defaultValue: T_4): T_4;
1271
- prop<T_5 = undefined>(name: string): T_5 | undefined;
1272
- setProp(name: string, value: unknown): void;
1273
- unsetProp(name: string): void;
1274
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1275
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1276
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1277
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1278
- clone(extraContext?: object | undefined): any;
1279
- validate(): void;
1280
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1281
- isValid(): boolean;
1282
- readonly cls: string;
1283
- getClsName(): string;
1284
- getAsEntityReference(byIdOnly: true): {
1285
- _id: string;
1286
- };
1287
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1288
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1289
- id: string;
1290
- _id: string;
1291
- schemaVersion: string;
1292
- systemName: string;
1293
- readonly slug: string;
1294
- readonly isSystemEntity: boolean;
1295
- } & {
1296
- readonly isDefault: boolean;
1297
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1298
- prop<T_6 = undefined>(name: string, defaultValue: T_6): T_6;
1299
- prop<T_7 = undefined>(name: string): T_7 | undefined;
1300
- setProp(name: string, value: unknown): void;
1301
- unsetProp(name: string): void;
1302
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1303
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1304
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1305
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1306
- clone(extraContext?: object | undefined): any;
1307
- validate(): void;
1308
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1309
- isValid(): boolean;
1310
- readonly cls: string;
1311
- getClsName(): string;
1312
- getAsEntityReference(byIdOnly: true): {
1313
- _id: string;
1314
- };
1315
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1316
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1317
- id: string;
1318
- _id: string;
1319
- schemaVersion: string;
1320
- systemName: string;
1321
- readonly slug: string;
1322
- readonly isSystemEntity: boolean;
1323
- } & import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity, key?: "a" | "b" | "c", factor?: number) => void;
1324
- scaleLatticeToMakeNonPeriodic: (material: {
1325
- _json: import("./material").MaterialSchemaJSON;
1326
- toJSON(): import("./types").MaterialJSON;
1327
- src: import("@mat3ra/esse/dist/js/types").FileSourceSchema | undefined;
1328
- updateFormula(): void;
1329
- isNonPeriodic: boolean;
1330
- getDerivedPropertyByName(name: string): {
1331
- name?: "volume" | undefined;
1332
- units?: "angstrom^3" | undefined;
1333
- value: number;
1334
- } | {
1335
- name?: "density" | undefined;
1336
- units?: "g/cm^3" | undefined;
1337
- value: number;
1338
- } | {
1339
- pointGroupSymbol?: string | undefined;
1340
- spaceGroupSymbol?: string | undefined;
1341
- tolerance?: {
1342
- units?: "angstrom" | undefined;
1343
- value: number;
1344
- } | undefined;
1345
- name?: "symmetry" | undefined;
1346
- } | {
1347
- name?: "elemental_ratio" | undefined;
1348
- value: number;
1349
- element?: string | undefined;
1350
- } | {
1351
- name?: "p-norm" | undefined;
1352
- degree?: number | undefined;
1353
- value: number;
1354
- } | {
1355
- name?: "inchi" | undefined;
1356
- value: string;
1357
- } | {
1358
- name?: "inchi_key" | undefined;
1359
- value: string;
1360
- } | undefined;
1361
- getDerivedProperties(): import("@mat3ra/esse/dist/js/types").DerivedPropertiesSchema;
1362
- readonly formula: string;
1363
- readonly unitCellFormula: string;
1364
- unsetFileProps(): void;
1365
- setBasis(textOrObject: string | import("./basis/basis").BasisConfig, format?: string | undefined, unitz?: string | undefined): void;
1366
- setBasisConstraints(constraints: import("./constraints/constraints").Constraint[]): void;
1367
- setBasisConstraintsFromArrayOfObjects(constraints: import("@mat3ra/esse/dist/js/types").AtomicConstraintsSchema): void;
1368
- readonly basis: import("./material").OptionallyConstrainedBasisConfig;
1369
- readonly Basis: import("./basis/constrained_basis").ConstrainedBasis;
1370
- readonly uniqueElements: string[];
1371
- lattice: import("@mat3ra/esse/dist/js/types").LatticeSchema;
1372
- readonly Lattice: Lattice;
1373
- getInchiStringForHash(): string;
1374
- calculateHash(salt?: string, isScaled?: boolean, bypassNonPeriodicCheck?: boolean): string;
1375
- hash: string;
1376
- readonly scaledHash: string;
1377
- toCrystal(): void;
1378
- toCartesian(): void;
1379
- getBasisAsXyz(fractional?: boolean): string;
1380
- getAsQEFormat(): string;
1381
- getAsPOSCAR(ignoreOriginal?: boolean, omitConstraints?: boolean): string;
1382
- getACopyWithConventionalCell(): any;
1383
- getConsistencyChecks(): import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
1384
- getBasisConsistencyChecks(): import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
1385
- consistencyChecks: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
1386
- addConsistencyChecks(array: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[]): void;
1387
- prop: {
1388
- <T = undefined>(name: string, defaultValue: T): T;
1389
- <T_1 = undefined>(name: string): T_1 | undefined;
1390
- } & {
1391
- <T_2 = undefined>(name: string, defaultValue: T_2): T_2;
1392
- <T_3 = undefined>(name: string): T_3 | undefined;
1393
- } & {
1394
- <T_4 = undefined>(name: string, defaultValue: T_4): T_4;
1395
- <T_5 = undefined>(name: string): T_5 | undefined;
1396
- } & {
1397
- <T_6 = undefined>(name: string, defaultValue: T_6): T_6;
1398
- <T_7 = undefined>(name: string): T_7 | undefined;
1399
- } & {
1400
- <T_8 = undefined>(name: string, defaultValue: T_8): T_8;
1401
- <T_9 = undefined>(name: string): T_9 | undefined;
1402
- };
1403
- setProp: ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void);
1404
- unsetProp: ((name: string) => void) & ((name: string) => void) & ((name: string) => void) & ((name: string) => void) & ((name: string) => void);
1405
- setProps: ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any);
1406
- toJSONSafe: ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
1407
- toJSONQuick: ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
1408
- clone: ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any);
1409
- validate: (() => void) & (() => void) & (() => void) & (() => void) & (() => void);
1410
- clean: ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
1411
- isValid: (() => boolean) & (() => boolean) & (() => boolean) & (() => boolean) & (() => boolean);
1412
- readonly cls: string;
1413
- getClsName: (() => string) & (() => string) & (() => string) & (() => string) & (() => string);
1414
- getAsEntityReference: {
1415
- (byIdOnly: true): {
1416
- _id: string;
1417
- };
1418
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1419
- } & {
1420
- (byIdOnly: true): {
1421
- _id: string;
1422
- };
1423
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1424
- } & {
1425
- (byIdOnly: true): {
1426
- _id: string;
1427
- };
1428
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1429
- } & {
1430
- (byIdOnly: true): {
1431
- _id: string;
1432
- };
1433
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1434
- } & {
1435
- (byIdOnly: true): {
1436
- _id: string;
1437
- };
1438
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1439
- };
1440
- getEntityByName: ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity);
1441
- id: string;
1442
- _id: string;
1443
- schemaVersion: string;
1444
- systemName: string;
1445
- readonly slug: string;
1446
- readonly isSystemEntity: boolean;
1447
- metadata: object;
1448
- updateMetadata(object: object): void;
1449
- name: string;
1450
- setName(name: string): void;
1451
- readonly isDefault: boolean;
1452
- } & {
1453
- consistencyChecks: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
1454
- addConsistencyChecks(array: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[]): void;
1455
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1456
- prop<T = undefined>(name: string, defaultValue: T): T;
1457
- prop<T_1 = undefined>(name: string): T_1 | undefined;
1458
- setProp(name: string, value: unknown): void;
1459
- unsetProp(name: string): void;
1460
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1461
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1462
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1463
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1464
- clone(extraContext?: object | undefined): any;
1465
- validate(): void;
1466
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1467
- isValid(): boolean;
1468
- readonly cls: string;
1469
- getClsName(): string;
1470
- getAsEntityReference(byIdOnly: true): {
1471
- _id: string;
1472
- };
1473
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1474
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1475
- id: string;
1476
- _id: string;
1477
- schemaVersion: string;
1478
- systemName: string;
1479
- readonly slug: string;
1480
- readonly isSystemEntity: boolean;
1481
- } & {
1482
- metadata: object;
1483
- updateMetadata(object: object): void;
1484
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1485
- prop<T_2 = undefined>(name: string, defaultValue: T_2): T_2;
1486
- prop<T_3 = undefined>(name: string): T_3 | undefined;
1487
- setProp(name: string, value: unknown): void;
1488
- unsetProp(name: string): void;
1489
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1490
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1491
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1492
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1493
- clone(extraContext?: object | undefined): any;
1494
- validate(): void;
1495
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1496
- isValid(): boolean;
1497
- readonly cls: string;
1498
- getClsName(): string;
1499
- getAsEntityReference(byIdOnly: true): {
1500
- _id: string;
1501
- };
1502
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1503
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1504
- id: string;
1505
- _id: string;
1506
- schemaVersion: string;
1507
- systemName: string;
1508
- readonly slug: string;
1509
- readonly isSystemEntity: boolean;
1510
- } & {
1511
- name: string;
1512
- setName(name: string): void;
1513
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1514
- prop<T_4 = undefined>(name: string, defaultValue: T_4): T_4;
1515
- prop<T_5 = undefined>(name: string): T_5 | undefined;
1516
- setProp(name: string, value: unknown): void;
1517
- unsetProp(name: string): void;
1518
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1519
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1520
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1521
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1522
- clone(extraContext?: object | undefined): any;
1523
- validate(): void;
1524
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1525
- isValid(): boolean;
1526
- readonly cls: string;
1527
- getClsName(): string;
1528
- getAsEntityReference(byIdOnly: true): {
1529
- _id: string;
1530
- };
1531
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1532
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1533
- id: string;
1534
- _id: string;
1535
- schemaVersion: string;
1536
- systemName: string;
1537
- readonly slug: string;
1538
- readonly isSystemEntity: boolean;
1539
- } & {
1540
- readonly isDefault: boolean;
1541
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1542
- prop<T_6 = undefined>(name: string, defaultValue: T_6): T_6;
1543
- prop<T_7 = undefined>(name: string): T_7 | undefined;
1544
- setProp(name: string, value: unknown): void;
1545
- unsetProp(name: string): void;
1546
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1547
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1548
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1549
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1550
- clone(extraContext?: object | undefined): any;
1551
- validate(): void;
1552
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1553
- isValid(): boolean;
1554
- readonly cls: string;
1555
- getClsName(): string;
1556
- getAsEntityReference(byIdOnly: true): {
1557
- _id: string;
1558
- };
1559
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1560
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1561
- id: string;
1562
- _id: string;
1563
- schemaVersion: string;
1564
- systemName: string;
1565
- readonly slug: string;
1566
- readonly isSystemEntity: boolean;
1567
- } & import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) => void;
1568
- translateAtomsToCenter: (material: {
1569
- _json: import("./material").MaterialSchemaJSON;
1570
- toJSON(): import("./types").MaterialJSON;
1571
- src: import("@mat3ra/esse/dist/js/types").FileSourceSchema | undefined;
1572
- updateFormula(): void;
1573
- isNonPeriodic: boolean;
1574
- getDerivedPropertyByName(name: string): {
1575
- name?: "volume" | undefined;
1576
- units?: "angstrom^3" | undefined;
1577
- value: number;
1578
- } | {
1579
- name?: "density" | undefined;
1580
- units?: "g/cm^3" | undefined;
1581
- value: number;
1582
- } | {
1583
- pointGroupSymbol?: string | undefined;
1584
- spaceGroupSymbol?: string | undefined;
1585
- tolerance?: {
1586
- units?: "angstrom" | undefined;
1587
- value: number;
1588
- } | undefined;
1589
- name?: "symmetry" | undefined;
1590
- } | {
1591
- name?: "elemental_ratio" | undefined;
1592
- value: number;
1593
- element?: string | undefined;
1594
- } | {
1595
- name?: "p-norm" | undefined;
1596
- degree?: number | undefined;
1597
- value: number;
1598
- } | {
1599
- name?: "inchi" | undefined;
1600
- value: string;
1601
- } | {
1602
- name?: "inchi_key" | undefined;
1603
- value: string;
1604
- } | undefined;
1605
- getDerivedProperties(): import("@mat3ra/esse/dist/js/types").DerivedPropertiesSchema;
1606
- readonly formula: string;
1607
- readonly unitCellFormula: string;
1608
- unsetFileProps(): void;
1609
- setBasis(textOrObject: string | import("./basis/basis").BasisConfig, format?: string | undefined, unitz?: string | undefined): void;
1610
- setBasisConstraints(constraints: import("./constraints/constraints").Constraint[]): void;
1611
- setBasisConstraintsFromArrayOfObjects(constraints: import("@mat3ra/esse/dist/js/types").AtomicConstraintsSchema): void;
1612
- readonly basis: import("./material").OptionallyConstrainedBasisConfig;
1613
- readonly Basis: import("./basis/constrained_basis").ConstrainedBasis;
1614
- readonly uniqueElements: string[];
1615
- lattice: import("@mat3ra/esse/dist/js/types").LatticeSchema;
1616
- readonly Lattice: Lattice;
1617
- getInchiStringForHash(): string;
1618
- calculateHash(salt?: string, isScaled?: boolean, bypassNonPeriodicCheck?: boolean): string;
1619
- hash: string;
1620
- readonly scaledHash: string;
1621
- toCrystal(): void;
1622
- toCartesian(): void;
1623
- getBasisAsXyz(fractional?: boolean): string;
1624
- getAsQEFormat(): string;
1625
- getAsPOSCAR(ignoreOriginal?: boolean, omitConstraints?: boolean): string;
1626
- getACopyWithConventionalCell(): any;
1627
- getConsistencyChecks(): import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
1628
- getBasisConsistencyChecks(): import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
1629
- consistencyChecks: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
1630
- addConsistencyChecks(array: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[]): void;
1631
- prop: {
1632
- <T = undefined>(name: string, defaultValue: T): T;
1633
- <T_1 = undefined>(name: string): T_1 | undefined;
1634
- } & {
1635
- <T_2 = undefined>(name: string, defaultValue: T_2): T_2;
1636
- <T_3 = undefined>(name: string): T_3 | undefined;
1637
- } & {
1638
- <T_4 = undefined>(name: string, defaultValue: T_4): T_4;
1639
- <T_5 = undefined>(name: string): T_5 | undefined;
1640
- } & {
1641
- <T_6 = undefined>(name: string, defaultValue: T_6): T_6;
1642
- <T_7 = undefined>(name: string): T_7 | undefined;
1643
- } & {
1644
- <T_8 = undefined>(name: string, defaultValue: T_8): T_8;
1645
- <T_9 = undefined>(name: string): T_9 | undefined;
1646
- };
1647
- setProp: ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void) & ((name: string, value: unknown) => void);
1648
- unsetProp: ((name: string) => void) & ((name: string) => void) & ((name: string) => void) & ((name: string) => void) & ((name: string) => void);
1649
- setProps: ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any) & ((json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined) => any);
1650
- toJSONSafe: ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
1651
- toJSONQuick: ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((exclude?: string[] | undefined) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
1652
- clone: ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any) & ((extraContext?: object | undefined) => any);
1653
- validate: (() => void) & (() => void) & (() => void) & (() => void) & (() => void);
1654
- clean: ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject) & ((config: import("@mat3ra/esse/dist/js/esse/types").AnyObject) => import("@mat3ra/esse/dist/js/esse/types").AnyObject);
1655
- isValid: (() => boolean) & (() => boolean) & (() => boolean) & (() => boolean) & (() => boolean);
1656
- readonly cls: string;
1657
- getClsName: (() => string) & (() => string) & (() => string) & (() => string) & (() => string);
1658
- getAsEntityReference: {
1659
- (byIdOnly: true): {
1660
- _id: string;
1661
- };
1662
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1663
- } & {
1664
- (byIdOnly: true): {
1665
- _id: string;
1666
- };
1667
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1668
- } & {
1669
- (byIdOnly: true): {
1670
- _id: string;
1671
- };
1672
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1673
- } & {
1674
- (byIdOnly: true): {
1675
- _id: string;
1676
- };
1677
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1678
- } & {
1679
- (byIdOnly: true): {
1680
- _id: string;
1681
- };
1682
- (byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1683
- };
1684
- getEntityByName: ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) & ((entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string) => import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity);
1685
- id: string;
1686
- _id: string;
1687
- schemaVersion: string;
1688
- systemName: string;
1689
- readonly slug: string;
1690
- readonly isSystemEntity: boolean;
1691
- metadata: object;
1692
- updateMetadata(object: object): void;
1693
- name: string;
1694
- setName(name: string): void;
1695
- readonly isDefault: boolean;
1696
- } & {
1697
- consistencyChecks: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[];
1698
- addConsistencyChecks(array: import("@mat3ra/esse/dist/js/types").ConsistencyCheck[]): void;
1699
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1700
- prop<T = undefined>(name: string, defaultValue: T): T;
1701
- prop<T_1 = undefined>(name: string): T_1 | undefined;
1702
- setProp(name: string, value: unknown): void;
1703
- unsetProp(name: string): void;
1704
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1705
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1706
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1707
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1708
- clone(extraContext?: object | undefined): any;
1709
- validate(): void;
1710
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1711
- isValid(): boolean;
1712
- readonly cls: string;
1713
- getClsName(): string;
1714
- getAsEntityReference(byIdOnly: true): {
1715
- _id: string;
1716
- };
1717
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1718
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1719
- id: string;
1720
- _id: string;
1721
- schemaVersion: string;
1722
- systemName: string;
1723
- readonly slug: string;
1724
- readonly isSystemEntity: boolean;
1725
- } & {
1726
- metadata: object;
1727
- updateMetadata(object: object): void;
1728
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1729
- prop<T_2 = undefined>(name: string, defaultValue: T_2): T_2;
1730
- prop<T_3 = undefined>(name: string): T_3 | undefined;
1731
- setProp(name: string, value: unknown): void;
1732
- unsetProp(name: string): void;
1733
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1734
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1735
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1736
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1737
- clone(extraContext?: object | undefined): any;
1738
- validate(): void;
1739
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1740
- isValid(): boolean;
1741
- readonly cls: string;
1742
- getClsName(): string;
1743
- getAsEntityReference(byIdOnly: true): {
1744
- _id: string;
1745
- };
1746
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1747
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1748
- id: string;
1749
- _id: string;
1750
- schemaVersion: string;
1751
- systemName: string;
1752
- readonly slug: string;
1753
- readonly isSystemEntity: boolean;
1754
- } & {
1755
- name: string;
1756
- setName(name: string): void;
1757
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1758
- prop<T_4 = undefined>(name: string, defaultValue: T_4): T_4;
1759
- prop<T_5 = undefined>(name: string): T_5 | undefined;
1760
- setProp(name: string, value: unknown): void;
1761
- unsetProp(name: string): void;
1762
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1763
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1764
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1765
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1766
- clone(extraContext?: object | undefined): any;
1767
- validate(): void;
1768
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1769
- isValid(): boolean;
1770
- readonly cls: string;
1771
- getClsName(): string;
1772
- getAsEntityReference(byIdOnly: true): {
1773
- _id: string;
1774
- };
1775
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1776
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1777
- id: string;
1778
- _id: string;
1779
- schemaVersion: string;
1780
- systemName: string;
1781
- readonly slug: string;
1782
- readonly isSystemEntity: boolean;
1783
- } & {
1784
- readonly isDefault: boolean;
1785
- _json: import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1786
- prop<T_6 = undefined>(name: string, defaultValue: T_6): T_6;
1787
- prop<T_7 = undefined>(name: string): T_7 | undefined;
1788
- setProp(name: string, value: unknown): void;
1789
- unsetProp(name: string): void;
1790
- setProps(json?: import("@mat3ra/esse/dist/js/esse/types").AnyObject | undefined): any;
1791
- toJSON(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1792
- toJSONSafe(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1793
- toJSONQuick(exclude?: string[] | undefined): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1794
- clone(extraContext?: object | undefined): any;
1795
- validate(): void;
1796
- clean(config: import("@mat3ra/esse/dist/js/esse/types").AnyObject): import("@mat3ra/esse/dist/js/esse/types").AnyObject;
1797
- isValid(): boolean;
1798
- readonly cls: string;
1799
- getClsName(): string;
1800
- getAsEntityReference(byIdOnly: true): {
1801
- _id: string;
1802
- };
1803
- getAsEntityReference(byIdOnly: false): Required<import("@mat3ra/esse/dist/js/types").EntityReferenceSchema>;
1804
- getEntityByName(entities: import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity[], entity: string, name: string): import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity;
1805
- id: string;
1806
- _id: string;
1807
- schemaVersion: string;
1808
- systemName: string;
1809
- readonly slug: string;
1810
- readonly isSystemEntity: boolean;
1811
- } & import("@mat3ra/code/dist/js/entity/in_memory").InMemoryEntity) => void;
533
+ scaleOneLatticeVector: (material: Material, key?: "a" | "b" | "c", factor?: number) => void;
534
+ scaleLatticeToMakeNonPeriodic: (material: Material) => void;
535
+ translateAtomsToCenter: (material: Material) => void;
1812
536
  };
1813
537
  basis: {
1814
538
  repeat: (basis: Basis, repetitions: number[]) => Basis;