@gembox/pdfviewer 2026.5.102 → 2026.5.103
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.
- package/dist/es/pdfviewer.css +1 -1
- package/dist/es/pdfviewer.d.ts +377 -0
- package/dist/es/pdfviewer.js +7907 -7760
- package/dist/iife/pdfviewer.css +1 -1
- package/dist/iife/pdfviewer.js +39 -39
- package/package.json +2 -1
package/dist/es/pdfviewer.css
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/*
|
|
2
|
-
* GemBox.PdfViewer v2026.5.
|
|
2
|
+
* GemBox.PdfViewer v2026.5.103 (https://www.gemboxsoftware.com/pdfviewer)
|
|
3
3
|
* Copyright © GemBox Ltd. — All rights reserved.
|
|
4
4
|
* Licensed under commercial license. See LICENSE.txt in the package root or e-mail us at info@gemboxsoftware.com to obtain the license.
|
|
5
5
|
*
|
package/dist/es/pdfviewer.d.ts
CHANGED
|
@@ -250,6 +250,23 @@ export declare namespace constants {
|
|
|
250
250
|
}
|
|
251
251
|
}
|
|
252
252
|
|
|
253
|
+
/**
|
|
254
|
+
* Defines the cursor modes available in the PDF viewer.
|
|
255
|
+
*
|
|
256
|
+
* @remarks
|
|
257
|
+
* The cursor mode determines how the mouse or touch interactions work with the PDF document.
|
|
258
|
+
*/
|
|
259
|
+
export declare enum CursorMode {
|
|
260
|
+
/**
|
|
261
|
+
* Text selection mode. Allows selecting and copying text from the PDF document.
|
|
262
|
+
*/
|
|
263
|
+
TextSelection = 0,
|
|
264
|
+
/**
|
|
265
|
+
* Draggable mode. Allows dragging the PDF document with mouse or touch instead of text selection.
|
|
266
|
+
*/
|
|
267
|
+
Draggable = 1
|
|
268
|
+
}
|
|
269
|
+
|
|
253
270
|
/**
|
|
254
271
|
* Represents an event that is emitted when a digital signing operation completes successfully.
|
|
255
272
|
*
|
|
@@ -513,6 +530,14 @@ export declare class DownloadButtonUI extends BasicButtonUI {
|
|
|
513
530
|
export declare interface DownloadButtonUIOptions extends VisibilityOption {
|
|
514
531
|
}
|
|
515
532
|
|
|
533
|
+
/**
|
|
534
|
+
* Represents the available values that can be displayed in dropdown menus for zoom options.
|
|
535
|
+
*
|
|
536
|
+
* @remarks
|
|
537
|
+
* This type includes constants for page fit and page width, as well as predefined zoom percentage values from the constants module.
|
|
538
|
+
*/
|
|
539
|
+
export declare type DropdownValues = typeof constants.pageFit | typeof constants.pageWidth | (typeof constants.zoomPercentageDropdownValues)[number];
|
|
540
|
+
|
|
516
541
|
/**
|
|
517
542
|
* Represents the e-signature element in the PDF viewer's side panel.
|
|
518
543
|
*
|
|
@@ -699,6 +724,11 @@ export declare interface FeaturesOptions {
|
|
|
699
724
|
digitalSigning?: DigitalSigningOptions;
|
|
700
725
|
}
|
|
701
726
|
|
|
727
|
+
export declare class FreeText {
|
|
728
|
+
get fontSize(): number;
|
|
729
|
+
set fontSize(value: number);
|
|
730
|
+
}
|
|
731
|
+
|
|
702
732
|
/**
|
|
703
733
|
* Represents the free text annotation component in the PDF viewer's toolbar.
|
|
704
734
|
*
|
|
@@ -824,6 +854,25 @@ export declare type NestedMessages = {
|
|
|
824
854
|
[key: string]: string | NestedMessages;
|
|
825
855
|
};
|
|
826
856
|
|
|
857
|
+
/**
|
|
858
|
+
* Represents a button in the PDF viewer toolbar that navigates to the next page of the document.
|
|
859
|
+
*
|
|
860
|
+
* @remarks
|
|
861
|
+
* This button allows users to move forward through the pages of the loaded PDF document, providing specific behavior for page navigation.
|
|
862
|
+
*/
|
|
863
|
+
export declare class NextPageButtonUI extends BasicButtonUI {
|
|
864
|
+
}
|
|
865
|
+
|
|
866
|
+
/**
|
|
867
|
+
* Represents a button in the PDF viewer toolbar that navigates to the next search match.
|
|
868
|
+
*
|
|
869
|
+
* @remarks
|
|
870
|
+
* This button allows users to move to the next occurrence of their search query within the document,
|
|
871
|
+
* providing specific behavior for search navigation.
|
|
872
|
+
*/
|
|
873
|
+
export declare class NextSearchButtonUI extends BasicButtonUI {
|
|
874
|
+
}
|
|
875
|
+
|
|
827
876
|
/**
|
|
828
877
|
* Represents a button in the PDF viewer toolbar that opens file dialog for loading PDF documents.
|
|
829
878
|
*
|
|
@@ -893,6 +942,32 @@ export declare interface PageEventMap {
|
|
|
893
942
|
*/
|
|
894
943
|
export declare const pageFit = "pageFit";
|
|
895
944
|
|
|
945
|
+
/**
|
|
946
|
+
* Represents an event that is fired when the input value has changed and page navigation occurs.
|
|
947
|
+
*
|
|
948
|
+
* @remarks
|
|
949
|
+
* This event provides read-only access to the target page number after validation.
|
|
950
|
+
*/
|
|
951
|
+
export declare interface PageInputChangedEvent extends ViewerEvent {
|
|
952
|
+
/**
|
|
953
|
+
* The target page number (entered as 1-based number) that has been applied.
|
|
954
|
+
*/
|
|
955
|
+
readonly pageNumber: number;
|
|
956
|
+
}
|
|
957
|
+
|
|
958
|
+
/**
|
|
959
|
+
* Represents an event that is fired when the input value is about to change.
|
|
960
|
+
*
|
|
961
|
+
* @remarks
|
|
962
|
+
* This event can be prevented to stop the page navigation from occurring.
|
|
963
|
+
*/
|
|
964
|
+
export declare interface PageInputChangingEvent extends ViewerEvent {
|
|
965
|
+
/**
|
|
966
|
+
* The page number string that is about to be applied.
|
|
967
|
+
*/
|
|
968
|
+
value: string;
|
|
969
|
+
}
|
|
970
|
+
|
|
896
971
|
/**
|
|
897
972
|
* Provides functionality for managing and navigating through pages in a PDF document.
|
|
898
973
|
*
|
|
@@ -952,6 +1027,43 @@ export declare class PageNavigation implements EventElement<PageEventMap> {
|
|
|
952
1027
|
previousPage(): void;
|
|
953
1028
|
}
|
|
954
1029
|
|
|
1030
|
+
/**
|
|
1031
|
+
* PageNavigationFieldEventMap is an interface used to provide type-safe event listeners and is not instantiated
|
|
1032
|
+
* or used directly. It maps event names to their corresponding event object types and
|
|
1033
|
+
* is consumed by addEventListener to ensure correct typing of listener callbacks.
|
|
1034
|
+
*/
|
|
1035
|
+
export declare interface PageNavigationFieldEventMap {
|
|
1036
|
+
/**
|
|
1037
|
+
* Event fired when the input value is about to change.
|
|
1038
|
+
*/
|
|
1039
|
+
inputChanging: PageInputChangingEvent;
|
|
1040
|
+
/**
|
|
1041
|
+
* Event fired when the input value has changed and page navigation occurs.
|
|
1042
|
+
*/
|
|
1043
|
+
inputChanged: PageInputChangedEvent;
|
|
1044
|
+
}
|
|
1045
|
+
|
|
1046
|
+
/**
|
|
1047
|
+
* Represents a field in the PDF viewer toolbar that allows users to navigate to specific pages by entering page numbers.
|
|
1048
|
+
*
|
|
1049
|
+
* @remarks
|
|
1050
|
+
* This component provides functionality for direct page navigation through user input, handling page number changes and validation.
|
|
1051
|
+
*/
|
|
1052
|
+
export declare class PageNavigationFieldUI implements VisibilityElement, EventElement<PageNavigationFieldEventMap> {
|
|
1053
|
+
/** @inheritdoc */
|
|
1054
|
+
get isVisible(): boolean;
|
|
1055
|
+
/** @inheritdoc */
|
|
1056
|
+
set isVisible(value: boolean);
|
|
1057
|
+
/** @inheritdoc */
|
|
1058
|
+
addEventListener<K extends keyof PageNavigationFieldEventMap>(type: K, listener: (event: PageNavigationFieldEventMap[K]) => void): void;
|
|
1059
|
+
/**
|
|
1060
|
+
* Sets the input value and handles page navigation.
|
|
1061
|
+
*
|
|
1062
|
+
* @param value - The page number string to navigate to.
|
|
1063
|
+
*/
|
|
1064
|
+
setInput(value: string): void;
|
|
1065
|
+
}
|
|
1066
|
+
|
|
955
1067
|
/**
|
|
956
1068
|
* Represents page navigation controls for the viewer toolbar.
|
|
957
1069
|
*/
|
|
@@ -1000,6 +1112,25 @@ export declare class PanModeButtonUI extends BasicButtonUI {
|
|
|
1000
1112
|
export declare interface PanModeButtonUIOptions extends VisibilityOption {
|
|
1001
1113
|
}
|
|
1002
1114
|
|
|
1115
|
+
/**
|
|
1116
|
+
* Represents a button in the PDF viewer toolbar that navigates to the previous page of the document.
|
|
1117
|
+
*
|
|
1118
|
+
* @remarks
|
|
1119
|
+
* This button allows users to move backward through the pages of the loaded PDF document, providing specific behavior for page navigation.
|
|
1120
|
+
*/
|
|
1121
|
+
export declare class PreviousPageButtonUI extends BasicButtonUI {
|
|
1122
|
+
}
|
|
1123
|
+
|
|
1124
|
+
/**
|
|
1125
|
+
* Represents a button in the PDF viewer toolbar that navigates to the previous search match.
|
|
1126
|
+
*
|
|
1127
|
+
* @remarks
|
|
1128
|
+
* This button allows users to move to the previous occurrence of their search query within the document,
|
|
1129
|
+
* providing specific behavior for search navigation.
|
|
1130
|
+
*/
|
|
1131
|
+
export declare class PreviousSearchButtonUI extends BasicButtonUI {
|
|
1132
|
+
}
|
|
1133
|
+
|
|
1003
1134
|
/**
|
|
1004
1135
|
* Represents a button in the PDF viewer toolbar that allows users to print the current document.
|
|
1005
1136
|
*
|
|
@@ -1020,6 +1151,32 @@ export declare class PrintButtonUI extends BasicButtonUI {
|
|
|
1020
1151
|
export declare interface PrintButtonUIOptions extends VisibilityOption {
|
|
1021
1152
|
}
|
|
1022
1153
|
|
|
1154
|
+
/**
|
|
1155
|
+
* Represents an event that is fired when the search query has changed and text searching occurs.
|
|
1156
|
+
*
|
|
1157
|
+
* @remarks
|
|
1158
|
+
* This event provides read-only access to the search query after validation.
|
|
1159
|
+
*/
|
|
1160
|
+
export declare interface QueryChangedEvent extends ViewerEvent {
|
|
1161
|
+
/**
|
|
1162
|
+
* The search query that has been applied.
|
|
1163
|
+
*/
|
|
1164
|
+
readonly value: string;
|
|
1165
|
+
}
|
|
1166
|
+
|
|
1167
|
+
/**
|
|
1168
|
+
* Represents an event that is fired when the search query is about to change.
|
|
1169
|
+
*
|
|
1170
|
+
* @remarks
|
|
1171
|
+
* This event can be prevented to stop the search from occurring.
|
|
1172
|
+
*/
|
|
1173
|
+
export declare interface QueryChangingEvent extends ViewerEvent {
|
|
1174
|
+
/**
|
|
1175
|
+
* The search query that is about to be applied.
|
|
1176
|
+
*/
|
|
1177
|
+
value: string;
|
|
1178
|
+
}
|
|
1179
|
+
|
|
1023
1180
|
/**
|
|
1024
1181
|
* Provides search functionality for finding text within PDF documents.
|
|
1025
1182
|
*
|
|
@@ -1170,6 +1327,43 @@ export declare interface SearchEventMap {
|
|
|
1170
1327
|
searchCompleted: SearchCompletedEvent;
|
|
1171
1328
|
}
|
|
1172
1329
|
|
|
1330
|
+
/**
|
|
1331
|
+
* SearchFieldEventMap is an interface used to provide type-safe event listeners and is not instantiated
|
|
1332
|
+
* or used directly. It maps event names to their corresponding event object types and
|
|
1333
|
+
* is consumed by addEventListener to ensure correct typing of listener callbacks.
|
|
1334
|
+
*/
|
|
1335
|
+
export declare interface SearchFieldEventMap {
|
|
1336
|
+
/**
|
|
1337
|
+
* Event fired when the search query is about to change.
|
|
1338
|
+
*/
|
|
1339
|
+
queryChanging: QueryChangingEvent;
|
|
1340
|
+
/**
|
|
1341
|
+
* Event fired when the search query has changed and text searching occurs.
|
|
1342
|
+
*/
|
|
1343
|
+
queryChanged: QueryChangedEvent;
|
|
1344
|
+
}
|
|
1345
|
+
|
|
1346
|
+
/**
|
|
1347
|
+
* Represents a field in the PDF viewer toolbar that allows users to search for text within documents.
|
|
1348
|
+
*
|
|
1349
|
+
* @remarks
|
|
1350
|
+
* This component provides functionality for text searching through user input, handling search queries and validation.
|
|
1351
|
+
*/
|
|
1352
|
+
export declare class SearchFieldUI implements VisibilityElement, EventElement<SearchFieldEventMap> {
|
|
1353
|
+
/** @inheritdoc */
|
|
1354
|
+
get isVisible(): boolean;
|
|
1355
|
+
/** @inheritdoc */
|
|
1356
|
+
set isVisible(value: boolean);
|
|
1357
|
+
/** @inheritdoc */
|
|
1358
|
+
addEventListener<K extends keyof SearchFieldEventMap>(type: K, listener: (event: SearchFieldEventMap[K]) => void): void;
|
|
1359
|
+
/**
|
|
1360
|
+
* Sets the search query and handles text searching.
|
|
1361
|
+
*
|
|
1362
|
+
* @param value - The search query string to find in the document.
|
|
1363
|
+
*/
|
|
1364
|
+
setQuery(value: string): void;
|
|
1365
|
+
}
|
|
1366
|
+
|
|
1173
1367
|
/**
|
|
1174
1368
|
* Event emitted when a search operation is starting.
|
|
1175
1369
|
*
|
|
@@ -1609,6 +1803,32 @@ export declare interface UIOptions {
|
|
|
1609
1803
|
sidePanel?: SidePanelUIOptions;
|
|
1610
1804
|
}
|
|
1611
1805
|
|
|
1806
|
+
/**
|
|
1807
|
+
* Represents an event that is fired when the zoom level has changed and been applied.
|
|
1808
|
+
*
|
|
1809
|
+
* @remarks
|
|
1810
|
+
* This event provides read-only access to the selected zoom level after validation.
|
|
1811
|
+
*/
|
|
1812
|
+
export declare interface ValueChangedEvent extends ViewerEvent {
|
|
1813
|
+
/**
|
|
1814
|
+
* The zoom level that has been applied.
|
|
1815
|
+
*/
|
|
1816
|
+
readonly value: DropdownValues;
|
|
1817
|
+
}
|
|
1818
|
+
|
|
1819
|
+
/**
|
|
1820
|
+
* Represents an event that is fired when the zoom level is about to change.
|
|
1821
|
+
*
|
|
1822
|
+
* @remarks
|
|
1823
|
+
* This event can be prevented to stop the zoom level from being applied.
|
|
1824
|
+
*/
|
|
1825
|
+
export declare interface ValueChangingEvent extends ViewerEvent {
|
|
1826
|
+
/**
|
|
1827
|
+
* The zoom level that is about to be applied.
|
|
1828
|
+
*/
|
|
1829
|
+
value: DropdownValues;
|
|
1830
|
+
}
|
|
1831
|
+
|
|
1612
1832
|
/**
|
|
1613
1833
|
* Represents a base event interface for the PDF viewer that provides functionality
|
|
1614
1834
|
* similar to the standard DOM Event interface, allowing events to be canceled.
|
|
@@ -1806,6 +2026,57 @@ export declare interface ZoomChangingEvent extends ViewerEvent {
|
|
|
1806
2026
|
zoomLevelAfter: ZoomLevel;
|
|
1807
2027
|
}
|
|
1808
2028
|
|
|
2029
|
+
/**
|
|
2030
|
+
* ZoomDropdownEventMap is an interface used to provide type-safe event listeners and is not instantiated
|
|
2031
|
+
* or used directly. It maps event names to their corresponding event object types and
|
|
2032
|
+
* is consumed by addEventListener to ensure correct typing of listener callbacks.
|
|
2033
|
+
*/
|
|
2034
|
+
export declare interface ZoomDropdownEventMap {
|
|
2035
|
+
/**
|
|
2036
|
+
* Event fired when the zoom level is about to change.
|
|
2037
|
+
*/
|
|
2038
|
+
valueChanging: ValueChangingEvent;
|
|
2039
|
+
/**
|
|
2040
|
+
* Event fired when the zoom level has changed and been applied.
|
|
2041
|
+
*/
|
|
2042
|
+
valueChanged: ValueChangedEvent;
|
|
2043
|
+
}
|
|
2044
|
+
|
|
2045
|
+
/**
|
|
2046
|
+
* Represents a dropdown in the PDF viewer toolbar that allows users to select different zoom levels.
|
|
2047
|
+
*
|
|
2048
|
+
* @remarks
|
|
2049
|
+
* This component provides functionality for zoom level selection through user input, handling zoom changes and validation.
|
|
2050
|
+
*/
|
|
2051
|
+
export declare class ZoomDropdownUI implements VisibilityElement, EventElement<ZoomDropdownEventMap> {
|
|
2052
|
+
/** @inheritdoc */
|
|
2053
|
+
get isVisible(): boolean;
|
|
2054
|
+
/** @inheritdoc */
|
|
2055
|
+
set isVisible(value: boolean);
|
|
2056
|
+
/** @inheritdoc */
|
|
2057
|
+
addEventListener<K extends keyof ZoomDropdownEventMap>(type: K, listener: (event: ZoomDropdownEventMap[K]) => void): void;
|
|
2058
|
+
/**
|
|
2059
|
+
* Selects a zoom level from the dropdown.
|
|
2060
|
+
*
|
|
2061
|
+
* @param value - The zoom level to apply
|
|
2062
|
+
*/
|
|
2063
|
+
select(value: DropdownValues): void;
|
|
2064
|
+
/**
|
|
2065
|
+
* Whether the dropdown is opened or closed.
|
|
2066
|
+
*/
|
|
2067
|
+
get isOpened(): boolean;
|
|
2068
|
+
/**
|
|
2069
|
+
* Whether the dropdown is opened or closed.
|
|
2070
|
+
*
|
|
2071
|
+
* @param value - The visibility state to set.
|
|
2072
|
+
*/
|
|
2073
|
+
set isOpened(value: boolean);
|
|
2074
|
+
/**
|
|
2075
|
+
* Toggles the open/closed state of the dropdown.
|
|
2076
|
+
*/
|
|
2077
|
+
toggleOpen(): void;
|
|
2078
|
+
}
|
|
2079
|
+
|
|
1809
2080
|
/**
|
|
1810
2081
|
* ZoomEventMap is an interface used to provide type-safe event listeners and is not instantiated
|
|
1811
2082
|
* or used directly. It maps event names to their corresponding event object types and
|
|
@@ -1820,6 +2091,59 @@ export declare interface ZoomEventMap {
|
|
|
1820
2091
|
zoomChanged: ZoomChangedEvent;
|
|
1821
2092
|
}
|
|
1822
2093
|
|
|
2094
|
+
/**
|
|
2095
|
+
* ZoomInButtonEventMap is an interface used to provide type-safe event listeners and is not instantiated
|
|
2096
|
+
* or used directly. It maps event names to their corresponding event object types and
|
|
2097
|
+
* is consumed by addEventListener to ensure correct typing of listener callbacks.
|
|
2098
|
+
*/
|
|
2099
|
+
export declare interface ZoomInButtonEventMap {
|
|
2100
|
+
/**
|
|
2101
|
+
* Event fired when the zoom in button is clicked.
|
|
2102
|
+
*/
|
|
2103
|
+
click: ZoomInClickEvent;
|
|
2104
|
+
}
|
|
2105
|
+
|
|
2106
|
+
/**
|
|
2107
|
+
* Represents a button in the PDF viewer toolbar that increases the magnification level of the document view.
|
|
2108
|
+
*
|
|
2109
|
+
* @remarks
|
|
2110
|
+
* This component provides functionality for zooming in on the document, handling zoom changes with before/after information.
|
|
2111
|
+
*/
|
|
2112
|
+
export declare class ZoomInButtonUI implements VisibilityElement, EventElement<ZoomInButtonEventMap> {
|
|
2113
|
+
/** @inheritdoc */
|
|
2114
|
+
get isVisible(): boolean;
|
|
2115
|
+
/** @inheritdoc */
|
|
2116
|
+
set isVisible(value: boolean);
|
|
2117
|
+
/** @inheritdoc */
|
|
2118
|
+
addEventListener<K extends keyof ZoomInButtonEventMap>(type: K, listener: (event: ZoomInButtonEventMap[K]) => void): void;
|
|
2119
|
+
/**
|
|
2120
|
+
* Increases the zoom level by one step.
|
|
2121
|
+
*
|
|
2122
|
+
* @remarks
|
|
2123
|
+
* This method calculates the next appropriate zoom level based on predefined steps and
|
|
2124
|
+
* emits {@link ZoomInClickEvent} before applying the change.
|
|
2125
|
+
*/
|
|
2126
|
+
click(): Promise<void>;
|
|
2127
|
+
}
|
|
2128
|
+
|
|
2129
|
+
/**
|
|
2130
|
+
* Represents an event that is fired when the zoom in button is clicked.
|
|
2131
|
+
*
|
|
2132
|
+
* @remarks
|
|
2133
|
+
* This event provides read-only access to the current zoom level and allows modification of the target
|
|
2134
|
+
* zoom level before it's applied. The event can be prevented to stop the zoom operation entirely.
|
|
2135
|
+
*/
|
|
2136
|
+
export declare interface ZoomInClickEvent extends ViewerEvent {
|
|
2137
|
+
/**
|
|
2138
|
+
* The current zoom level before the change.
|
|
2139
|
+
*/
|
|
2140
|
+
readonly zoomLevelBefore: number;
|
|
2141
|
+
/**
|
|
2142
|
+
* The target zoom level after the change. This value can be modified to customize the zoom operation.
|
|
2143
|
+
*/
|
|
2144
|
+
zoomLevelAfter: number;
|
|
2145
|
+
}
|
|
2146
|
+
|
|
1823
2147
|
/**
|
|
1824
2148
|
* Represents the zoom level that can be applied to the PDF viewer.
|
|
1825
2149
|
*
|
|
@@ -1828,6 +2152,59 @@ export declare interface ZoomEventMap {
|
|
|
1828
2152
|
*/
|
|
1829
2153
|
export declare type ZoomLevel = number | typeof constants.automatic | typeof constants.pageFit | typeof constants.pageWidth;
|
|
1830
2154
|
|
|
2155
|
+
/**
|
|
2156
|
+
* ZoomOutButtonEventMap is an interface used to provide type-safe event listeners and is not instantiated
|
|
2157
|
+
* or used directly. It maps event names to their corresponding event object types and
|
|
2158
|
+
* is consumed by addEventListener to ensure correct typing of listener callbacks.
|
|
2159
|
+
*/
|
|
2160
|
+
export declare interface ZoomOutButtonEventMap {
|
|
2161
|
+
/**
|
|
2162
|
+
* Event fired when the zoom out button is clicked.
|
|
2163
|
+
*/
|
|
2164
|
+
click: ZoomOutClickEvent;
|
|
2165
|
+
}
|
|
2166
|
+
|
|
2167
|
+
/**
|
|
2168
|
+
* Represents a button in the PDF viewer toolbar that decreases the magnification level of the document view.
|
|
2169
|
+
*
|
|
2170
|
+
* @remarks
|
|
2171
|
+
* This component provides functionality for zooming out on the document, handling zoom changes with before/after information.
|
|
2172
|
+
*/
|
|
2173
|
+
export declare class ZoomOutButtonUI implements VisibilityElement, EventElement<ZoomOutButtonEventMap> {
|
|
2174
|
+
/** @inheritdoc */
|
|
2175
|
+
get isVisible(): boolean;
|
|
2176
|
+
/** @inheritdoc */
|
|
2177
|
+
set isVisible(value: boolean);
|
|
2178
|
+
/** @inheritdoc */
|
|
2179
|
+
addEventListener<K extends keyof ZoomOutButtonEventMap>(type: K, listener: (event: ZoomOutButtonEventMap[K]) => void): void;
|
|
2180
|
+
/**
|
|
2181
|
+
* Decreases the zoom level by one step.
|
|
2182
|
+
*
|
|
2183
|
+
* @remarks
|
|
2184
|
+
* This method calculates the previous appropriate zoom level based on predefined steps and
|
|
2185
|
+
* emits {@link ZoomOutClickEvent} before applying the change.
|
|
2186
|
+
*/
|
|
2187
|
+
click(): Promise<void>;
|
|
2188
|
+
}
|
|
2189
|
+
|
|
2190
|
+
/**
|
|
2191
|
+
* Represents an event that is fired when the zoom out button is clicked.
|
|
2192
|
+
*
|
|
2193
|
+
* @remarks
|
|
2194
|
+
* This event provides read-only access to the current zoom level and allows modification of the target
|
|
2195
|
+
* zoom level before it's applied. The event can be prevented to stop the zoom operation entirely.
|
|
2196
|
+
*/
|
|
2197
|
+
export declare interface ZoomOutClickEvent extends ViewerEvent {
|
|
2198
|
+
/**
|
|
2199
|
+
* The current zoom level before the change.
|
|
2200
|
+
*/
|
|
2201
|
+
readonly zoomLevelBefore: number;
|
|
2202
|
+
/**
|
|
2203
|
+
* The target zoom level after the change. This value can be modified to customize the zoom operation.
|
|
2204
|
+
*/
|
|
2205
|
+
zoomLevelAfter: number;
|
|
2206
|
+
}
|
|
2207
|
+
|
|
1831
2208
|
/**
|
|
1832
2209
|
* Represents the default zoom percentage values for the dropdown menu.
|
|
1833
2210
|
*
|