You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONFIG.md
+22-19Lines changed: 22 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,15 @@
3
3
> This document provides a detailed explanation of the configuration options available within the Universal Viewer. Each option is described with its purpose, data type, and default value, helping users customise and optimise the viewer's behaviour and appearance for specific needs.
4
4
>
5
5
## Example Manifests:
6
-
> AV manifest: https://iiif.io/api/cookbook/recipe/0026-toc-opera/manifest.json
@@ -71,9 +73,10 @@ Determines if settings that have been changed from the default e.g reduce motion
71
73
72
74
#### avCenterPanel
73
75
74
-
##### mostSpecificRequiredStatement
76
+
##### mostSpecificRequiredStatement
75
77
**Type**: `boolean`
76
78
**Default**: `true`
79
+
Determines whether the most specific (deeply nested) requiredStatement is displayed, such as one defined at the canvas level instead of the higher manifest level, when multiple requiredStatements exist within the manifest. requiredStatementEnabled must also be set to true for this to show.
77
80
78
81
#### downloadDialogue
79
82
@@ -755,12 +758,12 @@ Determines if the subtitle is enabled.
755
758
##### mostSpecificRequiredStatement
756
759
**Type**: `boolean`
757
760
**Default**: `true`
758
-
Determines if the most specific required statement is displayed.
761
+
Determines whether the most specific (deeply nested) requiredStatement is displayed, such as one defined at the canvas level instead of the higher manifest level, when multiple requiredStatements exist within the manifest. requiredStatementEnabled must also be set to true for this to show.
759
762
760
763
##### requiredStatementEnabled
761
764
**Type**: `boolean`
762
765
**Default**: `true`
763
-
Determines if the required statement is enabled.
766
+
Determines if the [required statement](https://iiif.io/api/cookbook/recipe/0008-rights/) is enabled.
764
767
765
768
#### avCenterPanel
766
769
@@ -797,12 +800,12 @@ Determines if subtitles are enabled.
797
800
##### mostSpecificRequiredStatement
798
801
**Type**: `boolean`
799
802
**Default**: `true`
800
-
Determines if the most specific required statement is used.
803
+
Determines whether the most specific (deeply nested) requiredStatement is displayed, such as one defined at the canvas level instead of the higher manifest level, when multiple requiredStatements exist within the manifest. requiredStatementEnabled must also be set to true for this to show.
801
804
802
805
##### requiredStatementEnabled
803
806
**Type**: `boolean`
804
807
**Default**: `true`
805
-
Determines if the required statement is enabled.
808
+
Determines if the [required statement](https://iiif.io/api/cookbook/recipe/0008-rights/) is enabled.
806
809
807
810
##### posterImageExpanded
808
811
**Type**: `boolean`
@@ -894,7 +897,12 @@ Maximum pixel ratio for zoom.
894
897
##### mostSpecificRequiredStatement
895
898
**Type**: `boolean`
896
899
**Default**: `true`
897
-
Determines if the most specific required statement is displayed.
900
+
Determines whether the most specific (deeply nested) requiredStatement is displayed, such as one defined at the canvas level instead of the higher manifest level, when multiple requiredStatements exist within the manifest. requiredStatementEnabled must also be set to true for this to show.
901
+
902
+
##### requiredStatementEnabled
903
+
**Type**: `boolean`
904
+
**Default**: `true`
905
+
Determines if the [required statement](https://iiif.io/api/cookbook/recipe/0008-rights/) is enabled.
898
906
899
907
##### navigatorPosition
900
908
**Type**: `string`
@@ -906,11 +914,6 @@ Position of the navigator.
906
914
**Default**: `50`
907
915
Gap between pages.
908
916
909
-
##### requiredStatementEnabled
910
-
**Type**: `boolean`
911
-
**Default**: `true`
912
-
Determines if the required statement is enabled.
913
-
914
917
##### showHomeControl
915
918
**Type**: `boolean`
916
919
**Default**: `false`
@@ -961,12 +964,12 @@ Determines if subtitles are enabled.
961
964
##### mostSpecificRequiredStatement
962
965
**Type**: `boolean`
963
966
**Default**: `true`
964
-
Determines if the most specific required statement is used.
967
+
Determines whether the most specific (deeply nested) requiredStatement is displayed, such as one defined at the canvas level instead of the higher manifest level, when multiple requiredStatements exist within the manifest. requiredStatementEnabled must also be set to true for this to show.
965
968
966
969
##### requiredStatementEnabled
967
970
**Type**: `boolean`
968
971
**Default**: `true`
969
-
Determines if the required statement is enabled.
972
+
Determines if the [required statement](https://iiif.io/api/cookbook/recipe/0008-rights/) is enabled.
970
973
971
974
##### usePdfJs
972
975
**Type**: `boolean`
@@ -1003,12 +1006,12 @@ Determines if subtitles are enabled.
1003
1006
##### mostSpecificRequiredStatement
1004
1007
**Type**: `boolean`
1005
1008
**Default**: `true`
1006
-
Determines if the most specific required statement is used.
1009
+
Determines whether the most specific (deeply nested) requiredStatement is displayed, such as one defined at the canvas level instead of the higher manifest level, when multiple requiredStatements exist within the manifest. requiredStatementEnabled must also be set to true for this to show.
1007
1010
1008
1011
##### requiredStatementEnabled
1009
1012
**Type**: `boolean`
1010
1013
**Default**: `true`
1011
-
Determines if the required statement is enabled.
1014
+
Determines if the [required statement](https://iiif.io/api/cookbook/recipe/0008-rights/) is enabled.
0 commit comments