Difference between revisions of "SYSCLS DOCUMENT FITMODE"
m |
|||
| Line 11: | Line 11: | ||
The DOCUMENT FITMODE is a classification that allows a ubik data designer do pre-define how a document will be initially presented on the client, before any pan-zoom user interaction was done. This gives the possibility to optimize the user experience when quickly browsing through documents. For multi-page documents, the setting applies to the first page only. The needed parameter can be provided individually for each document by defining a value the property "FIT_TYPE" (see table below): | The DOCUMENT FITMODE is a classification that allows a ubik data designer do pre-define how a document will be initially presented on the client, before any pan-zoom user interaction was done. This gives the possibility to optimize the user experience when quickly browsing through documents. For multi-page documents, the setting applies to the first page only. The needed parameter can be provided individually for each document by defining a value the property "FIT_TYPE" (see table below): | ||
| − | * 0 ... Unspecified (default): The document will be shown as it is (100%) | + | * 0 ... Unspecified (default): The document will be shown as it is (100%). If the document is larger than the presentation area it will be cropped randomly. |
| − | * 1 ... Fit to container: The document will be fitted to the presentation area in the UI. | + | * 1 ... Fit to container: The document will be fitted to the presentation area in the UI. This will ensure that the document will not be cropped. |
| − | * 2 ... Fit to width: The document scaling will be adapted to use the full presentation area width. | + | * 2 ... Fit to width: The document scaling will be adapted to use the full presentation area width. If the document height is larger than the presentation area height, it will be cropped. |
| − | * 3 ... Fit to height: The document scaling will be adapted to use the full presentation area height. | + | * 3 ... Fit to height: The document scaling will be adapted to use the full presentation area height. If the document widthis larger than the presentation area width, it will be cropped. |
== MetaProperties == | == MetaProperties == | ||
Revision as of 08:55, 6 March 2019
 SYSCLS_DOCUMENT_FITMODE |
|
|---|---|
| Name | SYSCLS_DOCUMENT_FITMODE |
| Inheritance | SYSCLS_DOCUMENT |
| Namespace | System.Classification.Presentation |
| ID | {5ac5aa58-d59e-dc68-645d-0206ee75e688} |
| Purpose | Document "Fit to" mode classification object |
| Version | 2.6.3+ |
The DOCUMENT FITMODE is a classification that allows a ubik data designer do pre-define how a document will be initially presented on the client, before any pan-zoom user interaction was done. This gives the possibility to optimize the user experience when quickly browsing through documents. For multi-page documents, the setting applies to the first page only. The needed parameter can be provided individually for each document by defining a value the property "FIT_TYPE" (see table below):
- 0 ... Unspecified (default): The document will be shown as it is (100%). If the document is larger than the presentation area it will be cropped randomly.
- 1 ... Fit to container: The document will be fitted to the presentation area in the UI. This will ensure that the document will not be cropped.
- 2 ... Fit to width: The document scaling will be adapted to use the full presentation area width. If the document height is larger than the presentation area height, it will be cropped.
- 3 ... Fit to height: The document scaling will be adapted to use the full presentation area height. If the document widthis larger than the presentation area width, it will be cropped.
MetaProperties
| Name | Data type | Comment |
|---|---|---|
| FIT_MODE | Int | Document "Fit to" mode; 0 - "Unspecified" 1 - "Fit to container" 2 - "Fit to width" 3 - "Fit to height" |
